com.vmware.esx.settings.hosts.software

Interface Recommendations

All Superinterfaces:

RecommendationsTypes, Service

All Known Implementing Classes:

RecommendationsStub

public interface Recommendations
extends Service, RecommendationsTypes

The Recommendations interface provides methods to manage the generation and retrieval of recommended image specs. 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.software.RecommendationsTypes

RecommendationsTypes._VAPI_OPERATIONS, RecommendationsTypes.ExplanationDetails, RecommendationsTypes.Info

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	generate_Task(java.lang.String host) Generates recommended software image spec(s) based on current desired software spec.
void	generate_Task(java.lang.String host, AsyncCallback<java.lang.String> asyncCallback) Generates recommended software image spec(s) based on current desired software spec.
void	generate_Task(java.lang.String host, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Generates recommended software image spec(s) based on current desired software spec.
java.lang.String	generate_Task(java.lang.String host, InvocationConfig invocationConfig) Generates recommended software image spec(s) based on current desired software spec.
RecommendationsTypes.Info	get(java.lang.String host) Returns Information about the most recent recommendation generation result.
void	get(java.lang.String host, AsyncCallback<RecommendationsTypes.Info> asyncCallback) Returns Information about the most recent recommendation generation result.
void	get(java.lang.String host, AsyncCallback<RecommendationsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns Information about the most recent recommendation generation result.
RecommendationsTypes.Info	get(java.lang.String host, InvocationConfig invocationConfig) Returns Information about the most recent recommendation generation result.

Method Detail

generate_Task

java.lang.String generate_Task(java.lang.String host)

Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. 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.

Returns:

identifier for the task created by this API invocation

Throws:

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

ConcurrentChange - If a new desired image is committed in parallel via a different client while recommendation is being generated.

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.

generate_Task

java.lang.String generate_Task(java.lang.String host,
                               InvocationConfig invocationConfig)

Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. 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.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

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

ConcurrentChange - If a new desired image is committed in parallel via a different client while recommendation is being generated.

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.

generate_Task

void generate_Task(java.lang.String host,
                   AsyncCallback<java.lang.String> asyncCallback)

Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. 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 unknown internal error. The accompanying error message will give more details about the failure.
ConcurrentChange - If a new desired image is committed in parallel via a different client while recommendation is being generated.
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.

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

generate_Task

void generate_Task(java.lang.String host,
                   AsyncCallback<java.lang.String> asyncCallback,
                   InvocationConfig invocationConfig)

Generates recommended software image spec(s) based on current desired software spec. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. 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 unknown internal error. The accompanying error message will give more details about the failure.
ConcurrentChange - If a new desired image is committed in parallel via a different client while recommendation is being generated.
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.

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

invocationConfig - Configuration for the method invocation.

get

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

Returns Information about the most recent recommendation generation result. 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:

Information about the most recent recommendation generation result.

Throws:

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

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.

get

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

Returns Information about the most recent recommendation generation result. 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:

Information about the most recent recommendation generation result.

Throws:

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

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.

get

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

Returns Information about the most recent recommendation generation result. 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:
Information about the most recent recommendation generation result.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
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.

get

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

Returns Information about the most recent recommendation generation result. 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:
Information about the most recent recommendation generation result.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
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.