Host Firmware System Restore Firmware Configuration

Restore the configuration of the host to that specified in the bundle.

Upload the bundle to the URL returned by the QueryFirmwareConfigUploadURL method. The RestoreFirmwareConfiguration method will restore all configuration options, including the "admin" password, to the values in the bundle. The host will be rebooted immediately. The host must be in maintenance mode before this operation can be performed.

Required privileges: Host.Config.Firmware

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostFirmwareSystem/{moId}/RestoreFirmwareConfiguration

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

string

release

Required

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

Request Body

RestoreFirmwareConfigurationRequestType of type(s) application/json

Required

{
    "force": false
}

boolean

force

Required

Forces application of the configuration even if the bundle is mismatched.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidState: if the host is not in maintenance mode.

FileFault: if the file was not accessible.

MismatchedBundle: if the uuid / build number in the bundle does not match the uuid / build number of the host and parameter 'force' is set to false.

InvalidBundle: if the bundle does not have the expected contents.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Host Firmware System Operations

POST

Host Firmware System Backup Firmware Configuration