Route Map

9 min

\urls summary\ url get post patch put delete /rest/v1/running/route maps/{name}/{sequence id} y y y n y /rest/v1/rpc/show route map json n y n n n \examples\ \create a route map \ post https //{switch ip}/rest/v1/running/route maps { "name" "test", "sequence id" 11, "action" "deny", "description" "test" } \modify a route map \ patch rest/v1/running/route maps/test/11 { "description" "test ipv4 route map", "match condition" { "ipv4 prefix list" "test", "metric" 100, "peer local" "true" }, "set action" { "ipv4 next hop address" "10 0 0 1", "set metric" 2300 } } \show route map summary\ post https //{switch ip}/rest/v1/rpc/show route map json response \properties descriptions\ \route maps\ tree diagrams + rw route maps + rw route map \[name sequence id] + rw name + rw sequence id + rw description? + rw action + rw match condition \| + rw as path? \| + rw alias? \| + rw community? \| + rw extended community? \| + rw large community? \| + rw local preference? \| + rw origin? \| + rw default route? \| + rw route distinguisher? \| + rw route type? \| + rw vni? \| + rw interface? \| + rw ipv4 prefix list? \| + rw ipv4 prefix len? \| + rw ipv4 next hop address? \| + rw ipv4 next hop prefix list? \| + rw ipv4 next hop type? \| + rw ipv4 next hop prefix len? \| + rw ipv4 route source prefix list? \| + rw ipv6 prefix list? \| + rw ipv6 prefix len? \| + rw ipv6 next hop address? \| + rw ipv6 next hop prefix list? \| + rw ipv6 next hop type? \| + rw (peer value)? \| | + (peer ipv4 address) \| | | + rw peer ipv4 address? \| | + (peer ipv6 address) \| | | + rw peer ipv6 address? \| | + (peer interface) \| | | + rw peer interface? \| | + (peer local) \| | + rw peer local? \| + rw metric? \| + rw probability? \| + rw tag? + rw set action + rw aggregator as number + rw aggregator ip address + rw exclude as + rw (prepend)? \| + (prepend as) \| | + rw prepend as \| + (prepend last as) \| + rw prepend last as? + rw atomic aggregate? + rw community + rw delete community list? + rw distance? + rw local preference? + rw origin? + rw originator id? + rw sr te color? + rw weight? + rw ipv4 gateway? + rw ipv6 gateway? + rw (bandwidth) \| + (bandwidth) \| | + rw bandwidth value? \| + (bandwidth cumulative) \| | + rw bandwidth cumulative? \| + (bandwidth num multipaths) \| + rw bandwidth num multipaths? + rw bandwidth non transitive? + rw route target + rw site of origin + rw (next hop)? \| + (ipv4 next hop address) \| | + rw ipv4 next hop address? \| + (ipv4 next hop peer address) \| | + rw ipv4 next hop peer address? \| + (ipv4 next hop unchanged) \| + rw ipv4 next hop unchanged? + rw ipv4 vpn next hop address? + rw ipv6 forwarding address? + rw ipv6 next hop global address? + rw ipv6 next hop local address? + rw ipv6 next hop prefer global? + rw ipv6 next hop prefer peer? + rw ipv6 vpn next hop address? + rw label index? + rw large community + rw delete large community list? + rw metric type? + rw (value)? \| + (set metric) \| | + rw set metric? \| + (add metric) \| | + rw add metric? \| + (subtract metric) \| | + rw subtract metric? \| + (use round trip time) \| | + rw use round trip time? \| + (add round trip time) \| | + rw add round trip time? \| + (subtract round trip time) \| + rw subtract round trip time? + rw (source address)? \| + (ipv4 source address) \| | + rw ipv4 source address? \| + (ipv6 source address) \| + rw ipv6 source address? + rw table? + rw tag? table of properties name required type/range description route maps m path only node, has no configurable value name m route map name (sub property of route maps) route map instance name sequence id m 1 65535 (sub property of route maps) route map instance priority (low number means higher priority) description o string (sub property of route maps) route map description action m "permit" "deny" (sub property of route maps) route map actions permit (executes action), deny (quits evaluation) match condition m (sub property of route maps) path only node, has no configurable value route map match conditions as path o string (sub property of match condition) match bgp as path list alias o string (sub property of match condition) match bgp community alias name community o string (sub property of match condition) match bgp community list value in (1 99) for standard community list number or value in (100 500) expanded communitly list number or value of community list name extended community o string (sub property of match condition) match bgp/vpn extended community list value in (1 99) for standard extended community list number or value in (100 500) expanded extended communitly list number or value of extended community list name large community o string (sub property of match condition) match bgp large community list value in (1 99) for standard large community list number or value in (100 500) expanded large communitly list number or value of large community list name local preference o 0 4294967295 (sub property of match condition) match bgp local preference of route origin o "egp" "igp" "incomplete" (sub property of match condition) match bgp origin code default route o "true" "false" (sub property of match condition) default evpn type 5 route route distinguisher o string (sub property of match condition) route distinguisher, asn\ xx or a b c d\ xx route type o "macip" "multicast" "prefix" (sub property of match condition) specify route type vni o 1 16777215 (sub property of match condition) match vni interface o interface name (sub property of match condition) match first hop interface of route ipv4 prefix list o prefix list name (sub property of match condition) match an ipv4 prefix list ipv4 prefix len o 0 32 (sub property of match condition) match prefix length of ip address ipv4 next hop address o a b c d (sub property of match condition) match an ipv4 next hop address ipv4 next hop prefix list o prefix list name (sub property of match condition) match an ipv4 next hop prefix list ipv4 next hop type o "blackhole" (sub property of match condition) match an ipv4 next hop type ipv4 next hop prefix len o 0 32 (sub property of match condition) match ipv4 prefixlen of given nexthop ipv4 route source prefix list o prefix list name (sub property of match condition) match advertising source ipv4 address of route ipv6 prefix list o prefix list name (sub property of match condition) match an ipv6 prefix list ipv6 prefix len o 0 128 (sub property of match condition) match prefix length of ipv6 address ipv6 next hop address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of match condition) match an ipv6 next hop address ipv6 next hop prefix list o prefix list name (sub property of match condition) match an ipv6 next hop prefix list ipv6 next hop type o "blackhole" (sub property of match condition) match an ipv6 next hop type peer ipv4 address o a b c d (sub property of match condition) mutually exclusive with \ peer ipv6 address \ peer interface \ peer local ipv4 address of peer peer ipv6 address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of match condition) mutually exclusive with \ peer ipv4 address \ peer interface \ peer local ipv6 address of peer peer interface o interface name (sub property of match condition) mutually exclusive with \ peer ipv4 address \ peer ipv6 address \ peer local interface name of peer peer local o "true" "false" (sub property of match condition) mutually exclusive with \ peer ipv4 address \ peer ipv6 address \ peer interface static or redistributed routes metric o 1 4294967295 (sub property of match condition) match a route metric probability o 0 100 (sub property of match condition) match portion of routes defined by percentage value tag o 1 4294967295 (sub property of match condition) match a route tag set action m (sub property of route maps) path only node, has no configurable value route map set actions aggregator as number m 1 4294967295 (sub property of set action) set as number of aggregator aggregator ip address m a b c d (sub property of set action) set ip address of aggregator exclude as o 1 4294967295 (sub property of set action) exclude from the as path prepend as o 1 4294967295 (sub property of set action) mutually exclusive with \ prepend last as as number to prepend prepend last as o 1 10 (sub property of set action) mutually exclusive with \ prepend as number of times to insert last as atomic aggregate o "true" "false" (sub property of set action) set bgp atomic aggregate attribute community o string (sub property of set action) set bgp community attribute community number in aa\ nn format (where aa and nn are (0 65535)) or local as|no advertise|no export|internet|graceful shutdown|accept own nexthop|accept own |route filter translated v4|route filter v4|route filter translated v6|route filter v6 |llgr stale|no llgr|blackhole|no peer or additive delete community list o string (sub property of set action) set bgp community list (for deletion) value in (1 99) for standard community list number or value in (100 500) expanded communitly list number or value of community list name distance o 0 255 (sub property of set action) set bgp administrative distance to use local preference o 0 4294967295 (sub property of set action) set bgp local preference of route origin o "egp" "igp" "incomplete" (sub property of set action) match bgp origin code originator id o a b c d (sub property of set action) set bgp originator id attribute sr te color o 1 4294967295 (sub property of set action) set color of the sr te policies to match with weight o 0 4294967295 (sub property of set action) set bgp weight for routing table ipv4 gateway o a b c d (sub property of set action) set ipv4 gateway for prefix advertisement route ipv6 gateway o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) set ipv6 gateway for prefix advertisement route bandwidth value o 1 25600 (sub property of set action) mutually exclusive with \ bandwidth cumulative \ bandwidth num multipaths bandwidth cumulative o "true" "false" (sub property of set action) mutually exclusive with \ bandwidth value \ bandwidth num multipaths cumulative bandwidth of all multipaths (outbound only) bandwidth num multipaths o "true" "false" (sub property of set action) mutually exclusive with \ bandwidth value \ bandwidth cumulative internally computed bandwidth based on number of multipaths (outbound only) bandwidth non transitive o "true" "false" (sub property of set action) attribute is set as non transitive route target o string (sub property of set action) route target extended community in asn\ nn or ip address\ nn format (where asn (0 4294967295), nn (0 65535)) site of origin o string (sub property of set action) site of origin extended community in asn\ nn or ip address\ nn format (where asn (0 4294967295), nn (0 65535)) ipv4 next hop address o a b c d (sub property of set action) mutually exclusive with \ ipv4 next hop peer address \ ipv4 next hop unchanged ipv4 next hop peer address o "true" "false" (sub property of set action) mutually exclusive with \ ipv4 next hop address \ ipv4 next hop unchanged ipv4 next hop unchanged o "true" "false" (sub property of set action) mutually exclusive with \ ipv4 next hop address \ ipv4 next hop peer address ipv4 vpn next hop address o a b c d (sub property of set action) set ipv4 vpn next hop address ipv6 forwarding address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) ipv6 forwarding address ipv6 next hop global address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) set ipv6 global address of next hop ipv6 next hop local address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) set ipv6 local address of next hop ipv6 next hop prefer global o "true" "false" (sub property of set action) prefer global over link local if both exist ipv6 next hop prefer peer o "true" "false" (sub property of set action) use peer address (for bgp only) ipv6 vpn next hop address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) set ipv6 vpn next hop address label index o 0 1048560 (sub property of set action) set label index to associate with the prefix large community o string (sub property of set action) large community number in aa\ bb\ cc(where aa, bb anc cc are (0 4294967295)) format or additive delete large community list o string (sub property of set action) set bgp large community list (for deletion) value in (1 99) for standard large community list number or value in (100 500) expanded large communitly list number or value of large community list name metric type o "type 1" "type 2" (sub property of set action) set type of metric set metric o 0 4294967295 (sub property of set action) mutually exclusive with \ add metric \ subtract metric \ use round trip time \ add round trip time \ subtract round trip time use the following metric value add metric o 0 4294967295 (sub property of set action) mutually exclusive with \ set metric \ subtract metric \ use round trip time \ add round trip time \ subtract round trip time add value to metric subtract metric o 0 4294967295 (sub property of set action) mutually exclusive with \ set metric \ add metric \ use round trip time \ add round trip time \ subtract round trip time subtract value from metric use round trip time o "true" "false" (sub property of set action) mutually exclusive with \ set metric \ add metric \ subtract metric \ add round trip time \ subtract round trip time use the round trip time as metric add round trip time o "true" "false" (sub property of set action) mutually exclusive with \ set metric \ add metric \ subtract metric \ use round trip time \ subtract round trip time add round trip time to metric subtract round trip time o "true" "false" (sub property of set action) mutually exclusive with \ set metric \ add metric \ subtract metric \ use round trip time \ add round trip time subtract round trip time to metric ipv4 source address o a b c d (sub property of set action) mutually exclusive with \ ipv6 source address ipv6 source address o xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of set action) mutually exclusive with \ ipv4 source address table o 1 4294967295 (sub property of set action) kernel routing table id tag o 0 4294967295 (sub property of set action) tag value \show route map\ tree diagrams + x show route map json + w input \| + w name? + ro output + ro data? table of properties name required type/range description show route map json m path only node, has no configurable value show route map information name o string (sub property of input) name of a route map data ro \<anydata> (sub property of output)