com.vmware.vcenter.vm.storage.policy

Interface Compliance

All Superinterfaces:

ComplianceTypes, Service

All Known Implementing Classes:

ComplianceStub

public interface Compliance
extends Service, ComplianceTypes

The Compliance interface provides methods that return the compliance status of virtual machine entities(virtual machine home directory and virtual disks) that specify storage policy requirements. This interface was added in vSphere API 6.7.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.storage.policy.ComplianceTypes

ComplianceTypes.CheckSpec, ComplianceTypes.Info, ComplianceTypes.Status, ComplianceTypes.VmComplianceInfo

Method Summary

Methods

Modifier and Type	Method and Description
ComplianceTypes.Info	check(java.lang.String vm, ComplianceTypes.CheckSpec checkSpec) Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check.
void	check(java.lang.String vm, ComplianceTypes.CheckSpec checkSpec, AsyncCallback<ComplianceTypes.Info> asyncCallback) Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check.
void	check(java.lang.String vm, ComplianceTypes.CheckSpec checkSpec, AsyncCallback<ComplianceTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check.
ComplianceTypes.Info	check(java.lang.String vm, ComplianceTypes.CheckSpec checkSpec, InvocationConfig invocationConfig) Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check.
ComplianceTypes.Info	get(java.lang.String vm) Returns the cached storage policy compliance information of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<ComplianceTypes.Info> asyncCallback) Returns the cached storage policy compliance information of a virtual machine.
void	get(java.lang.String vm, AsyncCallback<ComplianceTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the cached storage policy compliance information of a virtual machine.
ComplianceTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Returns the cached storage policy compliance information of a virtual machine.

Method Detail

get

ComplianceTypes.Info get(java.lang.String vm)

Returns the cached storage policy compliance information of a virtual machine. 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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Virtual machine storage policy compliance Info ComplianceTypes.Info. If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Throws:

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

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

Unauthenticated - if the user cannot be authenticated.

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

get

ComplianceTypes.Info get(java.lang.String vm,
                       InvocationConfig invocationConfig)

Returns the cached storage policy compliance information of a virtual machine. 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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual machine storage policy compliance Info ComplianceTypes.Info. If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Throws:

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

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

Unauthenticated - if the user cannot be authenticated.

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

get

void get(java.lang.String vm,
       AsyncCallback<ComplianceTypes.Info> asyncCallback)

Returns the cached storage policy compliance information of a virtual machine. 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:
Virtual machine storage policy compliance Info ComplianceTypes.Info. If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

get

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

Returns the cached storage policy compliance information of a virtual machine. 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:
Virtual machine storage policy compliance Info ComplianceTypes.Info. If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

check

ComplianceTypes.Info check(java.lang.String vm,
                         ComplianceTypes.CheckSpec checkSpec)

Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check. 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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

checkSpec - Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info ComplianceTypes.Info is returned. If null, the behavior is equivalent to a ComplianceTypes.CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.

Returns:

Virtual machine storage policy compliance Info class . If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Throws:

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

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

Unauthenticated - if the user cannot be authenticated.

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

check

ComplianceTypes.Info check(java.lang.String vm,
                         ComplianceTypes.CheckSpec checkSpec,
                         InvocationConfig invocationConfig)

Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check. 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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

checkSpec - Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info ComplianceTypes.Info is returned. If null, the behavior is equivalent to a ComplianceTypes.CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual machine storage policy compliance Info class . If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Throws:

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

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

Unauthenticated - if the user cannot be authenticated.

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

check

void check(java.lang.String vm,
         ComplianceTypes.CheckSpec checkSpec,
         AsyncCallback<ComplianceTypes.Info> asyncCallback)

Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check. 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:
Virtual machine storage policy compliance Info class . If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

checkSpec - Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info ComplianceTypes.Info is returned. If null, the behavior is equivalent to a ComplianceTypes.CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.

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

check

void check(java.lang.String vm,
         ComplianceTypes.CheckSpec checkSpec,
         AsyncCallback<ComplianceTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the storage policy Compliance ComplianceTypes.Info of a virtual machine after explicitly re-computing compliance check. 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:
Virtual machine storage policy compliance Info class . If null, neither the virtual machine home directory nor any of it's virtual disks are associated with a storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
ServiceUnavailable - if the system is unable to communicate with a service necessary to complete the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

checkSpec - Parameter specifies the entities on which storage policy compliance check is to be invoked. The storage compliance Info ComplianceTypes.Info is returned. If null, the behavior is equivalent to a ComplianceTypes.CheckSpec with CheckSpec#vmHome set to true and CheckSpec#disks populated with all disks attached to the virtual machine.

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

invocationConfig - Configuration for the method invocation.