api

package
v4.0.1-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: UNKNOWN not legal advice Imports: 8 Imported by: 0

Documentation

Overview

Api classes for clustermgmt's golang SDK

Api classes for clustermgmt's golang SDK

Api classes for clustermgmt's golang SDK

Api classes for clustermgmt's golang SDK

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClustersApi 

type ClustersApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewClustersApi 

func NewClustersApi(apiClient *client.ApiClient) *ClustersApi

func (*ClustersApi) AddSnmpTransport 

func (api *ClustersApi) AddSnmpTransport(extId *string, body *import1.SnmpTransport, args ...map[string]interface{}) (*import1.AddSnmpTransportsApiResponse, error)

Adds transport ports and protocol details to the SNMP configuration associated with the cluster identified by {extId}.

func (*ClustersApi) CheckHypervisorRequirements 

func (api *ClustersApi) CheckHypervisorRequirements(extId *string, body *import1.HypervisorUploadParam, args ...map[string]interface{}) (*import1.CheckHypervisorRequirementsApiResponse, error)

Provides information on whether hypervisor ISO upload is required or not. This API is not supported for XEN hypervisor type.

func (*ClustersApi) CreateCluster 

func (api *ClustersApi) CreateCluster(body *import1.Cluster, args ...map[string]interface{}) (*import1.CreateClusterApiResponse, error)

Cluster create operation.

func (*ClustersApi) CreateRsyslogServer 

func (api *ClustersApi) CreateRsyslogServer(extId *string, body *import1.RsyslogServer, args ...map[string]interface{}) (*import1.CreateRsyslogServerApiResponse, error)

Adds RSYSLOG server configuration to the cluster identified by {extId}.

func (*ClustersApi) CreateSnmpTrap 

func (api *ClustersApi) CreateSnmpTrap(extId *string, body *import1.SnmpTrap, args ...map[string]interface{}) (*import1.CreateSnmpTrapApiResponse, error)

Add SNMP trap configuration associated with the cluster identified by {extId}.

func (*ClustersApi) CreateSnmpUser 

func (api *ClustersApi) CreateSnmpUser(extId *string, body *import1.SnmpUser, args ...map[string]interface{}) (*import1.CreateSnmpUserApiResponse, error)

Adds SNMP user configuration to the cluster identified by {extId}.

func (*ClustersApi) DeleteClusterById 

func (api *ClustersApi) DeleteClusterById(extId *string, runPrechecksOnly *bool, args ...map[string]interface{}) (*import1.DeleteClusterApiResponse, error)

Deletes the cluster identified by {extId}.

func (*ClustersApi) DeleteRsyslogServerById 

func (api *ClustersApi) DeleteRsyslogServerById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.DeleteRsyslogServerApiResponse, error)

Deletes RSYSLOG server configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) DeleteSnmpTrapById 

func (api *ClustersApi) DeleteSnmpTrapById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.DeleteSnmpTrapApiResponse, error)

Deletes SNMP trap configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) DeleteSnmpUserById 

func (api *ClustersApi) DeleteSnmpUserById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.DeleteSnmpUserApiResponse, error)

Deletes SNMP user configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) DiscoverUnconfiguredNodes 

func (api *ClustersApi) DiscoverUnconfiguredNodes(extId *string, body *import1.NodeDiscoveryParams, args ...map[string]interface{}) (*import1.DiscoverUnconfiguredNodesApiResponse, error)

Get the unconfigured node details such as node UUID, node position, node IP, foundation version and more.

func (*ClustersApi) ExpandCluster 

func (api *ClustersApi) ExpandCluster(extId *string, body *import1.ExpandClusterParams, args ...map[string]interface{}) (*import1.ExpandClusterApiResponse, error)

Add node on a cluster. This API is not supported for XEN hypervisor type.

func (*ClustersApi) FetchNodeNetworkingDetails 

func (api *ClustersApi) FetchNodeNetworkingDetails(extId *string, body *import1.NodeDetails, args ...map[string]interface{}) (*import1.FetchNodeNetworkingDetailsApiResponse, error)

Get a dictionary of cluster networks and available uplinks on the given nodes. This API is not supported for XEN hypervisor type.

func (*ClustersApi) FetchTaskResponse 

func (api *ClustersApi) FetchTaskResponse(extId *string, body *import1.SearchParams, args ...map[string]interface{}) (*import1.FetchTaskApiResponse, error)

Get task response based on the type of request.

func (*ClustersApi) GetClusterById 

func (api *ClustersApi) GetClusterById(extId *string, args ...map[string]interface{}) (*import1.GetClusterApiResponse, error)

Fetches the cluster entity details identified by {extId}.

func (*ClustersApi) GetClusterStats 

func (api *ClustersApi) GetClusterStats(clusterExtId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import3.DownSamplingOperator, args ...map[string]interface{}) (*import2.ClusterStatsApiResponse, error)

Get the statistics data of the cluster identified by {clusterExtId}.

func (*ClustersApi) GetFaultToleranceStatusByClusterId 

func (api *ClustersApi) GetFaultToleranceStatusByClusterId(extId *string, args ...map[string]interface{}) (*import1.GetFaultToleranceStatusByClusterIdApiResponse, error)

Fetches the domain fault tolerance status of the cluster identified by {extId}.

func (*ClustersApi) GetHostById 

func (api *ClustersApi) GetHostById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetHostApiResponse, error)

Fetches the details of the host identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) GetHostNicById 

func (api *ClustersApi) GetHostNicById(clusterExtId *string, hostExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetHostNicApiResponse, error)

Get the host NIC entity of the host identified by {hostExtId} belonging to the cluster identified by {clusterExtId}.

func (*ClustersApi) GetHostStats 

func (api *ClustersApi) GetHostStats(clusterExtId *string, hostExtId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import3.DownSamplingOperator, args ...map[string]interface{}) (*import2.HostStatsApiResponse, error)

Get the statistics data of the host identified by {hostExtId} belonging to the cluster identified by {clusterExtId}.

func (*ClustersApi) GetRackableUnitById 

func (api *ClustersApi) GetRackableUnitById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetRackableUnitApiResponse, error)

Fetches the rackable unit entity details identified by {extId} of the cluster identified by {clusterExtId}.

func (*ClustersApi) GetRsyslogServerById 

func (api *ClustersApi) GetRsyslogServerById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetRsyslogServerApiResponse, error)

Fetches the RSYSLOG server configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) GetSnmpConfigByClusterId 

func (api *ClustersApi) GetSnmpConfigByClusterId(extId *string, args ...map[string]interface{}) (*import1.GetSnmpConfigByClusterIdApiResponse, error)

Fetches SNMP config details of the cluster identified by {extId}.

func (*ClustersApi) GetSnmpTrapById 

func (api *ClustersApi) GetSnmpTrapById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetSnmpTrapApiResponse, error)

Fetches SNMP trap configuration details identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) GetSnmpUserById 

func (api *ClustersApi) GetSnmpUserById(clusterExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetSnmpUserApiResponse, error)

Fetches SNMP user configuration details identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) GetVirtualNicById 

func (api *ClustersApi) GetVirtualNicById(clusterExtId *string, hostExtId *string, extId *string, args ...map[string]interface{}) (*import1.GetVirtualNicApiResponse, error)

Get the virtual NIC entity of the host identified by {hostExtId} belonging to the cluster identified by {clusterExtId}.

func (*ClustersApi) ListClusters 

func (api *ClustersApi) ListClusters(page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListClustersApiResponse, error)

Lists all cluster entities registered to Prism Central.

func (*ClustersApi) ListHostNicsByHostId 

func (api *ClustersApi) ListHostNicsByHostId(clusterExtId *string, extId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListHostNicsByHostIdApiResponse, error)

Lists all host NICs for the host identified by {extId} belonging to the cluster identified by {clusterExtId}.

func (*ClustersApi) ListHosts 

func (api *ClustersApi) ListHosts(page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListHostsApiResponse, error)

Lists all host entities across clusters registered to Prism Central.

func (*ClustersApi) ListHostsByClusterId 

func (api *ClustersApi) ListHostsByClusterId(extId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListHostsByClusterIdApiResponse, error)

Lists all the hosts associated with the cluster identified by {extId}.

func (*ClustersApi) ListRackableUnitsByClusterId 

func (api *ClustersApi) ListRackableUnitsByClusterId(extId *string, args ...map[string]interface{}) (*import1.ListRackableUnitsByClusterIdApiResponse, error)

Lists the rackable units of the cluster identified by {extId}.

func (*ClustersApi) ListRsyslogServersByClusterId 

func (api *ClustersApi) ListRsyslogServersByClusterId(extId *string, args ...map[string]interface{}) (*import1.ListRsyslogServersByClusterIdApiResponse, error)

Lists the RSYSLOG server configurations associated with the cluster identified by {extId}.

func (*ClustersApi) ListVirtualNicsByHostId 

func (api *ClustersApi) ListVirtualNicsByHostId(clusterExtId *string, extId *string, page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListVirtualNicsByHostIdApiResponse, error)

Lists all virtual NICs for the host identified by {extId} belonging to the cluster identified by {clusterExtId}.

func (*ClustersApi) RemoveNode 

func (api *ClustersApi) RemoveNode(extId *string, body *import1.NodeRemovalParams, args ...map[string]interface{}) (*import1.RemoveNodeApiResponse, error)

Removes nodes from cluster identified by {extId}.

func (*ClustersApi) RemoveSnmpTransport 

func (api *ClustersApi) RemoveSnmpTransport(extId *string, body *import1.SnmpTransport, args ...map[string]interface{}) (*import1.RemoveSnmpTransportsApiResponse, error)

Removes transport ports and protocol detail from the SNMP configuration associated with the cluster identified by {extId}.

func (*ClustersApi) UpdateClusterById 

func (api *ClustersApi) UpdateClusterById(extId *string, body *import1.Cluster, args ...map[string]interface{}) (*import1.UpdateClusterApiResponse, error)

Update cluster operation.

func (*ClustersApi) UpdateRsyslogServerById 

func (api *ClustersApi) UpdateRsyslogServerById(clusterExtId *string, extId *string, body *import1.RsyslogServer, args ...map[string]interface{}) (*import1.UpdateRsyslogServerApiResponse, error)

Update RSYSLOG server configuration except RSYSLOG server name as it is a primary key of the entity.

func (*ClustersApi) UpdateSnmpStatus 

func (api *ClustersApi) UpdateSnmpStatus(extId *string, body *import1.SnmpStatusParam, args ...map[string]interface{}) (*import1.UpdateSnmpStatusApiResponse, error)

Updates the status of SNMP configuration associated with the cluster identified by {extId}.

func (*ClustersApi) UpdateSnmpTrapById 

func (api *ClustersApi) UpdateSnmpTrapById(clusterExtId *string, extId *string, body *import1.SnmpTrap, args ...map[string]interface{}) (*import1.UpdateSnmpTrapApiResponse, error)

Update SNMP trap configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) UpdateSnmpUserById 

func (api *ClustersApi) UpdateSnmpUserById(clusterExtId *string, extId *string, body *import1.SnmpUser, args ...map[string]interface{}) (*import1.UpdateSnmpUserApiResponse, error)

Updates SNMP user configuration identified by {extId} associated with the cluster identified by {clusterExtId}.

func (*ClustersApi) ValidateNode 

func (api *ClustersApi) ValidateNode(extId *string, body *import1.ValidateNodeParam, args ...map[string]interface{}) (*import1.ValidateNodeApiResponse, error)

Validates hypervisor bundle and node uplinks of the node. This API is not supported for XEN hypervisor type.

type DisksApi 

type DisksApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewDisksApi 

func NewDisksApi(apiClient *client.ApiClient) *DisksApi

func (*DisksApi) GetDiskById 

func (api *DisksApi) GetDiskById(extId *string, args ...map[string]interface{}) (*import1.GetDiskApiResponse, error)

Fetch the details of the Disk identified by {extId}.

func (*DisksApi) GetDiskStats 

func (api *DisksApi) GetDiskStats(extId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import3.DownSamplingOperator, args ...map[string]interface{}) (*import2.GetDiskStatsApiResponse, error)

Fetch the stats information of the Disk identified by {extId}.

func (*DisksApi) ListDisks 

func (api *DisksApi) ListDisks(page_ *int, limit_ *int, filter_ *string, orderby_ *string, apply_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListDisksApiResponse, error)

Fetch the details of Disks from all clusters registered to Prism Central.

type StorageContainersApi 

type StorageContainersApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewStorageContainersApi 

func NewStorageContainersApi(apiClient *client.ApiClient) *StorageContainersApi

func (*StorageContainersApi) CreateStorageContainer 

func (api *StorageContainersApi) CreateStorageContainer(body *import1.StorageContainer, xClusterId *string, args ...map[string]interface{}) (*import1.CreateStorageContainerApiResponse, error)

Creates a new Storage Container with the specified configuration on the cluster identified by cluster extId.

func (*StorageContainersApi) DeleteStorageContainerById 

func (api *StorageContainersApi) DeleteStorageContainerById(extId *string, ignoreSmallFiles *bool, args ...map[string]interface{}) (*import1.DeleteStorageContainerApiResponse, error)

Deletes an existing Storage Container identified by {containerExtId}.

func (*StorageContainersApi) GetStorageContainerById 

func (api *StorageContainersApi) GetStorageContainerById(extId *string, args ...map[string]interface{}) (*import1.GetStorageContainerApiResponse, error)

Fetch the configuration details of the existing Storage Container identified by the {containerExtId}. Note that the Storage Containers from PEs having versions prior to AOS 6.5 might have missing attribute data. Also, the Storage Container on these PEs under the Self Owned RBAC category might not be visible for non-admin users.

func (*StorageContainersApi) GetStorageContainerStats 

func (api *StorageContainersApi) GetStorageContainerStats(extId *string, startTime_ *string, endTime_ *string, samplingInterval_ *int, statType_ *import3.DownSamplingOperator, args ...map[string]interface{}) (*import2.GetStorageContainerStatsApiResponse, error)

Fetches the stats information of the Storage Container identified by {containerExtId}.

func (*StorageContainersApi) ListDataStoresByClusterId 

func (api *StorageContainersApi) ListDataStoresByClusterId(clusterExtId *string, filter_ *string, args ...map[string]interface{}) (*import1.ListDataStoresByClusterIdApiResponse, error)

List all the Datastores associated with Storage Containers from the cluster.

func (*StorageContainersApi) ListStorageContainers 

func (api *StorageContainersApi) ListStorageContainers(page_ *int, limit_ *int, filter_ *string, orderby_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListStorageContainersApiResponse, error)

Lists the Storage Containers present in the system. Note that the Storage Containers from PEs having versions prior to AOS 6.5 might have missing attribute data. Also, the Storage Container on these PEs under the Self Owned RBAC category might not be visible for non-admin users.

func (*StorageContainersApi) MountStorageContainer 

func (api *StorageContainersApi) MountStorageContainer(extId *string, body *import1.DataStoreMount, args ...map[string]interface{}) (*import1.MountStorageContainerApiResponse, error)

Mounts the Storage Container identified by {containerExtId} on an ESX Datastore.

func (*StorageContainersApi) UnmountStorageContainer 

func (api *StorageContainersApi) UnmountStorageContainer(extId *string, body *import1.DataStoreUnmount, args ...map[string]interface{}) (*import1.UnmountStorageContainerApiResponse, error)

Unmounts the Storage Container identified by {containerExtId} from the ESX Datastore.

func (*StorageContainersApi) UpdateStorageContainerById 

func (api *StorageContainersApi) UpdateStorageContainerById(extId *string, body *import1.StorageContainer, args ...map[string]interface{}) (*import1.UpdateStorageContainerApiResponse, error)

Updates the configuration of an existing Storage Container identified by {containerExtId}.

type VcenterExtensionsApi 

type VcenterExtensionsApi struct {
	ApiClient *client.ApiClient
	// contains filtered or unexported fields
}

func NewVcenterExtensionsApi 

func NewVcenterExtensionsApi(apiClient *client.ApiClient) *VcenterExtensionsApi

func (*VcenterExtensionsApi) GetVcenterExtensionById 

func (api *VcenterExtensionsApi) GetVcenterExtensionById(extId *string, args ...map[string]interface{}) (*import1.GetVcenterExtensionApiResponse, error)

Fetches vCenter server extension information for the given VcenterExtensionExtId.

func (*VcenterExtensionsApi) ListVcenterExtensions 

func (api *VcenterExtensionsApi) ListVcenterExtensions(page_ *int, limit_ *int, filter_ *string, select_ *string, args ...map[string]interface{}) (*import1.ListVcenterExtensionsApiResponse, error)

List of vCenter server extensions for the clusters registered under a Prism Central server.

func (*VcenterExtensionsApi) RegisterVcenterExtension 

func (api *VcenterExtensionsApi) RegisterVcenterExtension(extId *string, body *import1.VcenterCredentials, args ...map[string]interface{}) (*import1.RegisterVcenterExtensionApiResponse, error)

Registers Nutanix cluster as a vCenter server extension.

func (*VcenterExtensionsApi) UnregisterVcenterExtension 

func (api *VcenterExtensionsApi) UnregisterVcenterExtension(extId *string, body *import1.VcenterCredentials, args ...map[string]interface{}) (*import1.UnregisterVcenterExtensionApiResponse, error)

Unregisters Nutanix cluster as a vCenter server extension.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.