public interface Umds extends Service, UmdsTypes
Umds
interface provides methods to manage the VMware vSphere Update
Manager Download Service (UMDS) software depot used during ESX lifecycle
management. This is the depot downloaded using UMDS. If the UMDS depot is
specified, then online depots are ignored and data is downloaded only from the
UMDS depot.UmdsTypes._VAPI_OPERATIONS, UmdsTypes.DeleteResult, UmdsTypes.Info, UmdsTypes.PrecheckResult, UmdsTypes.SetSpec, UmdsTypes.UpdateSpec
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
java.lang.String |
delete_Task()
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete_Task(AsyncCallback<java.lang.String> asyncCallback)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete_Task(AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
java.lang.String |
delete_Task(InvocationConfig invocationConfig)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete()
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete(AsyncCallback<java.lang.Void> asyncCallback)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete(AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
void |
delete(InvocationConfig invocationConfig)
The task-based
delete() method removes content of the UMDS depot from
vLCM completely. |
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 the UMDS software depot.
|
void |
set(UmdsTypes.SetSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Sets or overwrites information about the UMDS software depot.
|
void |
set(UmdsTypes.SetSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Sets or overwrites information about the UMDS software depot.
|
void |
set(UmdsTypes.SetSpec spec,
InvocationConfig invocationConfig)
Sets or overwrites information about the 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.
|
UmdsTypes.Info get()
Synchronous method overload. Result of the invocation will be reported as a method return value.
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: VcIntegrity.lifecycleSettings.Read
. UmdsTypes.Info get(InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.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: VcIntegrity.lifecycleSettings.Read
. void get(AsyncCallback<UmdsTypes.Info> asyncCallback)
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:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(AsyncCallback<UmdsTypes.Info> asyncCallback, InvocationConfig invocationConfig)
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:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void set(UmdsTypes.SetSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
spec
- Specification to set the UMDS depot.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: VcIntegrity.lifecycleSettings.Write
. void set(UmdsTypes.SetSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
spec
- Specification to set the UMDS depot.invocationConfig
- Configuration for the method invocation.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: VcIntegrity.lifecycleSettings.Write
. void set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
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:
VcIntegrity.lifecycleSettings.Write
. spec
- Specification to set the UMDS depot.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void set(UmdsTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
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:
VcIntegrity.lifecycleSettings.Write
. spec
- Specification to set the UMDS depot.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete()
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Synchronous method overload. Result of the invocation will be reported as a method return value.
Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no UMDS depot configured in the system.ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. void delete(InvocationConfig invocationConfig)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no UMDS depot configured in the system.ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. java.lang.String delete_Task()
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no UMDS depot configured in the system.ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. java.lang.String delete_Task(InvocationConfig invocationConfig)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no UMDS depot configured in the system.ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. void delete_Task(AsyncCallback<java.lang.String> asyncCallback)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no UMDS depot configured in the system.
ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete_Task(AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no UMDS depot configured in the system.
ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(AsyncCallback<java.lang.Void> asyncCallback)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
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 in the system.
ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
delete()
method removes content of the UMDS depot from
vLCM completely. Note: The non task-based delete()
method has been
deprecated. It deletes only the record of UMDS depot from database, instead of
removing the content of UMDS depot from vLCM.
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 in the system.
ResourceInUse
- If the content of UMDS depot to be deleted is used in some baseline or desired
state. The value of the data property of Error
will be the PrecheckResult class that lists
the information of affected baselines and desired states. This error is
applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void update(UmdsTypes.UpdateSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
spec
- Update specification.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: VcIntegrity.lifecycleSettings.Write
. void update(UmdsTypes.UpdateSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
spec
- Update specification.invocationConfig
- Configuration for the method invocation.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: VcIntegrity.lifecycleSettings.Write
. void update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
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:
VcIntegrity.lifecycleSettings.Write
. spec
- Update specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void update(UmdsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
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:
VcIntegrity.lifecycleSettings.Write
. spec
- Update specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.