Pbm Profile Profile Manager Pbm Query Associated Profiles

Returns profiles associated with the specified entities.

Required privileges: StorageProfile.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmProfileProfileManager/{moId}/PbmQueryAssociatedProfiles

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

string

release

Required

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

Request Body

PbmQueryAssociatedProfilesRequestType of type(s) application/json

Required

Show optional properties

{
    "entities": [
        {
            "objectType": "string",
            "key": "string"
        }
    ]
}

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

array of object

entities

Required

Array of server object references.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Array of query result objects. Each PbmQueryProfileResult object identifies a virtual machine, virtual disk, or datastore and it contains a list of the profiles associated with that entity. It also describes the fault, if there is an error associated with one of the profiles.

[
    {
        "_typeName": "string",
        "object": {
            "_typeName": "string",
            "objectType": "string",
            "key": "string",
            "serverUuid": "string"
        },
        "profileId": [
            {
                "_typeName": "string",
                "uniqueId": "string"
            }
        ],
        "fault": {
            "_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"
                }
            ]
        }
    }
]

array of object

Optional

The PbmQueryProfileResult data object identifies a virtual machine, virtual disk, or datastore and it lists the identifier(s) for the associated profile(s).

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

500

PbmFault: If there is an internal server error.

Returns PbmFault of type(s) application/json

This response body class contains all of the following: MethodFault

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"entities":["object"]}' https://{api_host}/sdk/vim25/{release}/pbm/PbmProfileProfileManager/{moId}/PbmQueryAssociatedProfiles

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Policy Operations