com.vmware.esx.settings.hosts.enablement

Interface Software

All Superinterfaces:

Service, SoftwareTypes

All Known Implementing Classes:

SoftwareStub

public interface Software
extends Service, SoftwareTypes

The Software interface provides methods to control whether the host is managed with a single software specification. 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.enablement.SoftwareTypes

SoftwareTypes._VAPI_OPERATIONS, SoftwareTypes.CheckResult, SoftwareTypes.CheckSpec, SoftwareTypes.CheckType, SoftwareTypes.EnableSpec, SoftwareTypes.Info

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.enablement.SoftwareTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec) Checks the possibility to manage the host with a single software specification.
void	check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback) Checks the possibility to manage the host with a single software specification.
void	check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Checks the possibility to manage the host with a single software specification.
java.lang.String	check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, InvocationConfig invocationConfig) Checks the possibility to manage the host with a single software specification.
java.lang.String	enable_Task(java.lang.String host, SoftwareTypes.EnableSpec spec) Enables the feature which manages the host with a single software specification.
void	enable_Task(java.lang.String host, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback) Enables the feature which manages the host with a single software specification.
void	enable_Task(java.lang.String host, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Enables the feature which manages the host with a single software specification.
java.lang.String	enable_Task(java.lang.String host, SoftwareTypes.EnableSpec spec, InvocationConfig invocationConfig) Enables the feature which manages the host with a single software specification.
SoftwareTypes.Info	get(java.lang.String host) Returns whether the given standalone host is managed with a single software specification.
void	get(java.lang.String host, AsyncCallback<SoftwareTypes.Info> asyncCallback) Returns whether the given standalone host is managed with a single software specification.
void	get(java.lang.String host, AsyncCallback<SoftwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns whether the given standalone host is managed with a single software specification.
SoftwareTypes.Info	get(java.lang.String host, InvocationConfig invocationConfig) Returns whether the given standalone host is managed with a single software specification.

Method Detail

get

SoftwareTypes.Info get(java.lang.String host)

Returns whether the given standalone host is managed with a single software specification. 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:

True if feature is enabled, false otherwise.

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

get

SoftwareTypes.Info get(java.lang.String host,
                       InvocationConfig invocationConfig)

Returns whether the given standalone host is managed with a single software specification. 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:

True if feature is enabled, false otherwise.

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

get

void get(java.lang.String host,
         AsyncCallback<SoftwareTypes.Info> asyncCallback)

Returns whether the given standalone host is managed with a single software specification. 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:
True if feature is enabled, false otherwise.

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

get

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

Returns whether the given standalone host is managed with a single software specification. 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:
True if feature is enabled, false otherwise.

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

check_Task

java.lang.String check_Task(java.lang.String host,
                            SoftwareTypes.CheckSpec spec)

Checks the possibility to manage the host with a single software specification. This method was added in vSphere API 8.0.0.1.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

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

spec - Check specification. If null, all checks are performed.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

NotAllowedInCurrentState - If the feature is already enabled for the given host.

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.

check_Task

java.lang.String check_Task(java.lang.String host,
                            SoftwareTypes.CheckSpec spec,
                            InvocationConfig invocationConfig)

Checks the possibility to manage the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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.

Parameters:

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

spec - Check specification. If null, all checks are performed.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

NotAllowedInCurrentState - If the feature is already enabled for the given host.

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.

check_Task

void check_Task(java.lang.String host,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback)

Checks the possibility to manage the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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:
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the feature is already enabled for the given host.
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.

Parameters:

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

spec - Check specification. If null, all checks are performed.

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

check_Task

void check_Task(java.lang.String host,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Checks the possibility to manage the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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:
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the feature is already enabled for the given host.
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.

Parameters:

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

spec - Check specification. If null, all checks are performed.

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

invocationConfig - Configuration for the method invocation.

enable_Task

java.lang.String enable_Task(java.lang.String host,
                             SoftwareTypes.EnableSpec spec)

Enables the feature which manages the host with a single software specification. This method was added in vSphere API 8.0.0.1.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

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

spec - Enablement specification. If null, all checks are performed.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If feature enablement failed for the given host. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.

NotAllowedInCurrentState - If the feature is already enabled for the given host.

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.

enable_Task

java.lang.String enable_Task(java.lang.String host,
                             SoftwareTypes.EnableSpec spec,
                             InvocationConfig invocationConfig)

Enables the feature which manages the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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.

Parameters:

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

spec - Enablement specification. If null, all checks are performed.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If feature enablement failed for the given host. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.

NotAllowedInCurrentState - If the feature is already enabled for the given host.

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.

enable_Task

void enable_Task(java.lang.String host,
                 SoftwareTypes.EnableSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Enables the feature which manages the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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:
Error - If feature enablement failed for the given host. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.
NotAllowedInCurrentState - If the feature is already enabled for the given host.
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.

Parameters:

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

spec - Enablement specification. If null, all checks are performed.

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

enable_Task

void enable_Task(java.lang.String host,
                 SoftwareTypes.EnableSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Enables the feature which manages the host with a single software specification. This method was added in vSphere API 8.0.0.1.

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:
Error - If feature enablement failed for the given host. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.
NotAllowedInCurrentState - If the feature is already enabled for the given host.
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.

Parameters:

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

spec - Enablement specification. If null, all checks are performed.

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

invocationConfig - Configuration for the method invocation.