Pbm Profile Profile Manager Pbm Fetch Capability Metadata

Retrieves capability metadata.

Each capability metadata object has a unique identifier (PbmCapabilityMetadata.id). The identifier object (PbmCapabilityMetadataUniqueId) contains the unique ID and it identifies the namespace to which the capability metadata object belongs.

Each registered namespace is required to be globally unique. You can associate a capability metadata object with a unique vendor and resource type by using the namespace and the PbmCapabilityVendorResourceTypeInfo data returned by the PbmFetchVendorInfo method.

Required privileges: StorageProfile.View

Request

URI

POST

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

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 8.0.3.0 APIs.

Request Body

PbmFetchCapabilityMetadataRequestType of type(s) application/json

Required

{
    "resourceType": {
        "_typeName": "string",
        "resourceType": "string"
    },
    "vendorUuid": "string"
}

PbmProfileResourceType

resourceType

Optional

The PbmProfileResourceType data object defines the vSphere resource type that is supported for profile management.

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

string

vendorUuid

Optional

Unique identifier for the vendor/owner of capability metadata. The specified vendor ID must match PbmCapabilitySchemaVendorInfo.PbmCapabilitySchemaVendorInfo.vendorUuid. If omitted, the Server searchs all capability metadata registered with the system. If a vendorUuid unknown to the Server is specified, empty results will be returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Array of capability metadata objects, classified by category (PbmCapabilityMetadataPerCategory.subCategory).

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

[
    {
        "_typeName": "string",
        "subCategory": "string",
        "capabilityMetadata": [
            {
                "_typeName": "string",
                "id": {
                    "_typeName": "string",
                    "namespace": "string",
                    "id": "string"
                },
                "summary": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string",
                    "key": "string",
                    "messageCatalogKeyPrefix": "string",
                    "messageArg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ]
                },
                "mandatory": false,
                "hint": false,
                "keyId": "string",
                "allowMultipleConstraints": false,
                "propertyMetadata": [
                    {
                        "_typeName": "string",
                        "id": "string",
                        "summary": {
                            "_typeName": "string",
                            "label": "string",
                            "summary": "string",
                            "key": "string",
                            "messageCatalogKeyPrefix": "string",
                            "messageArg": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "value": {
                                        "_typeName": "string"
                                    }
                                }
                            ]
                        },
                        "mandatory": false,
                        "type": {
                            "_typeName": "string",
                            "typeName": "string"
                        },
                        "defaultValue": {
                            "_typeName": "string"
                        },
                        "allowedValue": {
                            "_typeName": "string"
                        },
                        "requirementsTypeHint": "string"
                    }
                ]
            }
        ]
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Storage Policy Operations