Adds an IP address to a virtual server.
HTTP request syntax (URI)
POST <base_URI>/v7/storage/virtual-servers/{id}/ip-addresses
Parameters
| Name | Type | Required | Values | Description |
|---|---|---|---|---|
| id | URI_PARAM | Y | string/number | Specifies either the virtual server object ID or the HNAS storage virtual server ID. |
| ipAddress | BODY | Y | string | New IPv4 or IPv6 address. |
| port | BODY | Y | string | Name of the port. |
| mask | BODY | Y | string | Netmask must be of the form x.x.x.x for an IPv4 address or specify a prefix length for an IPv6 address. |
Return codes
| Code | Data | Description |
|---|---|---|
| 204 | No Data | New IP address successfully added. |
| 400 | No Data | Missing or invalid request contents. |
| 404 | Error Message | Requested resource not found. |
| 500 | Error message | Error associated with the storage system. |
| 501 | No Data | Server has not implemented the request operation on the resource. |
Any HTTP status code other than 204 indicates that the API did not complete successfully.
Request example: Using the virtual server object ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/virtual-servers/333a3a3a4f49445f24232140255f56/ip-addresses -X POST -d '{ "ipAddress":"203.2.43.2", "port":"ag1", "mask": "255.255.255.0"}'
Response example: Using the virtual server object ID
HTTP/1.1 204 No Content
Request example: Using the HNAS storage virtual server ID
curl -vk -H "X-Api-Key: zrxvSDAv9x.RIP4gkmKarG3beF.or.4Tc2im7oeqYN88C9XPGHxbXC" https://172.17.11.11:8444/v7/storage/virtual-servers/15/ip-addresses -X POST -d '{ "ipAddress":"203.2.43.2", "port":"ag1", "mask": "255.255.255.0"}'
Response example: Using the HNAS storage virtual server ID
HTTP/1.1 204 No Content