Get Compute Policies
Returns information about the compliance of a virtual machine with a compute policy.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/compute/policies/{policy}
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine to query the status for. The parameter must be an identifier for the resource type: VirtualMachine.
string
policy
Required
Identifier of the policy to query the status for. The parameter must be an identifier for the resource type: com.vmware.vcenter.compute.Resources.COMPUTE_POLICY.
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
VmComputePoliciesInfo
of type application/json
Information about the compliance of the specified virtual machine with the specified compute policy.
{
"status": "UNKNOWN"
}
status
Required
The ObjectCompliance enumerated type defines the compliance states a policy can be in on a particular object.
UNKNOWN : The object has an unknown compliance state.
NOT_APPLICABLE : The object is in a state for which the policy does not apply.
COMPLIANT : The policy is in compliance on the object.
NOT_COMPLIANT : The policy is not in compliance on the object.
Possible values are: UNKNOWN , NOT_APPLICABLE , COMPLIANT , NOT_COMPLIANT
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if a virtual machine with the given identifier does not exist, or if a policy with the given identifier does not exist.
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-GetVmPolicyComputePolicies -Vm "MyVm" -Policy "MyPolicy"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/compute/policies/{policy}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.3.0
