vmware::esx::settings::depots::Umds Interface Reference

The Umds interface provides methods to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management. More...

Inherited by vmware::esx::settings::depots::UmdsStub.

List of all members.

Public Member Functions
vmware.esx.settings.depots.UmdsTypes.Info	Get ()
	Gets the information about a currently configured UMDS software depot.
vmware.esx.settings.depots.UmdsTypes.Info	Get (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the information about a currently configured UMDS software depot.
global::System.Threading.Tasks.Task < vmware.esx.settings.depots.UmdsTypes.Info >	GetAsync ()
	Gets the information about a currently configured UMDS software depot.
global::System.Threading.Tasks.Task < vmware.esx.settings.depots.UmdsTypes.Info >	GetAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Gets the information about a currently configured UMDS software depot.
void	Set (vmware.esx.settings.depots.UmdsTypes.SetSpec spec)
	Sets or overwrites information about an UMDS software depot.
void	Set (vmware.esx.settings.depots.UmdsTypes.SetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets or overwrites information about an UMDS software depot.
global::System.Threading.Tasks.Task	SetAsync (vmware.esx.settings.depots.UmdsTypes.SetSpec spec)
	Sets or overwrites information about an UMDS software depot.
global::System.Threading.Tasks.Task	SetAsync (vmware.esx.settings.depots.UmdsTypes.SetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Sets or overwrites information about an UMDS software depot.
void	Delete ()
	Removes the configured UMDS software depot.
void	Delete (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes the configured UMDS software depot.
global::System.Threading.Tasks.Task	DeleteAsync ()
	Removes the configured UMDS software depot.
global::System.Threading.Tasks.Task	DeleteAsync (global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Removes the configured UMDS software depot.
void	Update (vmware.esx.settings.depots.UmdsTypes.UpdateSpec spec)
	Updates the configuration of a currently configured UMDS software depot.
void	Update (vmware.esx.settings.depots.UmdsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the configuration of a currently configured UMDS software depot.
global::System.Threading.Tasks.Task	UpdateAsync (vmware.esx.settings.depots.UmdsTypes.UpdateSpec spec)
	Updates the configuration of a currently configured UMDS software depot.
global::System.Threading.Tasks.Task	UpdateAsync (vmware.esx.settings.depots.UmdsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the configuration of a currently configured UMDS software depot.

---

Detailed Description

The Umds interface provides methods to manage VMware vSphere Update Manager Download Service (UMDS) software depots used during ESX lifecycle management.

This is the depot downloaded using UMDS.

If a UMDS depot is specified then online depots are ignored and data is downloaded only from the UMDS depot.

---

Member Function Documentation

void vmware::esx::settings::depots::Umds::Delete

(

)

Removes the configured UMDS software depot.

It will not remove the downloaded metadata and payloads from that depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Implemented in vmware::esx::settings::depots::UmdsStub.

void vmware::esx::settings::depots::Umds::Delete	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes the configured UMDS software depot.

It will not remove the downloaded metadata and payloads from that depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::DeleteAsync

(

)

Removes the configured UMDS software depot.

It will not remove the downloaded metadata and payloads from that depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::DeleteAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Removes the configured UMDS software depot.

It will not remove the downloaded metadata and payloads from that depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Implemented in vmware::esx::settings::depots::UmdsStub.

vmware.esx.settings.depots.UmdsTypes.Info vmware::esx::settings::depots::Umds::Get	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Gets the information about a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Returns:

Information of the currently configured UMDS software depot.

Implemented in vmware::esx::settings::depots::UmdsStub.

vmware.esx.settings.depots.UmdsTypes.Info vmware::esx::settings::depots::Umds::Get

(

)

Gets the information about a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Returns:

Information of the currently configured UMDS software depot.

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.depots.UmdsTypes.Info> vmware::esx::settings::depots::Umds::GetAsync	(	global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Gets the information about a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Returns:

Information of the currently configured UMDS software depot.

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task<vmware.esx.settings.depots.UmdsTypes.Info> vmware::esx::settings::depots::Umds::GetAsync

(

)

Gets the information about a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS software depot set.
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 .

Returns:

Information of the currently configured UMDS software depot.

Implemented in vmware::esx::settings::depots::UmdsStub.

void vmware::esx::settings::depots::Umds::Set

(

vmware.esx.settings.depots.UmdsTypes.SetSpec

spec

)

Sets or overwrites information about an UMDS software depot.

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.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 .

Parameters:

spec

Implemented in vmware::esx::settings::depots::UmdsStub.

void vmware::esx::settings::depots::Umds::Set	(	vmware.esx.settings.depots.UmdsTypes.SetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets or overwrites information about an UMDS software depot.

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.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 .

Parameters:

spec
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::SetAsync	(	vmware.esx.settings.depots.UmdsTypes.SetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Sets or overwrites information about an UMDS software depot.

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.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 .

Parameters:

spec
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::SetAsync

(

vmware.esx.settings.depots.UmdsTypes.SetSpec

spec

)

Sets or overwrites information about an UMDS software depot.

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.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 .

Parameters:

spec

Implemented in vmware::esx::settings::depots::UmdsStub.

void vmware::esx::settings::depots::Umds::Update

(

vmware.esx.settings.depots.UmdsTypes.UpdateSpec

spec

)

Updates the configuration of a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS depot configured.
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 .

Parameters:

spec	Update specification.

Implemented in vmware::esx::settings::depots::UmdsStub.

void vmware::esx::settings::depots::Umds::Update	(	vmware.esx.settings.depots.UmdsTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates the configuration of a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS depot configured.
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 .

Parameters:

spec	Update specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::UpdateAsync	(	vmware.esx.settings.depots.UmdsTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates the configuration of a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS depot configured.
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 .

Parameters:

spec	Update specification.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::esx::settings::depots::UmdsStub.

global::System.Threading.Tasks.Task vmware::esx::settings::depots::Umds::UpdateAsync

(

vmware.esx.settings.depots.UmdsTypes.UpdateSpec

spec

)

Updates the configuration of a currently configured UMDS software depot.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the caller is not authenticated.
vmware.vapi.std.errors.NotFound	If there is no UMDS depot configured.
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 .

Parameters:

spec	Update specification.

Implemented in vmware::esx::settings::depots::UmdsStub.

---

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

• Umds.cs