Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: PUT /rest/staticiproute/{identifier}

staticiproute - REST API Methods
Page Tree
rootResource - staticiproute

Creates a static IP Route given a specific ID and values.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/staticiproute/{identifier}

HTTP Method

PUT

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[staticiproute - REST API Methods|Resource - staticiproute]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description

...

  • 0 - ROUTE_ENTRY_DIRECT
  • 1 - ROUTE_ENTRY_INDIRECT

...

...

ipDestinationAddrYesYesstringnone

...

45 - Max Length Is the IP or IPv6 address of the destination host or subnet

...

. In dotted-decimal notation for IPv4, and colon-hex notation for IPv6.
Info

If this is an IPv4 route and the Destination IP Address field and Mask field are both set to 0.0.0.0, then the static route is called the IPv4 default static route.

Info

If this is an IPv6 route and the Destination IP Address field is set to :: and the prefix/mask is set to 0 then the static route is called the IPv6 default static route.

ipDestinationMaskYesYesstringnone23 - Max Length IPv4: 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.

IPv6: Is the network prefix length for the destination host or subnet (i.e. 0-128).
Info

If Destination IP Address field is set to :: and the prefix is 0, then the static route is called default static route.

ipGatewayTypeNoNoEnum0Possible values:
  • 0 - ROUTE_ENTRY_INDIRECT
  • 1 - ROUTE_ENTRY_DIRECT
 Specifies the route type (Global/Indirect or Link Local/Direct) for this IPv6 Static Route. Note: This option only applies to IPv6 static routes.
ipNexthopAddressYesYesstringnone

...

45 - Max LengthIs the IP or IPv6 address of the next-hop router

...

. In dotted-decimal notation for IPv4, and colon-hex notation for IPv6.
ifNameYesYesstringnone20 - Max LengthApplicable to IPv6 Link Local routes only. This specifies the interface to use.
ipLinkMonitorEnabledNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 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.
ipStaticRouteMetricYesYesint1Possible values:
  • 1 - Minimum
  • 255 - Maximum
 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
languagebash
curl --cookie PHPSESSID=fsqgefadjojefv6lmdtij6lh44 -s -k -i https://134.56.72.218/rest/staticiproute/1 -X PUT --data "ConfigIEState=1&ipNexthopAddress=134.56.72.5&ipDestinationAddr=0.0.0.0&ipStaticRouteType=1&ipDestinationMask=0.0.0.0&ifName=&ipLinkMonitorEnabled=0&ipStaticRouteMetric=1"

Response:

...

languagehtml/xml

...

ipAddressingModeNoNoEnum0Possible values:
  • 0 - IPV4_ADDR_MODE
  • 1 - IPV6_ADDR_MODE
  • 2 - IPV4_AND_IPV6
 Specifies the address mode for this Static Route. Note only IPv4 and IPv6 are valid.