route-map

Configure a rule in a route map. You can use route maps to provide input to routing commands.

route-map Specification

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
Schema route-map schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/route-map/

route-map Attributes

Create List

POST

/axapi/v3/route-map/

route-map Attributes

Get Object

GET

/axapi/v3/route-map/{tag}+{action}+{sequence}

route-map Attributes

Get List

GET

/axapi/v3/route-map/

route-map-list

Modify Object

POST

/axapi/v3/route-map/{tag}+{action}+{sequence}

route-map Attributes

Replace Object

PUT

/axapi/v3/route-map/{tag}+{action}+{sequence}

route-map Attributes

Replace List

PUT

/axapi/v3/route-map/

route-map-list

Delete Object

DELETE

/axapi/v3/route-map/{tag}+{action}+{sequence}

route-map Attributes

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

Required: Yes

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

Required: Yes

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

Required: Yes

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

set

Specification
Type object

aggregator

Description: aggregator is a JSON Block . Please see below for l332_aggregator

Type: Object

as-path

Description: as-path is a JSON Block . Please see below for l332_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 l332_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 l332_dampening-cfg

Type: Object

extcommunity

Description: extcommunity is a JSON Block . Please see below for l332_extcommunity

Type: Object

ip

Description: ip is a JSON Block . Please see below for l332_ip

Type: Object

ipv6

Description: ipv6 is a JSON Block . Please see below for l332_ipv6

Type: Object

level

Description: level is a JSON Block . Please see below for l332_level

Type: Object

local-preference

Description: local-preference is a JSON Block . Please see below for l332_local-preference

Type: Object

metric

Description: metric is a JSON Block . Please see below for l332_metric

Type: Object

metric-type

Description: metric-type is a JSON Block . Please see below for l332_metric-type

Type: Object

origin

Description: origin is a JSON Block . Please see below for l332_origin

Type: Object

originator-id

Description: originator-id is a JSON Block . Please see below for l332_originator-id

Type: Object

tag

Description: tag is a JSON Block . Please see below for l332_tag

Type: Object

Required: Yes

uuid

Description: uuid of the object

Type: string

weight

Description: weight is a JSON Block . Please see below for l332_weight

Type: Object

set.extcommunity

Specification
Type object

rt

Description: rt is a JSON Block . Please see below for l332_rt

Type: Object

soo

Description: soo is a JSON Block . Please see below for l332_soo

Type: Object

set.extcommunity.rt

Specification
Type object

value

Description: VPN extended community

Type: string

Format: string-rlx

set.extcommunity.soo

Specification
Type object

value

Description: VPN extended community

Type: string

Format: string-rlx

set.origin

Specification
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
Type object

aggregator-as

Description: aggregator-as is a JSON Block . Please see below for l332_aggregator-as

Type: Object

set.aggregator.aggregator-as

Specification
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
Type object

weight-val

Description: Weight value

Type: number

Range: 0-4294967295

set.level

Specification
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
Type object

next-hop

Description: next-hop is a JSON Block . Please see below for l332_next-hop

Type: Object

set.ip.next-hop

Specification
Type object

address

Description: IP address of next hop

Type: string

Format: ipv4-address

set.metric

Specification
Type object

value

Description: Metric value

Type: string

set.as-path

Specification
Type object

num

Description: AS number

Type: number

Range: 1-4294967295

num2

Description: AS number

Type: number

Range: 1-4294967295

prepend

Description: Prepend to the as-path (AS number)

Type: string

Format: string-rlx

set.comm-list

Specification
Type object

delete

Description: Delete matching communities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Community-list name

Type: string

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 and 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 and name are mutually exclusive

set.local-preference

Specification
Type object

val

Description: Preference value

Type: number

Range: 0-4294967295

set.tag

Specification
Type object

value

Description: Tag value

Type: number

Range: 0-4294967295

set.ipv6

Specification
Type object

next-hop-1

Description: next-hop-1 is a JSON Block . Please see below for l332_next-hop-1

Type: Object

set.ipv6.next-hop-1

Specification
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 l332_local

Type: Object

set.ipv6.next-hop-1.local

Specification
Type object

address

Description: IPv6 address of next hop

Type: string

Format: ipv6-address

set.dampening-cfg

Specification
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
Type object

originator-ip

Description: IP address of originator

Type: string

Format: ipv4-address

set.metric-type

Specification
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
Type object

as-path

Description: as-path is a JSON Block . Please see below for l332_as-path

Type: Object

community

Description: community is a JSON Block . Please see below for l332_community

Type: Object

extcommunity

Description: extcommunity is a JSON Block . Please see below for l332_extcommunity

Type: Object

group

Description: group is a JSON Block . Please see below for l332_group

Type: Object

interface

Description: interface is a JSON Block . Please see below for l332_interface

Type: Object

ip

Description: ip is a JSON Block . Please see below for l332_ip

Type: Object

ipv6

Description: ipv6 is a JSON Block . Please see below for l332_ipv6

Type: Object

local-preference

Description: local-preference is a JSON Block . Please see below for l332_local-preference

Type: Object

metric

Description: metric is a JSON Block . Please see below for l332_metric

Type: Object

origin

Description: origin is a JSON Block . Please see below for l332_origin

Type: Object

route-type

Description: route-type is a JSON Block . Please see below for l332_route-type

Type: Object

tag

Description: tag is a JSON Block . Please see below for l332_tag

Type: Object

Required: Yes

uuid

Description: uuid of the object

Type: string

match.extcommunity

Specification
Type object

extcommunity-l-ext-cfg

Description: extcommunity-l-ext-cfg is a JSON Block . Please see below for l332_extcommunity-l-ext-cfg

Type: Object

extcommunity-l-name

Description: extcommunity-l-name is a JSON Block . Please see below for l332_extcommunity-l-name

Type: Object

extcommunity-l-std-cfg

Description: extcommunity-l-std-cfg is a JSON Block . Please see below for l332_extcommunity-l-std-cfg

Type: Object

match.extcommunity.extcommunity-l-std-cfg

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l-std

Description: Community-list number (standard)

Type: number

Range: 1-99

Mutual Exclusion: l-std l-ext and name are mutually exclusive

match.extcommunity.extcommunity-l-name

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Community-list name

Type: string

Mutual Exclusion: name l-std and l-ext are mutually exclusive

match.extcommunity.extcommunity-l-ext-cfg

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l-ext

Description: Community-list number (expanded)

Type: number

Range: 100-199

Mutual Exclusion: l-ext l-std and name are mutually exclusive

match.origin

Specification
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
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
Type object

address

Description: address is a JSON Block . Please see below for l332_address

Type: Object

next-hop

Description: next-hop is a JSON Block . Please see below for l332_next-hop

Type: Object

peer

Description: peer is a JSON Block . Please see below for l332_peer

Type: Object

match.ip.peer

Specification
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

Mutual Exclusion: name acl1 and acl2 are mutually exclusive

match.ip.next-hop

Specification
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

Mutual Exclusion: name acl1 and acl2 are mutually exclusive

prefix-list-1

Description: prefix-list-1 is a JSON Block . Please see below for l332_prefix-list-1

Type: Object

match.ip.next-hop.prefix-list-1

Specification
Type object

name

Description: IP prefix-list name

Type: string

match.ip.address

Specification
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

Mutual Exclusion: name acl1 and acl2 are mutually exclusive

prefix-list

Description: prefix-list is a JSON Block . Please see below for l332_prefix-list

Type: Object

match.ip.address.prefix-list

Specification
Type object

name

Description: IP prefix-list name

Type: string

match.metric

Specification
Type object

value

Description: Metric value

Type: number

Range: 0-4294967295

match.ipv6

Specification
Type object

address-1

Description: address-1 is a JSON Block . Please see below for l332_address-1

Type: Object

next-hop-1

Description: next-hop-1 is a JSON Block . Please see below for l332_next-hop-1

Type: Object

peer-1

Description: peer-1 is a JSON Block . Please see below for l332_peer-1

Type: Object

match.ipv6.next-hop-1

Specification
Type object

next-hop-acl-name

Description: IPv6 access-list name

Type: string

Mutual Exclusion: next-hop-acl-name and v6-addr are mutually exclusive

prefix-list-name

Description: IPv6 prefix-list name

Type: string

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.peer-1

Specification
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

Mutual Exclusion: name acl1 and acl2 are mutually exclusive

match.ipv6.address-1

Specification
Type object

name

Description: IPv6 access-list name

Type: string

prefix-list-2

Description: prefix-list-2 is a JSON Block . Please see below for l332_prefix-list-2

Type: Object

match.ipv6.address-1.prefix-list-2

Specification
Type object

name

Description: IPv6 prefix-list name

Type: string

match.community

Specification
Type object

l-ext-cfg

Description: l-ext-cfg is a JSON Block . Please see below for l332_l-ext-cfg

Type: Object

l-std-cfg

Description: l-std-cfg is a JSON Block . Please see below for l332_l-std-cfg

Type: Object

name-cfg

Description: name-cfg is a JSON Block . Please see below for l332_name-cfg

Type: Object

match.community.l-std-cfg

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l-std

Description: Community-list number (standard)

Type: number

Range: 1-99

Mutual Exclusion: l-std l-ext and name are mutually exclusive

match.community.name-cfg

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description: Community-list name

Type: string

Mutual Exclusion: name l-std and l-ext are mutually exclusive

match.community.l-ext-cfg

Specification
Type object

exact-match

Description: Do exact matching of ecommunities

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

l-ext

Description: Community-list number (expanded)

Type: number

Range: 100-199

Mutual Exclusion: l-ext l-std and name are mutually exclusive

match.local-preference

Specification
Type object

val

Description: Preference value

Type: number

Range: 0-4294967295

match.route-type

Specification
Type object

external

Description: external is a JSON Block . Please see below for l332_external

Type: Object

match.route-type.external

Specification
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
Type object

value

Description: Tag value

Type: number

Range: 0-4294967295

match.as-path

Specification
Type object

name

Description: AS path access-list name

Type: string

match.interface

Specification
Type object

ethernet

Description: Ethernet interface (Port number)

Type: number

Format: interface

Mutual Exclusion: ethernet loopback, trunk and ve are mutually exclusive

loopback

Description: Loopback interface (Port number)

Type: number

Range: 1-10

Mutual Exclusion: loopback ethernet, trunk and ve are mutually exclusive

trunk

Description: Trunk Interface (Trunk interface number)

Type: number

Range: 1-16

Mutual Exclusion: trunk ethernet, loopback and ve are mutually exclusive

ve

Description: Virtual ethernet interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

Mutual Exclusion: ve ethernet, loopback and trunk are mutually exclusive