com.vmware.vcenter.storage.policies.compliance

Interface VM

All Superinterfaces:

Service, VMTypes

All Known Implementing Classes:

VMStub

public interface VM
extends Service, VMTypes

The VM class provides methods related to query virtual machines of given compliance statuses. This interface was added in vSphere API 6.7.

Nested Class Summary

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

VMTypes.FilterSpec, VMTypes.Info, VMTypes.Status

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,VMTypes.Info>	list(VMTypes.FilterSpec filter) Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec.
void	list(VMTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback) Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec.
void	list(VMTypes.FilterSpec filter, AsyncCallback<java.util.Map<java.lang.String,VMTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec.
java.util.Map<java.lang.String,VMTypes.Info>	list(VMTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec.

Method Detail

list

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

Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec. If there are no virtual machines matching the VMTypes.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned. 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:

filter - compliance status of matching virtual machines for which information should be returned.

Returns:

compliance information about virtual machines matching the filter VMTypes.FilterSpec. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Throws:

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

InvalidArgument - if the VMTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.

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

Unauthenticated - if the user can not be authenticated.

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

Unsupported - if the API is invoked against vCenter Server version is less than 6.5

UnableToAllocateResource - If more than 1000 results match the VMTypes.FilterSpec

list

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

Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec. If there are no virtual machines matching the VMTypes.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned. 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:

filter - compliance status of matching virtual machines for which information should be returned.

invocationConfig - Configuration for the method invocation.

Returns:

compliance information about virtual machines matching the filter VMTypes.FilterSpec. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Throws:

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

InvalidArgument - if the VMTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.

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

Unauthenticated - if the user can not be authenticated.

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

Unsupported - if the API is invoked against vCenter Server version is less than 6.5

UnableToAllocateResource - If more than 1000 results match the VMTypes.FilterSpec

list

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

Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec. If there are no virtual machines matching the VMTypes.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned. 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:
compliance information about virtual machines matching the filter VMTypes.FilterSpec. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the VMTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have the required privileges.
Unsupported - if the API is invoked against vCenter Server version is less than 6.5
UnableToAllocateResource - If more than 1000 results match the VMTypes.FilterSpec

Parameters:

filter - compliance status of matching virtual machines for which information should be returned.

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

list

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

Returns compliance information about at most 1000 virtual machines matching the filter VMTypes.FilterSpec. If there are no virtual machines matching the VMTypes.FilterSpec an empty List is returned. Virtual machines without storage policy association are not returned. 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:
compliance information about virtual machines matching the filter VMTypes.FilterSpec. The key in the return value Map will be an identifier for the resource type: VirtualMachine.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the VMTypes.FilterSpec.getStatus() property contains a value that is not supported by the server.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have the required privileges.
Unsupported - if the API is invoked against vCenter Server version is less than 6.5
UnableToAllocateResource - If more than 1000 results match the VMTypes.FilterSpec

Parameters:

filter - compliance status of matching virtual machines for which information should be returned.

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

invocationConfig - Configuration for the method invocation.