route-map¶
Configure route-map
route-map Specification¶
Parameter Value Type Collection Object Key(s) tag, action, sequence Collection Name route-map-list Collection URI /axapi/v3/route-map Element Name route-map Element URI /axapi/v3/route-map/{tag}+{action}+{sequence} Element Attributes route-map_attributes Partition Visibility shared Schema route-map schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/route-map | ||
Create List | POST | /axapi/v3/route-map | ||
Get Object | GET | /axapi/v3/route-map/{tag}+{action}+{sequence} | ||
Get List | GET | /axapi/v3/route-map | ||
Modify Object | POST | /axapi/v3/route-map/{tag}+{action}+{sequence} | ||
Replace Object | PUT | /axapi/v3/route-map/{tag}+{action}+{sequence} | ||
Replace List | PUT | /axapi/v3/route-map | ||
Delete Object | DELETE | /axapi/v3/route-map/{tag}+{action}+{sequence} | ||
route-map-list¶
route-map-list is JSON List of route-map attributes
route-map-list : [
]
route-map attributes¶
action
Description ‘permit’: Route map permits set operations; ‘deny’: Route map denies set operations;
Type: string
Supported Values: permit, deny
match
Description: match is a JSON Block. Please see below for match
Type: Object
Reference Object: /axapi/v3/route-map/{tag}+{action}+{sequence}/match
sequence
Description Sequence to insert to/delete from existing route-map entry
Type: number
Range: 1-65535
set
Description: set is a JSON Block. Please see below for set
Type: Object
Reference Object: /axapi/v3/route-map/{tag}+{action}+{sequence}/set
tag
Description Route map tag
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
set¶
Specification Value Type object aggregator
Description: aggregator is a JSON Block. Please see below for set_aggregator
Type: Object
as-path
Description: as-path is a JSON Block. Please see below for set_as-path
Type: Object
atomic-aggregate
Description BGP atomic aggregate attribute
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
comm-list
Description: comm-list is a JSON Block. Please see below for set_comm-list
Type: Object
community
Description BGP community attribute
Type: string
Format: string-rlx
dampening-cfg
Description: dampening-cfg is a JSON Block. Please see below for set_dampening-cfg
Type: Object
ddos
Description: ddos is a JSON Block. Please see below for set_ddos
Type: Object
extcommunity
Description: extcommunity is a JSON Block. Please see below for set_extcommunity
Type: Object
ip
Description: ip is a JSON Block. Please see below for set_ip
Type: Object
ipv6
Description: ipv6 is a JSON Block. Please see below for set_ipv6
Type: Object
large-comm-list
Description: large-comm-list is a JSON Block. Please see below for set_large-comm-list
Type: Object
large-community
Description BGP large community attribute
Type: string
Format: string-rlx
level
Description: level is a JSON Block. Please see below for set_level
Type: Object
local-preference
Description: local-preference is a JSON Block. Please see below for set_local-preference
Type: Object
metric
Description: metric is a JSON Block. Please see below for set_metric
Type: Object
metric-type
Description: metric-type is a JSON Block. Please see below for set_metric-type
Type: Object
origin
Description: origin is a JSON Block. Please see below for set_origin
Type: Object
originator-id
Description: originator-id is a JSON Block. Please see below for set_originator-id
Type: Object
tag
Description: tag is a JSON Block. Please see below for set_tag
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
weight
Description: weight is a JSON Block. Please see below for set_weight
Type: Object
set_extcommunity¶
Specification Value Type object rt
Description: rt is a JSON Block. Please see below for set_extcommunity_rt
Type: Object
soo
Description: soo is a JSON Block. Please see below for set_extcommunity_soo
Type: Object
set_extcommunity_rt¶
Specification Value Type object value
Description VPN extended community
Type: string
Format: string-rlx
set_extcommunity_soo¶
Specification Value Type object value
Description VPN extended community
Type: string
Format: string-rlx
set_origin¶
Specification Value Type object egp
Description remote EGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: egp, igp, and incomplete are mutually exclusive
igp
Description local IGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: igp, egp, and incomplete are mutually exclusive
incomplete
Description unknown heritage
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: incomplete, egp, and igp are mutually exclusive
set_aggregator¶
Specification Value Type object aggregator-as
Description: aggregator-as is a JSON Block. Please see below for set_aggregator_aggregator-as
Type: Object
set_aggregator_aggregator-as¶
Specification Value Type object asn
Description AS number
Type: number
Range: 1-4294967295
ip
Description IP address of aggregator
Type: string
Format: ipv4-address
set_weight¶
Specification Value Type object weight-val
Description Weight value
Type: number
Range: 0-4294967295
set_level¶
Specification Value Type object value
Description ‘level-1’: Export into a level-1 area; ‘level-1-2’: Export into level-1 and level-2; ‘level-2’: Export into level-2 sub-domain;
Type: string
Supported Values: level-1, level-1-2, level-2
set_ip¶
Specification Value Type object next-hop
Description: next-hop is a JSON Block. Please see below for set_ip_next-hop
Type: Object
set_ip_next-hop¶
Specification Value Type object address
Description IP address of next hop
Type: string
Format: ipv4-address
set_metric¶
Specification Value Type object value
Description Metric Value (from -4294967295 to 4294967295)
Type: string
Maximum Length: 11 characters
Maximum Length: 1 characters
set_as-path¶
Specification Value Type object num
Description AS number
Type: string
Maximum Length: 11 characters
Maximum Length: 1 characters
num2
Description AS number
Type: string
Maximum Length: 11 characters
Maximum Length: 1 characters
prepend
Description Prepend to the as-path (AS number)
Type: string
Format: string-rlx
set_comm-list¶
Specification Value Type object delete
Description Delete matching communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description Community-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: name, v-std, and v-exp are mutually exclusive
name-delete
Description Delete matching communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
v-exp
Description Community-list number (expanded)
Type: number
Range: 100-199
Mutual Exclusion: v-exp,v-std, name, and l-name are mutually exclusive
v-exp-delete
Description Delete matching communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
v-std
Description Community-list number (standard)
Type: number
Range: 1-99
Mutual Exclusion: v-std,v-exp, name, l-v-exp, and l-name are mutually exclusive
set_local-preference¶
Specification Value Type object val
Description Preference value
Type: number
Range: 0-4294967295
set_ddos¶
Specification Value Type object class-list-cid
Description Class-List Cid
Type: number
Range: 1-32
class-list-name
Description Class-List Name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
zone
Description Zone Name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
set_tag¶
Specification Value Type object value
Description Tag value
Type: number
Range: 0-4294967295
set_ipv6¶
Specification Value Type object next-hop-1
Description: next-hop-1 is a JSON Block. Please see below for set_ipv6_next-hop-1
Type: Object
set_ipv6_next-hop-1¶
Specification Value Type object address
Description global address of next hop
Type: string
Format: ipv6-address
local
Description: local is a JSON Block. Please see below for set_ipv6_next-hop-1_local
Type: Object
set_ipv6_next-hop-1_local¶
Specification Value Type object address
Description IPv6 address of next hop
Type: string
Format: ipv6-address
set_large-comm-list¶
Specification Value Type object l-name
Description Large Community-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: l-name, v-std, and v-exp are mutually exclusive
l-v-exp
Description Large Community-list number (expanded)
Type: number
Range: 100-199
Mutual Exclusion: l-v-exp and v-std are mutually exclusive
l-v-exp-delete
Description Delete matching large communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
l-v-std
Description Large Community-list number (standard)
Type: number
Range: 1-99
l-v-std-delete
Description Delete matching large communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
large-name-delete
Description Delete matching large communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
set_dampening-cfg¶
Specification Value Type object dampening
Description Enable route-flap dampening
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
dampening-half-time
Description Reachability Half-life time for the penalty(minutes)
Type: number
Range: 1-45
dampening-max-supress
Description Maximum duration to suppress a stable route(minutes)
Type: number
Range: 1-255
dampening-penalty
Description Un-reachability Half-life time for the penalty(minutes)
Type: number
Range: 1-45
dampening-reuse
Description Value to start reusing a route
Type: number
Range: 1-20000
dampening-supress
Description Value to start suppressing a route
Type: number
Range: 1-20000
set_originator-id¶
Specification Value Type object originator-ip
Description IP address of originator
Type: string
Format: ipv4-address
set_metric-type¶
Specification Value Type object value
Description ‘external’: IS-IS external metric type; ‘internal’: IS-IS internal metric type; ‘type-1’: OSPF external type 1 metric; ‘type-2’: OSPF external type 2 metric;
Type: string
Supported Values: external, internal, type-1, type-2
match¶
Specification Value Type object as-path
Description: as-path is a JSON Block. Please see below for match_as-path
Type: Object
community
Description: community is a JSON Block. Please see below for match_community
Type: Object
extcommunity
Description: extcommunity is a JSON Block. Please see below for match_extcommunity
Type: Object
group
Description: group is a JSON Block. Please see below for match_group
Type: Object
interface
Description: interface is a JSON Block. Please see below for match_interface
Type: Object
ip
Description: ip is a JSON Block. Please see below for match_ip
Type: Object
ipv6
Description: ipv6 is a JSON Block. Please see below for match_ipv6
Type: Object
large-community
Description: large-community is a JSON Block. Please see below for match_large-community
Type: Object
local-preference
Description: local-preference is a JSON Block. Please see below for match_local-preference
Type: Object
metric
Description: metric is a JSON Block. Please see below for match_metric
Type: Object
origin
Description: origin is a JSON Block. Please see below for match_origin
Type: Object
route-type
Description: route-type is a JSON Block. Please see below for match_route-type
Type: Object
scaleout
Description: scaleout is a JSON Block. Please see below for match_scaleout
Type: Object
tag
Description: tag is a JSON Block. Please see below for match_tag
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
match_extcommunity¶
Specification Value Type object extcommunity-l-name
Description: extcommunity-l-name is a JSON Block. Please see below for match_extcommunity_extcommunity-l-name
Type: Object
match_extcommunity_extcommunity-l-name¶
Specification Value Type object exact-match
Description Do exact matching of ecommunities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description One or more Extended Community Lists (numbered or named)
Type: string
Format: string-rlx
match_origin¶
Specification Value Type object egp
Description remote EGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: egp, igp, and incomplete are mutually exclusive
igp
Description local IGP
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: igp, egp, and incomplete are mutually exclusive
incomplete
Description unknown heritage
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: incomplete, egp, and igp are mutually exclusive
match_group¶
Specification Value Type object group-id
Description HA or VRRP-A group id
Type: number
Range: 0-31
ha-state
Description ‘active’: HA or VRRP-A in Active State; ‘standby’: HA or VRRP-A in Standby State;
Type: string
Supported Values: active, standby
match_ip¶
Specification Value Type object address
Description: address is a JSON Block. Please see below for match_ip_address
Type: Object
next-hop
Description: next-hop is a JSON Block. Please see below for match_ip_next-hop
Type: Object
peer
Description: peer is a JSON Block. Please see below for match_ip_peer
Type: Object
rib
Description: rib is a JSON Block. Please see below for match_ip_rib
Type: Object
match_ip_peer¶
Specification Value Type object acl1
Description IP access-list number
Type: number
Range: 1-199
Mutual Exclusion: acl1, acl2, and name are mutually exclusive
acl2
Description IP access-list number (expanded range)
Type: number
Range: 1300-2699
Mutual Exclusion: acl2, acl1, and name are mutually exclusive
name
Description IP access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: name, acl1, and acl2 are mutually exclusive
match_ip_next-hop¶
Specification Value Type object acl1
Description IP access-list number
Type: number
Range: 1-199
Mutual Exclusion: acl1, acl2, and name are mutually exclusive
acl2
Description IP access-list number (expanded range)
Type: number
Range: 1300-2699
Mutual Exclusion: acl2, acl1, and name are mutually exclusive
name
Description IP access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: name, acl1, and acl2 are mutually exclusive
prefix-list-1
Description: prefix-list-1 is a JSON Block. Please see below for match_ip_next-hop_prefix-list-1
Type: Object
match_ip_next-hop_prefix-list-1¶
Specification Value Type object name
Description IP prefix-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
match_ip_rib¶
Specification Value Type object exact
Description Exact match a prefix (Prefix IPv4 address)
Type: string
Format: ipv4-cidr
Mutual Exclusion: exact, reachable, and unreachable are mutually exclusive
reachable
Description IP address is reachable
Type: string
Format: ipv4-address
Mutual Exclusion: reachable, exact, and unreachable are mutually exclusive
unreachable
Description IP address is unreachable
Type: string
Format: ipv4-address
Mutual Exclusion: unreachable, exact, and reachable are mutually exclusive
match_ip_address¶
Specification Value Type object acl1
Description IP access-list number
Type: number
Range: 1-199
Mutual Exclusion: acl1, acl2, and name are mutually exclusive
acl2
Description IP access-list number (expanded range)
Type: number
Range: 1300-2699
Mutual Exclusion: acl2, acl1, and name are mutually exclusive
name
Description IP access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: name, acl1, and acl2 are mutually exclusive
prefix-list
Description: prefix-list is a JSON Block. Please see below for match_ip_address_prefix-list
Type: Object
match_ip_address_prefix-list¶
Specification Value Type object name
Description IP prefix-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
match_metric¶
Specification Value Type object value
Description Metric value
Type: number
Range: 0-4294967295
match_ipv6¶
Specification Value Type object address-1
Description: address-1 is a JSON Block. Please see below for match_ipv6_address-1
Type: Object
next-hop-1
Description: next-hop-1 is a JSON Block. Please see below for match_ipv6_next-hop-1
Type: Object
peer-1
Description: peer-1 is a JSON Block. Please see below for match_ipv6_peer-1
Type: Object
rib
Description: rib is a JSON Block. Please see below for match_ipv6_rib
Type: Object
match_ipv6_next-hop-1¶
Specification Value Type object next-hop-acl-name
Description IPv6 access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: next-hop-acl-name and v6-addr are mutually exclusive
prefix-list-name
Description IPv6 prefix-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
v6-addr
Description IPv6 address of next hop
Type: string
Format: ipv6-address
Mutual Exclusion: v6-addr and next-hop-acl-name are mutually exclusive
match_ipv6_rib¶
Specification Value Type object exact
Description Exact match a prefix (Prefix IPv6 address)
Type: string
Format: ipv6-address-plen
Mutual Exclusion: exact, reachable, and unreachable are mutually exclusive
reachable
Description IPv6 address is reachable
Type: string
Format: ipv6-address
Mutual Exclusion: reachable, exact, and unreachable are mutually exclusive
unreachable
Description IPv6 address is unreachable
Type: string
Format: ipv6-address
Mutual Exclusion: unreachable, exact, and reachable are mutually exclusive
match_ipv6_peer-1¶
Specification Value Type object acl1
Description IPv6 access-list number
Type: number
Range: 1-199
Mutual Exclusion: acl1, acl2, and name are mutually exclusive
acl2
Description IP access-list number (expanded range)
Type: number
Range: 1300-2699
Mutual Exclusion: acl2, acl1, and name are mutually exclusive
name
Description IP access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Mutual Exclusion: name, acl1, and acl2 are mutually exclusive
match_ipv6_address-1¶
Specification Value Type object name
Description IPv6 access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
prefix-list-2
Description: prefix-list-2 is a JSON Block. Please see below for match_ipv6_address-1_prefix-list-2
Type: Object
match_ipv6_address-1_prefix-list-2¶
Specification Value Type object name
Description IPv6 prefix-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
match_large-community¶
Specification Value Type object l-name-cfg
Description: l-name-cfg is a JSON Block. Please see below for match_large-community_l-name-cfg
Type: Object
match_large-community_l-name-cfg¶
Specification Value Type object exact-match
Description Do exact matching of large-communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description One or more Large Community Lists (numbered or named)
Type: string
Format: string-rlx
match_local-preference¶
Specification Value Type object val
Description Preference value
Type: number
Range: 0-4294967295
match_route-type¶
Specification Value Type object external
Description: external is a JSON Block. Please see below for match_route-type_external
Type: Object
match_route-type_external¶
Specification Value Type object value
Description ‘type-1’: Match OSPF External Type 1 metrics; ‘type-2’: Match OSPF External Type 2 metrics;
Type: string
Supported Values: type-1, type-2
match_tag¶
Specification Value Type object value
Description Tag value
Type: number
Range: 0-4294967295
match_community¶
Specification Value Type object name-cfg
Description: name-cfg is a JSON Block. Please see below for match_community_name-cfg
Type: Object
match_community_name-cfg¶
Specification Value Type object exact-match
Description Do exact matching of communities
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
name
Description One or more Community Lists (numbered or named)
Type: string
Format: string-rlx
match_as-path¶
Specification Value Type object name
Description AS path access-list name
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
match_interface¶
Specification Value Type object ethernet
Description Ethernet interface (Port number)
Type: number
Format: interface
Mutual Exclusion: ethernet,loopback, trunk, ve, and tunnel are mutually exclusive
loopback
Description Loopback interface (Port number)
Type: number
Range: 0-10
Mutual Exclusion: loopback,ethernet, trunk, ve, and tunnel are mutually exclusive
trunk
Description Trunk Interface (Trunk interface number)
Type: number
Range: 1-4096
Mutual Exclusion: trunk,ethernet, loopback, ve, and tunnel are mutually exclusive
tunnel
Description Tunnel interface (Tunnel interface number)
Type: number
Format: interface
Mutual Exclusion: tunnel,ethernet, loopback, trunk, and ve are mutually exclusive
ve
Description Virtual ethernet interface (Virtual ethernet interface number)
Type: number
Range: 2-4094
Mutual Exclusion: ve,ethernet, loopback, trunk, and tunnel are mutually exclusive
match_scaleout¶
Specification Value Type object cluster-id
Description Scaleout Cluster-id
Type: number
Range: 1-64
operational-state
Description ‘up’: Scaleout is up and running; ‘down’: Scaleout is down or disabled;
Type: string
Supported Values: up, down