Profile Compliance Manager Query Compliance Status

Query the compliance status based on Profile and Entity filter.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ProfileComplianceManager/{moId}/QueryComplianceStatus

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

QueryComplianceStatusRequestType 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, compliance result for the specified profiles will be returned. This acts like a filtering criteria for the ComplianceResults based on specified profiles.

array of MoRefManagedEntity

entity

Optional

If specified, compliance results for these entities will be returned. This acts like a filtering criteria for the ComplianceResults based on entities.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

ComplianceResult. ComplianceResult information may not be available for all the entities. If the ComplianceResult is not available already, a new ComplianceCheck will not be triggered.

Returns Array of ComplianceResult of type(s) application/json

[
    {
        "_typeName": "string",
        "profile": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "complianceStatus": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "checkTime": "string",
        "failure": [
            {
                "_typeName": "string",
                "failureType": "string",
                "message": {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                },
                "expressionName": "string",
                "failureValues": [
                    {
                        "_typeName": "string",
                        "comparisonIdentifier": "string",
                        "profileInstance": "string",
                        "hostValue": {
                            "_typeName": "string"
                        },
                        "profileValue": {
                            "_typeName": "string"
                        }
                    }
                ]
            }
        ]
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Profile Compliance Manager Operations

POST

Profile Compliance Manager Check Compliance Task

POST