Rename a cluster node
Change the name of a cluster node.
Changing the cluster node name will trigger creation of a new self-signed SSL/TLS certificate for the HTTPS management server and (if present) for the embedded SMU. However, if the system has a custom certificate it will not be affected, but you may want to consider updating it to match the new domain name.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/nodes/{nodeId}
Parameters
Name | Type | Required | Values | Description |
nodeId | URI_PARAM | Y | string/number | Specifies either a node object ID or an HNAS storage cluster node ID. |
name | BODY | Y | string | New name for cluster node. |
Return codes
Code | Data | Description |
204 | No Data | Cluster node has been successfully renamed. |
400 | Error Message | Missing or invalid request contents. |
403 | Error Message | Operation forbidden by access level. |
404 | Error Message | Requested resource not found. |
500 | Error message | Error associated with the storage system. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Rename cluster node 1, to "dave"
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/nodes/1 -X PATCH -d '{"name":"dave"}'
Response example
HTTP/1.1 204 No Content