Set a node IP address
Sets an IP address on a node. Node addresses are used for management or clustering and not file serving. Unlike virtual server IP addresses, a system can only have one management address on each port.
HTTP request syntax (URI)
PATCH <base_URI>/v8/storage/nodes/{nodeId}/ip-addresses
Parameters
Name | Type | Required | Values | Description |
nodeId | URI_PARAM | Y | string/number | Specifies either the node object ID or the HNAS storage cluster node ID. |
ipAddress | BODY | Y | string | New IPv4 address. |
port | BODY | Y | string | Name of management port to associate the IP address with. Supported values are eth0 or eth1 |
netmask | BODY | Y | string | Netmask can be of the form x.x.x.x for an IPv4 address or specify a prefix length. |
Return codes
Code | Data | Description |
204 | No Data | New IP address successfully added. |
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
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v8/storage/nodes/1/ip-addresses -X PATCH -d '{"ipAddress":"203.2.43.2", "port":"eth0", "netmask": "255.255.255.0"}'
Response example
HTTP/1.1 204 No Content