api

package

v4.0.1-alpha.1 Latest Latest Go to latest Published: Aug 30, 2022 License: UNKNOWN not legal advice Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nutanix/ntnx-api-golang-clients

Documentation ¶

Overview ¶

Api classes for clustermgmt's golang SDK

Index ¶

type ClusterApi
- func NewClusterApi(apiClient *client.ApiClient) *ClusterApi

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ClusterApi ¶

type ClusterApi struct {
	ApiClient *client.ApiClient
}

func NewClusterApi ¶

func NewClusterApi(apiClient *client.ApiClient) *ClusterApi

func (*ClusterApi) GetCluster ¶

func (api *ClusterApi) GetCluster(clusterExtId *string, args ...map[string]interface{}) (*import1.GetClusterResponse, error)

*

Get cluster entity
Get cluster entity

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetClusterResponse, error)

func (*ClusterApi) GetClusters ¶

func (api *ClusterApi) GetClusters(page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.GetClustersResponse, error)

*

Get cluster entities
Get cluster entities

parameters:-
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - extId - name
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - name
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetClustersResponse, error)

func (*ClusterApi) GetDomainFaultToleranceStatus ¶

func (api *ClusterApi) GetDomainFaultToleranceStatus(clusterExtId *string, args ...map[string]interface{}) (*import1.GetDomainFaultToleranceResponse, error)

*

Get Domain Fault tolerance status
Get Domain Fault tolerance status

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetDomainFaultToleranceResponse, error)

func (*ClusterApi) GetGpuProfiles ¶

func (api *ClusterApi) GetGpuProfiles(clusterExtId *string, args ...map[string]interface{}) (*import1.GetGpuProfilesResponse, error)

*

Get GPU profiles
Get GPU profiles

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetGpuProfilesResponse, error)

func (*ClusterApi) GetHost ¶

func (api *ClusterApi) GetHost(clusterExtId *string, hostExtId *string, args ...map[string]interface{}) (*import1.GetHostResponse, error)

*

Get host entity
Get host entity

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> hostExtId (string) (required) : Host UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetHostResponse, error)

func (*ClusterApi) GetHostGpu ¶

func (api *ClusterApi) GetHostGpu(clusterExtId *string, hostExtId *string, hostGpuExtId *string, args ...map[string]interface{}) (*import1.GetHostGpuResponse, error)

*

Get host GPU
Get host GPU

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> hostExtId (string) (required) : Host UUID
-> hostGpuExtId (string) (required) : Host GPU UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetHostGpuResponse, error)

func (*ClusterApi) GetHostGpus ¶

func (api *ClusterApi) GetHostGpus(clusterExtId *string, hostExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.GetHostGpusResponse, error)

*

Get host GPUs on a particular host
Get host GPUs on a particular host

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> hostExtId (string) (required) : Host UUID
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - numberOfVgpusAllocated
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - numberOfVgpusAllocated
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetHostGpusResponse, error)

func (*ClusterApi) GetHostGpusOfCluster ¶

func (api *ClusterApi) GetHostGpusOfCluster(clusterExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.GetClusterHostGpusResponse, error)

*

Get all host GPUs of a cluster
Get all host GPUs of a cluster

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - numberOfVgpusAllocated
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - numberOfVgpusAllocated
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetClusterHostGpusResponse, error)

func (*ClusterApi) GetHosts ¶

func (api *ClusterApi) GetHosts(clusterExtId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, args ...map[string]interface{}) (*import1.GetHostsResponse, error)

*

Get host entities of a cluster
Get host entities of a cluster

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> page_ (int) (optional) : A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource.  Any number out of this range will be set to its nearest bound.  In other words, a page number of less than 0 would be set to 0 and a page number greater than the total available pages would be set to the last page.
-> limit_ (int) (optional) : A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 0 and 100. Any number out of this range will be set to the default maximum number of records, which is 100.
-> filter_ (string) (optional) : A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. The filter can be applied on the following fields: - bootTimeUsecs - cpuCapacityHz - cpuFrequencyHz - cpuModel - defaultVhdContainerId - defaultVhdContainerUuid - defaultVhdLocation - defaultVmContainerId - defaultVmContainerUuid - defaultVmLocation - gpuDriverVersion - hostName - memorySizeBytes - numberOfCpuCores - numberOfCpuSockets - numberOfCpuThreads
-> orderby_ (string) (optional) : A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, 'orderby=templateName desc' would get all templates sorted by templateName in desc order. The orderby can be applied to the following fields: - hostName
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetHostsResponse, error)

func (*ClusterApi) GetRackableUnit ¶

func (api *ClusterApi) GetRackableUnit(clusterExtId *string, rackableUnitExtId *string, args ...map[string]interface{}) (*import1.GetRackableUnitResponse, error)

*

Get rackable unit entity
Get rackable unit entity

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> rackableUnitExtId (string) (required) : Rackable unit UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetRackableUnitResponse, error)

func (*ClusterApi) GetRackableUnits ¶

func (api *ClusterApi) GetRackableUnits(clusterExtId *string, args ...map[string]interface{}) (*import1.GetRackableUnitsResponse, error)

*

Get rackable unit entities of a cluster
Get rackable unit entities of a cluster

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetRackableUnitsResponse, error)

func (*ClusterApi) GetRsyslogServers ¶

func (api *ClusterApi) GetRsyslogServers(clusterExtId *string, args ...map[string]interface{}) (*import1.GetRsyslogServersResponse, error)

*

Get RSYSLOG Servers configuration details
Get RSYSLOG Servers configuration details

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetRsyslogServersResponse, error)

func (*ClusterApi) GetSnmp ¶

func (api *ClusterApi) GetSnmp(clusterExtId *string, args ...map[string]interface{}) (*import1.GetSnmpResponse, error)

*

Get SNMP information
Get SNMP information

parameters:-
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (clustermgmt.v4.config.GetSnmpResponse, error)

Source Files ¶

View all Source files

cluster_api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL