vmware::vcenter::namespace_management::software::Clusters Interface Reference

The Clusters interface provides methods to upgrade the vSphere clusters. More...

Inherited by vmware::vcenter::namespace_management::software::ClustersStub.

List of all members.

Public Member Functions
void	Upgrade (string cluster, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec spec)
	Upgrade the cluster to a specific version.
void	Upgrade (string cluster, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrade the cluster to a specific version.
global::System.Threading.Tasks.Task	UpgradeAsync (string cluster, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec spec)
	Upgrade the cluster to a specific version.
global::System.Threading.Tasks.Task	UpgradeAsync (string cluster, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrade the cluster to a specific version.
global::System.Collections.Generic.Dictionary < string, vmware.vcenter.namespace_management.software.ClustersTypes.Result >	UpgradeMultiple (global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec > specs)
	Upgrade a set of clusters to its corresponding specific version.
global::System.Collections.Generic.Dictionary < string, vmware.vcenter.namespace_management.software.ClustersTypes.Result >	UpgradeMultiple (global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec > specs, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrade a set of clusters to its corresponding specific version.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.vcenter.namespace_management.software.ClustersTypes.Result > >	UpgradeMultipleAsync (global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec > specs)
	Upgrade a set of clusters to its corresponding specific version.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < string, vmware.vcenter.namespace_management.software.ClustersTypes.Result > >	UpgradeMultipleAsync (global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec > specs, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrade a set of clusters to its corresponding specific version.
vmware.vcenter.namespace_management.software.ClustersTypes.Info	Get (string cluster)
	Returns upgrade related information of a specific cluster.
vmware.vcenter.namespace_management.software.ClustersTypes.Info	Get (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns upgrade related information of a specific cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.namespace_management.software.ClustersTypes.Info >	GetAsync (string cluster)
	Returns upgrade related information of a specific cluster.
global::System.Threading.Tasks.Task < vmware.vcenter.namespace_management.software.ClustersTypes.Info >	GetAsync (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns upgrade related information of a specific cluster.
global::System.Collections.Generic.List < vmware.vcenter.namespace_management.software.ClustersTypes.Summary >	List ()
	Returns upgrade related information about all WCP enabled clusters.
global::System.Collections.Generic.List < vmware.vcenter.namespace_management.software.ClustersTypes.Summary >	List (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns upgrade related information about all WCP enabled clusters.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.namespace_management.software.ClustersTypes.Summary > >	ListAsync ()
	Returns upgrade related information about all WCP enabled clusters.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.namespace_management.software.ClustersTypes.Summary > >	ListAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns upgrade related information about all WCP enabled clusters.

---

Detailed Description

The Clusters interface provides methods to upgrade the vSphere clusters.

---

Member Function Documentation

vmware.vcenter.namespace_management.software.ClustersTypes.Info vmware::vcenter::namespace_management::software::Clusters::Get

(

string

cluster

)

Returns upgrade related information of a specific cluster.

Exceptions:

vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Parameters:

cluster

Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

vmware.vcenter.namespace_management.software.ClustersTypes.Info vmware::vcenter::namespace_management::software::Clusters::Get	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns upgrade related information of a specific cluster.

Exceptions:

vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<vmware.vcenter.namespace_management.software.ClustersTypes.Info> vmware::vcenter::namespace_management::software::Clusters::GetAsync

(

string

cluster

)

Returns upgrade related information of a specific cluster.

Exceptions:

vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Parameters:

cluster

Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<vmware.vcenter.namespace_management.software.ClustersTypes.Info> vmware::vcenter::namespace_management::software::Clusters::GetAsync	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns upgrade related information of a specific cluster.

Exceptions:

vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Collections.Generic.List<vmware.vcenter.namespace_management.software.ClustersTypes.Summary> vmware::vcenter::namespace_management::software::Clusters::List

(

)

Returns upgrade related information about all WCP enabled clusters.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Returns:

List of upgrade summary of all WCP enabled clusters.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Collections.Generic.List<vmware.vcenter.namespace_management.software.ClustersTypes.Summary> vmware::vcenter::namespace_management::software::Clusters::List	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns upgrade related information about all WCP enabled clusters.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Returns:

List of upgrade summary of all WCP enabled clusters.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.namespace_management.software.ClustersTypes.Summary> > vmware::vcenter::namespace_management::software::Clusters::ListAsync

(

)

Returns upgrade related information about all WCP enabled clusters.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Returns:

List of upgrade summary of all WCP enabled clusters.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.namespace_management.software.ClustersTypes.Summary> > vmware::vcenter::namespace_management::software::Clusters::ListAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns upgrade related information about all WCP enabled clusters.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have System.Read privilege.

Returns:

List of upgrade summary of all WCP enabled clusters.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

void vmware::vcenter::namespace_management::software::Clusters::Upgrade	(	string	cluster,
		vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Upgrade the cluster to a specific version.

This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior:

• ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unsupported	if pre-check failed of the cluster.
vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Specification for upgrading the cluster.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

void vmware::vcenter::namespace_management::software::Clusters::Upgrade	(	string	cluster,
		vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec	spec
	)

Upgrade the cluster to a specific version.

This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior:

• ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unsupported	if pre-check failed of the cluster.
vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Specification for upgrading the cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task vmware::vcenter::namespace_management::software::Clusters::UpgradeAsync	(	string	cluster,
		vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Upgrade the cluster to a specific version.

This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior:

• ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unsupported	if pre-check failed of the cluster.
vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Specification for upgrading the cluster.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task vmware::vcenter::namespace_management::software::Clusters::UpgradeAsync	(	string	cluster,
		vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec	spec
	)

Upgrade the cluster to a specific version.

This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior:

• ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unsupported	if pre-check failed of the cluster.
vmware.vapi.std.errors.NotFound	if cluster could not be located.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege.

Parameters:

cluster	Identifier for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Specification for upgrading the cluster.

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Collections.Generic.Dictionary<string, vmware.vcenter.namespace_management.software.ClustersTypes.Result> vmware::vcenter::namespace_management::software::Clusters::UpgradeMultiple

(

global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec >

specs

)

Upgrade a set of clusters to its corresponding specific version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs

Specifications for upgrading selected clusters. The key in the parameter map must be an identifier for the resource type: ClusterComputeResource .

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the result map will be an identifier for the resource type: ClusterComputeResource .

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Collections.Generic.Dictionary<string, vmware.vcenter.namespace_management.software.ClustersTypes.Result> vmware::vcenter::namespace_management::software::Clusters::UpgradeMultiple	(	global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec >	specs,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Upgrade a set of clusters to its corresponding specific version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs	Specifications for upgrading selected clusters. The key in the parameter map must be an identifier for the resource type: ClusterComputeResource .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the result map will be an identifier for the resource type: ClusterComputeResource .

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.vcenter.namespace_management.software.ClustersTypes.Result> > vmware::vcenter::namespace_management::software::Clusters::UpgradeMultipleAsync	(	global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec >	specs,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Upgrade a set of clusters to its corresponding specific version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs	Specifications for upgrading selected clusters. The key in the parameter map must be an identifier for the resource type: ClusterComputeResource .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the result map will be an identifier for the resource type: ClusterComputeResource .

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<string, vmware.vcenter.namespace_management.software.ClustersTypes.Result> > vmware::vcenter::namespace_management::software::Clusters::UpgradeMultipleAsync

(

global::System.Collections.Generic.Dictionary< string, vmware.vcenter.namespace_management.software.ClustersTypes.UpgradeSpec >

specs

)

Upgrade a set of clusters to its corresponding specific version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs

Specifications for upgrading selected clusters. The key in the parameter map must be an identifier for the resource type: ClusterComputeResource .

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the result map will be an identifier for the resource type: ClusterComputeResource .

Implemented in vmware::vcenter::namespace_management::software::ClustersStub.

---

The documentation for this interface was generated from the following file:

• software/Clusters.cs