Pbm Placement Solver Pbm Check Compatibility With Spec

Pbm Placement Solver Pbm Check Compatibility With Spec

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

Performs placement compatibility checking based on a storage profile specification.

If compatibility checking for a hub does not produce any errors, the hub is considered a viable candidate for virtual machine file storage.

Required privileges: StorageProfile.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/pbm/PbmPlacementSolver/{moId}/PbmCheckCompatibilityWithSpec
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
PbmCheckCompatibilityWithSpecRequestType of type(s) application/json
Required

Show optional properties

{
    "profileSpec": {
        "name": "string",
        "resourceType": {
            "resourceType": "string"
        },
        "constraints": {}
    }
}
{
    "hubsToSearch": [
        {
            "_typeName": "string",
            "hubType": "string",
            "hubId": "string"
        }
    ],
    "profileSpec": {
        "_typeName": "string",
        "name": "string",
        "description": "string",
        "category": "string",
        "resourceType": {
            "_typeName": "string",
            "resourceType": "string"
        },
        "constraints": {
            "_typeName": "string"
        }
    }
}
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.

profileSpec
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.
Responses
200

Array of compatibility result objects. The results array contains one entry for each entry in the hubsToSearch list. If a hubs list is not specified, the results array contains one entry for each datastore and storage pod in your vSphere environment. Any errors are described in the results array.

  • If there is an invalid argument error, the compatibility results will contain InvalidArgument faults indicating that the profile does not exist or that it does not match the requirement type.
  • If there are errors or warnings during compatibility checking, the compatibility results will contain faults derived from PbmCompatibilityCheckFault.
Returns Array of PbmPlacementCompatibilityResult of type(s) application/json
[
    {
        "_typeName": "string",
        "hub": {
            "_typeName": "string",
            "hubType": "string",
            "hubId": "string"
        },
        "matchingResources": [
            {
                "_typeName": "string"
            }
        ],
        "howMany": 0,
        "utilization": [
            {
                "_typeName": "string",
                "name": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "messageCatalogKeyPrefix": "string",
                    "messageArg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ]
                },
                "description": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "messageCatalogKeyPrefix": "string",
                    "messageArg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ]
                },
                "availableBefore": 0,
                "availableAfter": 0,
                "total": 0
            }
        ],
        "warning": [
            {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        ],
        "error": [
            {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        ]
    }
]