route-map match

Match values from routing table

match Specification

Parameter Value
Type Configuration Resource
Element Name match
Element URI /axapi/v3/route-map/{tag}+{action}+{sequence}/match
Element Attributes match_attributes
Partition Visibility shared
Schema match schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

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

match attributes

Get Object

GET

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

match attributes

Modify Object

POST

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

match attributes

Replace Object

PUT

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

match attributes

Delete Object

DELETE

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

match attributes

match attributes

as-path

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

Type: Object

community

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

Type: Object

extcommunity

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

Type: Object

group

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

Type: Object

interface

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

Type: Object

ip

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

Type: Object

ipv6

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

Type: Object

local-preference

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

Type: Object

metric

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

Type: Object

origin

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

Type: Object

route-type

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

Type: Object

scaleout

Description: scaleout is a JSON Block. Please see below for scaleout

Type: Object

tag

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

Type: Object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

extcommunity

Specification Value
Type object

extcommunity-l-name

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

Type: Object

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

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

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

ip

Specification Value
Type object

address

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

Type: Object

next-hop

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

Type: Object

peer

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

Type: Object

rib

Description: rib is a JSON Block. Please see below for ip_rib

Type: Object

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

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 ip_next-hop_prefix-list-1

Type: Object

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

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

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 ip_address_prefix-list

Type: Object

ip_address_prefix-list

Specification Value
Type object

name

Description IP prefix-list name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

metric

Specification Value
Type object

value

Description Metric value

Type: number

Range: 0-4294967295

ipv6

Specification Value
Type object

address-1

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

Type: Object

next-hop-1

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

Type: Object

peer-1

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

Type: Object

rib

Description: rib is a JSON Block. Please see below for ipv6_rib

Type: Object

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

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

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

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 ipv6_address-1_prefix-list-2

Type: Object

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

community

Specification Value
Type object

name-cfg

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

Type: Object

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

local-preference

Specification Value
Type object

val

Description Preference value

Type: number

Range: 0-4294967295

route-type

Specification Value
Type object

external

Description: external is a JSON Block. Please see below for route-type_external

Type: Object

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

tag

Specification Value
Type object

value

Description Tag value

Type: number

Range: 0-4294967295

as-path

Specification Value
Type object

name

Description AS path access-list name

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

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

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