This API has a deprecated equivalent from v7.0U1.
List Policies
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.
Request
URLURL
https://{api_host}/api/vcenter/storage/policies
Query Parameters
Query Parameters
array of
string
policies
Optional
Identifiers of storage policies that can match the filter. If unset or empty, storage policies with any identifiers match the filter. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.StoragePolicy. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.StoragePolicy.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
StoragePoliciesSummary
of type application/json
Commonly used Information about the storage policies.
[
{
"description": "string",
"name": "string",
"policy": "string"
}
]
string
description
Required
Description of the storage policy.
string
name
Required
Name of the storage policy.
string
policy
Required
Identifier of the storage policy. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.StoragePolicy. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.StoragePolicy.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Policies.FilterSpec contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 1024 storage policies exist.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListStoragePolicies -Policies "MyPolicies"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/storage/policies
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/storage/policies
x-vmw-doc-operation: list
Availability
Added in 7.0U2
