route-map set¶

Set values in destination routing protocol

set Specification¶

Parameter Value

Type Configuration Resource

Element Name set

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

Element Attributes set_attributes

Partition Visibility shared

Schema set schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/route-map/{tag}+{action}+{sequence}/set	set attributes
POST /axapi/v3/route-map/a+permit+1/set Payload: { "set": { "ip": { "next-hop": { "address": "3.3.3.3" } } } }
Get Object	GET	/axapi/v3/route-map/{tag}+{action}+{sequence}/set	set attributes
GET /axapi/v3/route-map/a+permit+1/set Reponse: { "set": { "ip": { "next-hop": { "address": "3.3.3.3" } }, "atomic-aggregate": 0, "dampening-cfg": { "dampening": 0 }, "origin": { "egp": 0 }, "uuid": "72156c20-503d-11ee-b31e-61a3d9cb4d7f", "a10-url": "/axapi/v3/route-map/a+permit+1/set" } }
Modify Object	POST	/axapi/v3/route-map/{tag}+{action}+{sequence}/set	set attributes
Replace Object	PUT	/axapi/v3/route-map/{tag}+{action}+{sequence}/set	set attributes
PUT /axapi/v3/route-map/a+permit+1/set Payload: { "set": { "ip": { "next-hop": { "address": "3.3.3.4" } } } }
Delete Object	DELETE	/axapi/v3/route-map/{tag}+{action}+{sequence}/set	set attributes
DELETE /axapi/v3/route-map/a+permit+1/set Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

set attributes¶

aggregator

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

Type: Object

as-path

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

Type: Object

ddos

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

Type: Object

extcommunity

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

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

large-comm-list

Description: large-comm-list is a JSON Block. Please see below for 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 level

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

metric-type

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

Type: Object

origin

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

Type: Object

originator-id

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

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

weight

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

Type: Object

extcommunity¶

Specification Value

Type object

rt

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

Type: Object

soo

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

Type: Object

extcommunity_rt¶

Specification Value

Type object

value

Description VPN extended community

Type: string

Format: string-rlx

extcommunity_soo¶

Specification Value

Type object

value

Description VPN extended community

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

aggregator¶

Specification Value

Type object

aggregator-as

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

Type: Object

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

weight¶

Specification Value

Type object

weight-val

Description Weight value

Type: number

Range: 0-4294967295

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

ip¶

Specification Value

Type object

next-hop

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

Type: Object

ip_next-hop¶

Specification Value

Type object

address

Description IP address of next hop

Type: string

Format: ipv4-address

metric¶

Specification Value

Type object

value

Description Metric Value (from -4294967295 to 4294967295)

Type: string

Maximum Length: 11 characters

Maximum Length: 1 characters

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

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

local-preference¶

Specification Value

Type object

val

Description Preference value

Type: number

Range: 0-4294967295

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

tag¶

Specification Value

Type object

value

Description Tag value

Type: number

Range: 0-4294967295

ipv6¶

Specification Value

Type object

next-hop-1

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

Type: Object

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 ipv6_next-hop-1_local

Type: Object

ipv6_next-hop-1_local¶

Specification Value

Type object

address

Description IPv6 address of next hop

Type: string

Format: ipv6-address

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

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

originator-id¶

Specification Value

Type object

originator-ip

Description IP address of originator

Type: string

Format: ipv4-address

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