HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

/system/route_maps/{Route_Map.name}/route_map_entries/{Route_Map_Entry.preference}

Path Params
string
required

Reference Resource: Route_Map
Name of the routemap.

string
required

Reference Resource: Route_Map_Entry
Route map entries keyed by preference value.

Body Params
string
enum
required

There are three types, permit, deny, and any.

Allowed:
string

Reference Resource: Route_Map_Entry
If call command is used, nextrm indicate which route map to goto. This is optional.

dampening
object

Route flap dampening configuration parameters.

string
length ≤ 80

Free form description of the filter, this is optional.

string
enum

Rather than normal exiting, route map can continue on processing next route map, or goto N route map and continue on processing. This is optional.

Allowed:
string

Reference Resource: Route_Map_Entry
If exitpolicy is goto, nextpref is the route map to jump to. This is optional.

match
object

The match rule for route map. Default is deny.

string

Reference Resource: BGP_ASPath_Filter
Match routes based on AS path. This is optional.

match_community_list
object

Reference Resource: BGP_Community_Filter
Maps the community list that should be matched to whether it should be matched exactly or based on the presence of any community from the list.

match_extcommunity_list
object

Reference Resource: BGP_Community_Filter
Extended community list name to be matched.

match_interface
array of strings
length ≤ 9223372036854776000

Reference Resource: Port
Match the specified interface in the route's next hop.

match_interface
string

Reference Resource: Prefix_List
Match IPv4 next hop routes based on Prefix list. This is optional.

string

Reference Resource: Prefix_List
Match routes based on IPv4 prefix list. This is optional.

string

Reference Resource: Prefix_List
Match IPv4 source routes based on Prefix list. This is optional.

string

Reference Resource: Prefix_List
Match IPv6 next hop routes based on Prefix list. This is optional.

string

Reference Resource: Prefix_List
Match routes based on IPv6 prefix list. This is optional.

match_tag
array of integers
length ≤ 9223372036854776000

Match the specified tags in the route.

match_tag
integer
required

Reference Resource: Route_Map_Entry
Route map entries keyed by preference value.

int64
2 to 4294967295

Specifies the route-map entry's sequence number that will be executed next if the current entry's match clause is successful If the specified entry does not exist, route-map processing will be terminated at the current sequence number if its clause is matched. Note that the 'continue' sequence number must be higher than the current route-map sequence number for it to take effect. This is optional.

set
object

The set rule for route map.

set_community_list_delete
array of strings
length ≤ 9223372036854776000

Reference Resource: BGP_Community_Filter
Removes communities from the specified community list for BGP route advertisements.

set_community_list_delete
set_tag
array of integers
length ≤ 9223372036854776000

Set the specified tags in the route.

set_tag
Responses
204

No Content

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!