com.vmware.esx.settings.depots

Interface Umds

All Superinterfaces:

Service, UmdsTypes

All Known Implementing Classes:

UmdsStub

public interface Umds
extends Service, UmdsTypes

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.depots.UmdsTypes

UmdsTypes.Info, UmdsTypes.SetSpec, UmdsTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.esx.settings.depots.UmdsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete() Removes the configured UMDS software depot.
void	delete(AsyncCallback<java.lang.Void> asyncCallback) Removes the configured UMDS software depot.
void	delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes the configured UMDS software depot.
void	delete(InvocationConfig invocationConfig) Removes the configured UMDS software depot.
UmdsTypes.Info	get() Gets the information about a currently configured UMDS software depot.
void	get(AsyncCallback<UmdsTypes.Info> asyncCallback) Gets the information about a currently configured UMDS software depot.
void	get(AsyncCallback<UmdsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the information about a currently configured UMDS software depot.
UmdsTypes.Info	get(InvocationConfig invocationConfig) Gets the information about a currently configured UMDS software depot.
void	set(UmdsTypes.SetSpec spec) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets or overwrites information about an UMDS software depot.
void	set(UmdsTypes.SetSpec spec, InvocationConfig invocationConfig) Sets or overwrites information about an UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a currently configured UMDS software depot.
void	update(UmdsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a currently configured UMDS software depot.

Method Detail

get

UmdsTypes.Info get()

Gets the information about a currently configured UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Returns:

Information of the currently configured UMDS software depot.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS software depot set.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

UmdsTypes.Info get(InvocationConfig invocationConfig)

Gets the information about a currently configured UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

Information of the currently configured UMDS software depot.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS software depot set.

ServiceUnavailable - If the service is not available.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

void get(AsyncCallback<UmdsTypes.Info> asyncCallback)

Gets the information about a currently configured UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information of the currently configured UMDS software depot.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(AsyncCallback<UmdsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Gets the information about a currently configured UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Information of the currently configured UMDS software depot.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
ServiceUnavailable - If the service is not available.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

void set(UmdsTypes.SetSpec spec)

Sets or overwrites information about an UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec -

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

set

void set(UmdsTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Sets or overwrites information about an UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec -

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid location is provided.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

set

void set(UmdsTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Sets or overwrites information about an UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec -

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(UmdsTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Sets or overwrites information about an UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
InvalidArgument - If an invalid location is provided.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec -

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete()

Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS software depot set.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

void delete(InvocationConfig invocationConfig)

Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS software depot set.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

void delete(AsyncCallback<java.lang.Void> asyncCallback)

Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Removes the configured UMDS software depot. It will not remove the downloaded metadata and payloads from that depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS software depot set.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

void update(UmdsTypes.UpdateSpec spec)

Updates the configuration of a currently configured UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - Update specification.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS depot configured.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

update

void update(UmdsTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the configuration of a currently configured UMDS software depot.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - Update specification.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no UMDS depot configured.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

ServiceUnavailable - If the service is not available.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

update

void update(UmdsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the configuration of a currently configured UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS depot configured.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Update specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(UmdsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the configuration of a currently configured UMDS software depot.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no UMDS depot configured.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
ServiceUnavailable - If the service is not available.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

spec - Update specification.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.