- Table of Contents
-
- 07-Layer 3 - IP Routing Command Reference
- 00-Preface
- 01-Basic IP routing commands
- 02-Static routing commands
- 03-RIP commands
- 04-OSPF commands
- 05-IS-IS commands
- 06-EIGRP commands
- 07-BGP commands
- 08-Policy-based routing commands
- 09-IPv6 static routing commands
- 10-RIPng commands
- 11-OSPFv3 commands
- 12-IPv6 policy-based routing commands
- 13-Routing policy commands
- 14-DCN commands
- Related Documents
-
Title | Size | Download |
---|---|---|
08-Policy-based routing commands | 80.54 KB |
display ip policy-based-route interface
display ip policy-based-route local
display ip policy-based-route setup
ip policy-based-route-log enable
reset ip policy-based-route statistics
Policy-based routing commands
apply access-vpn vpn-instance
Use apply access-vpn vpn-instance to set VPN instances.
Use undo apply access-vpn vpn-instance to remove VPN instances.
Syntax
apply access-vpn vpn-instance vpn-instance-name
undo apply access-vpn vpn-instance [ vpn-instance-name ]
Default
No VPN instance is specified on a node.
Views
Policy node view
Predefined user roles
network-admin
Parameters
vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. The specified VPN must already exist.
Usage guidelines
This command is not supported on SPC, CSPC (excluding CSPC-GE16XP4L-E, CSPC-GE24L-E, and CSPC-GP24GE8XP2L-E), or CMPE-1104 cards.
With a VPN instance specified, the undo apply access-vpn vpn-instance command removes the VPN instance.
Without any VPN instances specified, the undo apply access-vpn vpn-instance command removes all VPN instances.
Examples
# Set VPN 1 on node 10. In this example, VPN 1 has been created.
<Sysname> system-view
[Sysname] policy-based-route policy1 permit node 10
[Sysname-pbr-policy1-10] apply access-vpn vpn-instance vpn1
apply default-next-hop
Use apply default-next-hop to set default next hops.
Use undo apply default-next-hop to remove default next hops.
Syntax
apply default-next-hop [ vpn-instance vpn-instance-name ] { ip-address [ direct ] [ track track-entry-number ] }&<1-2>
undo apply default-next-hop [ [ vpn-instance vpn-instance-name ] ip-address&<1-2> ]
Default
No default next hop is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
vpn-instance vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. The specified VPN instance must already exist.
ip-address: Specifies the IP address of a default next hop. If you do not specify the vpn-instance vpn-instance-name option, the default next hop belongs to the public network.
direct: Specifies a directly connected default next hop.
track track-entry-number: Specifies a track entry by its number in the range of 1 to 1024.
Usage guidelines
This command is not supported on SPC, CSPC (excluding CSPC-GE16XP4L-E, CSPC-GE24L-E, and CSPC-GP24GE8XP2L-E), or CMPE-1104 cards.
You can specify multiple default next hops for backup or load sharing in one command line or by executing this command multiple times.
If you do not specify a default next hop when you execute the undo form of this command, all default next hops on the node are removed.
Examples
# Set a directly-connected default next hop of 1.1.1.1.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply default-next-hop 1.1.1.1 direct
apply next-hop
Use apply next-hop to set next hops.
Use undo apply next-hop to remove next hops.
Syntax
apply next-hop [ vpn-instance vpn-instance-name ] { ip-address [ direct ] [ track track-entry-number ] }&<1-2>
undo apply next-hop [ [ vpn-instance vpn-instance-name ] ip-address&<1-2> ]
Default
No next hop is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
vpn-instance vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. The specified VPN instance must already exist.
ip-address: Specifies the IP address of a next hop. If you do not specify the vpn-instance vpn-instance-name option, the next hop belongs to the public network.
direct: Specifies that the next hop must be directly connected to take effect.
track track-entry-number: Specifies a track entry by its number in the range of 1 to 1024.
&<1-2>: Indicates that you can specify up to two next hops, each of which can be associated with a track entry.
Usage guidelines
You can specify multiple next hops for backup or load sharing in one command line or by executing this command multiple times.
If you do not specify a next hop when you execute the undo form of this command, all next hops on the node are removed.
Examples
# Set a directly-connected next hop of 1.1.1.1.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply next-hop 1.1.1.1 direct
ip policy-based-route-log enable
apply output-interface
Use apply output-interface to set output interfaces.
Use undo apply output-interface to remove output interfaces.
Syntax
apply output-interface { interface-type interface-number [ track track-entry-number ] }
undo apply output-interface [ interface-type interface-number ]
Default
No output interface is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
interface-type interface-number: Specifies an interface by its type and number.
track track-entry-number: Specifies a track entry by its number in the range of 1 to 1024.
Usage guidelines
This command is not supported on SPC, CSPC (excluding CSPC-GE16XP4L-E, CSPC-GE24L-E, and CSPC-GP24GE8XP2L-E), or CMPE-1104 cards.
The output interface must be P2P type. Using a non-P2P output interface can result in forwarding failures when the interface has multiple next hops. Non-P2P interfaces include broadcast and NBMA interfaces such as Ethernet and virtual-template interfaces.
If you do not specify an output interface when you execute the undo form of this command, all output interfaces on the node are removed.
Examples
# Specify GigabitEthernet 3/1/1 as the output interface for IP packets.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply output-interface gigabitethernet 3/1/1
apply precedence
Use apply precedence to set a precedence for IP packets.
Use undo apply precedence to restore the default.
Syntax
apply precedence { type | value }
undo apply precedence
Default
No precedence is set for IP packets.
Views
Policy node view
Predefined user roles
network-admin
Parameters
type: Specifies the precedence type for IP packets.
value: Specifies the precedence for IP packets. Eight precedence values (0 to 7) are available. Each precedence value corresponds to a precedence type, as shown in Table 1. You can set either a precedence value or a precedence type for IP packets.
Table 1 IP precedence value and type mappings
Precedence value |
Precedence type |
0 |
routine |
1 |
priority |
2 |
immediate |
3 |
flash |
4 |
flash-override |
5 |
critical |
6 |
internet |
7 |
network |
Examples
# Set the precedence to 5 (critical) for IP packets.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply precedence critical
display ip policy-based-route
Use display ip policy-based-route to display PBR policy information.
Syntax
display ip policy-based-route [ policy policy-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
policy policy-name: Specifies a policy by its name, a case-sensitive string of 1 to 19 characters. If you do not specify a policy, this command displays information for all PBR policies.
Examples
# Display all policy information.
<Sysname> display ip policy-based-route
Policy name: aaa
node 1 permit:
if-match acl 2000
apply next-hop 1.1.1.1
Table 2 Command output
Field |
Description |
node 1 permit |
The match mode of Node 1 is permit. |
if-match acl |
Compares packets with the ACL. |
apply next-hop |
Specifies a next hop for permitted packets. |
Related commands
policy-based-route
display ip policy-based-route interface
Use display ip policy-based-route interface to display interface PBR configuration and statistics.
Syntax
In standalone mode:
display ip policy-based-route interface interface-type interface-number [ slot slot-number ]
In IRF mode:
display ip policy-based-route interface interface-type interface-number [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
interface-type interface-number: Specifies an interface by its type and number.
slot slot-number: Specifies a card by its slot number. If you do not specify a card, this command displays information on the active MPU. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies a card on an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the card. If you do not specify a card, this command displays information on the global active MPU. (In IRF mode.)
Examples
# Display PBR configuration and statistics on GigabitEthernet 3/1/1.
<Sysname> display ip policy-based-route interface gigabitethernet 3/1/1
Policy based routing information for interface GigabitEthernet3/1/1:
Policy name: aaa
node 0 deny:
Matched: 0
node 1 permit:
if-match acl 3999
Matched: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2
Matched: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
apply output-interface GigabitEthernet3/1/2 track 1
apply output-interface GigabitEthernet3/1/3 track 2
Matched: 0
Total matched: 0
<Sysname> display ip policy-based-route interface gigabitethernet 3/1/1
Policy based routing information for interface GigabitEthernet3/1/1:
Policy name: aaa
node 0 deny:
Matched: 0
node 1 permit:
if-match acl 3999
Matched: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2
apply output-interface GigabitEthernet3/1/2 track 1
apply output-interface GigabitEthernet3/1/3 track 2
Matched: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
Matched: 0
Total matched: 0
Table 3 Command output
Field |
Description |
Policy based routing information for interface xxxx |
PBR configuration and statistics on the interface. This field displays failed in brackets if none of the nodes in the policy has been successfully issued to the driver. The failed status will persist even after the policy is successfully issued. To clear the failed status, you must remove the policy from the interface and then apply it on the interface again. NOTE: The failed status is available on a per-slot basis. To obtain this information, you must specify a slot number when you execute the command. · For a global interface (for example, a VLAN interface), which might have member physical interfaces on multiple slots, specify a slot that contains its member interfaces. · For a physical interface, specify its slot number. |
node 0 deny node 2 permit |
Match mode of the node, permit or deny. If a node fails to be issued to the driver, the command displays the cause in brackets, which include: · not support—The device does not support the match criteria configured on the node. · no resource—No sufficient resources (for example, ACLs) are available for the node. NOTE: The cause is available only on a per-slot basis. To obtain this information, you must specify a slot number when you execute the command. · For a global interface (for example, a VLAN interface), which might have member physical interfaces on multiple slots, specify a slot that contains its member interfaces. · For a physical interface, specify its slot number. |
if-match acl |
Compares packets with the ACL. |
apply next-hop |
Specifies a next hop for permitted packets. |
apply output-interface track 1 (down) |
Specifies an output interface and its associated track entry for permitted packets. This field displays the interface status in brackets. · up—The interface is up. · down—The interface is down at network layer. · inactive—The card that hosts the interface is not in position. |
Matched: 0 |
Number of successful matches on the node. If the device does not have sufficient resources to count matches, this field displays no statistics resource in brackets. NOTE: The statistics collection failure cause is available only on a per-slot basis. To obtain this information, you must specify a slot number when you execute the command. · For a global interface (for example, a VLAN interface), which might have member physical interfaces on multiple slots, specify a slot that contains its member interfaces. · For a physical interface, specify its slot number. |
Total matched |
Total number of successful matches on all nodes. |
Related commands
reset ip policy-based-route statistics
display ip policy-based-route local
Use display ip policy-based-route local to display local PBR configuration and statistics.
Syntax
In standalone mode:
display ip policy-based-route local [ slot slot-number ]
In IRF mode:
display ip policy-based-route local [ chassis chassis-number slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies a card by its slot number. If you do not specify a card, this command displays local PBR configuration and statistics for the active MPU. (In standalone mode.)
chassis chassis-number slot slot-number: Specifies a card on an IRF member device. The chassis-number argument represents the member ID of the IRF member device. The slot-number argument represents the slot number of the card. If you do not specify a card, this command displays local PBR configuration and statistics for the global active MPU. (In IRF mode.)
Examples
# Display local PBR configuration and statistics.
<Sysname> display ip policy-based-route local
Policy based routing information for local:
Policy name: aaa
node 0 deny:
Matched: 0
node 1 permit:
if-match acl 3999
Matched: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2
Matched: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
Matched: 0
Total matched: 0
Table 4 Command output
Field |
Description |
Policy based routing information for local |
Local PBR configuration and statistics. |
node 0 deny/node 2 permit |
Match mode of the node: permit or deny. |
if-match acl |
Compares packets with the ACL. |
apply next-hop |
Specifies a next hop for permitted packets. |
Matched: 0 |
Number of successful matches on the node. |
Total matched |
Total number of successful matches on all nodes. |
Related commands
reset ip policy-based-route statistics
display ip policy-based-route setup
Use display ip policy-based-route setup to display PBR configuration.
Syntax
display ip policy-based-route setup
Views
Any view
Predefined user roles
network-admin
network-operator
Examples
# Display PBR configuration.
Policy name Type Interface
aaa Forward GigabitEthernet3/1/1
aaa Forward GigabitEthernet3/1/2
aaa Local N/A
Table 5 Command output
Field |
Description |
Type |
Type of the PBR: · Forward—Interface PBR. · Local—Local PBR. |
Interface Name |
Interface where the policy is applied. |
Related commands
ip policy-based-route
if-match acl
Use if-match acl to set an ACL match criterion.
Use undo if-match acl to restore the default.
Syntax
if-match acl { acl-number | name acl-name }
undo if-match acl
Default
No ACL match criterion is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
acl-number: Specifies an ACL by its number in the range of 2000 to 2999 for a basic ACL, and in the range of 3000 to 3999 for an advanced ACL.
name acl-name: Specifies an ACL by its name, a case-insensitive string of 1 to 63 characters starting with a letter. The ACL name cannot be all.
Examples
# Configure Node 11 of policy aa to permit the packets matching ACL 2011.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] if-match acl 2011
# Configure Node 11 of policy aa to permit the packets matching ACL aaa.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] if-match acl name aaa
ip local policy-based-route
Use ip local policy-based-route to specify a policy for local PBR.
Use undo ip local policy-based-route to restore the default.
Syntax
ip local policy-based-route policy-name
undo ip local policy-based-route
Default
No policy is referenced for local PBR.
Views
System view
Predefined user roles
network-admin
Parameters
policy-name: Specifies a policy by its name, a case-sensitive string of 1 to 19 characters. The specified policy must already exist.
Usage guidelines
Local PBR guides the forwarding of locally generated packets, such as ICMP packets generated by using the ping command.
Local PBR might affect local services, such as ping and Telnet. When you use local PBR, make sure you fully understand its impact on local services of the device.
You can specify only one policy for local PBR and must make sure the specified policy already exists.
Before you apply a new policy, you must first remove the current policy.
Examples
# Configure local PBR based on policy aaa.
<Sysname> system-view
[Sysname] ip local policy-based-route aaa
Related commands
display ip policy-based-route setup
policy-based-route
ip policy-based-route
Use ip policy-based-route to specify a policy for interface PBR on an interface.
Use undo ip policy-based-route to restore the default.
Syntax
ip policy-based-route policy-name [ share-mode ]
undo ip policy-based-route
Default
No policy is applied to an interface.
Views
Interface view
Predefined user roles
network-admin
Parameters
policy-name: Specifies a policy by its name, a case-sensitive string of 1 to 19 characters. The specified policy must already exist.
share-mode: Applies the policy in resource sharing mode. All interfaces applied with the policy on a card use the same hardware resources. If you do not specify this keyword, the interfaces use different hardware resources. On an interface, you can configure only one application in QoS and ACL resource sharing mode for traffic in one direction. The device supports only the packet filtering, QoS policy, and PBR applications. For information about packet filtering and QoS policies, see ACL commands and QoS policy commands in ACL and QoS Command Reference.
Usage guidelines
Typically, each interface on a card uses different hardware resources for a policy. To avoid resource usage overhead, you can specify the resource sharing mode when applying the policy to each interface. The interfaces will use the same hardware resources.
You can specify only one mode for the policy on an interface. Before you change the mode of the policy, you must first remove the current policy from the interface.
The resource sharing mode is supported only on CSPEX (excluding CSPEX-1204 and CSPEX-1104-E) cards.
Examples
# Apply policy aaa to GigabitEthernet 3/1/1.
<Sysname> system-view
[Sysname] interface gigabitethernet 3/1/1
[Sysname-GigabitEthernet3/1/1] ip policy-based-route aaa
Related commands
display ip policy-based-route setup
policy-based-route
ip policy-based-route-log enable
Use ip policy-based-route-log enable to enable the PBR logging feature.
Use undo ip policy-based-route-log enable to disable the PBR logging feature.
Syntax
ip policy-based-route-log enable
undo ip policy-based-route-log enable
Default
The PBR logging feature is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
The PBR logging feature helps the administrator locate and fix faults. The feature logs PBR events and sends the logs to the information center. The information center processes the logs according to output rules. For more information about the information center, see Network Management and Monitoring Configuration Guide.
Excessive PBR log messages degrade the performance of the device. To avoid this problem, disable the PBR logging feature.
Examples
# Enable the PBR logging feature.
<Sysname> system-view
[Sysname] ip policy-based-route-log enable
Related commands
apply next-hop
policy-based-route
policy-based-route
Use policy-based-route to create a policy node and enter its view, or enter the view of an existing policy node.
Use undo policy-based-route to delete a policy or policy node.
Syntax
policy-based-route policy-name [ deny | permit ] node node-number
undo policy-based-route policy-name [ deny | node node-number | permit ]
Default
No policy nodes exist.
Views
System view
Predefined user roles
network-admin
Parameters
policy-name: Specifies a policy by its name, a case-sensitive string of 1 to 19 characters.
deny: Specifies the match mode for the policy node as deny.
permit: Specifies the match mode for the policy node as permit (default mode).
node node-number: Specifies a policy node by its number. A smaller number has a higher priority. The value range for the node-number argument is 0 to 255.
Usage guidelines
A policy that has been applied to an interface or locally cannot be deleted. To delete it, you must first cancel the application.
· If a policy node is specified, the undo policy-based-route command deletes the specified policy node.
· If a match mode is specified, the command deletes all nodes configured with the match mode.
· If no policy node or match mode is specified, the command deletes the whole policy.
Examples
# Create permit-mode of Node 10 for policy policy1 and enter its view.
<Sysname> system-view
[Sysname] policy-based-route policy1 permit node 10
[Sysname-pbr-policy1-10]
Related commands
display ip policy-based-route
ip policy-based-route-log enable
reset ip policy-based-route statistics
Use reset ip policy-based-route statistics to clear PBR statistics.
Syntax
reset ip policy-based-route statistics [ policy policy-name ]
Views
User view
Predefined user roles
network-admin
Parameters
policy policy-name: Specifies a policy by its name, a case-sensitive string of 1 to 19 characters. If you do not specify a policy, this command clears PBR statistics for all policies.
Examples
# Clear all PBR statistics.
<Sysname> reset ip policy-based-route statistics
Related commands
display ip policy-based-route interface
display ip policy-based-route local