Host Specification Manager Update Host Sub Specification

Update the host specification with the provided host sub specification.

If there is no host specification for the host, create the host specification, which contains only the provided host sub specification, for this host; otherwise, add or update the host specification with the provided HostSubSpecification object. This method provides a way to incrementally build the host specification. On success, it will fire a HostSpecificationChangedEvent.

Required privileges: Profile.Edit

Request

URI

POST

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

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

UpdateHostSubSpecificationRequestType of type(s) application/json

Required

Show optional properties

{
    "host": {},
    "hostSubSpec": {
        "name": "string",
        "createdTime": "string"
    }
}

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

MoRefHostSystem

host

Required

Reference to an instance of the HostSystem managed object.

HostSubSpecification

hostSubSpec

Required

Host sub specification data are the data used when create a virtual device, and/or configure the virtual device and its related host services.

A typical example of host sub specification data is the DVS host view specification, which is used when create DVS host view on an ESXi host and configure the virtual switch on the host. The introduction of this type of data is for improving the availability of the ESXi host management. For example, when the VirtualCenter server is not available, an ESXi host will have enough information to reconfigure DVS host view properly when the ESXi host is booted from stateless or stateless caching. Host sub specification data are data for VMware internal data structure used in virtual device creation and configuration. They are different to AnswerFile which are from public knowledge domain or the public API of VMware ESXi host services. When the host sub specification data for a single feature are stored in multiple host sub specification data objects, it is the responsibility of the host specification source in this feature to guarantee the completeness and consistency of these host sub specification objects.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

HostSpecificationOperationFailed: If the method fails.

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

204 Response Body