Login
- Table of Contents
-
- 05-Network Connectivity Command Reference
- 00-Preface
- 01-MAC address table commands
- 02-Ethernet link aggregation commands
- 03-VLAN commands
- 04-Spanning tree commands
- 05-LLDP commands
- 06-Layer 2 forwarding commands
- 07-PPP commands
- 08-L2TP commands
- 09-ARP commands
- 10-IP addressing commands
- 11-DHCP commands
- 12-DHCPv6 commands
- 13-DNS commands
- 14-NAT commands
- 15-IP performance optimization commands
- 16-IPv6 basics commands
- 17-Tunneling commands
- 18-GRE commands
- 19-ADVPN commands
- 20-Basic IP routing commands
- 21-IP forwarding basics commands
- 22-Static routing commands
- 23-IPv6 static routing commands
- 24-RIP commands
- 25-Policy-based routing commands
- 26-IPv6 policy-based routing commands
- 27-OSPF commands
- 28-RIPng commands
- 29-BGP commands
- 30-IGMP snooping commands
- 31-MLD snooping commands
| Title | Size | Download |
|---|---|---|
| 25-Policy-based routing commands | 151.98 KB |
apply default-output-interface
display ip policy-based-route interface
display ip policy-based-route local
display ip policy-based-route setup
reset ip policy-based-route statistics
snmp-agent trap enable policy-based-route
Policy-based routing commands
apply continue
Use apply continue to compare packets with the next policy node upon forwarding failure through the specified path on the current node.
Use undo apply continue to restore the default.
Syntax
apply continue
undo apply continue
Default
PBR does not compare packets with the next policy node upon forwarding failure through the specified path on the current node.
Views
Policy node view
Predefined user roles
network-admin
Usage guidelines
This command takes effect when either of the following conditions exist and the match mode of the node is permit:
· None of the following clauses is configured for packet forwarding:
¡ apply next-hop
¡ apply output-interface
¡ apply default-next-hop
¡ apply default-output-interface
· One or multiple clauses used to direct packet forwarding are configured on the node, but they have become invalid. Then, a routing table lookup also fails for the matching packet.
|
|
NOTE: A clause might become invalid because the specified next hop is unreachable or the specified output interface is down. |
Examples
# Compare with the next policy node upon forwarding failure through the specified path on the current node.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply continue
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 { ip-address [ direct ] [ track track-entry-number ] }&<1-4>
undo apply default-next-hop [] ip-address&<1-4> ]
Default
No default next hops are set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
ip-address: Specifies the IP address of a default next hop.
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-4>: Indicates that you can specify up to four default next hops, each of which can be associated with a track entry.
Usage guidelines
Application scenarios
You can specify multiple default next hops for backup or load sharing in one command line or by executing this command multiple times.
· If the apply loadshare default-next-hop command is not configured on the policy node, multiple default next hops operate in primary/backup mode. PBR selects the first available default next hop according to the configuration order as the primary next hop to guide packet forwarding.
· If the apply loadshare default-next-hop command is configured on the policy node, multiple default next hops operate in load sharing mode. PBR load shares packets in round robin manner, starting from the first configured default next hop. PBR performs per-packet load sharing for packets that do not match any fast forwarding entry, and performs per-flow load sharing for packets that match a fast forwarding entry.
Restrictions and guidelines
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
Related commands
apply loadshare
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 ] }&<1-4>
undo apply default-output-interface [ { interface-type interface-number }&<1-4> ]
Default
No default output interfaces are 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-4>: Indicates that you can specify up to four interfaces, each of which can be associated with a track entry.
Usage guidelines
Application scenarios
You can specify multiple default output interfaces for backup or load sharing in one command line or by executing this command multiple times.
· If the apply loadshare default-output-interface command is not configured on the policy node, multiple default output interfaces operate in primary/backup mode. PBR selects the first available default output interface according to the configuration order as the primary output interface to guide packet forwarding.
· If the apply loadshare default-output-interface command is configured on the policy node, multiple default output interfaces operate in load sharing mode. PBR load shares packets in round robin manner, starting from the first configured default output interface. PBR performs per-packet load sharing for packets that do not match any fast forwarding entry, and performs per-flow load sharing for packets that match a fast forwarding entry.
Restrictions and guidelines
The default output interface must be P2P type. Using a non-P2P default output interface can result in forwarding failures when the interface has multiple next hops. Non-P2P interfaces include broadcast and non-broadcast multi-access (NBMA) interfaces such as Ethernet and virtual-template interfaces. In NBMA networks, packets are sent in unicast.
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 VLAN-interface 2 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 vlan-interface 2
Related commands
apply loadshare
apply ip-df
Use apply ip-df to set the Don't Fragment (DF) bit in the IP header of matching packets.
Use undo apply ip-df to restore the default.
Syntax
apply ip-df df-value
undo apply ip-df
Default
The DF bit is not set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
df-value: Sets the DF bit in the IP header of matching packets. The value can be 0 or 1.
Usage guidelines
Setting the DF bit to 0 allows packet fragmentation.
Setting the DF bit to 1 prohibits packet fragmentation.
Examples
# Set the DF bit in the IP header of matching packets to 0.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply ip-df 0
apply loadshare
Use apply loadshare to enable load sharing among multiple next hops, output interfaces, default next hops, or default output interfaces.
Use undo apply loadshare to restore the default.
Syntax
apply loadshare { default-next-hop | default-output-interface | next-hop | output-interface }
undo apply loadshare { default-next-hop | default-output-interface | next-hop | output-interface }
Default
Multiple next hops, output interfaces, default next hops, or default output interfaces operate in primary/backup mode.
Views
Policy node view
Predefined user roles
network-admin
Parameters
default-next-hop: Enables load sharing among multiple default next hops.
default-output-interface: Enables load sharing among multiple default output interfaces.
next-hop: Enables load sharing among multiple next hops.
output-interface: Enables load sharing among multiple output interfaces.
Usage guidelines
Multiple next hop, output interface, default next hop, or default output interface options operate in either primary/backup or load sharing mode. The following description uses multiple next hops as an example:
· Primary/backup mode—A next hop is selected from all next hops in configuration order for packet forwarding, with all remaining next hops as backups. When the selected next hop fails, the next available next hop takes over.
· Load sharing mode—Matching traffic is distributed across the available next hops. If the traffic does not match any fast forwarding entries, per-packet load sharing is performed. If the traffic matches a fast forwarding entry, per-flow load sharing is performed.
Examples
# Enable load sharing among multiple next hops.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply next-hop 1.1.1.1 2.2.2.2
[Sysname-pbr-aa-11] apply loadshare next-hop
# Enable load sharing among multiple output interfaces.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply output-interface vlan-interface 1 vlan-interface 2
[Sysname-pbr-aa-11] apply loadshare output-interface
# Enable load sharing among multiple default next hops.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply default-next-hop 1.1.1.1 2.2.2.2
[Sysname-pbr-aa-11] apply loadshare default-next-hop
# Enable load sharing among multiple default output interfaces.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] apply default-output-interface vlan-interface 1 vlan-interface 2
[Sysname-pbr-aa-11] apply loadshare default-output-interface
Related commands
apply default-next-hop
apply default-output-interface
apply next-hop
apply output-interface
apply next-hop
Use apply next-hop to set next hops.
Use undo apply next-hop to remove next hops.
Syntax
apply next-hop { ip-address [ direct ] [ track track-entry-number ] }&<1-4>
undo apply next-hop [ ip-address&<1-4> ]
Default
No next hops are set.
Views
Policy node view
Predefined user roles
network-admin
Parameters
ip-address: Specifies the IP address of a next hop.
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-4>: Indicates that you can specify up to four next hops, each of which can be associated with a track entry.
Usage guidelines
Application scenarios
You can specify multiple next hops for backup or load sharing in one command line or by executing this command multiple times.
· If the apply loadshare next-hop command is not configured on the policy node, multiple next hops operate in primary/backup mode. PBR selects the first available next hop according to the configuration order as the primary next hop to guide packet forwarding.
· If the apply loadshare next-hop command is configured on the policy node, multiple next hops operate in load sharing mode. PBR load shares packets in round robin manner, starting from the first configured next hop. PBR performs per-packet load sharing for packets that do not match any fast forwarding entry, and performs per-flow load sharing for packets that match a fast forwarding entry.
Restrictions and guidelines
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
apply loadshare
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-4>
undo apply output-interface [ { interface-type interface-number }&<1-4> ]
Default
No output interfaces are 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-4>: Indicates that you can specify up to four interfaces, each of which can be associated with a track entry.
Usage guidelines
Application scenarios
You can specify multiple output interfaces for backup or load sharing in one command line or by executing this command multiple times.
Restrictions and guidelines
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 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
Related commands
apply loadshare
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
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
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
interface-type interface-number: Specifies an interface by its type and number.
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:
Matches: 0
node 1 permit:
if-match acl 3999
Matches: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2
Matches: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
apply output-interface Vlan-interface3 track 1 (down)
apply output-interface Vlan-interface4 track 2 (inactive)
Matches: 0
Total matches: 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. To issue the policy, you must remove the policy from the interface and then apply it on the interface again. |
|
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. |
|
if-match acl |
Compares packets with the ACL. |
|
apply next-hop |
Specifies a next hop for permitted packets. |
|
apply output-interface |
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. |
|
Matches |
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. |
|
Total matches |
Total number of successful matches on all nodes. |
Related commands
ip policy-based-route
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
Views
Any view
Predefined user roles
network-admin
network-operator
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:
Matches: 0
node 1 permit:
if-match acl 3999
Matches: 0
node 2 permit:
if-match acl 2000
apply next-hop 2.2.2.2
Matches: 0
node 5 permit:
if-match acl 3101
apply next-hop 1.1.1.1
Matches: 0
Total matches: 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. |
|
Matches |
Number of successful matches on the node. |
|
Total matches |
Total number of successful matches on all nodes. |
Related commands
ip local policy-based-route
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 |
Interface where the policy is applied. This field displays N/A for a local PBR policy. |
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 letter a to z or A to Z. The ACL name cannot be all. For the command to take effect, make sure the specified ACL is a basic or advanced ACL.
Usage guidelines
If the specified ACL does not exist or has no rules configured, no packets will match the ACL.
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
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.
Examples
# Match packets with local QoS ID 200.
<Sysname> system-view
[Sysname] policy-based-route aa permit node 11
[Sysname-pbr-aa-11] if-match qos-local-id 200
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
Application scenarios
Use this command to guide forwarding of the packets generated by the device.
Restrictions and guidelines
Before you configure this command, make sure the specified PBR policy already exists. If the PBR policy does not exist, this command cannot take effect.
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 local
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
Application scenarios
Use this command to guide forwarding of the packets on an interface.
Restrictions and guidelines
You can apply only one policy to an interface. Before you can apply a new interface PBR policy to an interface, 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 interface
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 65535.
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
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
snmp-agent trap enable policy-based-route
Use snmp-agent trap enable policy-based-route to enable SNMP notifications for PBR.
Use undo snmp-agent trap enable policy-based-route to disable SNMP notifications for PBR.
Syntax
snmp-agent trap enable policy-based-route
undo snmp-agent trap enable policy-based-route
Default
SNMP notifications are enabled for PBR.
Views
System view
Predefined user roles
network-admin
Usage guidelines
After you enable this feature, PBR can generate notifications and send them to the SNMP module when the next hop becomes invalid. For the PBR notifications to be sent correctly, you must also configure SNMP on the device. For more information about configuring SNMP, see the network management and monitoring configuration guide for the device.
Examples
# Enable SNMP notifications for PBR.
<Sysname> system-view
[Sysname] snmp-agent trap enable policy-based-route
