About this Resource
Defines Static Route Managed Object.Note
When a Logical Interface is configured to use dynamic addressing, all default routes (i.e. 0.0.0.0/0) will be removed in order to maintain consistency in the system.
REST API Methods for this Resource
Resource Schema
Configuration
| 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. |
Overview
Content Tools