public interface EffectiveComponents extends Service, EffectiveComponentsTypes
EffectiveComponents
interface provides methods to get effective list
of components. This interface was added in vSphere API 8.0.0.1._VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,EffectiveComponentInfo> |
list(java.lang.String host)
Returns the effective components for the host.
|
void |
list(java.lang.String host,
AsyncCallback<java.util.Map<java.lang.String,EffectiveComponentInfo>> asyncCallback)
Returns the effective components for the host.
|
void |
list(java.lang.String host,
AsyncCallback<java.util.Map<java.lang.String,EffectiveComponentInfo>> asyncCallback,
InvocationConfig invocationConfig)
Returns the effective components for the host.
|
java.util.Map<java.lang.String,EffectiveComponentInfo> |
list(java.lang.String host,
InvocationConfig invocationConfig)
Returns the effective components for the host.
|
java.util.Map<java.lang.String,EffectiveComponentInfo> 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 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,EffectiveComponentInfo> 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 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,EffectiveComponentInfo>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of effective components keyed by their identifier.
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 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,EffectiveComponentInfo>> 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 effective components keyed by their identifier.
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 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.