com.vmware.esx.settings.hosts.software

Interface EffectiveComponents

All Superinterfaces:

EffectiveComponentsTypes, Service

All Known Implementing Classes:

EffectiveComponentsStub

public interface EffectiveComponents
extends Service, EffectiveComponentsTypes

The EffectiveComponents interface provides methods to get effective list of components. This interface was added in vSphere API 8.0.0.1.

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.software.EffectiveComponentsTypes

_VAPI_SERVICE_ID

Method Summary

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.

Method Detail

list

java.util.Map<java.lang.String,EffectiveComponentInfo> list(java.lang.String host)

Returns the effective components for the host. This method was added in vSphere API 8.0.0.1.

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

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

Returns:

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.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list

java.util.Map<java.lang.String,EffectiveComponentInfo> list(java.lang.String host,
                                                            InvocationConfig invocationConfig)

Returns the effective components for the host. This method was added in vSphere API 8.0.0.1.

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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

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.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list

void list(java.lang.String host,
          AsyncCallback<java.util.Map<java.lang.String,EffectiveComponentInfo>> asyncCallback)

Returns the effective components for the host. This method was added in vSphere API 8.0.0.1.

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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

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.

list

void list(java.lang.String host,
          AsyncCallback<java.util.Map<java.lang.String,EffectiveComponentInfo>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the effective components for the host. This method was added in vSphere API 8.0.0.1.

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:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

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.