This API has a deprecated equivalent from v7.0U1.
List Policies Compliance
Returns compliance information about entities matching the filter Compliance.FilterSpec. Entities without storage policy association are not returned.
Request
URLURL
https://{api_host}/api/vcenter/storage/policies/entities/compliance
Query Parameters
Query Parameters
array of
StoragePoliciesComplianceStatus
status
Required
Compliance Status that a virtual machine must have to match the filter.
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
StoragePoliciesComplianceSummary of type application/json
compliance information about entities matching the filter Compliance.FilterSpec.
[
{
"disks": "COMPLIANT",
"vm": "string",
"vm_home": "COMPLIANT"
}
]
string
vm
Required
Identifier of virtual machine When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: VirtualMachine. When operations return a value of this structure as a result, the field will be an identifier for the resource type: VirtualMachine.
disks
Optional
This enumeration defines the set of status values for a compliance operation.
COMPLIANT : Entity is in compliance.
NON_COMPLIANT : Entity is out of compliance.
UNKNOWN : Compliance status of the entity is not known.
NOT_APPLICABLE : Compliance computation is not applicable for this entity because it does not have any storage requirement that apply to the object-based datastore on which the entity is placed.
OUT_OF_DATE : Compliance status becomes out of date when the profile associated with the entity is edited and not applied. The compliance status will remain out of date until the latest policy is applied to the entity.
Possible values are: COMPLIANT , NON_COMPLIANT , UNKNOWN , NOT_APPLICABLE , OUT_OF_DATE
vm_home
Optional
This enumeration defines the set of status values for a compliance operation.
COMPLIANT : Entity is in compliance.
NON_COMPLIANT : Entity is out of compliance.
UNKNOWN : Compliance status of the entity is not known.
NOT_APPLICABLE : Compliance computation is not applicable for this entity because it does not have any storage requirement that apply to the object-based datastore on which the entity is placed.
OUT_OF_DATE : Compliance status becomes out of date when the profile associated with the entity is edited and not applied. The compliance status will remain out of date until the latest policy is applied to the entity.
Possible values are: COMPLIANT , NON_COMPLIANT , UNKNOWN , NOT_APPLICABLE , OUT_OF_DATE
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Compliance.FilterSpec.status field 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.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Code Samples
PowerCLI Client SDK Example
Invoke-ListPoliciesEntitiesCompliance -Status "COMPLIANT"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/storage/policies/entities/compliance?status=string
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/entities/compliance
x-vmw-doc-operation: list
Availability
Added in 7.0U2
