[{"label":"Latest (1.0.0)","version":"latest"}]
vsphere-replication-api

Check Storage Policy Compliance

Description

Check datastores for compliance against a given storage policy.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance
Copy

Path Parameters

Path Parameters

string
pairing_id Required

The ID of the pairing between this vSphere Replication server and the remote one.


string
vcenter_id Required

The ID of the vCenter server


string
storage_policy_id Required

The ID of a storage policy


Request Body

Request Body

array of string of mimetype application/json Required

List of datastores to check their compliance

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns StoragePolicyComplianceCheckDataDrResponseList of type application/json

Compliance result of datastores

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		],
		"limit": 0,
		"links": {
			"next": {
				"href": "string"
			},
			"previous": {
				"href": "string"
			},
			"self": {
				"href": "string"
			}
		},
		"offset": 0,
		"total": 0
	},
	"list": [
		{
			"compliant": false,
			"datastore": "string",
			"not_compliant_detailed_message": "string",
			"storage_policy_id": "string"
		}
	]
}
_meta Optional

List metadata


list Optional

Datastore compliance status against a storage policy

Errors

Errors

ResponseError
400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content


401

Unauthorized - the client must authenticate itself to get the requested response


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" https://{api_host}/pairings/{pairing_id}/vcenters/{vcenter_id}/storage-policies/{storage_policy_id}/actions/check-compliance
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions: StorageProfile.View
x-dr-remote-site-connectivity-contract:
    not-authenticated: DEPENDS_ON_PROVIDED_PARAMS
    server-down: DEPENDS_ON_PROVIDED_PARAMS


Feedback

Was this page helpful?