Pbm Compliance Manager Pbm Check Rollup Compliance
Checks rollup compliance of virtual machines and returns the results to your client.
For a specified virtual machine, a rollup compliance check verifies the storage requirements of the virtual machine and its virtual disks as compared with the storage provider capabilities.
The Server stores the compliance results for all of the storage entities associated with the virtual machines. You can call the PbmFetchRollupComplianceResult method to retrieve the stored results. However, for storage entities placed on vSAN, both fetchRollupComplianceResult and checkRollupCompliance methods have the same behaviour of recomputing the compliance.
Required privileges: StorageProfile.View
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 PbmComplianceManager/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
Show optional properties
{
"entity": [
{
"objectType": "string",
"key": "string"
}
]
}{
"entity": [
{
"_typeName": "string",
"objectType": "string",
"key": "string",
"serverUuid": "string"
}
]
}One or more references to virtual machines. A maximum of 1000 virtual machines can be specified in a call. The results of calling the checkRollupCompliance API with more than a 1000 entities is undefined.
Result of the rollup compliance check. The returned array contains one rollup compliance result for each virtual machine. A rollup compliance result object includes the overall compliance status that represents the collective compliance status for the virtual machine and its virtual disks.
[
{
"_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
}
]InvalidArgument: If one of the following situations occurs:
- You do not specify any entities.
- You specify only datastores or virtual disks.
- All of the specified virtual machines are invalid.
PbmFault: If there is an internal server error.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}