com.vmware.esx.settings.hosts.policies.apply

Interface Effective

All Superinterfaces:

EffectiveTypes, Service

All Known Implementing Classes:

EffectiveStub

public interface Effective
extends Service, EffectiveTypes

The Effective interface provides methods to manage the effective policies that will impact how the software and configuration specification documents are applied to an ESXi host. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.hosts.policies.apply.EffectiveTypes

EffectiveTypes.EffectivePolicySpec, EffectiveTypes.FailureAction

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.policies.apply.EffectiveTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
EffectiveTypes.EffectivePolicySpec	get(java.lang.String host) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
void	get(java.lang.String host, AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
void	get(java.lang.String host, AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback, InvocationConfig invocationConfig) Returns the effective policy based on system defaults and what has been configured for the ESXi host.
EffectiveTypes.EffectivePolicySpec	get(java.lang.String host, InvocationConfig invocationConfig) Returns the effective policy based on system defaults and what has been configured for the ESXi host.

Method Detail

get

EffectiveTypes.EffectivePolicySpec get(java.lang.String host)

Returns the effective policy based on system defaults and what has been configured for the ESXi 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 - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

Returns:

The effective policies that impact the apply method

Throws:

Error - If there is an 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.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

get

EffectiveTypes.EffectivePolicySpec get(java.lang.String host,
                                       InvocationConfig invocationConfig)

Returns the effective policy based on system defaults and what has been configured for the ESXi 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 - The host identifier. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

The effective policies that impact the apply method

Throws:

Error - If there is an 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.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String host,
         AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback)

Returns the effective policy based on system defaults and what has been configured for the ESXi 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:
The effective policies that impact the apply method

Operation Errors:
Error - If there is an 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.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

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

get

void get(java.lang.String host,
         AsyncCallback<EffectiveTypes.EffectivePolicySpec> asyncCallback,
         InvocationConfig invocationConfig)

Returns the effective policy based on system defaults and what has been configured for the ESXi 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:
The effective policies that impact the apply method

Operation Errors:
Error - If there is an 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.lifecycleSettings.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.

Parameters:

host - The host identifier. 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.