- Table of Contents
-
- 09-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-Basic BGP commands
- 07-Advanced 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-RIR commands
- Related Documents
-
Title | Size | Download |
---|---|---|
02-Static routing commands | 208.43 KB |
Contents
display route-static routing-table
ip route-static default-preference
ip route-static fast-reroute auto
ip route-static primary-path-detect bfd echo
ip route-static recursive-lookup tunnel
Static routing commands
delete static-routes all
Use delete static-routes all to delete all static routes.
Syntax
delete [ vpn-instance vpn-instance-name ] static-routes all
Views
System 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. If you do not specify a VPN instance, the command deletes all static routes for the public network.
Usage guidelines
CAUTION: This command might interrupt network communication and cause packet forwarding failure. Before executing the command, make sure you fully understand the potential impact on the network. |
When you use this command, the system will prompt you to confirm the operation before deleting all the static routes.
To delete one static route, use the undo ip route-static command. To delete all static routes, including the default route, use the delete static-routes all command.
Examples
# Delete all static routes.
<Sysname> system-view
[Sysname] delete static-routes all
This will erase all IPv4 static routes and their configurations, you must reconfigure all static routes.
Are you sure?[Y/N]:y
Related commands
ip route-static
display route-static nib
Use display route-static nib to display static route next hop information.
Syntax
display route-static nib [ nib-id ] [ verbose ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
nib-id: Specifies a NIB by its ID, a hexadecimal string of 1 to ffffffff. If you do not specify this argument, the command displays all static route next hop information.
verbose: Displays detailed static route next hop information. If you do not specify this keyword, the command displays brief static route next hop information.
Examples
# Displays brief static route next hop information.
<Sysname> display route-static nib
Total number of nexthop(s): 44
NibID: 0x11000000 Sequence: 0
Type: 0x21 Flushed: Yes
Age: 00h01m50s
UserKey0: 0x111 VrfNthp: 0
UserKey1: 0x0 Nexthop: 0.0.0.0
UserKey2: 0x0 IFIndex: 0x111
UserKey3: 0x0 LocalAddr: 0.0.0.0
TopoNthp: 0 ExtType: 0x0
Color: 0 COFlag: 0x0
LinkID: 0x0
SIDIndex: 0x0 SRPName:
OriNexthop: 0.0.0.0
NibID: 0x11000001 Sequence: 1
Type: 0x41 Flushed: Yes
Age: 00h01m50s
UserKey0: 0x0 VrfNthp: 5
UserKey1: 0x0 Nexthop: 2.2.2.2
UserKey2: 0x0 IFIndex: 0x111
UserKey3: 0x0 LocalAddr: 0.0.0.0
TopoNthp: 0 ExtType: 0x0
Color: 0 COFlag: 0x0
LinkID: 0x0
SIDIndex: 0x0 SRPName:
OriNexthop: 0.0.0.0
Table 1 Command output
Field |
Description |
NibID |
ID of the NIB. |
Sequence |
Sequence number of the NIB. |
Type |
Type of the NIB. |
Flushed |
Indicates whether the route with the NIB has been flushed to the FIB. |
Age |
Elapsed time since the next hop information was last updated. |
UserKey0 |
Reserved data 1. |
UserKey1 |
Reserved data 2. |
UserKey2 |
Reserved data 3. |
UserKey3 |
Reserved data 4. |
VrfNthp |
Index of the VPN instance to which the next hop belongs. This field displays 0 if the next hop is on the public network. |
Nexthop |
Next hop address. |
IFIndex |
Interface index |
LocalAddr |
Local interface address. |
TopoNthp |
Index of the topology that contains the next hop. This field displays 0 if the next hop is on the public network. |
ExtType |
NIB extension type. |
Color |
Color extended community attribute. |
COFlag |
Flag of the color extended community attribute. |
LinkID |
Link ID of the SDWAN TTE connection. |
SIDIndex |
SID index value. |
SRPName |
This field is not supported in the current software version. SR-MPLS TE policy name. |
OriNexthop |
Original next hop address of the route. If the route is obtained from a BGP UPDATE message, the address is the next hop IP address in the BGP UPDATE message. |
# Displays detailed static route next hop information.
<Sysname> display route-static nib verbose
Total number of nexthop(s): 44
NibID: 0x11000000 Sequence: 0
Type: 0x21 Flushed: Yes
Age: 00h01m50s
UserKey0: 0x111 VrfNthp: 0
UserKey1: 0x0 Nexthop: 0.0.0.0
UserKey2: 0x0 IFIndex: 0x10002
UserKey3: 0x0 LocalAddr: 0.0.0.0
TopoNthp: 0 ExtType: 0x0
Color: 0 COFlag: 0x0
LinkID: 0x0
SIDIndex: 0x0 SRPName:
OriNexthop: 0.0.0.0
RefCnt: 2 FlushRefCnt: 0
Flag: 0x2 Version: 1
1 nexthop(s):
PrefixIndex: 0 OrigNexthop: 0.0.0.0
RelyDepth: 0 RealNexthop: 0.0.0.0
Interface: NULL0 LocalAddr: 0.0.0.0
TunnelCnt: 0 Vrf: default-vrf
TunnelID: N/A Topology: base
Weight: 1000000 Flags: 0x0
SRPolicyNID: 4294967295 SRInterface:
ColorWeight: 0 Locator: N/A
OrigLinkID: 0x0 RealLinkID: 0x0
NibID: 0x11000001 Sequence: 1
Type: 0x41 Flushed: Yes
Age: 00h01m50s
UserKey0: 0x0 VrfNthp: 5
UserKey1: 0x0 Nexthop: 2.2.2.2
UserKey2: 0x0 IFIndex: 0x10002
UserKey3: 0x0 LocalAddr: 0.0.0.0
TopoNthp: 0 ExtType: 0x0
Color: 0 COFlag: 0x0
LinkID: 0x0
SIDIndex: 0x0 SRPName:
OriNexthop: 0.0.0.0
RefCnt: 1 FlushRefCnt: 0
Flag: 0x12 Version: 1
2 nexthop(s):
PrefixIndex: 0 OrigNexthop: 2.2.2.2
RelyDepth: 7 RealNexthop: 8.8.8.8
Interface: XGE0/0/6 LocalAddr: 12.12.12.12
TunnelCnt: 0 Vrf: default-vrf
TunnelID: N/A Topology: base
Weight: 1000000 Flags: 0x0
SRPolicyNID: 4294967295 SRInterface:
ColorWeight: 0 Locator: N/A
OrigLinkID: 0x0 RealLinkID: 0x0
PrefixIndex: 0 OrigNexthop: 2.2.2.2
RelyDepth: 9 RealNexthop: 0.0.0.0
Interface: NULL0 LocalAddr: 0.0.0.0
TunnelCnt: 0 Vrf: default-vrf
TunnelID: N/A Topology: base
Weight: 1000000 Flags: 0x0
SRPolicyNID: 4294967295 SRInterface:
ColorWeight: 0 Locator: N/A
OrigLinkID: 0x0 RealLinkID: 0x0
...
Table 2 Command output
Field |
Description |
NibID |
ID of the NIB. |
Sequence |
Sequence number of the NIB. |
Type |
Type of the NIB. |
Flushed |
Indicates whether the route with the NIB has been flushed to the FIB. |
Age |
Elapsed time since the next hop information was last updated. |
UserKey0 |
Reserved data 1. |
VrfNthp |
Index of the VPN instance that the next hop belongs to. This field displays 0 if the next hop is on the public network. |
UserKey1 |
Reserved data 2. |
UserKey2 |
Reserved data 3. |
UserKey3 |
Reserved data 4. |
Nexthop |
Next hop address. |
IFIndex |
Interface index |
LocalAddr |
Local interface address. |
TopoNthp |
Index of the topology that contains the next hop. This field displays 0 if the next hop is on the public network. |
ExtType |
NIB extension type. |
Color |
Color extended community attribute. |
COFlag |
Flag of the color extended community attribute. |
LinkID |
Link ID of the SDWAN TTE connection. |
SIDIndex |
SID index value. |
SRPName |
This field is not supported in the current software version. SR-MPLS TE policy name. |
OriNexthop |
Original next hop address of the route. If the route is obtained from a BGP UPDATE message, the address is the next hop IP address in the BGP UPDATE message. |
RefCnt |
Reference count of the next hop. |
FlushRefCnt |
Reference count of the next hop that is flushed to the FIB. |
Flag |
Flag of the next hop. |
Version |
Version of the next hop. |
x nexthop(s) |
Number of next hops. |
PrefixIndex |
Prefix index of the next hop for an ECMP route. |
OrigNexthop |
Original next hop. |
RelyDepth |
Recursion depth. |
RealNexthop |
Real next hop. |
Interface |
Output interface. |
localAddr |
Local interface address. |
TunnelCnt |
Number of tunnels after route recursion. |
Vrf |
VPN instance name. For the public network, this field displays default-vrf. |
TunnelID |
ID of the tunnel after route recursion. |
Topology |
Topology name. The topology name for the public network is base. |
Weight |
ECMP route weight. This field displays 0 for non-ECMP routes. |
Flags |
Flags of the detailed next hop. |
SRPolicyNID |
This field is not supported in the current software version. NIB ID of the route obtained from an SR-MPLS TE policy through route recursion. |
SRInterface |
This field is not supported in the current software version. Output interface of the route obtained from the SR-MPLS TE policy through route recursion. |
ColorWeight |
This field is not supported in the current software version. Weight value of the color attribute in the SR-MPLS TE policy. |
Locator |
IPv6 prefix of the locator to which the SID belongs. If no locator is available, this field displays N/A. |
OrigLinkID |
Original link ID of the SDWAN TTE connection. |
RealLinkID |
Real link ID of the SDWAN TTE connection. |
display route-static routing-table
Use display route-static routing-table to display static routing table information.
Syntax
display route-static routing-table [ vpn-instance vpn-instance-name ] [ ip-address { mask-length | mask } ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
vpn-instance vpn-instance-name: Specifies an MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. If you do not specify a VPN instance, the command displays static routing table information for the public network.
ip-address: Specifies the destination IP address in dotted decimal notation. If you do not specify this argument, the command displays all static routing table information.
mask-length: Specifies the mask length, an integer in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal notation.
Examples
# Display static routing table information.
<Sysname> display route-static routing-table
Total number of routes: 24
Status: * - valid
*Destination: 0.0.0.0/0
NibID: 0x1100000a NextHop: 2.2.2.10
MainNibID: N/A BkNextHop: N/A
BkNibID: N/A Interface: Ten-GigabitEthernet0/0/6
TableID: 0x2 BkInterface: Ten-GigabitEthernet0/0/7
Flag: 0x82d01 BfdSrcIp: N/A
DbIndex: 0xd BfdIfIndex: 0x0
Type: Normal BfdVrfIndex: 0
TrackIndex: 0xffffffff Label: NULL
Preference: 60 vrfIndexDst: 0
BfdMode: N/A vrfIndexNH: 0
Permanent: 0 Tag: 0
Destination: 0.0.0.0/0
NibID: 0x1100000b NextHop: 2.2.2.11
MainNibID: N/A BkNextHop: N/A
BkNibID: N/A Interface: Ten-GigabitEthernet0/0/8
TableID: 0x2 BkInterface: Ten-GigabitEthernet0/0/9
Flag: 0x82d01 BfdSrcIp: N/A
DbIndex: 0xd BfdIfIndex: 0x0
Type: Normal BfdVrfIndex: 0
TrackIndex: 0xffffffff Label: NULL
Preference: 60 vrfIndexDst: 0
BfdMode: N/A vrfIndexNH: 0
Permanent: 0 Tag: 0
...
Table 3 Command output
Field |
Description |
destination |
Destination address/prefix. |
NibID |
ID of the NIB. |
MainNibID |
ID of the primary next hop for static route FRR. |
BkNibID |
ID of the backup next hop for static route FRR. |
NextHop |
Next hop address. |
BkNextHop |
Backup next hop address. |
Interface |
Output interface of the route. (If an SRv6 TE policy is obtained through route recursion for the route, this field displays the policy name.) |
BkInterface |
Backup output interface. (If an SRv6 TE policy is obtained through route recursion for the route, this field displays the policy name.) |
TableID |
ID of the table to which the route belongs. |
Flag |
Flag of the route. |
DbIndex |
Index of the database to which the route belongs. |
Type |
Route type: · Normal. · DHCP. · NAT. |
BfdSrcIp |
Source IP address of the indirect BFD session. |
BfdIfIndex |
Index of the interface where BFD is enabled. |
BfdVrfIndex |
Index of the VPN instance where BFD is enabled. This field displays 0 if BFD is enabled for the public network. |
BfdMode |
BFD session mode: · N/A—No BFD session is configured. · Ctrl—Control packet mode · Echo—Echo packet mode. |
TrackIndex |
NQA Track index. |
vrfIndexDst |
Index of VPN instance to which the destination belongs. For the public network, this field displays 0. |
vrfIndexNH |
Index of the VPN instance to which the next hop belongs. For the public network, this field displays 0. |
Permanent |
Permanent static route flag. 1 indicates a permanent static route. |
ip route-static
Use ip route-static to configure a static route.
Use undo ip route-static to delete a static route.
Syntax
ip route-static dest-address { mask-length | mask } interface-type interface-number [ next-hop-address [ nexthop-index index-string ] | dhcp ] [ backup-interface interface-type interface-number [ backup-nexthop backup-nexthop-address ] [ permanent ] | bfd { control-packet | echo-packet | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static dest-address { mask-length | mask } next-hop-address [ nexthop-index index-string ] [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static dest-address { mask-length | mask } vpn-instance d-vpn-instance-name next-hop-address [ nexthop-index index-string ] [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static group group-name interface-type interface-number [ next-hop-address | dhcp ] [ backup-interface interface-type interface-number [ backup-nexthop backup-nexthop-address ] [ permanent ] | bfd { control-packet | echo-packet | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static group group-name next-hop-address [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static group group-name vpn-instance d-vpn-instance-name next-hop-address [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
undo ip route-static { dest-address { mask-length | mask } | group group-name } [ interface-type interface-number [ next-hop-address ] | next-hop-address | vpn-instance d-vpn-instance-name next-hop-address ] [ preference preference ]
ip route-static dest-address { mask-length | mask } { srv6-policy { color color-value end-point ipv6 ipv6-address | name policy-name } [ sid sid ] } [ preference preference ] [ tag tag-value ] [ description text ]
undo ip route-static dest-address { mask-length | mask } [ srv6-policy { color color-value end-point ipv6 ipv6-address | name policy-name } ] [ preference preference ]
Default
No static route is configured.
Views
System view
Predefined user roles
network-admin
Parameters
dest-address: Specifies the destination IP address of the static route, in dotted decimal notation.
mask-length: Specifies the mask length, an integer in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal notation.
group group-name: Specifies a static route group by its name, a case-sensitive string of 1 to 31 characters.
vpn-instance d-vpn-instance-name: Specifies a destination MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. If you do not specify the next-hop-address argument following this option, the device searches for the output interface in the specified destination VPN instance for packets matching the static route. If you specify the next-hop-address argument and this option, the device searches for the output interface in the specified destination VPN instance based on the specified next hop address for packets matching the static route.
interface-type interface-number: Specifies an output interface by its type and number. For more information, see Layer 3—IP Routing Configuration Guide.
next-hop-address: Specifies the IP address of the next hop, in dotted decimal notation. For more information, see Layer 3—IP Routing Configuration Guide.
dhcp: Specifies the default router designated by the DHCP server for the output interface as the next hop of the static route.
nexthop-index index-string: Specifies the index of the next hop. The index-string argument represents the index, which is a case-insensitive string of 1 to 93 characters. If you do not specify an index for the next hop, the static route uses the output interface and the IP address of the next hop as the next hop index. Do not specify the same next hop index for routes to the same destination.
recursive-lookup host-route: Specifies only host routes for static route recursion.
recursive-lookup longest-match: Specifies host routes with the longest matching mask for static route recursion.
backup-interface interface-type interface-number: Specifies a backup output interface by its type and number. If the backup output interface is an NBMA interface or broadcast interface and not a P2P interface, you must specify the backup next hop address.
backup-nexthop backup-nexthop-address: Specifies a backup next hop address.
bfd: Enables BFD to detect reachability of the static route's next hop. When the next hop is unreachable, the system immediately switches to the backup route.
control-packet: Specifies the BFD control mode.
bfd-source ip-address: Specifies the source IP address of BFD packets. As a best practice, specify the loopback interface address.
echo-packet: Specifies the BFD echo mode.
static session-name: Associates the static route with a static BFD session. The session-name argument represents the static BFD session name, a case-sensitive string of 1 to 64 characters. If you specify a nonexistent static BFD session, you must create the static BFD session to have the association take effect.
permanent: Specifies the route as a permanent static route. After you specify this keyword, the static route will always be active, even if the output interface is down.
track track-entry-number: Associates the static route with a track entry specified by its number in the range of 1 to 1024. For more information about Track, see High Availability Configuration Guide.
srv6-policy name policy-name: Specifies an SRv6 TE policy by its name for static route recursion. The policy-name argument represents the SRv6 TE policy name, a case-sensitive string of 1 to 59 characters. For more information about SRv6 TE policies, see Segment Routing Configuration Guide.
srv6-policy color color-value end-point ipv6 ipv6-address: Specifies an SRv6 TE policy by its color and endpoint attributes for static route recursion. The color-value argument represents the color attribute value of the SRv6 TE policy, in the range of 1 to 4294967295. The ipv6-address argument represents the endpoint IPv6 address of the SRv6 TE policy.
sid sid: Specifies the SRv6 SID of the tail node. Packets forwarded by the specified SRv6 TE policy will continue to be forwarded based on the specified SRv6 SID.
preference preference: Specifies a preference for the static route, in the range of 1 to 255. The default is 60.
tag tag-value: Sets a tag value for marking the static route, in the range of 1 to 4294967295. The default is 0. Tags of routes are used for route control in routing policies. For more information about routing policies, see Layer 3—IP Routing Configuration Guide.
recursive-lookup: Enables support for next hop recursion loops for the IPv4 static route. If you do not specify this keyword, the device does not support next hop recursion loops for the IPv4 static route.
description text: Configures a description of 1 to 150 characters for the static route. The description can include special characters, such as the space, except the question mark (?).
Usage guidelines
If the destination IP address and the mask are both 0.0.0.0 (or 0), the configured route is a default route. The default route is used for forwarding a packet matching no entry in the routing table.
Implement different routing policies to configure different route preferences. For example, to enable load sharing for multiple routes to the same destination, assign the same preference to the routes. To enable the routes to back up one another, assign different preferences to them.
Follow these guidelines when you specify the output interface or the next hop address of the static route:
· If the output interface is a Null 0 interface, no next hop address is required.
· If the output interface is a point-to-point interface, you can specify only the output interface. You do not need to change the configuration of the route even if the peer address is changed.
· NBMA or P2MP interfaces need IP address-to-link layer address mappings for successful packet delivery. As a best practice, specify the next hop address for the route at the same time if the output interface is an NBMA or P2MP interface.
· If the output interface is a broadcast interface, the device might have multiple next hops. Therefore, you must specify both the output interface and next hop IP address.
Follow these guidelines when you configure a static route:
· Enabling BFD for a flapping route could worsen the route flapping situation. Therefore, use it with caution. For more information about BFD, see High Availability Configuration Guide.
· For static routing-Track-NQA collaboration, you must configure the same VPN instance ID for the next hop to be detected and the NQA operation.
· If a static route needs route recursion, the associated track entry must monitor the next hop of the recursive route instead of that of the static route. Otherwise, a valid route might be mistakenly considered invalid.
· Do not specify the permanent keyword together with the bfd or track keyword.
If you specify a static route group, all prefixes in the static route group will be assigned the next hop and output interface specified by using this command.
After an interface obtains an IP address and gateway address through DHCP, the device automatically generates a static route with the interface as the output interface. The destination address of the static route is 0.0.0.0/0 and the next hop of the static route is the default router (the gateway address designated by the DHCP server). This static route cannot form ECMP routes with manually configured static routes. The device uses this static route to guide traffic forwarding only after the manually configured static routes become invalid.
Specify the dhcp keyword to use both the automatically generated static route and the manually configured static routes to guide traffic forwarding. This keyword is applicable when the device has dual egress WAN links.
The dhcp keyword enables the device to automatically generate a static route destined for the specified network with the DHCP-designated default router of the output interface as the next hop. This static route takes effect only after the output interface obtains an IP address and gateway address through DHCP, and becomes invalid upon the DHCP lease expiration. The next hop of this static route changes as the gateway address of the output interface changes. In addition, this static route can form ECMP routes with manually configured static routes.
To specify the dhcp keyword, make sure the output interface of the static route is a broadcast interface.
If you do not specify the recursive-lookup longest-match or recursive-lookup host-route keyword, the static route preferentially recurses to a direct route. The static route recurses to the route with the longest matching mask only when no matching direct route is found. If the destination network address of the direct route contains the next hop address of the static route, the following conditions might exist:
· The static route recurses the next hop to the direct route.
· The device determines that the next hop address of the static route is locally connected.
However, the next hop might be incorrect, which results in failure to forward packets matching the static route. If you specify the recursive-lookup longest-match keyword, the static route recurses to the route with the longest matching mask to ensure correct next hop recursion. If you specify the recursive-lookup host-route keyword, the static route recurses to only a host route with a 32-bit mask, and the static route can be activated only when the host route is reachable.
A recursion loop occurs when an IPv4 static route recurses to a related route whose destination address contains the destination address of the IPv4 static route. For example, a recursion loop occurs when the IPv4 static route destined for 10.1.0.0/24 recurses to a related route whose destination address is 10.1.0.0/16.
· If the recursive-lookup keyword is not specified, the recursion loop results in route recursion failure. The device further looks up for a related route.
· If the recursive-lookup keyword is specified, the device determines that the recursion succeeds if the output interface of the related route is an interface directly connected to the device.
If the output interface of an IPv4 static route is found through recursion loops, routing protocols on the device cannot advertise the IPv4 static route to other devices.
The recursive-lookup host-route and recursive-lookup keywords are mutually exclusive. You cannot specify both of the keywords.
Examples
# Configure a static route, whose destination address is 1.1.1.1/24, next hop address is 2.2.2.2, tag value is 45, and description information is for internet.
<Sysname> system-view
[Sysname] ip route-static 1.1.1.1 24 2.2.2.2 tag 45 description for internet
Related commands
display ip routing-table protocol
ip route-static-group
prefix
ip route-static arp-request
Use ip route-static arp-request to enable periodic sending of ARP requests to the next hops of static routes.
Use undo ip route-static arp-request to disable periodic sending of ARP requests to the next hops of static routes.
Syntax
ip route-static arp-request [ interval interval ]
undo ip route-static arp-request
Default
Periodic sending of ARP requests to the next hops of static routes is disabled.
Views
System view
Predefined user roles
network-admin
Parameters
interval: Specifies an ARP request sending interval in the range of 1 to 300 seconds. The default value is 5.
Usage guidelines
When the following conditions exist, a recursive static route becomes inactive:
· The static route uses a host route to reach its direct next hop.
· The host route is obtained by specifying the recursive-lookup host-route keyword in the ip route-static command or by routing policy-based recursive lookup.
· The host route is unavailable because the direct next hop cannot send gratuitous ARP messages and consequently no ARP entry exists for that host route on the device.
To resolve this issue, you can use this command to enable the device to periodically send ARP requests to the direct next hop. When the device receives an ARP response from the direct next hop, it stops sending ARP requests and activates the recursive static route.
This command applies only to a recursive static route that meets the following requirements:
· The static route has no output interface specified.
· The static route fails the next-hop recursion.
Examples
# Enable sending of ARP requests to the next hops of static routes and set the sending interval to 10 seconds.
<Sysname> system-view
[Sysname] ip route-static arp-request interval 10
Related commands
ip route-static
protocol nexthop recursive-lookup
ip route-static bfd
Use ip route-static bfd to configure BFD session parameters for a static route.
Use undo ip route-static bfd to restore the default.
Syntax
BFD control packet mode for single-hop detection and BFD echo packet mode:
ip route-static bfd interface-type interface-number next-hop-address { detect-multiplier detect-multiplier | min-echo-receive-interval min-echo-receive-interval | min-receive-interval min-receive-interval | min-transmit-interval min-transmit-interval } *
undo ip route-static bfd interface-type interface-number next-hop-address
BFD control packet mode for multihop detection:
ip route-static bfd [ vpn-instance d-vpn-instance-name ] next-hop-address source-ip ip-address { detect-multiplier detect-multiplier | min-receive-interval min-receive-interval | min-transmit-interval min-transmit-interval } *
undo ip route-static bfd [ vpn-instance d-vpn-instance-name ] next-hop-address
Default
No BFD session parameters are specifically configured for a static route. The static route uses the session parameters configured for the BFD module (common BFD session parameters).
Views
System view
Predefined user roles
network-admin
Parameters
interface-type interface-number: Specifies an output interface by its type and number.
vpn-instance d-vpn-instance-name: Specifies a destination MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. If the next hop of the static route belongs to the public network, do not specify this option.
next-hop-address: Specifies the IP address of the next hop, in dotted decimal notation.
source-ip ip-address: Specifies a source IPv4 address for BFD packets, in dotted decimal notation.
detect-multiplier detect-multiplier: Sets the BFD detection time multiplier. The value range for the detect-multiplier argument is 3 to 50. The default value is 5.
min-echo-receive-interval min-echo-receive-interval: Sets the minimum interval for receiving BFD echo packets, in milliseconds. The value range for the min-echo-receive-interval argument is 10 to 10000.
min-receive-interval min-receive-interval: Sets the minimum interval for receiving BFD control packets, in milliseconds. The value range for the min-receive-interval argument is 10 to 10000.
min-transmit-interval min-transmit-interval: Sets the minimum interval for transmitting BFD control packets, in milliseconds. The value range for the min-transmit-interval argument is 10 to 10000.
Usage guidelines
Use this command to configure BFD session parameters for a static route, including parameters that determine the BFD detection time. The BFD detection time = detect-multiplier × max (min-echo-receive-interval, min-receive-interval, min-transmit-interval). For more information about the calculation method of BFD detection time, see BFD in High Availability Command Reference.
If you specify the output interface when executing this command, support for the BFD session parameters varies by BFD session mode.
· Echo-mode BFD sessions support only the min-echo-receive-interval and detect-multiplier parameters.
· Control-mode BFD sessions for single-hop detection support only the min-receive-interval, min-transmit-interval, and detect-multiplier parameters.
To apply the configured BFD session parameters, use one of the following combinations of parameters to specify a static route:
· In control packet mode for single-hop detection and in echo packet mode, use the output interface and next hop address.
· In control packet mode for multihop detection, use the next hop address and BFD packet source address. If the next hop belongs to a VPN instance, use the destination VPN instance, next hop address, and BFD packet source address to specify the static route.
For an unspecified BFD session parameter, the static route uses the value of the corresponding common BFD session parameter.
Examples
# Configure BFD session parameters for the static route with output interface Ten-GigabitEthernet 0/0/6 and next hop 1.2.3.4. The BFD detection time multiplier is 20 and the minimum interval for receiving BFD echo packets is 1000 milliseconds.
<Sysname> system-view
[Sysname] ip route-static bfd ten-gigabitethernet 0/0/6 1.2.3.4 detect-multiplier 20 min-echo-receive-interval 1000
ip route-static default-preference
Use ip route-static default-preference to configure a default preference for static routes.
Use undo ip route-static default-preference to restore the default.
Syntax
ip route-static default-preference default-preference
undo ip route-static default-preference
Default
The default preference of static routes is 60.
Views
System view
Predefined user roles
network-admin
Parameters
default-preference: Specifies a default preference for static routes, in the range of 1 to 255.
Usage guidelines
If no preference is specified for a static route, the default preference applies.
When the default preference is reconfigured, it applies only to newly added static routes.
Examples
# Set a default preference of 120 for static routes.
<Sysname> system-view
[Sysname] ip route-static default-preference 120
Related commands
display ip routing-table protocol
ip route-static fast-reroute auto
Use ip route-static fast-reroute auto to configure static route FRR to automatically select a backup next hop.
Use undo ip route-static fast-reroute auto to disable static route FRR from automatically selecting a backup next hop.
Syntax
ip route-static fast-reroute auto
undo ip route-static fast-reroute auto
Default
Static route FRR is disabled from automatically selecting a backup next hop.
Views
System view
Predefined user roles
network-admin
Examples
# Configure static route FRR to automatically select a backup next hop.
<Sysname> system-view
[Sysname] ip route-static fast-reroute auto
ip route-static primary-path-detect bfd echo
Use ip route-static primary-path-detect bfd echo to enable BFD echo packet mode for static route FRR.
Use undo ip route-static primary-path-detect bfd to disable BFD echo packet mode for static route FRR.
Syntax
ip route-static primary-path-detect bfd echo
undo ip route-static primary-path-detect bfd
Default
BFD echo packet mode for static route FRR is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
This command enables static route FRR to use BFD echo packet mode for fast failure detection on the primary link.
Examples
# Enable BFD echo packet mode for static route FRR.
<Sysname> system-view
[Sysname] ip route-static 1.1.1.1 32 ten-gigabitethernet 0/0/6 2.2.2.2 backup-interface ten-gigabitethernet 0/0/7 backup-nexthop 3.3.3.3
[Sysname] ip route-static primary-path-detect bfd echo
ip route-static recursive-lookup tunnel
Use ip route-static recursive-lookup tunnel to allow static routes to recurse to LSP tunnels.
Use undo ip route-static recursive-lookup tunnel to restore the default.
Syntax
ip route-static recursive-lookup tunnel [ prefix-list ipv4-prefix-list-name ] [ tunnel-policy tunnel-policy-name | tunnel-selector tunnel-selector-name ]
undo ip route-static recursive-lookup tunnel
Default
Static routes cannot recurse to LSP tunnels.
Views
System view
Predefined user roles
network-admin
Parameters
prefix-list ipv4-prefix-list-name: Specifies an IPv4 prefix list by its name, a case-sensitive string of 1 to 63 characters. Only static routes filtered by the specified IPv4 prefix list can recurse to LSP tunnels. If you do not specify an IPv4 prefix list, this command allows all static routes to recurse to LSP tunnels.
tunnel-policy tunnel-policy-name: Specifies a tunnel policy by its name, a case-sensitive string of 1 to 19 characters. Static routes can recurse only to LSP tunnels that match the specified tunnel policy.
tunnel-selector tunnel-selector-name: Specifies a tunnel selector by its name, a case-sensitive string of 1 to 40 characters. Static routes can recurse only to LSP tunnels that match the specified tunnel selector.
Usage guidelines
By default, a static route can recurse only to output interfaces and next hops based on IP forwarding. This command allows the device to preferentially recurse static routes to LSP tunnels. If a static route cannot recurse to an LSP tunnel, the device recurses the static route to an output interface and next hop based on IP forwarding.
If you do not specify the tunnel-policy tunnel-policy-name or tunnel-selector tunnel-selector-name option, this command allows static routes to recurse to any LSP tunnels.
If you execute this command multiple times, the most recent configuration takes effect.
Examples
# Enable the device to recurse static routes to LSP tunnels.
<Sysname> system-view
[Sysname] ip route-static recursive-lookup tunnel
ip route-static vpn-instance
Use ip route-static vpn-instance to configure a static route in a VPN instance.
Use undo ip route-static vpn-instance to delete a static route from a VPN instance.
Syntax
ip route-static vpn-instance s-vpn-instance-name dest-address { mask-length | mask } interface-type interface-number [ next-hop-address [ nexthop-index index-string ] | dhcp ] [ backup-interface interface-type interface-number [ backup-nexthop backup-nexthop-address ] [ permanent ] | bfd { control-packet | echo-packet | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static vpn-instance s-vpn-instance-name dest-address { mask-length | mask } next-hop-address [ nexthop-index index-string ] [ recursive-lookup { host-route | longest-match } ] [ public ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static vpn-instance s-vpn-instance-name dest-address { mask-length | mask } vpn-instance d-vpn-instance-name next-hop-address [ nexthop-index index-string ] [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static vpn-instance s-vpn-instance-name group group-name interface-type interface-number [ next-hop-address | dhcp ] [ backup-interface interface-type interface-number [ backup-nexthop backup-nexthop-address ] [ permanent ] | bfd { control-packet | echo-packet | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static vpn-instance s-vpn-instance-name group group-name next-hop-address [ recursive-lookup { host-route | longest-match } ] [ public ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
ip route-static vpn-instance s-vpn-instance-name group group-name vpn-instance d-vpn-instance-name next-hop-address [ recursive-lookup { host-route | longest-match } ] [ bfd { control-packet bfd-source ip-address | static session-name } | permanent | track track-entry-number ] [ preference preference ] [ tag tag-value ] [ recursive-lookup ] [ description text ]
undo ip route-static vpn-instance s-vpn-instance-name { dest-address { mask-length | mask } | group group-name } [ interface-type interface-number [ next-hop-address | dhcp ] | next-hop-address [ public ] | vpn-instance d-vpn-instance-name next-hop-address ] [ preference preference ]
ip route-static vpn-instance s-vpn-instance-name { dest-address { mask-length | mask } | group group-name } { public | vpn-instance d-vpn-instance-name } [ preference preference ] [ tag tag-value ] [ description text ]
undo ip route-static vpn-instance s-vpn-instance-name { dest-address { mask-length | mask } | group group-name } [ public | vpn-instance d-vpn-instance-name ] [ preference preference ]
ip route-static vpn-instance s-vpn-instance-name dest-address { mask-length | mask } { srv6-policy { color color-value end-point ipv6 ipv6-address | name policy-name } [ sid sid ] } [ preference preference ] [ tag tag-value ] [ description text ]
undo ip route-static vpn-instance s-vpn-instance-name dest-address { mask-length | mask } [ srv6-policy { color color-value end-point ipv6 ipv6-address | name policy-name } ]
Default
No static route is configured in a VPN instance.
Views
System view
Predefined user roles
network-admin
Parameters
vpn-instance s-vpn-instance-name: Specifies a source MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. Each VPN instance has its own routing table, and the configured static route is installed in the routing tables of the specified VPN instances.
dest-address: Specifies the destination IP address of the static route, in dotted decimal notation.
mask-length: Specifies the mask length, an integer in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal notation.
group group-name: Specifies a static route group by its name, a case-sensitive string of 1 to 31 characters.
vpn-instance d-vpn-instance-name: Specifies a destination MPLS L3VPN instance by its name, a case-sensitive string of 1 to 31 characters. If you do not specify the next-hop-address argument following this option, the device searches for the output interface in the specified destination VPN instance for packets matching the static route. If you specify the next-hop-address argument and this option, the device searches for the output interface in the specified destination VPN instance based on the specified next hop address for packets matching the static route.
interface-type interface-number: Specifies an output interface by its type and number. For more information, see Layer 3—IP Routing Configuration Guide.
next-hop-address: Specifies the IP address of the next hop, in dotted decimal notation. For more information, see Layer 3—IP Routing Configuration Guide.
dhcp: Specifies the default router designated by the DHCP server for the output interface as the next hop of the static route.
nexthop-index index-string: Specifies the index of the next hop. The index-string argument represents the index, which is a case-insensitive string of 1 to 93 characters. If you do not specify an index for the next hop, the static route uses the output interface and the IP address of the next hop as the next hop index. Do not specify the same next hop index for routes to the same destination.
recursive-lookup host-route: Specifies only host routes for static route recursion.
recursive-lookup longest-match: Specifies host routes with the longest matching mask for static route recursion.
backup-interface interface-type interface-number: Specifies a backup output interface by its type and number. If the backup output interface is a non-P2P interface (an NBMA interface or broadcast interface), you must specify the backup next hop address.
backup-nexthop backup-nexthop-address: Specifies a backup next hop address.
bfd: Enables BFD to detect reachability of the static route's next hop. When the next hop is unreachable, the system immediately switches to the backup route.
control-packet: Specifies the BFD control mode.
bfd-source ip-address: Specifies the source IP address of BFD packets. As a best practice, specify the loopback interface address.
echo-packet: Specifies the BFD echo mode.
static session-name: Associates the static route with a static BFD session. The session-name argument represents the static BFD session name, a case-sensitive string of 1 to 64 characters. If you specify a nonexistent static BFD session, you must create the static BFD session to have the association take effect.
permanent: Specifies the route as a permanent static route. After you specify this keyword, the static route will always be active, even if the output interface is down.
track track-entry-number: Associates the static route with a track entry specified by its number in the range of 1 to 1024. For more information about Track, see High Availability Configuration Guide.
public: Specifies the public network. If you specify this keyword following the next-hop-address argument, the next hop is on the public network. The device searches for the output interface in the public network based on the next hop address for packets matching the static route. If you specify the next-hop-address argument without specifying the public keyword, the device searches for the output interface in the source VPN instance based on the next hop address for packets matching the static route. If you specify the public keyword without specifying the next-hop-address argument, the device searches for the output interface in the public network for packets matching the static route.
srv6-policy name policy-name: Specifies an SRv6 TE policy by its name for static route recursion. The policy-name argument represents the SRv6 TE policy name, a case-sensitive string of 1 to 59 characters. For more information about SRv6 TE policies, see Segment Routing Configuration Guide.
srv6-policy color color-value end-point ipv6 ipv6-address: Specifies an SRv6 TE policy by its color and endpoint attributes for static route recursion. The color-value argument represents the color attribute value of the SRv6 TE policy, in the range of 1 to 4294967295. The ipv6-address argument represents the endpoint IPv6 address of the SRv6 TE policy.
sid sid: Specifies the SRv6 SID of the tail node. Packets forwarded by the specified SRv6 TE policy will continue to be forwarded based on the specified SRv6 SID.
preference preference: Specifies a preference for the static route, in the range of 1 to 255. The default is 60.
tag tag-value: Sets a tag value for marking the static route, in the range of 1 to 4294967295. The default is 0. Tags of routes are used for route control in routing policies. For more information about routing policies, see Layer 3—IP Routing Configuration Guide.
recursive-lookup: Enables support for next hop recursion loops for the IPv4 static route. If you do not specify this keyword, the device does not support next hop recursion loops for the IPv4 static route.
description text: Configures a description of 1 to 150 characters for the static route. The description can include special characters, such as the space, except the question mark (?).
Usage guidelines
If the destination IP address and the mask are both 0.0.0.0 (or 0), the configured route is a default route. The default route is used for forwarding a packet matching no entry in the routing table.
Implement different routing policies to configure different route preferences. For example, to enable load sharing for multiple routes to the same destination, assign the same preference to the routes. To enable the routes to back up one another, assign different preferences to them.
Follow these guidelines when you specify the output interface or the next hop address of the static route:
· If the output interface is a Null 0 interface, no next hop address is required.
· If the output interface is a point-to-point interface, you can specify only the output interface. You do not need to change the configuration of the route even if the peer address is changed.
· NBMA or P2MP interfaces need IP address-to-link layer address mappings for successful packet delivery. As a best practice, specify the next hop address for the route at the same time if the output interface is an NBMA or P2MP interface.
· If the output interface is a broadcast interface that might have multiple next hops, you must specify both the output interface and next hop IP address.
Follow these guidelines when you configure a static route:
· Enabling BFD for a flapping route could worsen the route flapping situation. Therefore, use it with caution. For more information about BFD, see High Availability Configuration Guide.
· For static routing-Track-NQA collaboration, you must configure the same VPN instance ID for the next hop to be detected and the NQA operation.
· If a static route needs route recursion, the associated track entry must monitor the next hop of the related route instead of that of the recursive static route. Otherwise, a valid route might be mistakenly considered invalid.
· You cannot specify the permanent keyword together with the bfd and track keywords.
If you specify a static route group, all prefixes in the static route group will be assigned the next hop and output interface specified by using this command.
After an interface obtains an IP address and gateway address through DHCP, the device automatically generates a static route with the interface as the output interface. The destination address of the static route is 0.0.0.0/0 and the next hop of the static route is the default router (the gateway address designated by the DHCP server). This static route cannot form ECMP routes with manually configured static routes. The device uses this static route to guide traffic forwarding only after the manually configured static routes become invalid.
Specify the dhcp keyword to use both the automatically generated static route and the manually configured static routes to guide traffic forwarding. This keyword is applicable when the device has dual egress WAN links.
The dhcp keyword enables the device to automatically generate a static route destined for the specified network with the DHCP-designated default router of the output interface as the next hop. This static route takes effect only after the output interface obtains an IP address and gateway address through DHCP, and becomes invalid upon the DHCP lease expiration. The next hop of this static route changes as the gateway address of the output interface changes. In addition, this static route can form ECMP routes with manually configured static routes.
To specify the dhcp keyword, make sure the output interface of the static route is a broadcast interface.
If you do not specify the recursive-lookup longest-match or recursive-lookup host-route keyword, the static route preferentially recurses to a direct route. The static route recurses to the route with the longest matching mask only when no matching direct route is found. If the destination network address of the direct route contains the next hop address of the static route, the following conditions might exist:
· The static route recurses the next hop to the direct route.
· The device determines that the next hop address of the static route is locally connected.
However, the next hop might be incorrect, which results in failure to forward packets matching the static route. If you specify the recursive-lookup longest-match keyword, the static route recurses to the route with the longest matching mask to ensure correct next hop recursion. If you specify the recursive-lookup host-route keyword, the static route recurses to only a host route with a 32-bit mask, and the static route can be activated only when the host route is reachable.
A recursion loop occurs when an IPv4 static route recurses to a related route whose destination address contains the destination address of the IPv4 static route. For example, a recursion loop occurs when the IPv4 static route destined for 10.1.0.0/24 recurses to a related route whose destination address is 10.1.0.0/16.
· If the recursive-lookup keyword is not specified, the recursion loop results in route recursion failure. The device further looks up for a related route.
· If the recursive-lookup keyword is specified, the device determines that the recursion succeeds if the output interface of the related route is an interface directly connected to the device.
If the output interface of an IPv4 static route is found through recursion loops, routing protocols on the device cannot advertise the IPv4 static route to other devices.
The recursive-lookup host-route and recursive-lookup keywords are mutually exclusive. You cannot specify both of the keywords.
Examples
# Configure a static route in VPN instance vpn1, whose destination address is 1.1.1.1/24, next hop address is 2.2.2.2 in VPN instance vpn2, tag value is 45, and description information is for internet.
<Sysname> system-view
[Sysname] ip route-static vpn-instance vpn1 1.1.1.1 24 vpn-instance vpn2 2.2.2.2 tag 45 description for internet
Related commands
display ip routing-table protocol
ip route-static-group
prefix
ip route-static-group
Use ip route-static-group to create a static route group and enter its view, or enter the view of an existing static route group.
Use undo ip route-static-group to delete a static route group.
Syntax
ip route-static-group group-name
undo ip route-static-group group-name
Default
No static route groups exist.
Views
System view
Predefined user roles
network-admin
Parameters
group-name: Specifies the static route group name, a case-sensitive string of 1 to 31 characters.
Examples
# Create static route group test and enter its view.
<Sysname> system-view
[Sysname] ip route-static-group test
[Sysname-route-static-group-test]
Related commands
ip route-static
prefix
prefix
Use prefix to add a static route prefix to a static route group.
Use undo prefix to delete a static route prefix from a static route group.
Syntax
prefix dest-address { mask-length | mask }
undo prefix dest-address { mask-length | mask }
Default
No static route prefix is added to a static route group.
Views
Static route group view
Predefined user roles
network-admin
Parameters
dest-address: Specifies the destination IP address of the static route, in dotted decimal notation.
mask-length: Specifies the mask length, an integer in the range of 0 to 32.
mask: Specifies the subnet mask in dotted decimal notation.
Usage guidelines
Execute this command repeatedly to add multiple static route prefixes to a static route group.
After you add static route prefixes to a static route group, you can specify that group in the ip route-static group command to configure static routes with the prefixes. To configure more static routes, you only need to add new static route prefixes to the group.
Examples
# Add static route prefix 1.1.1.1/32 to static route group test.
<Sysname> system-view
[Sysname] ip route-static-group test
[Sysname-route-static-group-test] prefix 1.1.1.1 32
Related commands
ip route-static
ip route-static-group