Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/Host Operations
PUTHost OperationsSince 4.7.0SynchronousAuth Required

UpdateHostIpmi

UpdateHostIpmi

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    The resource UUID.

Body Fields

  • updatehostipmiObjectRequired

    updatehostipmi request body object.

    • ipmiAddressString

      Optional. The IPMI address.

    • ipmiUsernameString

      Optional. The IPMI user name.

    • ipmiPasswordString

      Optional. The IPMI password.

    • ipmiPortint

      Optional. The IPMI port.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns an empty JSON object {}.

Endpoint

PUT/zstack/v1/hosts/ipmi/{uuid}/actions

/zstack/v1/hosts/ipmi/{uuid}/actions

Operation ID

UpdateHostIpmi

Permalink

Request Example

curl -X PUT 'http://{host}/zstack/v1/hosts/ipmi/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"updatehostipmi":{"ipmiAddress":"<ipmiAddress>","ipmiUsername":"<ipmiUsername>","ipmiPassword":"<ipmiPassword>","ipmiPort":1},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "hostIpmiInventory": { "ipmiAddress": "192.168.0.1", "ipmiUsername": "admin", "ipmiPort": 623, "ipmiPassword": "password" } }

Change History

This API has no change history records yet.

View all change history