SOsodafoundation
Host

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

Changed on

Modify host details

Request

  • Base URL
    https://localhost:50040
  • Auth
    HTTP basic

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"
    }
  ]
}

Changes

  • fe6600fe7546Revision changes
    • warning

      changed the pattern of the request property from ^(([a-zA-Z0-9_-]|[a-zA-Z0-9_-][a-zA-Z0-9_-]*[a-zA-Z0-9_-]))*([A-Za-z0-9_-]|[A-Za-z0-9_-][A-Za-z0-9_-]*[A-Za-z0-9_-])$ to ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

  • 3ee778b81b92Revision changes
    • warning

      changed the pattern of the request property from ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$ to ^(([a-zA-Z0-9_-]|[a-zA-Z0-9_-][a-zA-Z0-9_-]*[a-zA-Z0-9_-]))*([A-Za-z0-9_-]|[A-Za-z0-9_-][A-Za-z0-9_-]*[A-Za-z0-9_-])$

    • info

      the request property became nullable