com.vmware.vcenter.namespace_management

Interface VirtualMachineClasses

All Superinterfaces:

Service, VirtualMachineClassesTypes

All Known Implementing Classes:

VirtualMachineClassesStub

public interface VirtualMachineClasses
extends Service, VirtualMachineClassesTypes

The VirtualMachineClasses interface provides management methods for customizable virtual machine classes. A virtual machine class represents a policy and configuration resource which defines a set of attributes to be used in the configuration of a virtual machine instance. This interface was added in vSphere API 7.0.2.00100.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.VirtualMachineClassesTypes

VirtualMachineClassesTypes.ConfigStatus, VirtualMachineClassesTypes.CreateSpec, VirtualMachineClassesTypes.DynamicDirectPathIODevice, VirtualMachineClassesTypes.Info, VirtualMachineClassesTypes.InstanceStorage, VirtualMachineClassesTypes.InstanceStorageVolume, VirtualMachineClassesTypes.Message, VirtualMachineClassesTypes.UpdateSpec, VirtualMachineClassesTypes.VGPUDevice, VirtualMachineClassesTypes.VirtualDevices

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.VirtualMachineClassesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	create(VirtualMachineClassesTypes.CreateSpec spec) Create a VM class object.
void	create(VirtualMachineClassesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Create a VM class object.
void	create(VirtualMachineClassesTypes.CreateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Create a VM class object.
void	create(VirtualMachineClassesTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a VM class object.
void	delete(java.lang.String vmClass) Delete the VM class object.
void	delete(java.lang.String vmClass, AsyncCallback<java.lang.Void> asyncCallback) Delete the VM class object.
void	delete(java.lang.String vmClass, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete the VM class object.
void	delete(java.lang.String vmClass, InvocationConfig invocationConfig) Delete the VM class object.
VirtualMachineClassesTypes.Info	get(java.lang.String vmClass) Return information about a VM class.
void	get(java.lang.String vmClass, AsyncCallback<VirtualMachineClassesTypes.Info> asyncCallback) Return information about a VM class.
void	get(java.lang.String vmClass, AsyncCallback<VirtualMachineClassesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Return information about a VM class.
VirtualMachineClassesTypes.Info	get(java.lang.String vmClass, InvocationConfig invocationConfig) Return information about a VM class.
java.util.List<VirtualMachineClassesTypes.Info>	list() Return information about all VirtualMachine classes.
void	list(AsyncCallback<java.util.List<VirtualMachineClassesTypes.Info>> asyncCallback) Return information about all VirtualMachine classes.
void	list(AsyncCallback<java.util.List<VirtualMachineClassesTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Return information about all VirtualMachine classes.
java.util.List<VirtualMachineClassesTypes.Info>	list(InvocationConfig invocationConfig) Return information about all VirtualMachine classes.
void	update(java.lang.String vmClass, VirtualMachineClassesTypes.UpdateSpec spec) Update the configuration of the VM class object.
void	update(java.lang.String vmClass, VirtualMachineClassesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update the configuration of the VM class object.
void	update(java.lang.String vmClass, VirtualMachineClassesTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update the configuration of the VM class object.
void	update(java.lang.String vmClass, VirtualMachineClassesTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update the configuration of the VM class object.

Method Detail

create

void create(VirtualMachineClassesTypes.CreateSpec spec)

Create a VM class object. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

spec - Information about the VM class object to be created.

Throws:

AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.

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

InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

create

void create(VirtualMachineClassesTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Create a VM class object. This method was added in vSphere API 7.0.2.00100.

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 - Information about the VM class object to be created.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.

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

InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

create

void create(VirtualMachineClassesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Create a VM class object. This method was added in vSphere API 7.0.2.00100.

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

Operation Errors:
AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

spec - Information about the VM class object to be created.

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

create

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

Create a VM class object. This method was added in vSphere API 7.0.2.00100.

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:
AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

spec - Information about the VM class object to be created.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String vmClass,
            VirtualMachineClassesTypes.UpdateSpec spec)

Update the configuration of the VM class object. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

spec - Information about the VM class object to be updated.

Throws:

AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.

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

InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.

NotFound - if or the vmClass cannot be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

update

void update(java.lang.String vmClass,
            VirtualMachineClassesTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Update the configuration of the VM class object. This method was added in vSphere API 7.0.2.00100.

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:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

spec - Information about the VM class object to be updated.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.

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

InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.

NotFound - if or the vmClass cannot be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

update

void update(java.lang.String vmClass,
            VirtualMachineClassesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Update the configuration of the VM class object. This method was added in vSphere API 7.0.2.00100.

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

Operation Errors:
AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.
NotFound - if or the vmClass cannot be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

spec - Information about the VM class object to be updated.

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

update

void update(java.lang.String vmClass,
            VirtualMachineClassesTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update the configuration of the VM class object. This method was added in vSphere API 7.0.2.00100.

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:
AlreadyExists - if a VM class by the name as specified in the spec already exists in the vCenter inventory.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the input refers to an invalid storage policy or if the input spec includes settings that are out of acceptable bounds or a combination of settings that are not internally consistent with the input spec.
NotFound - if or the vmClass cannot be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

spec - Information about the VM class object to be updated.

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

invocationConfig - Configuration for the method invocation.

get

VirtualMachineClassesTypes.Info get(java.lang.String vmClass)

Return information about a VM class. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

Returns:

Information about the specified VM class.

Throws:

NotFound - if VM class can not be found in the vCenter inventory.

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

VirtualMachineClassesTypes.Info get(java.lang.String vmClass,
                                    InvocationConfig invocationConfig)

Return information about a VM class. This method was added in vSphere API 7.0.2.00100.

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:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified VM class.

Throws:

NotFound - if VM class can not be found in the vCenter inventory.

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

void get(java.lang.String vmClass,
         AsyncCallback<VirtualMachineClassesTypes.Info> asyncCallback)

Return information about a VM class. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
Information about the specified VM class.

Operation Errors:
NotFound - if VM class can not be found in the vCenter inventory.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

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

get

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

Return information about a VM class. This method was added in vSphere API 7.0.2.00100.

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 VM class.

Operation Errors:
NotFound - if VM class can not be found in the vCenter inventory.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<VirtualMachineClassesTypes.Info> list()

Return information about all VirtualMachine classes. This method was added in vSphere API 7.0.2.00100.

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

Returns:

List of information about all VirtualMachine classes

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<VirtualMachineClassesTypes.Info> list(InvocationConfig invocationConfig)

Return information about all VirtualMachine classes. This method was added in vSphere API 7.0.2.00100.

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:

List of information about all VirtualMachine classes

Throws:

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

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(AsyncCallback<java.util.List<VirtualMachineClassesTypes.Info>> asyncCallback)

Return information about all VirtualMachine classes. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
List of information about all VirtualMachine classes

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

list

void list(AsyncCallback<java.util.List<VirtualMachineClassesTypes.Info>> asyncCallback,
          InvocationConfig invocationConfig)

Return information about all VirtualMachine classes. This method was added in vSphere API 7.0.2.00100.

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:
List of information about all VirtualMachine classes

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String vmClass)

Delete the VM class object. This method was added in vSphere API 7.0.2.00100.

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

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

Throws:

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

ResourceInUse - - TBD

NotFound - VM class could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

delete

void delete(java.lang.String vmClass,
            InvocationConfig invocationConfig)

Delete the VM class object. This method was added in vSphere API 7.0.2.00100.

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:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

invocationConfig - Configuration for the method invocation.

Throws:

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

ResourceInUse - - TBD

NotFound - VM class could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

delete

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

Delete the VM class object. This method was added in vSphere API 7.0.2.00100.

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.
ResourceInUse - - TBD
NotFound - VM class could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

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

delete

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

Delete the VM class object. This method was added in vSphere API 7.0.2.00100.

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.
ResourceInUse - - TBD
NotFound - VM class could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have VirtualMachineClasses.Manage privilege.

Parameters:

vmClass - Identifier for the VM class. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.VirtualMachineClass.

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

invocationConfig - Configuration for the method invocation.