Fortinet white logo
Fortinet white logo

CLI Reference

config router route-map

config router route-map

Configure route maps.

config router route-map
    Description: Configure route maps.
    edit <name>
        set comments {string}
        config rule
            Description: Rule.
            edit <id>
                set action [permit|deny]
                set match-as-path {string}
                set match-community {string}
                set match-extcommunity {string}
                set match-community-exact [enable|disable]
                set match-extcommunity-exact [enable|disable]
                set match-origin [none|egp|...]
                set match-interface {string}
                set match-ip-address {string}
                set match-ip6-address {string}
                set match-ip-nexthop {string}
                set match-ip6-nexthop {string}
                set match-metric {integer}
                set match-route-type [external-type1|external-type2|...]
                set match-tag {integer}
                set match-vrf {integer}
                set set-aggregator-as {integer}
                set set-aggregator-ip {ipv4-address-any}
                set set-aspath-action [prepend|replace]
                set set-aspath <as1>, <as2>, ...
                set set-atomic-aggregate [enable|disable]
                set set-community-delete {string}
                set set-community <community1>, <community2>, ...
                set set-community-additive [enable|disable]
                set set-dampening-reachability-half-life {integer}
                set set-dampening-reuse {integer}
                set set-dampening-suppress {integer}
                set set-dampening-max-suppress {integer}
                set set-dampening-unreachability-half-life {integer}
                set set-extcommunity-rt <community1>, <community2>, ...
                set set-extcommunity-soo <community1>, <community2>, ...
                set set-ip-nexthop {ipv4-address}
                set set-ip6-nexthop {ipv6-address}
                set set-ip6-nexthop-local {ipv6-address}
                set set-local-preference {integer}
                set set-metric {integer}
                set set-metric-type [external-type1|external-type2|...]
                set set-originator-id {ipv4-address-any}
                set set-origin [none|egp|...]
                set set-tag {integer}
                set set-weight {integer}
                set set-route-tag {integer}
                set set-priority {integer}
            next
        end
    next
end

config router route-map

Parameter

Description

Type

Size

Default

comments

Optional comments.

string

Maximum length: 127

name

Name.

string

Maximum length: 35

config rule

Parameter

Description

Type

Size

Default

id

Rule ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

action

Action.

option

-

permit

Option

Description

permit

Permit.

deny

Deny.

match-as-path

Match BGP AS path list.

string

Maximum length: 35

match-community

Match BGP community list.

string

Maximum length: 35

match-extcommunity

Match BGP extended community list.

string

Maximum length: 35

match-community-exact

Enable/disable exact matching of communities.

option

-

disable

Option

Description

enable

Enable exact matching of communities.

disable

Disable exact matching of communities.

match-extcommunity-exact

Enable/disable exact matching of extended communities.

option

-

disable

Option

Description

enable

Enable exact matching of extended communities.

disable

Disable exact matching of extended communities.

match-origin

Match BGP origin code.

option

-

none

Option

Description

none

None.

egp

Remote EGP.

igp

Local IGP.

incomplete

Unknown heritage.

match-interface

Match interface configuration.

string

Maximum length: 15

match-ip-address

Match IP address permitted by access-list or prefix-list.

string

Maximum length: 35

match-ip6-address

Match IPv6 address permitted by access-list6 or prefix-list6.

string

Maximum length: 35

match-ip-nexthop

Match next hop IP address passed by access-list or prefix-list.

string

Maximum length: 35

match-ip6-nexthop

Match next hop IPv6 address passed by access-list6 or prefix-list6.

string

Maximum length: 35

match-metric

Match metric for redistribute routes.

integer

Minimum value: 0 Maximum value: 4294967295

match-route-type

Match route type.

option

-

Option

Description

external-type1

External type 1.

external-type2

External type 2.

none

No type specified.

match-tag

Match tag.

integer

Minimum value: 0 Maximum value: 4294967295

match-vrf

Match VRF ID.

integer

Minimum value: 0 Maximum value: 251

set-aggregator-as

BGP aggregator AS.

integer

Minimum value: 0 Maximum value: 4294967295

0

set-aggregator-ip

BGP aggregator IP.

ipv4-address-any

Not Specified

0.0.0.0

set-aspath-action

Specify preferred action of set-aspath.

option

-

prepend

Option

Description

prepend

Prepend.

replace

Replace.

set-aspath <as>

Prepend BGP AS path attribute.

AS number (0 - 4294967295). Use quotes for repeating numbers, For example, "1 1 2".

string

Maximum length: 79

set-atomic-aggregate

Enable/disable BGP atomic aggregate attribute.

option

-

disable

Option

Description

enable

Enable BGP atomic aggregate attribute.

disable

Disable BGP atomic aggregate attribute.

set-community-delete

Delete communities matching community list.

string

Maximum length: 35

set-community <community>

BGP community attribute.

Attribute: AA|AA:NN|internet|local-AS|no-advertise|no-export.

string

Maximum length: 79

set-community-additive

Enable/disable adding set-community to existing community.

option

-

disable

Option

Description

enable

Enable adding set-community to existing community.

disable

Disable adding set-community to existing community.

set-dampening-reachability-half-life

Reachability half-life time for the penalty.

integer

Minimum value: 0 Maximum value: 45

0

set-dampening-reuse

Value to start reusing a route.

integer

Minimum value: 0 Maximum value: 20000

0

set-dampening-suppress

Value to start suppressing a route.

integer

Minimum value: 0 Maximum value: 20000

0

set-dampening-max-suppress

Maximum duration to suppress a route.

integer

Minimum value: 0 Maximum value: 255

0

set-dampening-unreachability-half-life

Unreachability Half-life time for the penalty.

integer

Minimum value: 0 Maximum value: 45

0

set-extcommunity-rt <community>

Route Target extended community.

AA:NN.

string

Maximum length: 79

set-extcommunity-soo <community>

Site-of-Origin extended community.

Community (format = AA:NN).

string

Maximum length: 79

set-ip-nexthop

IP address of next hop.

ipv4-address

Not Specified

set-ip6-nexthop

IPv6 global address of next hop.

ipv6-address

Not Specified

set-ip6-nexthop-local

IPv6 local address of next hop.

ipv6-address

Not Specified

set-local-preference

BGP local preference path attribute.

integer

Minimum value: 0 Maximum value: 4294967295

set-metric

Metric value.

integer

Minimum value: 0 Maximum value: 4294967295

set-metric-type

Metric type.

option

-

Option

Description

external-type1

External type 1.

external-type2

External type 2.

none

No type specified.

set-originator-id

BGP originator ID attribute.

ipv4-address-any

Not Specified

set-origin

BGP origin code.

option

-

none

Option

Description

none

None.

egp

Remote EGP.

igp

Local IGP.

incomplete

Unknown heritage.

set-tag

Tag value.

integer

Minimum value: 0 Maximum value: 4294967295

set-weight

BGP weight for routing table.

integer

Minimum value: 0 Maximum value: 4294967295

set-route-tag

Route tag for routing table.

integer

Minimum value: 0 Maximum value: 4294967295

set-priority

Priority for routing table.

integer

Minimum value: 1 Maximum value: 65535

config router route-map

config router route-map

Configure route maps.

config router route-map
    Description: Configure route maps.
    edit <name>
        set comments {string}
        config rule
            Description: Rule.
            edit <id>
                set action [permit|deny]
                set match-as-path {string}
                set match-community {string}
                set match-extcommunity {string}
                set match-community-exact [enable|disable]
                set match-extcommunity-exact [enable|disable]
                set match-origin [none|egp|...]
                set match-interface {string}
                set match-ip-address {string}
                set match-ip6-address {string}
                set match-ip-nexthop {string}
                set match-ip6-nexthop {string}
                set match-metric {integer}
                set match-route-type [external-type1|external-type2|...]
                set match-tag {integer}
                set match-vrf {integer}
                set set-aggregator-as {integer}
                set set-aggregator-ip {ipv4-address-any}
                set set-aspath-action [prepend|replace]
                set set-aspath <as1>, <as2>, ...
                set set-atomic-aggregate [enable|disable]
                set set-community-delete {string}
                set set-community <community1>, <community2>, ...
                set set-community-additive [enable|disable]
                set set-dampening-reachability-half-life {integer}
                set set-dampening-reuse {integer}
                set set-dampening-suppress {integer}
                set set-dampening-max-suppress {integer}
                set set-dampening-unreachability-half-life {integer}
                set set-extcommunity-rt <community1>, <community2>, ...
                set set-extcommunity-soo <community1>, <community2>, ...
                set set-ip-nexthop {ipv4-address}
                set set-ip6-nexthop {ipv6-address}
                set set-ip6-nexthop-local {ipv6-address}
                set set-local-preference {integer}
                set set-metric {integer}
                set set-metric-type [external-type1|external-type2|...]
                set set-originator-id {ipv4-address-any}
                set set-origin [none|egp|...]
                set set-tag {integer}
                set set-weight {integer}
                set set-route-tag {integer}
                set set-priority {integer}
            next
        end
    next
end

config router route-map

Parameter

Description

Type

Size

Default

comments

Optional comments.

string

Maximum length: 127

name

Name.

string

Maximum length: 35

config rule

Parameter

Description

Type

Size

Default

id

Rule ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

action

Action.

option

-

permit

Option

Description

permit

Permit.

deny

Deny.

match-as-path

Match BGP AS path list.

string

Maximum length: 35

match-community

Match BGP community list.

string

Maximum length: 35

match-extcommunity

Match BGP extended community list.

string

Maximum length: 35

match-community-exact

Enable/disable exact matching of communities.

option

-

disable

Option

Description

enable

Enable exact matching of communities.

disable

Disable exact matching of communities.

match-extcommunity-exact

Enable/disable exact matching of extended communities.

option

-

disable

Option

Description

enable

Enable exact matching of extended communities.

disable

Disable exact matching of extended communities.

match-origin

Match BGP origin code.

option

-

none

Option

Description

none

None.

egp

Remote EGP.

igp

Local IGP.

incomplete

Unknown heritage.

match-interface

Match interface configuration.

string

Maximum length: 15

match-ip-address

Match IP address permitted by access-list or prefix-list.

string

Maximum length: 35

match-ip6-address

Match IPv6 address permitted by access-list6 or prefix-list6.

string

Maximum length: 35

match-ip-nexthop

Match next hop IP address passed by access-list or prefix-list.

string

Maximum length: 35

match-ip6-nexthop

Match next hop IPv6 address passed by access-list6 or prefix-list6.

string

Maximum length: 35

match-metric

Match metric for redistribute routes.

integer

Minimum value: 0 Maximum value: 4294967295

match-route-type

Match route type.

option

-

Option

Description

external-type1

External type 1.

external-type2

External type 2.

none

No type specified.

match-tag

Match tag.

integer

Minimum value: 0 Maximum value: 4294967295

match-vrf

Match VRF ID.

integer

Minimum value: 0 Maximum value: 251

set-aggregator-as

BGP aggregator AS.

integer

Minimum value: 0 Maximum value: 4294967295

0

set-aggregator-ip

BGP aggregator IP.

ipv4-address-any

Not Specified

0.0.0.0

set-aspath-action

Specify preferred action of set-aspath.

option

-

prepend

Option

Description

prepend

Prepend.

replace

Replace.

set-aspath <as>

Prepend BGP AS path attribute.

AS number (0 - 4294967295). Use quotes for repeating numbers, For example, "1 1 2".

string

Maximum length: 79

set-atomic-aggregate

Enable/disable BGP atomic aggregate attribute.

option

-

disable

Option

Description

enable

Enable BGP atomic aggregate attribute.

disable

Disable BGP atomic aggregate attribute.

set-community-delete

Delete communities matching community list.

string

Maximum length: 35

set-community <community>

BGP community attribute.

Attribute: AA|AA:NN|internet|local-AS|no-advertise|no-export.

string

Maximum length: 79

set-community-additive

Enable/disable adding set-community to existing community.

option

-

disable

Option

Description

enable

Enable adding set-community to existing community.

disable

Disable adding set-community to existing community.

set-dampening-reachability-half-life

Reachability half-life time for the penalty.

integer

Minimum value: 0 Maximum value: 45

0

set-dampening-reuse

Value to start reusing a route.

integer

Minimum value: 0 Maximum value: 20000

0

set-dampening-suppress

Value to start suppressing a route.

integer

Minimum value: 0 Maximum value: 20000

0

set-dampening-max-suppress

Maximum duration to suppress a route.

integer

Minimum value: 0 Maximum value: 255

0

set-dampening-unreachability-half-life

Unreachability Half-life time for the penalty.

integer

Minimum value: 0 Maximum value: 45

0

set-extcommunity-rt <community>

Route Target extended community.

AA:NN.

string

Maximum length: 79

set-extcommunity-soo <community>

Site-of-Origin extended community.

Community (format = AA:NN).

string

Maximum length: 79

set-ip-nexthop

IP address of next hop.

ipv4-address

Not Specified

set-ip6-nexthop

IPv6 global address of next hop.

ipv6-address

Not Specified

set-ip6-nexthop-local

IPv6 local address of next hop.

ipv6-address

Not Specified

set-local-preference

BGP local preference path attribute.

integer

Minimum value: 0 Maximum value: 4294967295

set-metric

Metric value.

integer

Minimum value: 0 Maximum value: 4294967295

set-metric-type

Metric type.

option

-

Option

Description

external-type1

External type 1.

external-type2

External type 2.

none

No type specified.

set-originator-id

BGP originator ID attribute.

ipv4-address-any

Not Specified

set-origin

BGP origin code.

option

-

none

Option

Description

none

None.

egp

Remote EGP.

igp

Local IGP.

incomplete

Unknown heritage.

set-tag

Tag value.

integer

Minimum value: 0 Maximum value: 4294967295

set-weight

BGP weight for routing table.

integer

Minimum value: 0 Maximum value: 4294967295

set-route-tag

Route tag for routing table.

integer

Minimum value: 0 Maximum value: 4294967295

set-priority

Priority for routing table.

integer

Minimum value: 1 Maximum value: 65535