Page History
REST API Method: PUT /rest/staticiproute/{identifier}
| Page Tree | ||
|---|---|---|
|
Creates a static IP Route given a specific ID and values.
URL:
https://134.56.227.163/rest/staticiproute/{identifier}
HTTP Method
PUT
Requires Authentication:
true
Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| ipStaticRouteType | No | No | Enum | 1 | Possible values:
| Specifies the route type. Only indirect route types are currently supported. |
| ifName | Yes | Yes | string | none | 20 - Max Length | Deprecated. Is the interface name for this static route. |
| ipDestinationAddr | Yes | Yes | string | none | 23 - Max Length | Is the IP address of the destination host or subnet, in dotted notation. {info}If Destination IP Address field and Mask field are both set to 0.0.0.0, then the static route is called default static route. |
| ipDestinationMask | Yes | Yes | string | none | 23 - Max Length | Is the network mask of the destination host or subnet, in dotted notation. {info}If Destination IP Address field and Mask field are both set to 0.0.0.0, then the static route is called default static route. |
| ipNexthopAddress | Yes | Yes | string | none | 23 - Max Length | Is the IP address of the next-hop router, in dotted notation. |
| ipLinkMonitorEnabled | No | No | Enum | 0 | Possible values:
| Specifies if this next-hop router is monitored by the link monitor. This field is automatically enabled when the link monitor selects this next-hop router as the gateway for monitoring. |
| ipStaticRouteMetric | Yes | Yes | int | 1 | Possible values:
| Is the routing cost of this route and hence indirectly specifies the preference of the route. Lower values indicate more preferred routes. Typical value is 1 for most static routes indicating that static routes are preferred to dynamic routes. |
Usage Example: (about cURL | requires a session token)
| Code Block | ||
|---|---|---|
| ||
curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44cuc2h83fqaispmu6m519sa5642 -s -k -i https://134.56.72.218/rest/staticiproute/1 -X PUT --data "ConfigIEState=1&ipNexthopAddress=134192.56168.725.5&ipDestinationAddr=0.0.0.0&ipStaticRouteType=12&ipDestinationMask=0.0.0.0&ifName=&ipLinkMonitorEnabled=0&ipStaticRouteMetric=1" |
Response:
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0"?> <root> <status> <http_code>500<code>200</http_code> </status> <app_status<staticiproute id="1" href="https://134.56.72.218/rest/staticiproute/1"> <app_status_entry code="12002" params="Route to 134.56.72.5, already exists"/> </app_status> </status> <ifName></ifName> <ipDestinationAddr>0.0.0.0</ipDestinationAddr> <ipDestinationMask>0.0.0.0</ipDestinationMask> <ipLinkMonitorEnabled>0</ipLinkMonitorEnabled> <ipNexthopAddress>192.168.5.5</ipNexthopAddress> <ipStaticRouteMetric>1</ipStaticRouteMetric> <ipStaticRouteType>2</ipStaticRouteType> </staticiproute> </root> |
Overview
Content Tools