Host Profile Retrieve Description

Host Profile Retrieve Description

Returns the localizable description for the profile.

Required privileges: System.View

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

string
release
Required

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


Authentication
This operation uses the following authentication methods.
Responses
200

Profile divided into sections containing element descriptions and messages.

Returns ProfileDescription of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "section": [
        {
            "_typeName": "string",
            "description": {
                "_typeName": "string",
                "label": "string",
                "summary": "string",
                "key": "string",
                "messageCatalogKeyPrefix": "string",
                "messageArg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ]
            },
            "message": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    ]
}
section
Required

Sections which make up the profile description.