vmware::esx::settings::clusters::DepotOverrides Interface Reference

The DepotOverrides interface provides methods to manage software depots overriden for a given cluster. More...

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

List of all members.

Public Member Functions
vmware.esx.settings.clusters.DepotOverridesTypes.Info	Get (string cluster)
	Returns the information about currently configured depot overrides for a given cluster.
vmware.esx.settings.clusters.DepotOverridesTypes.Info	Get (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the information about currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task < vmware.esx.settings.clusters.DepotOverridesTypes.Info >	GetAsync (string cluster)
	Returns the information about currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task < vmware.esx.settings.clusters.DepotOverridesTypes.Info >	GetAsync (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the information about currently configured depot overrides for a given cluster.
void	Add (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot)
	Adds a new depot override to the list of currently configured depot overrides for a given cluster.
void	Add (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Adds a new depot override to the list of currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task	AddAsync (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot)
	Adds a new depot override to the list of currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task	AddAsync (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Adds a new depot override to the list of currently configured depot overrides for a given cluster.
void	Remove (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot)
	Removes a depot override from the list of currently configured depot overrides for a given cluster.
void	Remove (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a depot override from the list of currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task	RemoveAsync (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot)
	Removes a depot override from the list of currently configured depot overrides for a given cluster.
global::System.Threading.Tasks.Task	RemoveAsync (string cluster, vmware.esx.settings.clusters.DepotOverridesTypes.Depot depot, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes a depot override from the list of currently configured depot overrides for a given cluster.

---

Detailed Description

The DepotOverrides interface provides methods to manage software depots overriden for a given cluster.

In general ESX servers reach out to vCenter (VUM) to fetch the metadata and payloads required for lifecycle operations. But in ROBO environments ESX clusters can't (or because of bandwidth requirements shouldn't) reach out to vCenter to fetch payloads and metadata. This interface allows setting cluster level overrides for depots. If any depots are provided for a cluster, then vCenter level depots are not used for that cluster's remediation. These are not synced periodically at vCenter and are only used by ESXs for lifecycle operations.

---

Member Function Documentation

void vmware::esx::settings::clusters::DepotOverrides::Add	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot
	)

Adds a new depot override to the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid location is provided.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.AlreadyExists	if depot override with given information already exists.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

void vmware::esx::settings::clusters::DepotOverrides::Add	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Adds a new depot override to the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid location is provided.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.AlreadyExists	if depot override with given information already exists.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

global::System.Threading.Tasks.Task vmware::esx::settings::clusters::DepotOverrides::AddAsync	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Adds a new depot override to the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid location is provided.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.AlreadyExists	if depot override with given information already exists.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

global::System.Threading.Tasks.Task vmware::esx::settings::clusters::DepotOverrides::AddAsync	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot
	)

Adds a new depot override to the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.InvalidArgument	If an invalid location is provided.
vmware.vapi.std.errors.NotFound	If there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.AlreadyExists	if depot override with given information already exists.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

vmware.esx.settings.clusters.DepotOverridesTypes.Info vmware::esx::settings::clusters::DepotOverrides::Get

(

string

cluster

)

Returns the information about currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
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.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read .

Parameters:

cluster

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

Returns:

Information about currently configured depot overrides for a given cluster.

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

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

Returns the information about currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
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.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read .

Parameters:

cluster	Identifier for 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:

Information about currently configured depot overrides for a given cluster.

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

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

Returns the information about currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
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.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read .

Parameters:

cluster	Identifier for 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:

Information about currently configured depot overrides for a given cluster.

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

global::System.Threading.Tasks.Task<vmware.esx.settings.clusters.DepotOverridesTypes.Info> vmware::esx::settings::clusters::DepotOverrides::GetAsync

(

string

cluster

)

Returns the information about currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
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.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Read . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read .

Parameters:

cluster

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

Returns:

Information about currently configured depot overrides for a given cluster.

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

void vmware::esx::settings::clusters::DepotOverrides::Remove	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot
	)

Removes a depot override from the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot override with given information or no cluster associated with identifier {param.name cluster} in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

cluster	Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
depot	Information of the depot override to be removed.

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

void vmware::esx::settings::clusters::DepotOverrides::Remove	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes a depot override from the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot override with given information or no cluster associated with identifier {param.name cluster} in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

global::System.Threading.Tasks.Task vmware::esx::settings::clusters::DepotOverrides::RemoveAsync	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot
	)

Removes a depot override from the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot override with given information or no cluster associated with identifier {param.name cluster} in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

cluster	Identifier for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
depot	Information of the depot override to be removed.

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

global::System.Threading.Tasks.Task vmware::esx::settings::clusters::DepotOverrides::RemoveAsync	(	string	cluster,
		vmware.esx.settings.clusters.DepotOverridesTypes.Depot	depot,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes a depot override from the list of currently configured depot overrides for a given cluster.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no depot override with given information or no cluster associated with identifier {param.name cluster} in the system.
vmware.vapi.std.errors.Error	If there is some unknown internal error. The accompanying error message will give more details about the failure.
vmware.vapi.std.errors.ServiceUnavailable	If the service is not available.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires VcIntegrity.lifecycleSettings.Write . The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write .

Parameters:

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

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

---

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

• DepotOverrides.cs