public interface Components extends Service, ComponentsTypes
Components
interface provides methods to manage desired component
specification for a standalone ESX host. This interface was added in vSphere API
8.0.0.1._VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
ComponentInfo |
get(java.lang.String host,
java.lang.String component)
Returns the component version for the given component in the desired software
specification.
|
void |
get(java.lang.String host,
java.lang.String component,
AsyncCallback<ComponentInfo> asyncCallback)
Returns the component version for the given component in the desired software
specification.
|
void |
get(java.lang.String host,
java.lang.String component,
AsyncCallback<ComponentInfo> asyncCallback,
InvocationConfig invocationConfig)
Returns the component version for the given component in the desired software
specification.
|
ComponentInfo |
get(java.lang.String host,
java.lang.String component,
InvocationConfig invocationConfig)
Returns the component version for the given component in the desired software
specification.
|
java.util.Map<java.lang.String,ComponentInfo> |
list(java.lang.String host)
Returns a list of components in the desired software specification.
|
void |
list(java.lang.String host,
AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)
Returns a list of components in the desired software specification.
|
void |
list(java.lang.String host,
AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback,
InvocationConfig invocationConfig)
Returns a list of components in the desired software specification.
|
java.util.Map<java.lang.String,ComponentInfo> |
list(java.lang.String host,
InvocationConfig invocationConfig)
Returns a list of components in the desired software specification.
|
ComponentInfo get(java.lang.String host, java.lang.String component)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.null
then version is supposed to be chosen based on the constraints
in the system.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system or or no
component associated with component
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
ComponentInfo get(java.lang.String host, java.lang.String component, 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.invocationConfig
- Configuration for the method invocation.null
then version is supposed to be chosen based on the constraints
in the system.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.NotFound
- If there is no host associated with host
in the system or or no
component associated with component
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void get(java.lang.String host, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Details about the component version.
If null
then version is supposed to be chosen based on the constraints
in the system.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system or or no
component associated with component
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String host, java.lang.String component, AsyncCallback<ComponentInfo> 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:
Details about the component version.
If null
then version is supposed to be chosen based on the constraints
in the system.
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
NotFound
- If there is no host associated with host
in the system or or no
component associated with component
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.component
- Identifier of the component.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.component
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String host)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String host, 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.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.invocationConfig
- Configuration for the method invocation.Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void list(java.lang.String host, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of ComponentInfo keyed by the component identifier. If no version is
specified in desired software specification, then it will be empty.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.
Operation Errors:
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(java.lang.String host, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> 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:
Map of ComponentInfo keyed by the component identifier. If no version is
specified in desired software specification, then it will be empty.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.component
.
Operation Errors:
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.