put_hostname

(PUT)/hostname/?sid={sid}

Description

Updates the hostname for the specified system. This API also handles any changes to ensure that the changes are made throughout the system, from the network configuration files to the "system client" (a client used by the appliance) and the "system name".

The user must specify a system id for updating the hostname, and checks done to ensure that the hostname of a replicating system or a replication target is prohibited.

Request

Syntax

PUT /api/hostname/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

"sid={sid}" as part of the URL to specify the system id, is required to select the system on which the hostname is being changed.

Name	Description	Type	Required
name	hostname of the system, maximum of 63 characters	string	required

• | hostnames can be a combination of upper- and lower-case characters, numbers, and a dash (-) | long_name | fully-qualified hostname | string | optional
• | The maximum name may be 255 characters with unlimited '.' qualifiers | keep_alias | keep an alias to the current hostname | boolean | optional
• | default is not to keep an alias (false) |

Response

HTTP 200 (OK)

Parameters

Examples

Sample Request

PUT /api/hostname/?sid=1
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

data passed in:

{
    "name":  "myUEB",
    "long_name": "myUEB.acme.local.us"
}

Sample Response

HTTP Status: 200 (OK)

Failed hostname update will return HTTP Status 500 with a result object with an error message and KB link as defined here