api

package
v4.0.2-alpha.2 Latest Latest
Warning

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

 Go to latest Published: Feb 7, 2023 License: UNKNOWN not legal advice Imports: 6 Imported by: 0

Documentation

Overview

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 ClusterApi 

type ClusterApi struct {
	ApiClient *client.ApiClient
}

func NewClusterApi 

func NewClusterApi(apiClient *client.ApiClient) *ClusterApi

func (*ClusterApi) AddNode 

func (api *ClusterApi) AddNode(body *import1.ExpandClusterParams, clusterExtId *string, args ...map[string]interface{}) (*import1.AddNodeTaskResponse, error)

* 

Add node on a cluster
Add node on a cluster

parameters:-
-> body (clustermgmt.v4.config.ExpandClusterParams) (required) : Property of the node to be added
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.AddNodeTaskResponse, error)

func (*ClusterApi) AddRsyslogServer 

func (api *ClusterApi) AddRsyslogServer(body *import1.RsyslogServer, clusterExtId *string, args ...map[string]interface{}) (*import1.AddRsyslogServerTaskApiResponse, error)

* 

Add new RSYSLOG server configuration
Add new RSYSLOG server configuration

parameters:-
-> body (clustermgmt.v4.config.RsyslogServer) (required) : RSYSLOG server to add
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.AddRsyslogServerTaskApiResponse, error)

func (*ClusterApi) AddSnmpTransport 

func (api *ClusterApi) AddSnmpTransport(body *[]import1.SnmpTransport, clusterExtId *string, args ...map[string]interface{}) (*import1.AddSnmpTransportsTaskApiResponse, error)

* 

Add SNMP transports
Add SNMP transports

parameters:-
-> body ([]clustermgmt.v4.config.SnmpTransport) (required) : SNMP transports to add
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.AddSnmpTransportsTaskApiResponse, error)

func (*ClusterApi) AddSnmpTrap 

func (api *ClusterApi) AddSnmpTrap(body *import1.SnmpTrap, clusterExtId *string, args ...map[string]interface{}) (*import1.AddSnmpTrapTaskApiResponse, error)

* 

Add SNMP trap
Add SNMP trap

parameters:-
-> body (clustermgmt.v4.config.SnmpTrap) (required) : SNMP trap to add
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.AddSnmpTrapTaskApiResponse, error)

func (*ClusterApi) AddSnmpUser 

func (api *ClusterApi) AddSnmpUser(body *import1.SnmpUser, clusterExtId *string, args ...map[string]interface{}) (*import1.AddSnmpUserTaskApiResponse, error)

* 

Add SNMP user
Add SNMP user

parameters:-
-> body (clustermgmt.v4.config.SnmpUser) (required) : SNMP user to add
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.AddSnmpUserTaskApiResponse, error)

func (*ClusterApi) DeleteRsyslogServer 

func (api *ClusterApi) DeleteRsyslogServer(clusterExtId *string, rsyslogServerExtId *string, args ...map[string]interface{}) (*import1.DeleteRsyslogServerTaskApiResponse, error)

* 

Delete RSYSLOG Server
Delete RSYSLOG Server

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

returns: (*clustermgmt.v4.config.DeleteRsyslogServerTaskApiResponse, error)

func (*ClusterApi) DeleteSnmpTrap 

func (api *ClusterApi) DeleteSnmpTrap(clusterExtId *string, trapExtId *string, args ...map[string]interface{}) (*import1.DeleteSnmpTrapTaskApiResponse, error)

* 

Delete SNMP trap
Delete SNMP trap

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

returns: (*clustermgmt.v4.config.DeleteSnmpTrapTaskApiResponse, error)

func (*ClusterApi) DeleteSnmpUser 

func (api *ClusterApi) DeleteSnmpUser(clusterExtId *string, userExtId *string, args ...map[string]interface{}) (*import1.DeleteSnmpUserTaskApiResponse, error)

* 

Delete SNMP user
Delete SNMP user

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

returns: (*clustermgmt.v4.config.DeleteSnmpUserTaskApiResponse, error)

func (*ClusterApi) DiscoverUnconfiguredNodes 

func (api *ClusterApi) DiscoverUnconfiguredNodes(body *import1.NodeDiscoveryParams, clusterExtId *string, args ...map[string]interface{}) (*import1.DiscoverNodeTaskApiResponse, error)

* 

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

parameters:-
-> body (clustermgmt.v4.config.NodeDiscoveryParams) (required) : Discover unconfigured node details
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.DiscoverNodeTaskApiResponse, error)

func (*ClusterApi) GetAllHostGpus 

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

* 

Get all host GPUs
Get all host GPUs

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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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: - cluster/uuid - 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.GetAllHostGpusResponse, error)

func (*ClusterApi) GetAllHosts 

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

* 

Get all host entities
Get all host 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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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 - cluster/uuid - 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.GetAllHostsResponse, error)

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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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, page_ *int, limit_ *int, args ...map[string]interface{}) (*import1.GetGpuProfilesResponse, error)

* 

Get GPU profiles
Get GPU profiles

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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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: - cluster/uuid - 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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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: - cluster/uuid - 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 lead to no results being returned.
-> 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 lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
-> 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 - cluster/uuid - 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) GetRsyslogServer 

func (api *ClusterApi) GetRsyslogServer(clusterExtId *string, rsyslogServerExtId *string, args ...map[string]interface{}) (*import1.GetRsyslogServerResponse, error)

* 

Get RSYSLOG server configuration
Get RSYSLOG server configuration

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

returns: (*clustermgmt.v4.config.GetRsyslogServerResponse, 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)

func (*ClusterApi) GetSnmpTrap 

func (api *ClusterApi) GetSnmpTrap(clusterExtId *string, trapExtId *string, args ...map[string]interface{}) (*import1.GetSnmpTrapResponse, error)

* 

Get SNMP trap configuration
Get SNMP trap configuration

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

returns: (*clustermgmt.v4.config.GetSnmpTrapResponse, error)

func (*ClusterApi) GetSnmpUser 

func (api *ClusterApi) GetSnmpUser(clusterExtId *string, userExtId *string, args ...map[string]interface{}) (*import1.GetSnmpUserResponse, error)

* 

Get SNMP user configuration
Get SNMP user configuration

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

returns: (*clustermgmt.v4.config.GetSnmpUserResponse, error)

func (*ClusterApi) IsBundleCompatible 

func (api *ClusterApi) IsBundleCompatible(body *import1.BundleParam, clusterExtId *string, args ...map[string]interface{}) (*import1.IsBundleCompatibleTaskResponse, error)

* 

Get hypervisor bundle compatibility information
Provides details on whether hypervisor bundle is compatible or not

parameters:-
-> body (clustermgmt.v4.config.BundleParam) (required) : ISO attributes to validate compatibility
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.IsBundleCompatibleTaskResponse, error)

func (*ClusterApi) IsHypervisorUploadRequired 

func (api *ClusterApi) IsHypervisorUploadRequired(body *import1.HypervisorUploadParam, clusterExtId *string, args ...map[string]interface{}) (*import1.HypervisorUplpadRequiredTaskResponse, error)

* 

Get hypervisor ISO upload information
Provides information on whether hypervisor ISO upload is required or not

parameters:-
-> body (clustermgmt.v4.config.HypervisorUploadParam) (required) : Parameters to get information on whether hypervisor ISO upload is required or not
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.HypervisorUplpadRequiredTaskResponse, error)

func (*ClusterApi) NodesNetworkingDetails 

func (api *ClusterApi) NodesNetworkingDetails(body *import1.NodeDetails, clusterExtId *string, args ...map[string]interface{}) (*import1.GetNodeNetworkingTaskApiResponse, error)

* 

Get network information of unconfigured nodes
Get a dictionary of cluster networks and available uplinks on the given nodes

parameters:-
-> body (clustermgmt.v4.config.NodeDetails) (required) : Node specific details required to fetch node networking information
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.GetNodeNetworkingTaskApiResponse, error)

func (*ClusterApi) RemoveNode 

func (api *ClusterApi) RemoveNode(body *import1.NodeRemovalParams, clusterExtId *string, args ...map[string]interface{}) (*import1.RemoveNodeTaskResponse, error)

* 

Removes nodes from cluster
Removes nodes from cluster

parameters:-
-> body (clustermgmt.v4.config.NodeRemovalParams) (required) : Parameters to remove nodes from cluster
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.RemoveNodeTaskResponse, error)

func (*ClusterApi) RemoveSnmpTransport 

func (api *ClusterApi) RemoveSnmpTransport(body *[]import1.SnmpTransport, clusterExtId *string, args ...map[string]interface{}) (*import1.RemoveSnmpTransportsTaskApiResponse, error)

* 

Remove SNMP transports
Remove SNMP transports

parameters:-
-> body ([]clustermgmt.v4.config.SnmpTransport) (required) : SNMP transports to remove
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.RemoveSnmpTransportsTaskApiResponse, error)

func (*ClusterApi) RenameHost 

func (api *ClusterApi) RenameHost(body *import1.HostNameParam, clusterExtId *string, hostExtId *string, args ...map[string]interface{}) (*import1.HostRenameResponse, error)

* 

Rename AHV host in a cluster.
Rename AHV host in a cluster. Requests are processed in parallel and if multiple rename requests are submitted they can be executed in random order.

parameters:-
-> body (clustermgmt.v4.config.HostNameParam) (required) : Host rename parameters
-> clusterExtId (string) (required) : Cluster UUID
-> hostExtId (string) (required) : Host UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.HostRenameResponse, error)

func (*ClusterApi) SearchTask 

func (api *ClusterApi) SearchTask(body *import1.SearchParams, taskExtId *string, args ...map[string]interface{}) (*import1.GetSearchResponse, error)

* 

Get task response based on the type of request
Get task response based on the type of request

parameters:-
-> body (clustermgmt.v4.config.SearchParams) (required) : Search parameters
-> taskExtId (string) (required) : The external identifier of the task.
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.GetSearchResponse, error)

func (*ClusterApi) UpdateCluster 

func (api *ClusterApi) UpdateCluster(body *import1.ClusterEntity, clusterExtId *string, args ...map[string]interface{}) (*import1.UpdateClusterTaskApiResponse, error)

* 

Update cluster
Update cluster

parameters:-
-> body (clustermgmt.v4.config.ClusterEntity) (required) : Cluster resource to update
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.UpdateClusterTaskApiResponse, error)

func (*ClusterApi) UpdateRsyslogServer 

func (api *ClusterApi) UpdateRsyslogServer(body *import1.RsyslogServer, clusterExtId *string, rsyslogServerExtId *string, args ...map[string]interface{}) (*import1.UpdateRsyslogServerTaskApiResponse, error)

* 

Update RSYSLOG server configuration
Update RSYSLOG server configuration

parameters:-
-> body (clustermgmt.v4.config.RsyslogServer) (required) : RSYSLOG server to update
-> clusterExtId (string) (required) : Cluster UUID
-> rsyslogServerExtId (string) (required) : RSYSLOG server UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.UpdateRsyslogServerTaskApiResponse, error)

func (*ClusterApi) UpdateSnmpStatus 

func (api *ClusterApi) UpdateSnmpStatus(body *import1.SnmpStatusParam, clusterExtId *string, args ...map[string]interface{}) (*import1.UpdateSnmpStatusTaskApiResponse, error)

* 

Update SNMP status
Update SNMP status

parameters:-
-> body (clustermgmt.v4.config.SnmpStatusParam) (required) : SNMP status
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.UpdateSnmpStatusTaskApiResponse, error)

func (*ClusterApi) UpdateSnmpTrap 

func (api *ClusterApi) UpdateSnmpTrap(body *import1.SnmpTrap, clusterExtId *string, trapExtId *string, args ...map[string]interface{}) (*import1.UpdateSnmpTrapTaskApiResponse, error)

* 

Update SNMP trap
Update SNMP trap

parameters:-
-> body (clustermgmt.v4.config.SnmpTrap) (required) : SNMP trap to update
-> clusterExtId (string) (required) : Cluster UUID
-> trapExtId (string) (required) : SNMP trap UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.UpdateSnmpTrapTaskApiResponse, error)

func (*ClusterApi) UpdateSnmpUser 

func (api *ClusterApi) UpdateSnmpUser(body *import1.SnmpUser, clusterExtId *string, userExtId *string, args ...map[string]interface{}) (*import1.UpdateSnmpUserTaskApiResponse, error)

* 

Update SNMP user
Update SNMP user

parameters:-
-> body (clustermgmt.v4.config.SnmpUser) (required) : SNMP user to update
-> clusterExtId (string) (required) : Cluster UUID
-> userExtId (string) (required) : SNMP user UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.UpdateSnmpUserTaskApiResponse, error)

func (api *ClusterApi) ValidateUplinks(body *[]import1.UplinkNode, clusterExtId *string, args ...map[string]interface{}) (*import1.ValidateUplinksTaskApiResponse, error)

* 

Validates uplink information for the nodes
Validates whether the uplink information for the given nodes can be used to add nodes to the cluster

parameters:-
-> body ([]clustermgmt.v4.config.UplinkNode) (required) : Parameters for validating uplinks
-> clusterExtId (string) (required) : Cluster UUID
-> args (map[string]interface{}) (optional) : Additional Arguments

returns: (*clustermgmt.v4.config.ValidateUplinksTaskApiResponse, error)

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.