Host Specification Manager Retrieve Host Specification

Retrieve the host specification.

When the parameter fromHost is true, the host specification is retrieved from the host; otherwise, it is from the host specification "database" for this manager. When retrieved from host, the copy in host specification "database" will be updated. On success, it will fire a HostSpecificationChangedEvent.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSpecificationManager/{moId}/RetrieveHostSpecification

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 HostSpecificationManager/{moId}.

string

release

Required

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

Request Body

RetrieveHostSpecificationRequestType of type(s) application/json

Required

Show optional properties

{
    "host": {},
    "fromHost": false
}

{
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "fromHost": false
}

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

boolean

fromHost

Required

Whether retrieve from the host.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The host specification of the specified host.

Returns HostSpecification of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "createdTime": "string",
    "lastModified": "string",
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "subSpecs": [
        {
            "_typeName": "string",
            "name": "string",
            "createdTime": "string",
            "data": [
                0
            ],
            "binaryData": "string"
        }
    ],
    "changeID": "string"
}

string As date-time As date-time

createdTime

Required

Time at which the host specification was created.

string As date-time As date-time

lastModified

Optional

Time at which the host specification was last modified.

If it isn't set, it is the same as createdTime.

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

array of HostSubSpecification

subSpecs

Optional

The collection of the host sub specifications.

It is optional.

string

changeID

Optional

The change ID for querying the host specification data updated in a time period.

It has a format of timestamp:change_number, where timestamp is the decimal string of a start time, and change_number is the decimal string of an auto incremented variable counting from the start time.

500

HostSpecificationOperationFailed: If the method fails when retrieve from host.

Returns HostSpecificationOperationFailed of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body