Get Route Map (v2.3)
GET/sdwan/v2.3/api/sites/:site_id/elements/:element_id/routing_routemaps/:config_id
Get a specific route map.
Request
Path Parameters
The ID of the site.
The ID of the element.
The BGP peer config ID.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The value true or false for auto-generated route map for an element.
The description of the route map. Max size = 1024.
The ID of the route map.
The name of the route map. Max size = 128.
route_map_entries RoutingRouteMapEntryV2N3[]
The details of the route map entries.
To continue to use the rule that the route matches.
match RoutingRouteMapEntryMatchClause
The details of route match.
As Path Id
Community List Id
Ip Next Hop Id
Ip Prefix List Id
Metric
Tag
Enter an order number from 1 to 65535 to define the order in which this route map will be used.
It allow routes to be advertised or Deny to block the routes from being advertised.
set RoutingRouteMapEntrySetClause
The details of the route map set.
Additive Community
As Path Prepend
Community
Ip Next Hop
Ip V6 Next Hop
Local Preference
Metric
Tag
Possible values: [type-1
, type-2
]
Type
Weight
A information field that can be added to identify the route map. Maximum 10 unique tags of length 1024 each are allowed.
Possible values: [bgp
, ospf
]
Routing used for BGP or OSPF.
{
"auto_generated": true,
"id": "string",
"name": "string",
"route_map_entries": [
{
"continue_entry": "string",
"match": {
"as_path_id": "string",
"community_list_id": "string",
"ip_next_hop_id": "string",
"ip_prefix_list_id": "string",
"metric": 0,
"tag": 0
},
"order": 0,
"permit": true,
"set": {
"additive_community": true,
"as_path_prepend": "string",
"community": "string",
"ip_next_hop": "string",
"ip_v6_next_hop": "string",
"local_preference": 0,
"metric": 0,
"tag": 0,
"type": "type-1",
"weight": 0
}
}
],
"tags": [
"string"
],
"used_for": "bgp"
}