PbmComplianceResult

The PbmComplianceResult data object describes the results of profile compliance checking for a virtual machine or virtual disk.

This structure may be used only with operations rendered under /pbm.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "checkTime": "string",
    "entity": {
        "_typeName": "string",
        "objectType": "string",
        "key": "string",
        "serverUuid": "string"
    },
    "profile": {
        "_typeName": "string",
        "uniqueId": "string"
    },
    "complianceTaskStatus": "string",
    "complianceStatus": "string",
    "mismatch": false,
    "violatedPolicies": [
        {
            "_typeName": "string",
            "expectedValue": {
                "_typeName": "string",
                "id": {
                    "_typeName": "string",
                    "namespace": "string",
                    "id": "string"
                },
                "constraint": [
                    {
                        "_typeName": "string",
                        "propertyInstance": [
                            {
                                "_typeName": "string",
                                "id": "string",
                                "operator": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ]
                    }
                ]
            },
            "currentValue": {
                "_typeName": "string",
                "id": {
                    "_typeName": "string",
                    "namespace": "string",
                    "id": "string"
                },
                "constraint": [
                    {
                        "_typeName": "string",
                        "propertyInstance": [
                            {
                                "_typeName": "string",
                                "id": "string",
                                "operator": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ]
                    }
                ]
            }
        }
    ],
    "errorCause": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "operationalStatus": {
        "_typeName": "string",
        "healthy": false,
        "operationETA": "string",
        "operationProgress": 0,
        "transitional": false
    },
    "info": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    }
}

string As date-time As date-time

checkTime

Required

Time when the compliance was checked.

PbmServerObjectRef

entity

Required

The PbmServerObjectRef data object identifies a virtual machine, virtual disk attached to a virtual machine, a first class storage object or a datastore.

This structure may be used only with operations rendered under /pbm.

PbmProfileId

profile

Optional

Profile unique identifier.

This structure may be used only with operations rendered under /pbm.

string

complianceTaskStatus

Optional

Status of the current running compliance operation.

If there is no compliance check operation triggered, this indicates the last compliance task status. complianceTaskStatus is a string value that corresponds to one of the PbmComplianceResultComplianceTaskStatusEnum values.

string

complianceStatus

Required

Status of the compliance operation.

complianceStatus is a string value that corresponds to one of the PbmComplianceStatusEnum values.

When you perform compliance checking on an entity whose associated profile contains more than one subprofile ( PbmCapabilityProfile . PbmCapabilityProfile.constraints), a compliant result for any one of the subprofiles will produce a compliant result for the operation.

boolean

mismatch

Required

Deprecated as of vSphere 2016, use PbmComplianceStatusEnum to know if a mismatch has occurred. If PbmComplianceResult.complianceStatus value is outOfDate, mismatch has occurred.

Set to true if there is a profile version mismatch between the Storage Profile Server and the storage provider.

If you receive a result that indicates a mismatch, you must use the vSphere API to update the profile associated with the virtual machine or virtual disk.

array of PbmCompliancePolicyStatus

violatedPolicies

Optional

Values for capabilities that are known to be non-compliant with the specified constraints.

array of MethodFault

errorCause

Optional

This property is set if the compliance task fails with errors.

There can be more than one error since a policy containing multiple blobs can return multiple failures, one for each blob.

PbmComplianceOperationalStatus

operationalStatus

Optional