com.vmware.vcenter.storage.policies

Interface VM

All Superinterfaces:

Service, VMTypes

All Known Implementing Classes:

VMStub

public interface VM
extends Service, VMTypes

The VM interface provides methods managing the storage policy association for a virtual machine and its virtual disks. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.storage.policies.VMTypes

VMTypes.Info

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,VMTypes.Info>	list(java.lang.String policy) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
void	list(java.lang.String policy, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
void	list(java.lang.String policy, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.
java.util.Map<java.lang.String,VMTypes.Info>	list(java.lang.String policy, InvocationConfig invocationConfig) Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy.

Method Detail

list

java.util.Map<java.lang.String,VMTypes.Info> list(java.lang.String policy)

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

Returns:

Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Throws:

NotFound - if there is no policy associated with policy in the system.

UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.

Unauthenticated - if the user cannot be authenticated.

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

Error - if the backend server encounters some an error while processing the request.

Unauthorized - if the user does not have the required priveleges.

list

java.util.Map<java.lang.String,VMTypes.Info> list(java.lang.String policy,
                                                InvocationConfig invocationConfig)

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Throws:

NotFound - if there is no policy associated with policy in the system.

UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.

Unauthenticated - if the user cannot be authenticated.

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

Error - if the backend server encounters some an error while processing the request.

Unauthorized - if the user does not have the required priveleges.

list

void list(java.lang.String policy,
        AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback)

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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

Operation Result:
Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
NotFound - if there is no policy associated with policy in the system.
UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.
Unauthenticated - if the user cannot be authenticated.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Error - if the backend server encounters some an error while processing the request.
Unauthorized - if the user does not have the required priveleges.

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

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

list

void list(java.lang.String policy,
        AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback,
        InvocationConfig invocationConfig)

Returns information about the virtual machines and/or their virtual disks that are associated with the given storage policy. This method was added in vSphere API 6.7.

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

Operation Result:
Information about the virtual machines and/or their virtual disks that are associated with the given storage policy. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
NotFound - if there is no policy associated with policy in the system.
UnableToAllocateResource - if more than 1000 virtual machines are associated with the specified policy.
Unauthenticated - if the user cannot be authenticated.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Error - if the backend server encounters some an error while processing the request.
Unauthorized - if the user does not have the required priveleges.

Parameters:

policy - storage policy identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

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

invocationConfig - Configuration for the method invocation.