com.vmware.vcenter.storage

Interface Policies

All Superinterfaces:

PoliciesTypes, Service

All Known Implementing Classes:

PoliciesStub

public interface Policies
extends Service, PoliciesTypes

The Policies interface provides methods for managing the storage policies. This interface was added in vSphere API 6.7.

Nested Class Summary

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

PoliciesTypes.CompatibilityInfo, PoliciesTypes.CompatibleDatastoreInfo, PoliciesTypes.FilterSpec, PoliciesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.storage.PoliciesTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
PoliciesTypes.CompatibilityInfo	checkCompatibility(java.lang.String policy, java.util.Set<java.lang.String> datastores) Returns datastore compatibility summary about a specific storage policy.
void	checkCompatibility(java.lang.String policy, java.util.Set<java.lang.String> datastores, AsyncCallback<PoliciesTypes.CompatibilityInfo> asyncCallback) Returns datastore compatibility summary about a specific storage policy.
void	checkCompatibility(java.lang.String policy, java.util.Set<java.lang.String> datastores, AsyncCallback<PoliciesTypes.CompatibilityInfo> asyncCallback, InvocationConfig invocationConfig) Returns datastore compatibility summary about a specific storage policy.
PoliciesTypes.CompatibilityInfo	checkCompatibility(java.lang.String policy, java.util.Set<java.lang.String> datastores, InvocationConfig invocationConfig) Returns datastore compatibility summary about a specific storage policy.
java.util.List<PoliciesTypes.Summary>	list(PoliciesTypes.FilterSpec filter) Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter.
void	list(PoliciesTypes.FilterSpec filter, AsyncCallback<java.util.List<PoliciesTypes.Summary>> asyncCallback) Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter.
void	list(PoliciesTypes.FilterSpec filter, AsyncCallback<java.util.List<PoliciesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter.
java.util.List<PoliciesTypes.Summary>	list(PoliciesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter.

Method Detail

list

java.util.List<PoliciesTypes.Summary> list(PoliciesTypes.FilterSpec filter)

Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. 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 - Specification of matching storage policies for which information should be returned. If null, the behavior is equivalent to a PoliciesTypes.FilterSpec with all properties null which means all storage policies match the filter

Returns:

Commonly used Information about the storage policies.

Throws:

InvalidArgument - if the PoliciesTypes.FilterSpec 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 doesn't have the required privileges.

UnableToAllocateResource - if more than 1024 storage policies exist.

list

java.util.List<PoliciesTypes.Summary> list(PoliciesTypes.FilterSpec filter,
                                           InvocationConfig invocationConfig)

Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. 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 - Specification of matching storage policies for which information should be returned. If null, the behavior is equivalent to a PoliciesTypes.FilterSpec with all properties null which means all storage policies match the filter

invocationConfig - Configuration for the method invocation.

Returns:

Commonly used Information about the storage policies.

Throws:

InvalidArgument - if the PoliciesTypes.FilterSpec 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 doesn't have the required privileges.

UnableToAllocateResource - if more than 1024 storage policies exist.

list

void list(PoliciesTypes.FilterSpec filter,
          AsyncCallback<java.util.List<PoliciesTypes.Summary>> asyncCallback)

Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. This method was added in vSphere API 6.7.

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

Invocation Result:
Commonly used Information about the storage policies.

Operation Errors:
InvalidArgument - if the PoliciesTypes.FilterSpec 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 doesn't have the required privileges.
UnableToAllocateResource - if more than 1024 storage policies exist.

Parameters:

filter - Specification of matching storage policies for which information should be returned. If null, the behavior is equivalent to a PoliciesTypes.FilterSpec with all properties null which means all storage policies match the filter

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

list

void list(PoliciesTypes.FilterSpec filter,
          AsyncCallback<java.util.List<PoliciesTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information about at most 1024 visible (subject to permission checks) storage solicies availabe in vCenter. These storage policies can be used for provisioning virtual machines or disks. 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.

Invocation Result:
Commonly used Information about the storage policies.

Operation Errors:
InvalidArgument - if the PoliciesTypes.FilterSpec 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 doesn't have the required privileges.
UnableToAllocateResource - if more than 1024 storage policies exist.

Parameters:

filter - Specification of matching storage policies for which information should be returned. If null, the behavior is equivalent to a PoliciesTypes.FilterSpec with all properties null which means all storage policies match the filter

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

invocationConfig - Configuration for the method invocation.

checkCompatibility

PoliciesTypes.CompatibilityInfo checkCompatibility(java.lang.String policy,
                                                   java.util.Set<java.lang.String> datastores)

Returns datastore compatibility summary about a specific 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 - The storage policy identifier The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

datastores - Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore.

Returns:

datastore compatibility summary about a specific storage policy.

Throws:

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

NotFound - if the storage policy specified does not exist.

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 doesn't have the required privileges.

UnableToAllocateResource - if input more than 1024 datastores.

checkCompatibility

PoliciesTypes.CompatibilityInfo checkCompatibility(java.lang.String policy,
                                                   java.util.Set<java.lang.String> datastores,
                                                   InvocationConfig invocationConfig)

Returns datastore compatibility summary about a specific 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 - The storage policy identifier The parameter must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.

datastores - Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore.

invocationConfig - Configuration for the method invocation.

Returns:

datastore compatibility summary about a specific storage policy.

Throws:

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

NotFound - if the storage policy specified does not exist.

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 doesn't have the required privileges.

UnableToAllocateResource - if input more than 1024 datastores.

checkCompatibility

void checkCompatibility(java.lang.String policy,
                        java.util.Set<java.lang.String> datastores,
                        AsyncCallback<PoliciesTypes.CompatibilityInfo> asyncCallback)

Returns datastore compatibility summary about a specific 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.

Invocation Result:
datastore compatibility summary about a specific storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the storage policy specified does not exist.
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 doesn't have the required privileges.
UnableToAllocateResource - if input more than 1024 datastores.

Parameters:

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

datastores - Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore.

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

checkCompatibility

void checkCompatibility(java.lang.String policy,
                        java.util.Set<java.lang.String> datastores,
                        AsyncCallback<PoliciesTypes.CompatibilityInfo> asyncCallback,
                        InvocationConfig invocationConfig)

Returns datastore compatibility summary about a specific 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.

Invocation Result:
datastore compatibility summary about a specific storage policy.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the storage policy specified does not exist.
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 doesn't have the required privileges.
UnableToAllocateResource - if input more than 1024 datastores.

Parameters:

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

datastores - Datastores used to check compatibility against a storage policy. The number of datastores is limited to 1024. The parameter must contain identifiers for the resource type: Datastore.

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

invocationConfig - Configuration for the method invocation.