Naming a Node

A node can be named, by means of the REST API.

HTTP Method and URI

POST /node/controller/rename

Description

Names and, if required, renames an individual node. This API is therefore used as part of the node-provisioning process, and can also be used or reused subsequent to all other aspects of node-provisioning, including specification of username and password for the Full Administrator. However, the API can only be used while the node constitutes a single-node cluster: once the node has become part of a multi-node cluster, the API can no longer be used.

Curl Syntax

curl -X POST -u <username>:<password> \
  http://<ip-address-or-domain-name>:8091/node/controller/rename \
  -d hostname=<name>

The username and password need only be specified if credentials have been configured for the administrator, as described in Establishing Credentials.

The name argument must be one of the following:

The IP address of the underlying host (either IPv4 or IPv6).
A fully qualified hostname that corresponds, in the appropriate network maps, to the IP address of the underlying host.
The loopback address, 127.0.0.1.

Responses

Success returns 200 OK. Failure to specify the name argument correctly returns 400 Bad Request, and a message such as the following: ["Could not listen on address \"10.144.220.107\": eaddrnotavail"]. If a username and password have already been assigned, failure to authenticate returns 401 Unauthorized. An incorrectly expressed URI or flag returns 404 Object Not Found.

Example

The following example specifies the IP of the underlying host as the name of the node.

curl -X POST -u Administrator:password \
http://10.144.220.101:8091/node/controller/rename \
-d hostname='10.144.220.101'