com.vmware.appliance.vcenter.settings.v1

Interface Config

All Superinterfaces:

ConfigTypes, Service

All Known Implementing Classes:

ConfigStub

public interface Config
extends Service, ConfigTypes

The Config interface provides methods to manage desired configuration specification of vCenter.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.appliance.vcenter.settings.v1.ConfigTypes

ConfigTypes._VAPI_OPERATIONS, ConfigTypes.CreateSpec, ConfigTypes.Info, ConfigTypes.ScanSpec

Field Summary

Fields inherited from interface com.vmware.appliance.vcenter.settings.v1.ConfigTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ConfigTypes.CreateSpec spec) Creates a Profile.
void	create(ConfigTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a Profile.
void	create(ConfigTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a Profile.
java.lang.String	create(ConfigTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a Profile.
void	delete() Deletes a profile.
void	delete(AsyncCallback<java.lang.Void> asyncCallback) Deletes a profile.
void	delete(AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a profile.
void	delete(InvocationConfig invocationConfig) Deletes a profile.
ConfigTypes.Info	get() Returns information about a profile.
void	get(AsyncCallback<ConfigTypes.Info> asyncCallback) Returns information about a profile.
void	get(AsyncCallback<ConfigTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a profile.
ConfigTypes.Info	get(InvocationConfig invocationConfig) Returns information about a profile.
java.lang.String	scan_Task(java.lang.String version) Scans all the components in the profiles against the applied profile.
void	scan_Task(java.lang.String version, AsyncCallback<java.lang.String> asyncCallback) Scans all the components in the profiles against the applied profile.
void	scan_Task(java.lang.String version, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Scans all the components in the profiles against the applied profile.
java.lang.String	scan_Task(java.lang.String version, InvocationConfig invocationConfig) Scans all the components in the profiles against the applied profile.
java.lang.String	scanDesiredState_Task(ConfigTypes.ScanSpec spec) Scans all the components in the desired state against the applied profile.
void	scanDesiredState_Task(ConfigTypes.ScanSpec spec, AsyncCallback<java.lang.String> asyncCallback) Scans all the components in the desired state against the applied profile.
void	scanDesiredState_Task(ConfigTypes.ScanSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Scans all the components in the desired state against the applied profile.
java.lang.String	scanDesiredState_Task(ConfigTypes.ScanSpec spec, InvocationConfig invocationConfig) Scans all the components in the desired state against the applied profile.

Method Detail

create

java.lang.String create(ConfigTypes.CreateSpec spec)

Creates a Profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

spec - Specification of the profile to be created.

Returns:

ID of newly-created profile. The return value will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile.

Throws:

AlreadyExists - if a profile with the specified name already exists.

Error - if the system reports an error while responding to the request.

InvalidArgument - if any of the specified parameters are invalid.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

create

java.lang.String create(ConfigTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Creates a Profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

spec - Specification of the profile to be created.

invocationConfig - Configuration for the method invocation.

Returns:

ID of newly-created profile. The return value will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile.

Throws:

AlreadyExists - if a profile with the specified name already exists.

Error - if the system reports an error while responding to the request.

InvalidArgument - if any of the specified parameters are invalid.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

create

void create(ConfigTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a Profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
ID of newly-created profile. The return value will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile.

Operation Errors:
AlreadyExists - if a profile with the specified name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

spec - Specification of the profile to be created.

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

create

void create(ConfigTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a Profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:
ID of newly-created profile. The return value will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile.

Operation Errors:
AlreadyExists - if a profile with the specified name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if any of the specified parameters are invalid.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

spec - Specification of the profile to be created.

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

invocationConfig - Configuration for the method invocation.

get

ConfigTypes.Info get()

Returns information about a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Returns:

Information about the specified profile.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - If given version is different than the latest one.

NotFound - If there is no profile or version associated with profile or version in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

get

ConfigTypes.Info get(InvocationConfig invocationConfig)

Returns information about a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified profile.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - If given version is different than the latest one.

NotFound - If there is no profile or version associated with profile or version in the system.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

get

void get(AsyncCallback<ConfigTypes.Info> asyncCallback)

Returns information about a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about the specified profile.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - If given version is different than the latest one.
NotFound - If there is no profile or version associated with profile or version in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

get

void get(AsyncCallback<ConfigTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 specified profile.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - If given version is different than the latest one.
NotFound - If there is no profile or version associated with profile or version in the system.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

invocationConfig - Configuration for the method invocation.

delete

void delete()

Deletes a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if any other operation running on the same profile.

NotFound - if the profile is not found.

ServiceUnavailable - if the system is unable to communicate service to complete the request.

Unauthenticated - if the user can not be authenticated.

delete

void delete(InvocationConfig invocationConfig)

Deletes a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotAllowedInCurrentState - if any other operation running on the same profile.

NotFound - if the profile is not found.

ServiceUnavailable - if the system is unable to communicate service to complete the request.

Unauthenticated - if the user can not be authenticated.

delete

void delete(AsyncCallback<java.lang.Void> asyncCallback)

Deletes a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if any other operation running on the same profile.
NotFound - if the profile is not found.
ServiceUnavailable - if the system is unable to communicate service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

delete

void delete(AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes a profile. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if any other operation running on the same profile.
NotFound - if the profile is not found.
ServiceUnavailable - if the system is unable to communicate service to complete the request.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

invocationConfig - Configuration for the method invocation.

scan_Task

java.lang.String scan_Task(java.lang.String version)

Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

version - version of the profile. The parameter must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version.

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.

NotFound - If there is no profile associated with profile in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scan_Task

java.lang.String scan_Task(java.lang.String version,
                           InvocationConfig invocationConfig)

Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

version - version of the profile. The parameter must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version.

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.

NotFound - If there is no profile associated with profile in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scan_Task

void scan_Task(java.lang.String version,
               AsyncCallback<java.lang.String> asyncCallback)

Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.
NotFound - If there is no profile associated with profile in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

version - version of the profile. The parameter must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version.

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

scan_Task

void scan_Task(java.lang.String version,
               AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.
NotFound - If there is no profile associated with profile in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

version - version of the profile. The parameter must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version.

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

invocationConfig - Configuration for the method invocation.

scanDesiredState_Task

java.lang.String scanDesiredState_Task(ConfigTypes.ScanSpec spec)

Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

spec -

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.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scanDesiredState_Task

java.lang.String scanDesiredState_Task(ConfigTypes.ScanSpec spec,
                                       InvocationConfig invocationConfig)

Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

spec -

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.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scanDesiredState_Task

void scanDesiredState_Task(ConfigTypes.ScanSpec spec,
                           AsyncCallback<java.lang.String> asyncCallback)

Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec -

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

scanDesiredState_Task

void scanDesiredState_Task(ConfigTypes.ScanSpec spec,
                           AsyncCallback<java.lang.String> asyncCallback,
                           InvocationConfig invocationConfig)

Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

spec -

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

invocationConfig - Configuration for the method invocation.