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.
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"
}
]
}
]
}
Host Profile Operations
POST
Host Profile Associate Profile
POST
Host Profile Check Profile Compliance Task
POST
Host Profile Destroy Profile
POST
Host Profile Dissociate Profile
POST
Host Profile Execute Host Profile
POST
Host Profile Export Profile
GET
Host Profile Get Compliance Check Time
GET
Host Profile Get Compliance Status
GET
Host Profile Get Config
GET
Host Profile Get Created Time
GET
Host Profile Get Description
GET
Host Profile Get Entity
GET
Host Profile Get Modified Time
GET
Host Profile Get Name
GET
Host Profile Get Reference Host
GET
Host Profile Get Validation Failure Info
GET
Host Profile Get Validation State
GET
Host Profile Get Validation State Update Time
POST
Host Profile Host Profile Reset Validation State
POST
Host Profile Retrieve Description
POST
Host Profile Update Host Profile
POST
Host Profile Update Reference Host