Pbm Compliance Manager Pbm Query By Rollup Compliance Status

Returns the virtual machines for the given rollup compliance status.

Required privileges: StorageProfile.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmComplianceManager/{moId}/PbmQueryByRollupComplianceStatus

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 PbmComplianceManager/{moId}.

string

release

Required

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

Request Body

PbmQueryByRollupComplianceStatusRequestType of type(s) application/json

Required

{
    "status": "string"
}

string

status

Required

PbmComplianceStatusEnum

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Array of VirtualMachine entities

[
    {
        "_typeName": "string",
        "objectType": "string",
        "key": "string",
        "serverUuid": "string"
    }
]

array of object

Optional

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.

500

InvalidArgument: If the given status parameter is invalid or incorrect format.

PbmFault: If there is an internal service error.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_typeName": "string",
    "faultCause": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"status":"string"}' https://{api_host}/sdk/vim25/{release}/pbm/PbmComplianceManager/{moId}/PbmQueryByRollupComplianceStatus

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Policy Operations

POST

Pbm Compliance Manager Pbm Check Compliance