Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-176940115.5 KB
Host

Modify host details

put/v1beta/{tenantId}/host/hosts/{hostId}

Request body

hostNamestring

Only numbers, letters, '-', '.' in ASCII characters are allowed.

ipstring

IP address of the host, mandatory

portinteger

Host access port

accessMode'agent' | 'agentless'

The way to access host, system will access host to get more information and install agent if accessMode is 'agent'. 'port', 'username'and 'password' are requried in 'agent' mode.

usernamestring

username to access Host

passwordstring

password to access Host

availabilityZonesstring[] nullable

Example request

{
  "hostName": "opensds-node1",
  "ip": "8.8.8.8",
  "port": 22,
  "username": "root",
  "password": "password",
  "initiators": [
    {
      "portName": "20000024ff5bb888",
      "protocol": "iscsi"
    }
  ]
}

Response

OK

idstring
createdAtstring date-time
updatedAtstring date-time
tenantIdstring
hostNamestring
osTypestring
accessModestring
ipstring
portstring
usernamestring
availabilityZonesstring[]

Example response

{
  "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
  "createdAt": "2017-07-10T14:36:58.014Z",
  "updatedAt": "2017-07-10T14:36:58.014Z",
  "initiators": [
    {
      "portName": "20000024ff5bb888",
      "protocol": "iscsi"
    }
  ]
}