ip/route

Configures, retrieves, and modifies static route to the IP routing table.

Resource URIs


URI	Description
<base_URI>/config/running/ip/route	Configures static route to the IP routing table.


GET URIs	Description
<base_URI>/config/running/ip/route	Retrieves static route to the IP routing table.


POST URIs	Payload	Description
<base_URI>/config/running/ip/route	<static-route-nh><static-route-dest>{ip-address}</static-route-dest><static-route-next-hop>{ip-address}</static-route-next-hop></static-route-nh></static-route-nh>	Specifies the destination IPv4 address and mask in the format A.B.C.D/L (where "L" is the prefix length of the mask)
<base_URI>/config/running/ip/route	<static-route-oif><static-route-dest>{ip-address}</static-route-dest><static-route-oif-type>{enumeration}</static-route-oif-type><InterfaceNumber>{string}</InterfaceNumber></static-route-oif>	Specifies the destination IPv4 address for egress interface.


PUT URIs	Payload	Description
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}/metric	<metric>{unit32}</metric>	Configures the cost metric of the route. Valid values range from 1 through 16.
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}/distance	<distance>{unit32}</distance>	Configures the administrative distance of the route. When comparing otherwise equal routes to a destination, a Extreme device prefers lower administrative distances over higher ones.
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}/tag	<tag>{unit32}</tag>	Configures the tag value of the route to use for route filtering with a route map.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}/metric	<metric>{unit32}</metric>	Configures the cost metric of the route for egress interface. Valid values range from 1 through 16.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}/distance	<distance>{unit32}</distance>	Configures the administrative distance of the route for egress interface. When comparing otherwise equal routes to a destination, a Extreme device prefers lower administrative distances over higher ones.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}/tag	<tag>{unit32}</tag>	Configures the tag value of the route to use for route filtering with a route map for egress interface.


PATCH URIs	Payload	Description
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}	<base_URI><static-route-nh><metric>{uint32}</metric></static-route-nh>	Configures the cost metric of the route.
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}	base_URI><static-route-nh><distance>{uint32}</distance></static-route-nh>	Configures the administrative distance of the route.
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}	<base_URI><static-route-nh><tag>{uint32}</tag></static-route-nh>	Configures the tag value of the route to use for route filtering with a route map.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}	<base_URI><static-route-oif><metric>{uint32}</metric></static-route-oif>	Configures the cost metric of the route for egress interface.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}	<base_URI><static-route-oif><distance>{uint32}</distance></static-route-oif>	Configures the administrative distance of the route for egress interface.
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}	<base_URI><static-route-oif><tag>{uint32}</tag></static-route-oif>	Configures the tag value of the route to use for route filtering with a route map for egress interface.


DELETE URIs
<base_URI>/config/running/ip/route/static-route-nh/{static-route-dest},{static-route-next-hop}
<base_URI>/config/running/ip/route/static-route-oif/{static-route-dest},{static-route-oif-type},{InterfaceNumber}
<base_URI>/config/running/ip/router-id

Parameters

distance: Specifies the administrative distance of the route. When comparing otherwise equal routes to a destination, a Extreme device prefers lower administrative distances over higher ones. Valid values range from 1 through 254. The default is 1.
metric: Specifies the cost metric of the route. Valid values range from 1 through 16. The default is 1.
tag: Specifies the tag value of the route to use for route filtering with a route map. Valid values range from 0 through 4294967295. The default is 0.
static-route-dest: Specifies the destination IPv4 address and mask in the format A.B.C.D/L (where "L" is the prefix length of the mask).
static-route-next-hop: Specifies the IPv4 address of the next hop.
static-route-oif-type: The egress interface type.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/ip/route

None

<route xmlns="urn:Extreme.com:mgmt:Extreme-rtm" y:self="/rest/config/running/ip/route">
  </route>

URI

The following example uses the POST option to configure static route to the IP routing table.

http://host:80/rest/config/running/config/running/ip/route

<static-route-nh><static-route-dest>13.1.1.0/24</static-route-dest><static-route-next-hop>11.1.1.2</static-route-next-hop>
</static-route-nh>

None

URI

The following example uses the DELETE option to remove static route to the IP routing table.

http://host:80/rest/config/running/ip/route/static-route-nh/%2216.1.1.0/24%22%2C14.1.1.2

None