/system/vrfs/{VRF.name}/static_routes/{Static_Route.prefix}/static_nexthops

post

https://switch-ip/rest/v10.16/system/vrfs/{VRF.name}/static_routes/{Static_Route.prefix}/static_nexthops

Path Params

VRF.name

string

required

Reference Resource: VRF
VRF identifier. Should be alphanumeric. VRF names must be unique.

Static_Route.prefix

string

required

Reference Resource: Static_Route
IPv4 or IPv6 destination prefix and mask in the address/mask format. Example 192.168.0.0/16

Body Params

bfd_enable

boolean

Enables BFD session to the specific next hop.

distance

integer

1 to 255

Administrative distance to be used instead of the default.

integer

required

Reference Resource: Static_Nexthop
Nexthops of the static route indexed by an unique identifier. Should be empty in case of Nullroute or Reject.

ip_address

string

length ≤ 49

IP address of the nexthop device.

ipsla_track_object

string

Reference Resource: Ipsla_Track_Object
Object monitor associated with the static route. When object monitor status is down, the route associated with this nexthop will be brought down. Similarly when the object monitor status is up, the route associated with this nexthop will be brought up.

port

string

Reference Resource: Port
Egress port, if specified.

tag

int64

1 to 4294967295

Route tag to be used to filter routes and apply administrative policies, such as redistribution with route maps.

type

string

enum

Nexthop corresponding to the static route is 'forward', 'nullroute' or 'reject'. forward - Packets to destinations that match this route will be forwarded based on the nexthop entry. reject - Packets to destinations that match this route will be discarded and corresponding ICMP unreachable messages sent to the sender. nullroute - Packets to destinations that match this route will be silently discarded.

Allowed:

use_forwarding_address

boolean

Set the nexthop address as the static route forwarding address. This nexthop address is used as forwarding address by OSPF to shorten route paths.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Response

Click Try It! to start a request and see the response here!