PbmRollupComplianceResult

PbmRollupComplianceResult
PbmRollupComplianceResult

The PbmRollupComplianceResult data object identifies the virtual machine for which rollup compliance was checked, and it contains the overall status and a list of compliance result objects.

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

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "oldestCheckTime": "string",
    "entity": {
        "_typeName": "string",
        "objectType": "string",
        "key": "string",
        "serverUuid": "string"
    },
    "overallComplianceStatus": "string",
    "overallComplianceTaskStatus": "string",
    "result": [
        {
            "_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"
                        }
                    }
                ]
            }
        }
    ],
    "errorCause": [
        {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ],
    "profileMismatch": false
}
string As date-time As date-time
oldestCheckTime
Required

Indicates the earliest time that compliance was checked for any of the entities in the rollup compliance check.

The compliance check time for a single entity is represented in the PbmComplianceResult.PbmComplianceResult.checkTime property. If the PbmComplianceResult.checkTime property is unset for any of the objects in the results array, the oldestCheckTime property will be unset.

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.

string
overallComplianceStatus
Required

Overall compliance status of the virtual machine and its virtual disks.

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

The overall compliance status is determined by the following rules, applied in the order listed:

  • If all the entities are compliant, the overall status is compliant.
  • Else if any entity's status is outOfDate, the overall status is outOfDate.
  • Else if any entity's status is nonCompliant, the overall status is nonCompliant.
  • Else if any entity's status is unknown, the overall status is unknown.
  • Else if any entity's status is notApplicable, the overall status is notApplicable.
string
overallComplianceTaskStatus
Optional

Overall compliance task status of the virtual machine and its virtual disks.

overallComplianceTaskStatus is a string value that corresponds to one of the PbmComplianceResult. PbmComplianceResult.complianceTaskStatus values.

array of PbmComplianceResult
result
Optional

Individual compliance results that make up the rollup.

array of MethodFault
errorCause
Optional

This property is set if the overall compliance task fails with some error.

This property indicates the causes of error. If there are multiple failures, it stores these failure in this array.

boolean
profileMismatch
Required

Deprecated as of vSphere 2016, use PbmRollupComplianceResult.overallComplianceStatus to know if profile mismatch has occurred. If overallComplianceStatus value is outOfDate, it means profileMismatch has occurred.

True if and only if PbmComplianceResult.

PbmComplianceResult.mismatch is true for at least one entity in the rollup compliance check.

Property Of
Returned By