Route policy command reference

Command hierarchies

Route policy configuration commands

config 
    - [no] router [router-name]
        - [no] policy-options
            - abort
            - begin
            - commit
            - [no] policy-statement name
                - default-action {accept | next-entry | reject}
                - no default-action
                - description description-string
                - no description
                - [no] entry entry-id
                    - action {accept| next-entry | next-policyreject}
                    - no action
                    - description description-string
                    - no description
                    - [no] from
                        - family [ipv4] [ipv6] [vpn-ipv4] [vpn-ipv6] [l2-vpn] [ms-pw] [route-target]
                        - group-address prefix-list-name
                        - no group-address
                        - [no] host-ip prefix-list-name
                        - prefix-list name [name...(up to 5 max)]
                        - no prefix-list
                        - source-address  ip-address
                        - no source-address
config 
    - [no] router 
        - [no] policy-options
            - [no] prefix-list name
                - prefix ip-prefix/prefix-length [exact | longer | through length | prefix-length-range length1-length2]
                - no prefix [ipv-prefix/prefix-length] [exact | longer | through length | prefix-length-range  length1-length2]

Show commands

show
    - router 
        - policy [name | prefix-list name | admin]   

Command descriptions

Configuration commands

Generic commands

abort
Syntax

abort

Context

config>router>policy-options

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command discards changes made to a route policy.

begin
Syntax

begin

Context

config>router>policy-options

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates or edits route policies.

commit
Syntax

commit

Context

config>router>policy-options

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command saves the changes made to a route policy.

description
Syntax

description string

no description

Context

config>router>policy-options>policy-statement

config>router>policy-options>policy-statement>entry

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a text description which is stored in the configuration file to help identify the content of the entity.

The no form of this command removes the string from the configuration.

Parameters
string

Specifies the description character string. Allowed values are any string up to 80 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

Route policy options

policy-options
Syntax

[no] policy-options

Context

config>router

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure route policies. Route policies are used for IGMP group membership report filtering.

The no form of this command deletes the route policy configuration.

Route policy prefix commands

prefix-list
Syntax

[no] prefix-list name

Context

config>router>policy-options

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure a prefix list to use in route policy entries.

The no form of this command deletes the named prefix list.

Parameters
name

Specifies the prefix list name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

prefix
Syntax

[no] prefix [ipv-prefix/prefix-length] [exact | longer | through length | prefix-length-range length1-length2]

Context

config>router>policy-options>prefix-list

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command creates a prefix entry in the route policy prefix list.

The no form of this command deletes the prefix entry from the prefix list.

Parameters
ip-prefix

Specifies the IP prefix for prefix list entry, in dotted-decimal notation.

Values

ipv4-prefix — a.b.c.d (host bits must be 0)

ipv6-prefix — x:x:x:x:x:x:x:x (eight 16-bit pieces)

  • x:x:x:x:x:x:d.d.d.d
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)

ipv4-prefix-length — 0 to 32

ipv6-prefix-length — 0 to 128

exact

Specifies the prefix list entry only matches the route with the specified ip-prefix and prefix mask (length) values.

longer

Specifies the prefix list entry matches any route that matches the specified ip-prefix and prefix mask length values greater than the specified mask.

through length

Specifies the prefix list entry matches any route that matches the specified ip-prefix and has a prefix length between the specified length values inclusive.

Values

0 to 32

prefix-length-range length1-length2

Specifies a route must match the most significant bits and have a prefix length with the specified range. The range is inclusive of start and end values.

Values

0 to 32, length2 must be a greater value than length1

Route policy entry match commands

entry
Syntax

entry entry-id

no entry

Context

config>router>policy-options>policy-statement

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context edit route policy entries within the route policy statement.

Multiple entries can be created using unique entries. The 7210 SAS OS exits the filter when the first match is found and executes the action specified. For this reason, entries must be sequenced properly from most to least explicit.

An entry does not require matching criteria defined (in which case, everything matches) but must have at least define an action to be considered complete. Entries without an action are considered incomplete and are rendered inactive.

The no form of this command removes the specified entry from the route policy statement.

Parameters
entry-id

Specifies the entry ID expressed as a decimal integer. An entry-id uniquely identifies match criteria and the corresponding action. Nokia recommends that multiple entries be specified entry-ids in staggered increments. This allows users to insert a new entry in an existing policy without requiring renumbering of all the existing entries.

Values

1 to 4294967295

from
Syntax

[no] from

Context

config>router>policy-options>policy-statement>entry

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure policy match criteria based on a route source or the protocol from which the route is received.

If no condition is specified, all route sources are considered to match.

The no form of this command deletes the source match criteria for the route policy statement entry.

family
Syntax

family [ipv4] [ipv6] [vpn-ipv4] [vpn-ipv6] [l2-vpn] [ms-pw] [route-target]

no family

Context

config>router>policy-options>policy-statement>entry>from

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies address families as matching conditions.

Parameters
ipv4

Specifies IPv4 routing information.

ipv6

Specifies IPv6 routing information.

vpn-ipv4

Specifies IPv4 VPN routing information.

vpn-ipv6

Specifies IPv6 VPN routing information.

ms-pw

Specifies ms-pw routing information.

l2-vpn

Exchanges Layer 2 VPN information.

route-target

Specifies the route target to be accepted and advertised from/to route reflector clients.

group-address
Syntax

group-address prefix-list-name

no group-address

Context

config>router>policy-options>policy-statement>entry>from

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies the multicast group-address prefix list containing multicast group-addresses that are embedded in the join or prune packet as a filter criterion. The prefix list must be configured before entering this command. Prefix lists are configured in the config>router>policy-options>prefix-list context.

The no form of this command removes the criterion from the configuration.

Default

no group-address

Parameters
prefix-list-name

Specifies the prefix-list name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The prefix-list-name is defined in the config>router>policy-options>prefix-list context.

host-ip
Syntax

host-ip prefix-list-name

Context

config>router>policy-options>policy-statement>entry>from

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies a prefix list host IP address as a match criterion for the route policy-statement entry.

Default

no host-ip

Parameters
prefix-list-name

Specifies the prefix-list name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

The prefix-list-name is defined in the config>router>policy-options>prefix-list context.

policy-statement
Syntax

[no] policy-statement name

Context

config>router>policy-options

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure a route policy statement.

Route policy statements enable appropriate processing of IGMP group membership reports received from hosts. The processing action taken is determined by the action associated with the entries configured in the policy statement.

The policy-statement is a logical grouping of match and action criteria.

The no form of this command deletes the policy statement.

Default

no policy-statement

Parameters
name

Specifies the route policy statement name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

prefix-list
Syntax

prefix-list name [name...up to 5 max]

no prefix-list

Context

config>router>policy-options>policy-statement>entry>from

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures a prefix list as a match criterion for a route policy statement entry.

If no prefix list is specified, any network prefix is considered a match.

The prefix lists specify the network prefix (this includes the prefix and length) a specific policy entry applies.

A maximum of five prefix names can be specified.

The no form of this command removes the prefix list match criterion.

Default

no prefix-list

Parameters
name

Specifies the prefix list name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

source-address
Syntax

source-address ip-address

no source-address

Context

config>router>policy-options>policy-statement>entry>from

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command specifies the source address that is embedded in the join or prune packet as a filter criterion. This command specifies a multicast data source address as a match criterion for this entry.

The no form of this command removes the criterion from the configuration.

Parameters
ip-address

Specifies the IP prefix for the IP match criterion in dotted-decimal notation.

Values

ipv4-address — a.b.c.d

ipv6-address — x:x:x:x:x:x:x:x (eight 16-bit pieces

  • x:x:x:x:x:x:d.d.d.d
  • x — 0 to FFFF (hexadecimal)
  • d — 0 to 255 (decimal)

Route policy action commands

action
Syntax

action {accept | next-entry | next-policy | reject}

no action

Context

config>router>policy-options>policy-statement>entry

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command configures actions to take for routes matching a route policy statement entry.

This command is required and must be entered for the entry to be active.

A route policy entry without the action command is considered incomplete and is inactive.

The no form of this command deletes the action context from the entry.

Default

no action

Parameters
accept

Specifies that packets matching the entry match criteria are accepted and processed appropriately.

next-entry

Specifies that the actions specified would be taken and policy evaluation would continue with next policy entry (if any others are specified).

next-policy

Specifies that the actions specified would be made to the route attributes and policy evaluation would continue with next route policy (if any others are specified).

reject

Specifies that packets matching the entry match criteria would be rejected.

default-action
Syntax

default-action {accept | next-entry| reject}

no default-action

Context

config>router>policy-options>policy-statement

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

Commands in this context configure actions for packets that do not match any route policy statement entries when the accept parameter is specified.

The default action clause can be set to all available action states including: accept, reject, next-entry and next-policy. If the action states accept or reject then the policy evaluation terminates and the appropriate result is returned.

If a default action is defined and no match occurred with the entries in the policy, the default action clause is used.

If a default action is defined and one or more matches occurred with the entries of the policy, the default action is not used.

The no form of this command deletes the default-action context for the policy statement.

Default

no default-action

Parameters
accept

Specifies that packets matching the entry match criteria are accepted and processed appropriately.

next-entry

Specifies that the actions specified would be taken and policy evaluation would continue with next policy entry (if any others are specified).

reject

Specifies that packets matching the entry match criteria would be rejected.

Show commands

policy

Syntax

policy [name | prefix-list [name] | admin]

Context

show>router

Platforms

Supported on all 7210 SAS platforms as described in this document

Description

This command displays configured policy statement information.

Parameters
policy name

Displays information similar to the info command, for a specific policy-statement. If a name is provided, the matching policy-statement displays. If no statement name is specified, a list of all policies statements and descriptions display.

prefix-list name

Displays the prefix lists configured in the route policy.

admin

Displayed the entire policy option configuration, including any un-committed configuration changes. This command is similar to the info command.

Output

The following outputs are examples of policy information, and Output fields: show route policy describes the output fields:

Sample output for router policy

The show router policy command displays all configured route policies.

*A:7210-2# show router policy 
===============================================================================
Route Policies
===============================================================================
Policy                           Description                                   
-------------------------------------------------------------------------------
block-igmp                       Reject-Reports-From-Specific-Group-And-Host   
permit-igmp                      Accept-Reports-From-Specific-Group-And-Host   
-------------------------------------------------------------------------------
Policies : 2
===============================================================================
*A:7210-2#
Sample output for router policy admin

The show router policy admin command is similar to the info command, which displays information about the route policies and parameters.


*A:7210-2# show router policy admin 
    prefix-list "host"
        prefix 10.0.0.0/8 longer
    exit
    prefix-list "group"
        prefix 10.6.6.6/32 exact
    exit
    policy-statement "block-igmp"
        description "Reject-Reports-From-Specific-Group-And-Host"
        entry 1
            from
                host-ip "host"
            exit
            action next-entry
            exit
        exit
        entry 2
            from
                group-address "group"
            exit
            action reject
        exit
        default-action accept
        exit                          
    exit
    policy-statement "permit-igmp"
        description "Accept-Reports-From-Specific-Group-And-Host"
        entry 1
            from
                host-ip "host1"
                group-address "group1"
            exit
            action accept
            exit
        exit
        default-action reject
Sample output for router policy name

The show router policy name command displays information about a specific route policy.

*A:7210-2# show router policy permit-igmp 
    description "Accept-Reports-From-Specific-Group-And-Host"
    entry 1
        from
            host-ip "host1"
            group-address "group1"
        exit
        action accept
        exit
    exit
    default-action reject
*A:7210-2#


The show router policy prefix-list command, lists the prefix
-lists configured in the route policy.

*A:7210-2# show router policy prefix-list 
==================================
Prefix Lists
==================================
Prefix List Name                                                               
----------------------------------
host                              
group                             
----------------------------------
Num Prefix Lists: 2
==================================
*A:7210-2#
Table 1. Output fields: show route policy

Label

Description

Policy

Displays a list of route policy names

Description

Displays the description of each route policy

Policies

The total number of policies configured