Pbm Placement Solver Pbm Query Matching Hub With Spec

Deprecated as of vSphere 2016, use PbmCheckRequirements instead in order to retrieve both compatible compute and storage location.

Finds matching placement hubs based on a profile creation specification.

This method returns only those hubs that match the specification.

Required privileges: StorageProfile.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmPlacementSolver/{moId}/PbmQueryMatchingHubWithSpec

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

string

release

Required

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

Request Body

PbmQueryMatchingHubWithSpecRequestType of type(s) application/json

Required

Show optional properties

{
    "createSpec": {
        "name": "string",
        "resourceType": {
            "resourceType": "string"
        },
        "constraints": {}
    }
}

{
    "hubsToSearch": [
        {
            "_typeName": "string",
            "hubType": "string",
            "hubId": "string"
        }
    ],
    "createSpec": {
        "_typeName": "string",
        "name": "string",
        "description": "string",
        "category": "string",
        "resourceType": {
            "_typeName": "string",
            "resourceType": "string"
        },
        "constraints": {
            "_typeName": "string"
        }
    }
}

array of PbmPlacementHub

hubsToSearch

Optional

Candidate list of hubs, either datastores or storage pods or a mix. If this parameter is not specified, the Server uses all of the datastores and storage pods for placement compatibility checking.

PbmCapabilityProfileCreateSpec

createSpec

Required

The PbmCapabilityProfileCreateSpec describes storage requirements.

Use this data object to create a PbmCapabilityProfile.

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

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Subset of the hubsToSearch list that satisfies the profile requirements. A storage pod is returned if and only if all its member datastores satisfy the profile requirements, whether the hubs list contains any of the member datastores or not. If a datastore and its storage pod are in the hubs list, and both satisfy the requirements, both are returned.

Returns Array of PbmPlacementHub of type(s) application/json

[
    {
        "_typeName": "string",
        "hubType": "string",
        "hubId": "string"
    }
]

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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Storage Policy Operations

POST

Pbm Placement Solver Pbm Check Compatibility