Profile Compliance Manager Check Compliance Task

Profile Compliance Manager Check Compliance Task

Check compliance of an entity against a Profile.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/ProfileComplianceManager/{moId}/CheckCompliance_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case ProfileComplianceManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
CheckComplianceRequestType of type(s) application/json
Required 
{
    "profile": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "entity": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ]
}
array of MoRefProfile
profile
Optional

If specified, check compliance against the specified profiles. If not specified, use the profiles associated with the entities. If both Profiles and Entities are specified, Check the compliance of each Entity against each of the profile specified.

For more information, look at the KMap below.

P represents if Profile is specified.

E represents if Entity is specified.

            P                        ^P
  ---------------------------------------------------
  | Check compliance      |  Profiles associated    |
 E|  of each entity       |   with the specified    |
  |  against each of the  |   entity will be used   |
  |  profiles specified.  |   for checking          |
  |                       |   compliance.           |
  |                       |                         |
  |                       |                         |
  ---------------------------------------------------
  | All entities          |   InvalidArgument       |
  |  associated with the  |   Exception is thrown.  |
  |  profile are checked. |                         |
^E|                       |                         |
  |                       |                         |
  |                       |                         |
  |                       |                         |
  ---------------------------------------------------
array of MoRefManagedEntity
entity
Optional

If specified, the compliance check is done against this entity.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

On This Page
Profile Compliance Manager Operations
POST
Profile Compliance Manager Check Compliance Task
POST
Profile Compliance Manager Clear Compliance Status
POST
Profile Compliance Manager Query Compliance Status
POST
Profile Compliance Manager Query Expression Metadata