Cisco IOS Release 12.0 Network Protocols Command Reference, Part 1
IP Addressing Commands

Table Of Contents

IP Addressing Commands

arp (global)

arp (interface)

arp timeout

clear arp-cache

clear host

clear ip nat translation

clear ip nhrp

clear ip route

ip address

ip broadcast-address

ip cef traffic-statistics

ip classless

ip default-gateway

ip directed-broadcast

ip domain-list

ip domain-lookup

ip domain-name

ip forward-protocol

ip forward-protocol spanning-tree

ip forward-protocol turbo-flood

ip helper-address

ip host

ip host-routing

ip hp-host

ip irdp

ip mobile arp

ip name-server

ip nat

ip nat inside destination

ip nat inside source

ip nat outside source

ip nat pool

ip nat service

ip nat translation

ip netmask-format

ip nhrp authentication

ip nhrp holdtime

ip nhrp interest

ip nhrp map

ip nhrp map multicast

ip nhrp max-send

ip nhrp network-id

ip nhrp nhs

ip nhrp record

ip nhrp responder

ip nhrp server-only

ip nhrp trigger-svc

ip nhrp use

ip probe proxy

ip proxy-arp

ip routing

ip subnet-zero

ip unnumbered

no ip gratuitous-arps

show arp

show hosts

show ip aliases

show ip arp

show ip interface

show ip irdp

show ip masks

show ip nat statistics

show ip nat translations

show ip nhrp

show ip nhrp traffic

term ip netmask-format

tunnel mode


IP Addressing Commands


The Internet Protocol (IP) is a packet-based protocol used to exchange data over computer networks. IP handles addressing, fragmentation, reassembly, and protocol demultiplexing. It is the foundation on which all other Internet protocols, collectively referred to as the Internet Protocol suite, are built. IP is a network-layer protocol that contains addressing information and some control information that allows data packets to be routed.

The Transmission Control Protocol (TCP) is built upon the IP layer. TCP is a connection-oriented protocol that specifies the format of data and acknowledgments used in the transfer of data. TCP also specifies the procedures that the computers use to ensure that the data arrives correctly. TCP allows multiple applications on a system to communicate concurrently because it handles all demultiplexing of the incoming traffic among the application programs.

Use the commands in this chapter to configure and monitor the addressing of IP networks. For IP addressing configuration information and examples, refer to the "Configuring IP Addressing" chapter of the Network Protocols Configuration Guide, Part 1.

arp (global)

To add a permanent entry in the Address Resolution Protocol (ARP) cache, use the arp global configuration command. To remove an entry from the ARP cache, use the no form of this command.

arp ip-address hardware-address type [alias]

no arp ip-address hardware-address type [alias]

Syntax Description

ip-address

IP address in four-part dotted-decimal format corresponding to the local data link address.

hardware-address

Local data link address (a 48-bit address).

type

Encapsulation description. For Ethernet interfaces, this is typically the arpa keyword. For Fiber Distributed Data Interface (FDDI) and Token Ring interfaces, this is always snap.

alias

(Optional) Indicates that the Cisco IOS software should respond to ARP requests as if it were the owner of the specified address.


Defaults

No entries are permanently installed in the ARP cache.

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

The Cisco IOS software uses ARP cache entries to translate 32-bit IP addresses into 48-bit hardware addresses.

Because most hosts support dynamic resolution, you generally do not need to specify static ARP cache entries.

To remove all nonstatic entries from the ARP cache, use the clear arp-cache privileged EXEC command.

Examples

The following is an example of a static ARP entry for a typical Ethernet host:

arp 192.31.7.19 0800.0900.1834 arpa

Related Commands

Command
Description

clear arp-cache

Deletes all dynamic entries from the ARP cache.


arp (interface)

To control the interface-specific handling of IP address resolution into 48-bit Ethernet, FDDI, and Token Ring hardware addresses, use the arp interface configuration command. To disable an encapsulation type, use the no form of this command.

arp {arpa | frame-relay | probe | snap | timeout}

no arp {arpa | frame-relay | probe | snap | timeout}

Syntax Description

arpa

Standard Ethernet-style ARP (RFC 826).

frame-relay

Enables ARP over a frame-relay encapsulated interface

probe

HP Probe protocol for IEEE-802.3 networks.

snap

ARP packets conforming to RFC 1042.

timeout

Set ARP cache timeout


Defaults

Standard Ethernet-style ARP

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

Unlike most commands that take multiple arguments, arguments to the arp command are not mutually exclusive. Each command enables or disables a specific type of ARP. For example, if you enter the arp arpa command followed by the arp probe command, the Cisco IOS software would send three (two for probe and one for arpa) packets each time it needed to discover a Media Access Control (MAC) address.

The arp probe command allows the software to use the Probe protocol (in addition to ARP) whenever it attempts to resolve an IEEE-802.3 or Ethernet local data link address. The subset of Probe that performs address resolution is called Virtual Address Request and Reply. Using Probe, the software can communicate transparently with Hewlett-Packard IEEE-802.3 hosts that use this type of data encapsulation.


Note Cisco's support for HP Probe proxy support changed as of Software Release 8.3(2) and subsequent software releases. The no arp probe command is now the default. All interfaces that will use Probe must now be explicitly configured for arp probe.


Given a network protocol address (IP address), the arp frame-relay command determines the corresponding hardware address, which would be a data link connection identifier (DLCI) for frame relay.

The show interfaces EXEC command displays the type of ARP being used on a particular interface. To remove all nonstatic entries from the ARP cache, use the clear arp-cache privileged EXEC command.

Examples

The following example enables probe services:

interface ethernet 0
 arp probe

Related Commands

Command
Description

clear arp-cache

Deletes all dynamic entries from the ARP cache.

show interfaces

Displays statistics for all interfaces configured on the router or access server.


arp timeout

To configure how long an entry remains in the ARP cache, use the arp timeout interface configuration command. To restore the default value, use the no form of this command.

arp timeout seconds

no arp timeout seconds

Syntax Description

seconds

Time (in seconds) that an entry remains in the ARP cache. A value of zero means that entries are never cleared from the cache.


Defaults

14400 seconds (4 hours)

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

This command is ignored when issued on interfaces that do not use ARP. The show interfaces EXEC command displays the ARP timeout value. The value follows the "Entry Timeout:" heading, as seen in this sample show interfaces display:

ARP type: ARPA, PROBE, Entry Timeout: 14400 sec

Examples

The following example sets the ARP timeout to 12000 seconds to allow entries to time out more quickly than the default:

interface ethernet 0
 arp timeout 12000

Related Commands

Command
Description

show interfaces

Displays statistics for all interfaces configured on the router or access server.


clear arp-cache

To delete all dynamic entries from the ARP cache, to clear the fast-switching cache, and to clear the IP route cache, use the clear arp-cache EXEC command.

clear arp-cache

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release
Modification

10.0

This command was introduced.


Examples

The following example removes all dynamic entries from the ARP cache and clears the fast-switching cache:

clear arp-cache

Related Commands

Command
Description

arp (global)

Adds a permanent entry in the ARP cache.

arp (interface)

Controls the interface-specific handling of IP address resolution into 48-bit Ethernet, FDDI, and Token Ring hardware addresses.


clear host

To delete entries from the host-name-and-address cache, use the clear host EXEC command.

clear host {name | *}

Syntax Description

name

Particular host entry to remove.

*

Removes all entries.


Command Modes

EXEC

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

The host name entries will not be removed from nonvolatile random-access memory (NVRAM), but will be cleared in running memory.

Examples

The following example clears all entries from the host name-and-address cache:

clear host *

Related Commands

Command
Description

ip host

Defines a static host name-to-address mapping in the host cache.

show hosts

Displays the default domain name, the style of name lookup service, a list of name server hosts, and the cached list of host names and addresses.


clear ip nat translation

To clear dynamic Network Address Translation (NAT) translations from the translation table, use the clear ip nat translation EXEC command.

clear ip nat translation {* | [inside global-ip local-ip] [outside local-ip global-ip]}

clear ip nat translation protocol inside global-ip global-port local-ip local-port [outside
local-ip global-ip]

Syntax Description

*

Clears all dynamic translations.

inside

Clears the inside translations containing the specified global-ip and local-ip addresses.

global-ip

When used without the arguments protocol, global-port, and local-port, clears a simple translation that also contains the specified local-ip address. When used with the arguments protocol, global-port, and local-port, clears an extended translation.

local-ip

(Optional) Clears an entry that contains this local IP address and the specified global-ip address.

outside

Clears the outside translations containing the specified global-ip and local-ip addresses.

protocol

(Optional) Clears an entry that contains this protocol and the specified global-ip address, local-ip address, global-port, and local-port.

global-port

(Optional) Clears an entry that contains this global-port and the specified protocol, global-ip address, local-ip address, and local-port.

local-port

(Optional) Clears an entry that contains this local-port and the specified protocol, global-ip address, local-ip address, and global-port.


Command Modes

EXEC

Command History

Release
Modification

11.2

This command was introduced.


Usage Guidelines

Use this command to clear entries from the translation table before they time out.

Examples

The following example shows the NAT entries before and after the UDP entry being cleared:

Router# show ip nat translation
Pro Inside global      Inside local       Outside local      Outside global
udp 171.69.233.209:1220 192.168.1.95:1220 171.69.2.132:53    171.69.2.132:53
tcp 171.69.233.209:11012 192.168.1.89:11012 171.69.1.220:23  171.69.1.220:23
tcp 171.69.233.209:1067 192.168.1.95:1067 171.69.1.161:23    171.69.1.161:23

Router# clear ip nat translation udp inside 171.69.233.209 1220 192.168.1.95 1220
171.69.2.132 53 171.69.2.132 53

Router# show ip nat translation 
Pro Inside global      Inside local       Outside local      Outside global
tcp 171.69.233.209:11012 192.168.1.89:11012 171.69.1.220:23  171.69.1.220:23
tcp 171.69.233.209:1067 192.168.1.95:1067 171.69.1.161:23    171.69.1.161:23

Related Commands

Command
Description

ip nat

Designates that traffic originating from or destined for the interface is subject to NAT.

ip nat inside destination

Enables NAT of the inside destination address.

ip nat inside source

Enables NAT of the inside source address.

ip nat outside source

Enables NAT of the outside source address.

ip nat pool

Defines a pool of IP addresses for NAT.

ip nat service

Changes the amount of time after which NAT translations time out.

show ip nat statistics

Displays NAT statistics.

show ip nat translations

Displays active NAT translations.


clear ip nhrp

To clear all dynamic entries from the Next Hop Resolution Protocol (NHRP) cache, use the clear ip nhrp EXEC command.

clear ip nhrp

Syntax Description

This command has no arguments or keywords.

Command Modes

EXEC

Command History

Release
Modification

11.0

This command was introduced.


Usage Guidelines

This command does not clear any static (configured) IP-to-nonbroadcast multiaccess (NBMA) address mappings from the NHRP cache.

Examples

The following example clears all dynamic entries from the NHRP cache for the interface:

clear ip nhrp 

Related Commands

Command
Description

show ip nhrp

Displays the NHRP cache.


clear ip route

To delete routes from the IP routing table, use the clear ip route EXEC command.

clear ip route {network [mask] | *}

Syntax Description

network

Network or subnet address to remove.

mask

(Optional) Subnet address to remove.

*

Removes all routing table entries.


Defaults

All entries are removed.

Command Modes

EXEC

Command History

Release
Modification

10.0

This command was introduced.


Examples

The following example removes a route to network 132.5.0.0 from the IP routing table:

clear ip route 132.5.0.0

ip address

To set a primary or secondary IP address for an interface, use the ip address interface configuration command. To remove an IP address or disable IP processing, use the no form of this command.

ip address ip-address mask [secondary]

no ip address ip-address mask [secondary]

Syntax Description

ip-address

IP address.

mask

Mask for the associated IP subnet.

secondary

(Optional) Specifies that the configured address is a secondary IP address. If this keyword is omitted, the configured address is the primary IP address.


Defaults

No IP address is defined for the interface.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

An interface can have one primary IP address and multiple secondary IP addresses. Packets generated by the Cisco IOS software always use the primary IP address. Therefore, all routers and access servers on a segment should share the same primary network number.

Hosts can determine subnet masks using the Internet Control Message Protocol (ICMP) Mask Request message. Routers respond to this request with an ICMP Mask Reply message.

You can disable IP processing on a particular interface by removing its IP address with the no ip address command. If the software detects another host using one of its IP addresses, it will print an error message on the console.

The optional keyword secondary allows you to specify an unlimited number of secondary addresses. Secondary addresses are treated like primary addresses, except the system never generates datagrams other than routing updates with secondary source addresses. IP broadcasts and ARP requests are handled properly, as are interface routes in the IP routing table.

Secondary IP addresses can be used in a variety of situations. The following are the most common applications:

There may not be enough host addresses for a particular network segment. For example, your subnetting allows up to 254 hosts per logical subnet, but on one physical subnet you need to have 300 host addresses. Using secondary IP addresses on the routers or access servers allows you to have two logical subnets using one physical subnet.

Many older networks were built using Level 2 bridges. The judicious use of secondary addresses can aid in the transition to a subnetted, router-based network. Routers on an older, bridged segment can be easily made aware that there are many subnets on that segment.

Two subnets of a single network might otherwise be separated by another network. This situation is not permitted when subnets are in use. In these instances, the first network is extended, or layered on top of the second network using secondary addresses.


Note If any router on a network segment uses a secondary address, all other devices on that same segment must also use a secondary address from the same network or subnet. Inconsistent use of secondary addresses on a network segment can very quickly cause routing loops.



Note When you are routing Open Shortest Path First (OSPF), ensure that all secondary addresses of an interface fall into the same OSPF area as the primary addresses.


To transparently bridge IP on an interface, you must do two things:

Disable IP routing (specify no ip routing).

Add the interface to a bridge group. (See the bridge-group command.)

To concurrently route and transparently bridge IP on an interface, see the bridge crb command.

Examples

In the following example, 131.108.1.27 is the primary address and 192.31.7.17 and 192.31.8.17 are secondary addresses for Ethernet interface 0:

interface ethernet 0
 ip address 131.108.1.27 255.255.255.0
 ip address 192.31.7.17 255.255.255.0 secondary
 ip address 192.31.8.17 255.255.255.0 secondary

Related Commands

Command
Description

bridge crb

Enables the Cisco IOS software to both route and bridge a given protocol on separate interfaces within a single router.

bridge-group

Assigns each network interface to a bridge group.


ip broadcast-address

To define a broadcast address for an interface, use the ip broadcast-address interface configuration command. To restore the default IP broadcast address, use the no form of this command.

ip broadcast-address [ip-address]

no ip broadcast-address [ip-address]

Syntax Description

ip-address

(Optional) IP broadcast address for a network.


Defaults

Default address: 255.255.255.255 (all ones)

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.


Examples

The following example specifies an IP broadcast address of 0.0.0.0:

ip broadcast-address 0.0.0.0

ip cef traffic-statistics

To change the time interval that controls when NHRP will set up or tear down an SVC, use the ip cef traffic-statistics global configuration command. To restore the default values, use the no form of this command.

ip cef traffic-statistics [load-interval seconds] [update-rate seconds]

no ip cef traffic-statistics

Syntax Description

load-interval seconds

(Optional) Length of time (in 30-second increments) during which the average trigger-threshold and teardown-threshold are calculated before an SVC setup or teardown action is taken. (These thresholds are configured in the ip nhrp trigger-svc command.) The load-interval range is 30 seconds to 300 seconds, in 30-second increments. The default value is 30 seconds.

update-rate seconds

(Optional) Frequency that the port adapter sends the accounting statistics to the RP. When using NHRP in distributed CEF switching mode, this value must be set to 5 seconds. The default value is 10 seconds.


Defaults

load-interval: 30 seconds

update-rate: 10 seconds

Command Modes

Global configuration

Command History

Release
Modification

12.0

This command was introduced.


Usage Guidelines

The thresholds in the ip nhrp trigger-svc command must be exceeded during a certain time interval, which is 30 seconds by default. To change that interval, use the load-interval seconds argument of the ip cef traffic-statistics command.

When NHRP is configured on a CEF switching node with a VIP2 adapter, you must make sure the update-rate is set to 5 seconds.

Other features could also use the ip cef traffic-statistics command; this NHRP feature relies on it.

Examples

In the following example, the triggering and teardown thresholds are calculated based on an average over 120 seconds:

ip cef traffic-statistics load-interval 120

Related Commands

Command
Description

ip nhrp trigger-svc

Configures when NHRP will set up and tear down an SVC based on aggregate traffic rates.


ip classless

At times the router might receive packets destined for a subnet of a network that has no network default route. To have the Cisco IOS software forward such packets to the best supernet route possible, use the ip classless global configuration command. To disable this feature, use the no form of this command.

ip classless

no ip classless

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.

11.3

The default behavior changed from disabled to enabled.


Usage Guidelines

This command allows the software to forward packets that are destined for unrecognized subnets of directly connected networks. The packets are forwarded to the best supernet route.

When the ip classless feature is disabled, the software discards the packets when a router receives packets for a subnet that numerically falls within its subnetwork addressing scheme, if there is no such subnet number in the routing table and there is no network default route.


Note If the supernet, or default route, is learned via IS-IS or OSPF, the no ip classless configuration command is ignored.


Examples

The following example prevents the software from forwarding packets destined for an unrecognized subnet to the best supernet possible:

no ip classless

ip default-gateway

To define a default gateway (router) when IP routing is disabled, use the ip default-gateway global configuration command. To disable this function, use the no form of this command.

ip default-gateway ip-address

no ip default-gateway ip-address

Syntax Description

ip-address

IP address of the router.


Defaults

Disabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

The Cisco IOS software sends any packets that need the assistance of a gateway to the address you specify. If another gateway has a better route to the requested host, the default gateway sends an ICMP Redirect message back. The ICMP Redirect message indicates which local router the Cisco IOS software should use.

Examples

The following example defines the router on IP address 192.31.7.18 as the default router:

ip default-gateway 192.31.7.18

Related Commands

Command
Description

ip redirects

Enables the sending of ICMP Redirect messages if the Cisco IOS software is forced to resend a packet through the same interface on which it was received.

show ip redirects

Displays the address of a default gateway (router) and the address of hosts for which an ICMP Redirect message has been received.


ip directed-broadcast

To enable the translation of directed broadcast to physical broadcasts, use the ip directed-broadcast interface configuration command. To disable this function, use the no form of this command.

ip directed-broadcast [access-list-number] | [extended access-list-number]

no ip directed-broadcast [access-list-number] | [extended access-list-number]

Syntax Description

access-list-number

(Optional) Standard access list number in the range from 1 to 199. If specified, a broadcast must pass the access list to be forwarded.

extended access-list-number

(Optional) Extended access list number in the range from 1300 to 2699.


Defaults

Disabled; all IP directed broadcasts are dropped.

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.

12.0

The default behavior changed to directed broadcasts being dropped.


Usage Guidelines

An IP directed broadcast is an IP packet whose destination address is a valid broadcast address for some IP subnet, but which originates from a node that is not itself part of that destination subnet.

A router that is not directly connected to its destination subnet forwards an IP directed broadcast in the same way it would forward unicast IP packets destined to a host on that subnet. When a directed broadcast packet reaches a router that is directly connected to its destination subnet, that packet is "exploded" as a broadcast on the destination subnet. The destination address in the IP header of the packet is rewritten to the configured IP broadcast address for the subnet, and the packet is sent as a link-layer broadcast.

The ip directed-broadcast interface command controls the explosion of directed broadcasts when they reach their target subnets. The command affects only the final transmission of the directed broadcast on its ultimate destination subnet. It does not affect the transit unicast routing of IP directed broadcasts.

If directed broadcast is enabled for an interface, incoming IP packets whose addresses identify them as directed broadcasts intended for the subnet to which that interface is attached will be exploded as broadcasts on that subnet. If an access list has been configured with the ip directed-broadcast command, only directed broadcasts that are permitted by the access list in question will be forwarded; all other directed broadcasts destined for the interface subnet will be dropped.

If the no ip directed-broadcast command has been configured for an interface, directed broadcasts destined for the subnet to which that interface is attached will be dropped, rather than being broadcast.


Note Because directed broadcasts, and particularly Internet Control Message Protocol (ICMP) directed broadcasts, have been abused by malicious persons, we recommend that security-conscious users disable the ip directed-broadcast command on any intereface where directed broadcasts are not needed and that they use access lists to limit the number of exploded packets.


Examples

The following example enables forwarding of IP directed broadcasts on Ethernet interface 0:

interface ethernet 0
 ip directed-broadcast

Related Commands

Command
Description

ip forward-protocol

Specifies which protocols and ports the router forwards when forwarding broadcast packets.


ip domain-list

To define a list of default domain names to complete unqualified host names, use the ip domain-list global configuration command. To delete a name from a list, use the no form of this command.

ip domain-list name

no ip domain-list name

Syntax Description

name

Domain name. Do not include the initial period that separates an unqualified name from the domain name.


Defaults

No domain names are defined.

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

If there is no domain list, the domain name that you specified with the ip domain-name global configuration command is used. If there is a domain list, the default domain name is not used. The ip domain-list command is similar to the ip domain-name command, except that with ip domain-list you can define a list of domains, each to be tried in turn.

Examples

The following example adds several domain names to a list:

ip domain-list martinez.com
ip domain-list stanford.edu 

The following example adds a name to and then deletes a name from the list:

ip domain-list sunya.edu
no ip domain-list stanford.edu

Related Commands

Command
Description

ip domain-name

Defines a default domain name to complete unqualified host names (names without a dotted-decimal domain name).


ip domain-lookup

To enable the IP Domain Naming System (DNS)-based host name-to-address translation, use the ip domain-lookup global configuration command. To disable the DNS, use the no form of this command.

ip domain-lookup

no ip domain-lookup

Syntax Description

This command has no arguments or keywords.

Defaults

Enabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Examples

The following example enables the IP Domain Naming System-based host name-to-address translation:

ip domain-lookup

Related Commands

Command
Description

ip domain-name

Defines a default domain name to complete unqualified host names (names without a dotted-decimal domain name).

ip name-server

Specifies the address of one or more name servers to use for name and address resolution.


ip domain-name

To define a default domain name that the Cisco IOS software uses to complete unqualified host names (names without a dotted-decimal domain name), use the ip domain-name global configuration command. To disable use of the DNS, use the no form of this command.

ip domain-name name

no ip domain-name

Syntax Description

name

Default domain name used to complete unqualified host names. Do not include the initial period that separates an unqualified name from the domain name.


Defaults

Enabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

Any IP host name that does not contain a domain name (that is, any name without a dot), will have the dot and cisco.com appended to it before being added to the host table.

Examples

The following example defines cisco.com as the default domain name:

ip domain-name cisco.com

Related Commands

Command
Description

ip domain-list

Defines a list of default domain names to complete unqualified host names.

ip domain-lookup

Enables the IP DNS-based host name-to-address translation.

ip name-server

Specifies the address of one or more name servers to use for name and address resolution.


ip forward-protocol

To specify which protocols and ports the router forwards when forwarding broadcast packets, use the ip forward-protocol global configuration command. To remove a protocol or port, use the no form of this command.

ip forward-protocol {udp [port] | nd | sdns}

no ip forward-protocol {udp [port] | nd | sdns}

Syntax Description

udp

Forward User Datagram Protocol (UDP) datagrams. See the "Default" section below for a list of port numbers forwarded by default.

port

(Optional) Destination port that controls which UDP services are forwarded.

nd

Forward Network Disk (ND) datagrams. This protocol is used by older diskless Sun workstations.

sdns

Secure Data Network Service.


Defaults

If an IP helper address is defined, UDP forwarding is enabled on default ports. If UDP flooding is configured, UDP flooding is enabled on the default ports.

If a helper address is specified and UDP forwarding is enabled, broadcast packets destined to the following port numbers are forwarded by default:

Trivial File Transfer Protocol (TFTP) (port 69)

Domain Naming System (port 53)

Time service (port 37)

NetBIOS Name Server (port 137)

NetBIOS Datagram Server (port 138)

Boot Protocol (BOOTP) client and server datagrams (ports 67 and 68)

TACACS service (port 49)

IEN-116 Name Service (port 42)

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


ip forward-protocol spanning-tree

To permit IP broadcasts to be flooded throughout the internetwork in a controlled fashion, use the ip forward-protocol spanning-tree global configuration command. To disable the flooding of IP broadcasts, use the no form of this command.

ip forward-protocol spanning-tree [any-local-broadcast]

no ip forward-protocol spanning-tree [any-local-broadcast]

Syntax Description

any-local-broadcast

(Optional) Accept any local broadcast when flooding.


Defaults

Disabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

A packet must meet the following criteria to be considered for flooding:

The MAC address of the received frame must be all-ones broadcast address (ffff.ffff.ffff).

The IP destination address must be one of the following: all-ones broadcast (255.255.255.255), subnet broadcast for the receiving interface; major-net broadcast for the receiving interface if the no ip classless command is also configured; or any local IP broadcast address if the ip forward-protocol spanning-tree any-local-broadcast command is configured.

The IP time-to-live (TTL) value must be at least 2.

The IP protocol must be UDP (17).

The UDP destination port must be for TFTP, Domain Name System (DNS), Time, NetBIOS, ND, or BOOTP packet, or a UDP port specified by the ip forward-protocol udp global configuration command.

A flooded UDP datagram is given the destination address specified by the ip broadcast-address interface configuration command on the output interface. The destination address can be set to any desired address. Thus, the destination address may change as the datagram propagates through the network. The source address is never changed. The TTL value is decremented.

After a decision has been made to send the datagram out on an interface (and the destination address possibly changed), the datagram is handed to the normal IP output routines and is therefore subject to access lists, if they are present on the output interface.

The ip forward-protocol spanning-tree command uses the database created by the bridging spanning-tree protocol. Therefore, the transparent bridging option must be in the routing software, and bridging must be configured on each interface that is to participate in the flooding in order to support this capability.

If an interface does not have bridging configured, it still will be able to receive broadcasts, but it will never forward broadcasts received on that interface. Also, it will never use that interface to send broadcasts received on a different interface.

If no actual bridging is desired, you can configure a type-code bridging filter that will deny all packet types from being bridged. Refer to the "Configuring Transparent Bridging" chapter in the Bridging and IBM Networking Configuration Guide for more information about using access lists to filter bridged traffic. The spanning-tree database is still available to the IP forwarding code to use for the flooding.

The spanning-tree-based flooding mechanism forwards packets whose contents are all ones (255.255.255.255), all zeros (0.0.0.0), and, if subnetting is enabled, all networks (131.108.255.255 as an example in the network number 131.108.0.0). This mechanism also forward packets whose contents are the zeros version of the all-networks broadcast when subnetting is enabled (for example, 131.108.0.0).

This command is an extension of the ip helper-address interface configuration command, in that the same packets that may be subject to the helper address and forwarded to a single network can now be flooded. Only one copy of the packet will be put on each network segment.

Examples

The following example permits IP broadcasts to be flooded through the internetwork in a controlled fashion:

ip forward-protocol spanning-tree

Related Commands

Command
Description

ip broadcast-address

Defines a broadcast address for an interface.

ip forward-protocol

Specifies which protocols and ports the router forwards when forwarding broadcast packets.

ip forward-protocol turbo-flood

Speeds up flooding of UDP datagrams using the spanning-tree algorithm.

ip helper-address

Forwards UDP broadcasts, including BOOTP, received on an interface.


ip forward-protocol turbo-flood

To speed up flooding of User Datagram Protocol (UDP) datagrams using the spanning-tree algorithm, use the ip forward-protocol turbo-flood global configuration command. To disable this feature, use the no form of this command.

ip forward-protocol turbo-flood

no ip forward-protocol turbo-flood

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Global configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

Used in conjunction with the ip forward-protocol spanning-tree global configuration command, this feature is supported over Advanced Research Projects Agency (ARPA)-encapsulated Ethernets, FDDI, and HDLC-encapsulated serials, but is not supported on Token Rings. As long as the Token Rings and the non-HDLC serials are not part of the bridge group being used for UDP flooding, turbo flooding will behave normally.

Examples

The following is an example of a two-port router using this feature:

ip forward-protocol turbo-flood
ip forward-protocol spanning-tree
!
interface ethernet 0
 ip address 128.9.1.1
 bridge-group 1
!
interface ethernet 1
 ip address 128.9.1.2
 bridge-group 1
!
 bridge 1 protocol dec

Related Commands

Command
Description

ip forward-protocol

Specifies which protocols and ports the router forwards when forwarding broadcast packets.

ip forward-protocol spanning-tree

Permits IP broadcasts to be flooded throughout the internetwork in a controlled fashion.


ip helper-address

To have the Cisco IOS software forward User Datagram Protocol (UDP) broadcasts, including BOOTP, received on an interface, use the ip helper-address interface configuration command. To disable the forwarding of broadcast packets to specific addresses, use the no form of this command.

ip helper-address address

no ip helper-address address

Syntax Description

address

Destination broadcast or host address to be used when forwarding UDP broadcasts. There can be more than one helper address per interface.


Defaults

Disabled

Command Modes

Interface configuration

Command History

Release
Modification

10.0

This command was introduced.


Usage Guidelines

Combined with the ip forward-protocol global configuration command, the ip helper-address command allows you to control which broadcast packets and which protocols are forwarded.


Note In order for the ip helper-address command to function correctly, the ip bootp server command must be enabled.


One common application that requires helper addresses is Dynamic Host Configuration Protocol (DHCP), which is defined in RFC 1531. DHCP protocol information is carried inside of BOOTP packets. To enable BOOTP broadcast forwarding for a set of clients, configure a helper address on the router interface closest to the client. The helper address should specify the address of the DHCP server. If you have multiple servers, you can configure one helper address for each server. Because BOOTP packets are forwarded by default, DHCP information can now be forwarded by the router. The DHCP server now receives broadcasts from the DHCP clients.

All of the following conditions must be met in order for a UDP or IP packet to be helpered by the ip helper-address command:

The MAC address of the received frame must be all-ones broadcast address (ffff.ffff.ffff).

The IP destination address must be one of the following: all-ones broadcast (255.255.255.255), subnet broadcast for the receiving interface; or major-net broadcast for the receiving interface if the no ip classless command is also configu