Host Profile Manager Query Host Profile Metadata

Host Profile Manager Query Host Profile Metadata

Retrieve the metadata for a set of profiles.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostProfileManager/{moId}/QueryHostProfileMetadata
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 HostProfileManager/{moId}.

string
release
Required

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

Request Body
QueryHostProfileMetadataRequestType of type(s) application/json
Required 
{
    "profileName": [
        "string"
    ],
    "profile": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
array of string
profileName
Optional

Names of the profiles for which metadata is requested. If not set, the method returns metadata for all the profiles.

MoRefProfile
profile
Optional

Reference to an instance of the Profile managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

List of profile metadata objects.

Returns Array of ProfileMetadata of type(s) application/json 
[
    {
        "_typeName": "string",
        "key": "string",
        "profileTypeName": "string",
        "description": {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "messageCatalogKeyPrefix": "string",
            "messageArg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ]
        },
        "sortSpec": [
            {
                "_typeName": "string",
                "policyId": "string",
                "parameter": "string"
            }
        ],
        "profileCategory": "string",
        "profileComponent": "string",
        "operationMessages": [
            {
                "_typeName": "string",
                "operationName": "string",
                "message": {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            }
        ]
    }
]

On This Page
Host Profile Manager Operations
POST
Host Profile Manager Apply Entities Config Task
POST
Host Profile Manager Apply Host Config Task
POST
Host Profile Manager Check Answer File Status Task
POST
Host Profile Manager Composite Host Profile Task
POST
Host Profile Manager Create Default Profile
POST
Host Profile Manager Create Profile
POST
Host Profile Manager Export Answer File Task
POST
Host Profile Manager Find Associated Profile
POST
Host Profile Manager Generate Config Task List
POST
Host Profile Manager Generate Host Config Task Spec Task
POST
Host Profile Manager Generate Host Profile Task List Task
GET
Host Profile Manager Get Profile
POST
Host Profile Manager Query Answer File Status
POST
Host Profile Manager Query Host Profile Metadata
POST
Host Profile Manager Query Policy Metadata
POST
Host Profile Manager Query Profile Structure
POST
Host Profile Manager Retrieve Answer File
POST
Host Profile Manager Retrieve Answer File For Profile
POST
Host Profile Manager Retrieve Host Customizations
POST
Host Profile Manager Retrieve Host Customizations For Profile
POST
Host Profile Manager Update Answer File Task
POST
Host Profile Manager Update Host Customizations Task
POST
Host Profile Manager Validate Host Profile Composition Task