This API has a deprecated equivalent from v7.0U1.
Check Compatibility Policies
Returns datastore compatibility summary about a specific storage policy.
Request
URLURL
https://{api_host}/api/vcenter/storage/policies/{policy}?action=check-compatibility
Path Parameters
Path Parameters
string
policy
Required
The storage policy identifier The parameter must be an identifier 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"
Request Body
Request Body
StoragePoliciesCheckCompatibilityRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"datastores": [
"string"
]
}
array of
string
datastores
Required
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
StoragePoliciesCompatibilityInfo
of type application/json
datastore compatibility summary about a specific storage policy.
{
"compatible_datastores": [
{
"datastore": "string"
}
]
}
compatible_datastores
Required
Info about a list of datastores compatible with a specific storage policy.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if input more than 1024 datastores.
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
$StoragePoliciesCheckCompatibilityRequestBody = Initialize-StoragePoliciesCheckCompatibilityRequestBody -Datastores "MyDatastores"
Invoke-CheckCompatibilityPolicyPolicies -Policy "MyPolicy" -StoragePoliciesCheckCompatibilityRequestBody $StoragePoliciesCheckCompatibilityRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"datastores":["string"]}' https://{api_host}/api/vcenter/storage/policies/{policy}?action=check-compatibility
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/storage/policies/{policy}?action=check-compatibility
x-vmw-doc-operation: check_compatibility
Availability
Added in 7.0U2
