Route Map

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		(sub-property of output)