- Table of Contents
-
- 05-Layer 3—IP Routing Command Reference
- 00-Preface
- 01-Basic IP routing commands
- 02-Static routing commands
- 03-OSPF commands
- 04-IS-IS commands
- 05-BGP commands
- 06-Policy-based routing commands
- 07-IPv6 static routing commands
- 08-OSPFv3 commands
- 09-IPv6 policy-based routing commands
- 10-Routing policy commands
- 11-DCN commands
- Related Documents
-
| Title | Size | Download |
|---|---|---|
| 06-Policy-based routing commands | 116.04 KB |
Contents
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 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-n>
undo apply next-hop [ [ vpn-instance vpn-instance-name ] ip-address&<1-n> ]
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 to which the next hop belongs. The vpn-instance-name argument is a case-sensitive string of 1 to 31 characters. If the next hop belongs to the public network, do not specify this option.
ip-address: Specifies the IP address of the 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-n>: Indicates that you can specify up to n next hops. The value for n is 2.
Usage guidelines
You can specify multiple next hops for backup or load sharing in one command line or by executing this command multiple times.
With a next hop specified, the undo apply next-hop command removes the next hop.
Without any next hop specified, the undo apply next-hop command removes all next hops.
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 ] }&<1-n>
undo apply output-interface [ { interface-type interface-number }&<1-n> ]
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.
&<1-n>: Indicates that you can specify up to n interfaces.
Usage guidelines
You can specify multiple output interfaces for backup or load sharing in one command line or by executing this command multiple times.
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.
With an output interface specified, the undo apply output-interface command removes the output interface.
Without any output interface specified, the undo apply output-interface command removes all output interfaces.
Examples
# Specify GigabitEthernet 1/0/12 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 1/0/12
Related commands
apply loadshare
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 (active)
apply next-hop 2.2.2.2 (active)
Table 1 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 (active) |
Specifies a next hop for permitted packets. This field also displays the state of the next hop. · active—The next hop is reachable. · inactive—The next hop is unreachable. |
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
display ip policy-based-route interface interface-type interface-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 an IRF member device by its member ID. If you do not specify a member device, this command displays interface PBR configuration and statistics on the master device.
Examples
# Display PBR configuration and statistics on GigabitEthernet 1/0/12.
<Sysname> display ip policy-based-route interface gigabitethernet 1/0/12
Policy based routing information for interface GigabitEthernet1/0/12(failed):
Policy name: aaa
node 0 deny:
Matched: 0, bytes: 0
node 1 permit:
if-match acl 3999
Matched: 0, bytes: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2 (active)
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1 (active)
Matched: 0, bytes: 0
Total matched: 0, total bytes: 0
<Sysname> display ip policy-based-route interface gigabitethernet 1/0/12
Policy based routing information for interface GigabitEthernet1/0/12:
Policy name: aaa
node 0 deny:
Matched: 0, bytes: 0
node 1 permit:
if-match acl 3999
Matched: 0, bytes: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2 (active)
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1 (active)
Matched: 0, bytes: 0
Total matched: 0, total bytes: 0
Table 2 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 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, 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, 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 (active) |
Specifies a next hop for permitted packets. This field also displays the state of the next hop. · active—The next hop is reachable. · inactive—The next hop is unreachable. |
|
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. If the device does not support counting successful matches on a node, this field displays N/A. If match counting is disabled on the node, this field is not displayed. 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, 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. |
|
bytes: |
Number of matching bytes on the node. This field displays N/A if the device does not support counting matching bytes on a node. This field is not displayed if match counting is disabled on the node. |
|
Total matched |
Total number of successful matches on all nodes. This field displays N/A if the device does not support counting successful matches on a node. This field is not displayed if match counting is disabled on all nodes. |
|
total bytes: |
Total number of matching bytes on all nodes. This field displays N/A if the device does not support counting matching bytes on a node. This field is not displayed if match counting is disabled 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
display ip policy-based-route local [ slot slot-number ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
slot slot-number: Specifies an IRF member device by its member ID. If you do not specify a member device, this command displays local PBR configuration and statistics on the master device.
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, bytes: 0
node 1 permit:
if-match acl 3999
Matched: 0, bytes: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2 (active)
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1 (active)
Matched: 0, bytes: 0
Total matched: 0, total bytes: 0
Table 3 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 (active) |
Specifies a next hop for permitted packets. This field also displays the state of the next hop. · active—The next hop is reachable. · inactive—The next hop is unreachable. |
|
Matched: 0 |
Number of successful matches on the node. This field displays N/A if the device does not support counting successful matches on a node. This field is not displayed if match counting is disabled on the node. |
|
bytes: |
Number of matching bytes on the node. This field displays N/A if the device does not support counting matching bytes on a node. This field is not displayed if match counting is disabled on the node. |
|
Total matched |
Total number of successful matches on all nodes. This field displays N/A if the device does not support counting successful matches on a node. This field is not displayed if match counting is disabled on all nodes. |
|
total bytes: |
Total number of matching bytes on all nodes. This field displays N/A if the device does not support counting matching bytes on a node. This field is not displayed if match counting is disabled 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 GigabitEthernet1/0/12
aaa Forward GigabitEthernet1/0/13
aaa Local N/A
Table 4 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 specified 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
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.
Usage guidelines
You can apply only one policy to an interface. Before you apply a new policy, you must first remove the current policy from the interface.
Examples
# Apply policy aaa to GigabitEthernet 1/0/12.
<Sysname> system-view
[Sysname] interface gigabitethernet 1/0/12
[Sysname-GigabitEthernet1/0/12] 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
