Create a network route

NAS File Storage REST API v7 Reference

Version

14.7.x

14.6.x

Audience

anonymous

Part Number

MK-92HNAS088-05

Creates a network route.

HTTP request syntax (URI)

POST <base_URI>/v7/storage/file-devices/network-routes

Parameters

Name	Type	Required	Values	Description
destination	string	Y	string	Destination IP address.
gateway	string	Y	string	Gateway IP address.
type	string	Y	string	Route type. Valid values are: ROUTE_TYPE_HOST ROUTE_TYPE_NETWORK ROUTE_TYPE_GATEWAY Note: For more details, see https://knowledge.hitachivantara.com/Documents/Storage/NAS_Platform.
mask	string	Y	string	IP address mask. Valid values are: ROUTE_MASK_24 ROUTE_MASK_25 ROUTE_MASK_26 ROUTE_MASK_27 ROUTE_MASK_28 ROUTE_MASK_29 ROUTE_MASK_30 ROUTE_MASK_31 ROUTE_MASK_32 Note: For more details, see https://knowledge.hitachivantara.com/Documents/Storage/NAS_Platform.

Return codes

Code	Data	Description
201	route	Route object successfully created.
400	No Data	Missing or invalid request contents.
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 201 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/v7/storage/file-devices/network-routes -d '{ "destination":"1.2.3.4", "mask":"ROUTE_MASK_30",
"type":"ROUTE_TYPE_HOST", "gateway":"1.2.3.4"}' -X POST

Response example

HTTP/1.1 201 Created
{
   "route" : {
      "MTU" : 0,
      "destination" : "1.2.3.4/32",
      "flags" : 68,
      "gateway" : "1.2.3.4",
      "isClusterNodeRoute" : false,
      "isStaticRoute" : true,
      "nodeId" : 0,
      "objectId" : "486f73743a3a3a312e322e332e343a3a3a312e322e332e342f3332",
      "type" : "Host"
   },
   "uri" : "https://172.17.58.117:8444/v7/storage/file-devices/network-routes/486f73743a3a3a312e322e332e343a3a3a312e322e332e342f3332"
}