- Table of Contents
-
- 04-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-BGP commands
- 07-Policy-based routing commands
- 08-IPv6 static routing commands
- 09-RIPng commands
- 10-OSPFv3 commands
- 11-IPv6 policy-based routing commands
- 12-Routing policy commands
- 13-DCN commands
- Related Documents
-
Title | Size | Download |
---|---|---|
07-Policy-based routing commands | 114.76 KB |
Contents
apply default-output-interface
display ip policy-based-route interface
display ip policy-based-route local
display ip policy-based-route setup
ip policy-based-route-log enable
ip policy-based-route vxlan-mode 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 for 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
With a VPN instance specified, the undo apply access-vpn vpn-instance command removes the VPN instance.
Without any VPN instance specified, the undo apply access-vpn vpn-instance command removes all VPN instances.
Examples
# Set VPN 1 for node 10. (VPN 1 already exists. already exist.)
<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 to which the default next hop belongs. The vpn-instance-name argument is a case-sensitive string of 1 to 31 characters. If the default next hop belongs to the public network, do not specify this option.
ip-address: Specifies the IP address of the 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.
&<1-2>: Indicates that you can specify up to two default next hops.
Usage guidelines
You can specify multiple default next hops for backup in one command line or by executing this command multiple times.
With a default next hop specified, the undo apply default-next-hop command removes the default next hop.
Without any default next hop specified, the undo apply default-next-hop command removes all default next hops.
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 default-output-interface
Use apply default-output-interface to set default output interfaces.
Use undo apply default-output-interface to remove default output interfaces.
Syntax
apply default-output-interface interface-type interface-number [ track track-entry-number ]
undo apply default-output-interface [ interface-type interface-number ]
Default
No default 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
With a default output interface specified, the undo apply default-output-interface command removes the default output interface.
Without any default output interface specified, the undo apply default-output-interface command removes all default output interfaces.
Examples
# Specify Tunnel 11 as the default output interface for IP packets.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply default-output-interface Tunnel 11
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 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-2>: Indicates that you can specify up to two next hops.
Usage guidelines
You can specify multiple next hops for backup 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 ]
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
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 VLAN-interface 2 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 vlan-interface 2
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 precedences and corresponding types
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
apply statistics
Use apply statistics to enable match counting on a policy node.
Use undo apply statistics to restore the default.
Syntax
apply statistics
undo apply statistics
Default
Match counting is disabled on a policy node.
Views
Policy node view
Predefined user roles
network-admin
Usage guidelines
To include the number of successful matches and matching bytes on a policy node in the statistics displayed by a display command, execute this command. As a best practice to conserve hardware resources, disable this counting function.
This apply clause is always executed for the policy node.
Examples
# Enable match counting on policy node 11.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply statistics
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
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 a device by its ID, which is fixed at 1.
Examples
# Display PBR configuration and statistics on VLAN-interface 2.
<Sysname> display ip policy-based-route interface vlan-interface 2
Policy based routing information for interface Vlan-interface2(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
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
apply output-interface Vlan-interface3 track 1
apply output-interface Vlan-interface4 track 2
Matched: 0, bytes: 0
Total matched: 0, total bytes: 0
<Sysname> display ip policy-based-route interface vlan-interface 2
Policy based routing information for interface Vlan-interface2:
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
apply output-interface Vlan-interface3 track 1
apply output-interface Vlan-interface4 track 2
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
Matched: 0, bytes: 0
Total matched: 0, total bytes: 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 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. · 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. 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 (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. |
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 a device by its ID, which is fixed at 1.
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
Matched: 0, bytes: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
Matched: 0, bytes: 0
Total matched: 0, total bytes: 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. 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.
<Sysname> display ip policy-based-route setup
Policy name Type Interface
pr01 Forward Vlan-interface2
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
if-match qos-local-id
Use if-match qos-local-id to set a local QoS ID match criterion.
Use undo if-match qos-local-id to restore the default.
Syntax
if-match qos-local-id local-id-value qppb-manipulation
undo if-match qos-local-id
Default
No local QoS ID match criterion is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
local-id-value: Specifies a local QoS ID in the range of 1 to 4095.
qppb-manipulation: Applies the match criterion only to QPPB when the device acts as a BGP receiver. A received packet matches the policy node if the local QoS ID obtained from its matching route entry is identical to the specified local QoS ID criterion. For more information about QPPB, see ACL and QoS Configuration Guide.
Usage guidelines
This command takes effect only on HFR cards and only when the TCAM operating mode of the device is routing or mix. For more information about TCAM operating modes, see device management in Fundamentals Configuration Guide.
Examples
# Match packets with local QoS ID 200, and apply the match criterion only to QPPB.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] if-match qos-local-id 200 qppb-manipulation
if-match vxlan-id
Use if-match vxlan-id to set a VXLAN match criterion
Use undo if-match vxlan-id to restore the default.
Syntax
if-match vxlan-id vxlan-id
undo if-match vxlan-id
Default
No VXLAN match criterion is set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
vxlan-id: Specifies a VXLAN ID in the range of 0 to 16777215.
Examples
# Configure Node 11 of policy aaa to permit packets with the VXLAN ID 1000.
<Sysname> system-view
[Sysname] policy-based-route aaa permit node 11
[Sysname-pbr-aaa-11] if-match vxlan-id 1000
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 [ 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. In this mode, all interfaces on an interface card with the same policy applied share one hardware resource. If you do not specify this keyword, each interface occupies one independent hardware resource. You can apply only one ACL, QoS policy, or PBR policy with the share-mode keyword specified to one direction of an interface. For information about ACL and QoS policies, see ACL commands and QoS policy commands in ACL and QoS Command Reference.
This keyword is supported only in R3608 and later.
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 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 VLAN-interface 2.
<Sysname> system-view
[Sysname] interface vlan-interface 2
[Sysname-Vlan-interface2] 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
ip policy-based-route vxlan-mode enable
Use ip policy-based-route vxlan-mode enable to enable VXLAN-mode PBR.
Use undo ip policy-based-route vxlan-mode enable to disable VXLAN-mode PBR.
Syntax
ip policy-based-route vxlan-mode enable
undo ip policy-based-route vxlan-mode enable
Default
VXLAN-mode PBR is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
VXLAN-mode PBR enables you to guide packets from a site-facing interface on a VXLAN VTEP to a VXLAN tunnel by using a PBR policy. If VXLAN-mode PBR is not enabled, the PBR policy on a site-facing interface cannot guide packets to a VXLAN tunnel.
Execute this command before you apply a PBR policy to a site-facing interface. This command requires updating forwarding entries, which is time-consuming and might cause inadequate table entry resources.
Examples
# Enable VXLAN-mode PBR.
<Sysname> system-view
[Sysname] ip policy-based-route vxlan-mode enable
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 2047.
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