vmware::esx::settings::clusters::Software Interface Reference

The Software interface provides methods to manage desired software specification of an ESX cluster. More...

Inherited by vmware::esx::settings::clusters::SoftwareStub.

List of all members.

Public Member Functions
vmware.esx.settings.SoftwareInfo	Get (string cluster)
	Returns the complete desired software specification.
vmware.esx.settings.SoftwareInfo	Get (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the complete desired software specification.
global::System.Threading.Tasks.Task < vmware.esx.settings.SoftwareInfo >	GetAsync (string cluster)
	Returns the complete desired software specification.
global::System.Threading.Tasks.Task < vmware.esx.settings.SoftwareInfo >	GetAsync (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the complete desired software specification.
string	Scan_Task (string cluster)
	Scans all the hosts in the cluster against the cluster's desired state.
string	Scan_Task (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Scans all the hosts in the cluster against the cluster's desired state.
global::System.Collections.Generic.Dictionary < vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri >	Export (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ExportSpec spec)
	Exports the desired software specification document and/or image.
global::System.Collections.Generic.Dictionary < vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri >	Export (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ExportSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Exports the desired software specification document and/or image.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri > >	ExportAsync (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ExportSpec spec)
	Exports the desired software specification document and/or image.
global::System.Threading.Tasks.Task < global::System.Collections.Generic.Dictionary < vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri > >	ExportAsync (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ExportSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Exports the desired software specification document and/or image.
string	Apply_Task (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ApplySpec spec)
	Applies the desired software document associated with the given cluster to hosts within the cluster.
string	Apply_Task (string cluster, vmware.esx.settings.clusters.SoftwareTypes.ApplySpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Applies the desired software document associated with the given cluster to hosts within the cluster.
string	Check_Task (string cluster, vmware.esx.settings.clusters.SoftwareTypes.CheckSpec spec)
	Runs checks on the cluster before applying the desired software document across all hosts in the cluster.
string	Check_Task (string cluster, vmware.esx.settings.clusters.SoftwareTypes.CheckSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Runs checks on the cluster before applying the desired software document across all hosts in the cluster.

---

Detailed Description

The Software interface provides methods to manage desired software specification of an ESX cluster.

---

Member Function Documentation

string vmware::esx::settings::clusters::Software::Apply_Task	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ApplySpec	spec
	)

Applies the desired software document associated with the given cluster to hosts within the cluster.

If commit field is set, it implies the minimum commit that the Software.Apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.AlreadyInDesiredState	If the cluster is already at specified commit as described in the apply specification.
vmware.vapi.std.errors.Error	If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.InvalidArgument	If the commit field of spec specifies an invalid commit, or the hosts field of spec specifies an invalid host or a host not part of the cluster.
vmware.vapi.std.errors.NotAllowedInCurrentState	If there is another operation in progress.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.TimedOut	If the operation times out.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Apply specification.

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

string vmware::esx::settings::clusters::Software::Apply_Task	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ApplySpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Applies the desired software document associated with the given cluster to hosts within the cluster.

If commit field is set, it implies the minimum commit that the Software.Apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.AlreadyInDesiredState	If the cluster is already at specified commit as described in the apply specification.
vmware.vapi.std.errors.Error	If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.InvalidArgument	If the commit field of spec specifies an invalid commit, or the hosts field of spec specifies an invalid host or a host not part of the cluster.
vmware.vapi.std.errors.NotAllowedInCurrentState	If there is another operation in progress.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.TimedOut	If the operation times out.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Apply specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

string vmware::esx::settings::clusters::Software::Check_Task	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.CheckSpec	spec
	)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster.

Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If commit field is set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.InvalidArgument	If the commit field of spec specifies an invalid commit, or the hosts field of spec specifies an invalid host or a host not part of the cluster.
vmware.vapi.std.errors.NotAllowedInCurrentState	If there is another operation in progress or if the commit field of spec specifies a commit that has already been applied.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.TimedOut	If the operation times out.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Check specification.

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

string vmware::esx::settings::clusters::Software::Check_Task	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.CheckSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster.

Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If commit field is set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.InvalidArgument	If the commit field of spec specifies an invalid commit, or the hosts field of spec specifies an invalid host or a host not part of the cluster.
vmware.vapi.std.errors.NotAllowedInCurrentState	If there is another operation in progress or if the commit field of spec specifies a commit that has already been applied.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.TimedOut	If the operation times out.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec	Check specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Collections.Generic.Dictionary<vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri> vmware::esx::settings::clusters::Software::Export	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ExportSpec	spec
	)

Exports the desired software specification document and/or image.

This API will not export the solution section of the desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is am unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec

Returns:

A map from export type to URL of the exported data for that type.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Collections.Generic.Dictionary<vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri> vmware::esx::settings::clusters::Software::Export	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ExportSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Exports the desired software specification document and/or image.

This API will not export the solution section of the desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is am unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

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

Returns:

A map from export type to URL of the exported data for that type.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri> > vmware::esx::settings::clusters::Software::ExportAsync	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ExportSpec	spec
	)

Exports the desired software specification document and/or image.

This API will not export the solution section of the desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is am unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

cluster	Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
spec

Returns:

A map from export type to URL of the exported data for that type.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.Dictionary<vmware.esx.settings.clusters.SoftwareTypes.ExportType, global::System.Uri> > vmware::esx::settings::clusters::Software::ExportAsync	(	string	cluster,
		vmware.esx.settings.clusters.SoftwareTypes.ExportSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Exports the desired software specification document and/or image.

This API will not export the solution section of the desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is am unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

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

Returns:

A map from export type to URL of the exported data for that type.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

vmware.esx.settings.SoftwareInfo vmware::esx::settings::clusters::Software::Get	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the complete desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

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

Returns:

Cluster software specification.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

vmware.esx.settings.SoftwareInfo vmware::esx::settings::clusters::Software::Get

(

string

cluster

)

Returns the complete desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

cluster

Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .

Returns:

Cluster software specification.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.SoftwareInfo> vmware::esx::settings::clusters::Software::GetAsync

(

string

cluster

)

Returns the complete desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

cluster

Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .

Returns:

Cluster software specification.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.SoftwareInfo> vmware::esx::settings::clusters::Software::GetAsync	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the complete desired software specification.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read .

Parameters:

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

Returns:

Cluster software specification.

Implemented in vmware::esx::settings::clusters::SoftwareStub.

string vmware::esx::settings::clusters::Software::Scan_Task	(	string	cluster,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Scans all the hosts in the cluster against the cluster's desired state.

The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

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

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

string vmware::esx::settings::clusters::Software::Scan_Task

(

string

cluster

)

Scans all the hosts in the cluster against the cluster's desired state.

The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:

vmware.vapi.std.errors.Error	If there is unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system or if desired software document is not found.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthenticated	If the caller is not authenticated.

Parameters:

cluster

Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .

Returns:

Identifier for the task created by this API invocation

Implemented in vmware::esx::settings::clusters::SoftwareStub.

---

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

• clusters/Software.cs