Configuring the Cisco IOS DHCP Relay Agent

All Cisco devices that run Cisco software include a DHCP server and the relay agent software. A DHCP relay agent is any host or IP device that forwards DHCP packets between clients and servers. This module describes the concepts and tasks needed to configure the Cisco IOS DHCP relay agent.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the feature information table.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/​go/​cfn. An account on Cisco.com is not required.

Prerequisites for Configuring the Cisco IOS DHCP Relay Agent

  • Before you configure the DHCP relay agent, you should understand the concepts documented in the “DHCP Overview” module.

  • The Cisco IOS DHCP server and relay agent are enabled by default. You can verify whether they have been disabled by checking your configuration file. If they have been disabled, the no service dhcp command will appear in the configuration file. Use the service dhcp command to reenable the functionality if necessary.

  • The Cisco IOS DHCP relay agent will be enabled on an interface only when the ip helper-address command is configured. This command enables the DHCP broadcast to be forwarded to the configured DHCP server.

Information About the DHCP Relay Agent

DHCP Relay Agent Overview

A DHCP relay agent is any host that forwards DHCP packets between clients and servers. Relay agents are used to forward requests and replies between clients and servers when they are not on the same physical subnet. Relay agent forwarding is distinct from the normal forwarding of an IP device, where IP datagrams are switched between networks somewhat transparently. By contrast, relay agents receive DHCP messages and then generate a new DHCP message to send out on another interface. The relay agent sets the gateway IP address (giaddr field of the DHCP packet) and, if configured, adds the relay agent information option (option82) in the packet and forwards it to the DHCP server. The reply from the server is forwarded back to the client after removing option 82.

The DHCP relay agent supports the use of unnumbered interfaces. An unnumbered interface can “borrow” the IP address of another interface already configured on the device, which conserves network and address space. For DHCP clients connected though the unnumbered interfaces, the DHCP relay agent automatically adds a static host route once the DHCP client obtains an address, specifying the unnumbered interface as the outbound interface. The route is automatically removed once the lease time expires or when the client releases the address.

How to Configure the DHCP Relay Agent

Specifying the Packet Forwarding Address

Perform this task to configure the DHCP relay agent to forward packets to a DHCP server.

SUMMARY STEPS

    1.    enable

    2.    configure terminal

    3.    interface type number

    4.    ip helper-address address


DETAILED STEPS
     Command or ActionPurpose
    Step 1 enable


    Example: 
    Device> enable
     

    Enables privileged EXEC mode.

    • Enter your password if prompted.

     
    Step 2 configure terminal


    Example: 
    Device# configure terminal
     

    Enters global configuration mode.

     
    Step 3 interface type number


    Example: 
    Device(config)# interface GigabitEthernet0/0/0
     

    Configures an interface and enters interface configuration mode.

     
    Step 4 ip helper-address address


    Example: 
    Device(config-if)# ip helper-address 172.16.1.2
     

    Forwards UPD broadcasts, including BOOTP and DHCP.

    • The addressargument can be a specific DHCP server address, or it can be the network address if other DHCP servers are on the destination network segment. Using the network address enables other servers to respond to DHCP requests.

    • If you have multiple servers, you can configure one helper address for each server.

     

    Configuring Support for the Relay Agent Information Option

    Automatic DHCP address allocation is typically based on an IP address, which may be either the gateway IP address (giaddr field of the DHCP packet) or the incoming interface IP address. In some networks, additional information may be required to further determine the IP addresses that need to be allocated. By using the relay agent information option (option 82), the Cisco IOS relay agent can include additional information about itself when forwarding client-originated DHCP packets to a DHCP server. Cisco software supports this functionality by using the ip dhcp relay information option command. The relay agent will automatically add the circuit identifier suboption and the remote ID suboption to the relay agent information option and forward them to the DHCP server.

    The DHCP server can use this information to assign IP addresses, perform access control, and set quality of service (QoS) and security policies (or other parameter-assignment policies) for each subscriber of a service provider network.

    The figure below shows how the relay agent information option is inserted into the DHCP packet as follows:

    1. The DHCP client generates a DHCP request and broadcasts it on the network.

    2. The DHCP relay agent intercepts the broadcast DHCP request packet and inserts the relay agent information option (option 82) into the packet. The relay agent information option contains related suboptions.

    3. The DHCP relay agent unicasts the DHCP packet to the DHCP server.

    4. The DHCP server receives the packet, uses the suboptions to assign IP addresses and other configuration parameters to the packet, and forwards the packet back to the client.

    5. The suboption fields are stripped off of the packet by the relay agent while forwarding the packet to the client.

    Figure 1. Operation of the Relay Agent Information Option

    A DHCP relay agent may receive a message from another DHCP relay agent that already contains relay information. By default, the relay information from the previous relay agent is replaced. If this behavior is not suitable for your network, you can use the ip dhcp relay information policy {drop | keep | replace} global configuration command to change it.

    To ensure the correct operation of the reforwarding policy, disable the relay agent information check by using the no ip dhcp relay information check global configuration command.

    Before You Begin

    It is important to understand how DHCP options work. See the “DHCP Overview” module for more information.


    Note
    • If the ip dhcp relay information command is configured in global configuration mode but not configured in interface configuration mode, the global configuration is applied to all interfaces.
    • If the ip dhcp relay information command is configured in both global configuration mode and interface configuration mode, the interface configuration command takes precedence over the global configuration command. However, the global configuration is applied to interfaces without the interface configuration.
    • If the ip dhcp relay information command is not configured in global configuration mode but is configured in interface configuration mode, only the interface with the configuration option applied is affected. All other interfaces are not impacted by the configuration.
    See the “Configuring Relay Agent Information Option Support per Interface” section for more information on per-interface support for the relay agent information option.
    SUMMARY STEPS

      1.    enable

      2.    configure terminal

      3.    ip dhcp relay information option

      4.    ip dhcp relay information check

      5.    ip dhcp relay information policy {drop | keep | replace}

      6.    ip dhcp relay information trust-all

      7.    end

      8.    show ip dhcp relay information trusted-sources


    DETAILED STEPS
       Command or ActionPurpose
      Step 1 enable


      Example: 
      Device> enable
       

      Enables privileged EXEC mode.

      • Enter your password if prompted.

       
      Step 2 configure terminal


      Example: 
      Device# configure terminal
       

      Enters global configuration mode.

       
      Step 3 ip dhcp relay information option


      Example: 
      Device(config)# ip dhcp relay information option
       

      Enables the system to insert the DHCP relay agent information option (option-82 field) in BOOTREQUEST messages forwarded to a DHCP server.

      • This function is disabled by default.

       
      Step 4 ip dhcp relay information check


      Example: 
      Device(config)# ip dhcp relay information check
       

      (Optional) Configures DHCP to check whether the relay agent information option in forwarded BOOTREPLY messages is valid.

      • By default, DHCP verifies whether the option-82 field in DHCP reply packets that it receives from the DHCP server is valid. If an invalid message is received, the relay agent drops the packet. If a valid message is received, the relay agent removes the option-82 field and forwards the packet. Use the ip dhcp relay information check command to reenable this functionality if it has been disabled.

       
      Step 5 ip dhcp relay information policy {drop | keep | replace}


      Example: 
      Device(config)# ip dhcp relay information policy replace
       

      (Optional) Configures the reforwarding policy (that specifies what a relay agent should do if a message already contains relay information) for a DHCP relay agent.

       
      Step 6 ip dhcp relay information trust-all


      Example: 
      Device(config)# ip dhcp relay information trust-all
       

      (Optional) Configures all interfaces on a device as trusted sources of the DHCP relay information option.

      • By default, if the gateway address is set to all zeros in the DHCP packet and the relay agent information option is already present in the packet, the DHCP relay agent will discard the packet. Use the ip dhcp relay information trust-all command to override this behavior and accept the packets.

      • This command is useful if there is a switch placed between the client and the relay agent that may insert option 82. Use this command to ensure that these packets do not get dropped.

      • You can configure an individual interface as a trusted source of the DHCP relay information option by using the ip dhcp relay information trusted interface configuration mode command.

       
      Step 7 end


      Example: 
      Device(config)# end
       

      Returns to privileged EXEC mode.

       
      Step 8 show ip dhcp relay information trusted-sources


      Example: 
      Device# show ip dhcp relay information trusted-sources
       

      (Optional) Displays all interfaces that are configured to be a trusted source for the DHCP relay information option.

       

      Configuring Per-Interface Support for the Relay Agent Information Option

      The interface configuration allows a Cisco device to reach subscribers with different DHCP option 82 requirements on different interfaces.

      Before You Begin

      It is important to understand how DHCP options work. See the “DHCP Overview” module for more information.


      Note
      • If the ip dhcp relay information command is configured in global configuration mode but not configured in interface configuration mode, the global configuration is applied to all interfaces.
      • If the ip dhcp relay information command is configured in both global configuration mode and interface configuration mode, the interface configuration command takes precedence over the global configuration command. However, the global configuration is applied to interfaces without the interface configuration.
      • If the ip dhcp relay information command is not configured in global configuration mode but is configured in interface configuration mode, only the interface on which the configuration option is applied is affected. All other interfaces are not impacted by the configuration.
      SUMMARY STEPS

        1.    enable

        2.    configure terminal

        3.    interface type number

        4.    ip dhcp relay information option-insert [none]

        5.    ip dhcp relay information check-reply [none]

        6.    ip dhcp relay information policy-action {drop | keep | replace}

        7.    exit

        8.    Repeat Steps 3 through 7 to configure relay agent information settings on different interfaces.


      DETAILED STEPS
         Command or ActionPurpose
        Step 1 enable


        Example: 
        Device> enable
         

        Enables privileged EXEC mode.

        • Enter your password if prompted.

         
        Step 2 configure terminal


        Example: 
        Device# configure terminal
         

        Enters global configuration mode.

         
        Step 3 interface type number


        Example: 
        Device(config)# interface FastEthernet0/0
         

        Configures an interface and enters interface configuration mode.

         
        Step 4 ip dhcp relay information option-insert [none]


        Example: 
        Device(config-if)# ip dhcp relay information option-insert
         

        Enables the system to insert the DHCP relay agent information option (option-82 field) in forwarded BOOTREQUEST messages to a DHCP server.

        • This function is disabled by default. However, if support for the relay agent information option is configured in global configuration mode, but not configured in interface configuration mode, the interface inherits the global configuration.

        • The ip dhcp relay information option-insert none interface configuration command is saved in the running configuration. This command takes precedence over any global relay agent information configuration.

         
        Step 5 ip dhcp relay information check-reply [none]


        Example: 
        Device(config-if)# ip dhcp relay information check-reply
         

        Configures a DHCP server to validate the relay information option in forwarded BOOTREPLY messages.

        • By default, DHCP verifies whether the option-82 field in the DHCP reply packets that it receives from the DHCP server is valid. If an invalid message is received, the relay agent drops the packet. If a valid message is received, the relay agent removes the option-82 field and forwards the packet. Use the ip dhcp relay information check-reply command to reenable this functionality if it has been disabled.

        • The ip dhcp relay information check-reply none interface configuration command option is saved in the running configuration. This command takes precedence over any global relay agent information configuration.

         
        Step 6 ip dhcp relay information policy-action {drop | keep | replace}


        Example: 
        Device(config-if)# ip dhcp relay information policy-action replace
         

        Configures the information reforwarding policy (that specifies what a relay agent should do if a message already contains relay information) for a DHCP relay agent.

         
        Step 7 exit


        Example: 
        Device(config-if)# exit
         

        Exits interface configuration mode.

         
        Step 8 Repeat Steps 3 through 7 to configure relay agent information settings on different interfaces.  

        —

         

        Configuring the Subscriber Identifier Suboption of the Relay Agent Information Option

        Perform this task to enable an Internet service provider (ISP) to add a unique identifier to the subscriber-identifier suboption of the relay agent information option.

        The unique identifier enables an ISP to identify a subscriber, to assign specific actions to that subscriber (for example, assignment of host IP address, subnet mask, and domain name system DNS), and to trigger accounting.

        Before the introduction of this feature, if a subscriber moved, each ISP had to be informed of the change and all ISPs had to reconfigure the DHCP settings for the affected customers at the same time. Even if the service was not changed, every move involved administrative changes in the ISP environment. With the introduction of this feature, if a subscriber moves from one Network Access Server to another, there is no need for a change in the configuration on the part of the DHCP server or ISP.

        Before You Begin

        You should configure the unique identifier for each subscriber.

        The new configurable subscriber-identifier option should be configured on the interface connected to the client. When a subscriber moves from one interface to the other, the interface configuration should also be changed.

        The server should be able to recognize the new suboption.

        SUMMARY STEPS

          1.    enable

          2.    configure terminal

          3.    ip dhcp relay information option

          4.    interface type number

          5.    ip dhcp relay information option subscriber-id string


        DETAILED STEPS
           Command or ActionPurpose
          Step 1 enable


          Example: 
          Device> enable
           

          Enables privileged EXEC mode.

          • Enter your password if prompted.

           
          Step 2 configure terminal


          Example: 
          Device# configure terminal
           

          Enters global configuration mode.

           
          Step 3 ip dhcp relay information option


          Example: 
          Device(config)# ip dhcp relay information option
           

          Enables the system to insert the DHCP relay agent information option (option-82 field) in forwarded BOOTREQUEST messages to a DHCP server.

          • This function is disabled by default.

           
          Step 4 interface type number


          Example: 
          Device(config)# interface atm4/0/0
           

          Configures an interface and enters interface configuration mode.

           
          Step 5 ip dhcp relay information option subscriber-id string


          Example: 
          Device(config-if)# ip dhcp relay information option subscriber-id newsubscriber123
           

          Specifies that a DHCP relay agent add a subscriber identifier suboption to the relay information option.

          • The string argument can be up to a maximum of 50 characters and can be alphanumeric.

          Note   

          If more than 50 characters are configured, the string is truncated.

          Note   

          The ip dhcp relay information option subscriber-idcommand is disabled by default to ensure backward capability.

           

          Configuring DHCP Relay Class Support for Client Identification

          DHCP relay class support for client identification allows the Cisco relay agent to forward client-generated DHCP messages to different DHCP servers based on the content of the following four options:

          • Option 60: vendor class identifier

          • Option 77: user class

          • Option 124: vendor-identifying vendor class

          • Option 125: vendor-identifying vendor-specific information

          Each option identifies the type of client that is sending the DHCP message.

          Relay pools provide a method to define DHCP pools that are not used for address allocation. These relay pools can specify that DHCP messages from clients on a specific subnet should be forwarded to a specific DHCP server. These relay pools can be configured with relay classes inside the pool that help determine the forwarding behavior.

          For example, after receiving the option in a DHCP DISCOVER message, the relay agent will match and identify the relay class from the relay pool and then direct the DHCP DISCOVER message to the DHCP server associated with that identified relay class.

          In an example application, a Cisco device acting as a DHCP relay agent receives DHCP requests from two VoIP services (H.323 and the Session Initiation Protocol [SIP]). The requesting devices are identified by option 60.

          Both VoIP services have a different back-office infrastructure, so they cannot be serviced by the same DHCP server. Requests for H.323 devices must be forwarded to the H.323 server, and requests from SIP devices must be forwarded to the SIP server. The solution is to configure the relay agent with relay classes that are configured to match option 60 values sent by the client devices. Based on the option value, the relay agent will match and identify the relay class, and forward the DHCP DISCOVER message to the DHCP server associated with the identified relay class.

          The Cisco IOS DHCP server examines the relay classes that are applicable to a pool and then uses the exact match class regardless of the configuration order. If the exact match is not found, the DHCP server uses the first default match found.

          Before You Begin

          It is important to understand how DHCP options work. See the “DHCP Overview” module for more information.

          You must know the hexadecimal value of each byte location in the options to be able to configure the option hex command. The format may vary from product to product. Contact the relay agent vendor for this information.

          SUMMARY STEPS

            1.    enable

            2.    configure terminal

            3.    ip dhcp class class-name

            4.    option code hex hex-pattern [*][mask bit-mask-pattern]

            5.    exit

            6.    Repeat Steps 3 through 5 for each DHCP class that you need to configure.

            7.    ip dhcp pool name

            8.    relay source ip-address subnet-mask

            9.    class class-name

            10.    relay target [vrf vrf-name | global] ip-address

            11.    exit

            12.    Repeat Steps 9 through 11 for each DHCP class that you need to configure.


          DETAILED STEPS
             Command or ActionPurpose
            Step 1 enable


            Example: 
            Device> enable
             

            Enables privileged EXEC mode.

            • Enter your password if prompted.

             
            Step 2 configure terminal


            Example: 
            Device# configure terminal
             

            Enters global configuration mode.

             
            Step 3 ip dhcp class class-name


            Example: 
            Device(config)# ip dhcp class SIP
             

            Defines a DHCP class and enters DHCP class configuration mode.

             
            Step 4 option code hex hex-pattern [*][mask bit-mask-pattern]


            Example: 
            Device(dhcp-class)# option 60 hex 010203
             

            Enables the relay agent to make forwarding decisions based on DHCP options inserted in the DHCP message.

             
            Step 5 exit


            Example: 
            Device(dhcp-class)# exit
             

            Exits DHCP class configuration mode.

             
            Step 6 Repeat Steps 3 through 5 for each DHCP class that you need to configure.  

            —

             
            Step 7 ip dhcp pool name


            Example: 
            Device(config)# ip dhcp pool ABC
             

            Configures a DHCP pool on a DHCP server and enters DHCP pool configuration mode.

             
            Step 8 relay source ip-address subnet-mask


            Example: 
            Device(dhcp-config)# relay source 10.2.0.0 255.0.0.0
             

            Configures the relay source.

            • This command is similar to the network command in a normal DHCP network pool, because it restricts the use of the address pool to packets arriving on the interface whose configured IP address and mask match the relay source configuration.

             
            Step 9 class class-name


            Example: 
            Device(dhcp-config)# class SIP
             

            Associates a class with a DHCP pool and enters DHCP pool class configuration mode.

             
            Step 10 relay target [vrf vrf-name | global] ip-address


            Example: 
            Device(config-dhcp-pool-class)# relay target 10.21.3.1
             

            Configures an IP address for a DHCP server to which packets are forwarded.

             
            Step 11 exit


            Example: 
            Device(config-dhcp-pool-class)# exit
             

            Exits DHCP pool class configuration mode.

             
            Step 12 Repeat Steps 9 through 11 for each DHCP class that you need to configure.  

            —

             

            Configuring DHCP Relay Agent Support for MPLS VPNs

            Perform this task to configure DHCP relay agent support for MPLS VPNs.

            Before You Begin

            Before configuring DHCP relay support for MPLS VPNs, you must configure standard MPLS VPNs.

            SUMMARY STEPS

              1.    enable

              2.    configure terminal

              3.    ip dhcp relay information option vpn

              4.    interface type number

              5.    ip helper-address vrf name [global] address


            DETAILED STEPS
               Command or ActionPurpose
              Step 1 enable


              Example: 
              Device> enable
               

              Enables privileged EXEC mode.

              • Enter your password if prompted.

               
              Step 2 configure terminal


              Example: 
              Device# configure terminal
               

              Enters global configuration mode.

               
              Step 3 ip dhcp relay information option vpn


              Example: 
              Device(config)# ip dhcp relay information option vpn
               

              Enables the system to insert VPN suboptions into the DHCP relay agent information option in forwarded BOOTREQUEST messages to a DHCP server and sets the gateway address to the outgoing interface toward the DHCP server.

              • The VPN suboptions are also added to the BOOTP broadcast packets when the command is configured.

               
              Step 4 interface type number


              Example: 
              Device(config)# interface GigabitEthernet0/0/0
               

              Configures an interface and enters interface configuration mode.

               
              Step 5 ip helper-address vrf name [global] address


              Example: 
              Device(config-if)# ip helper-address vrf blue 172.27.180.232
               

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

              • If the DHCP server resides in a different VPN or global space that is different from the VPN, then the vrf name or global options allow you to specify the name of the VRF or global space in which the DHCP server resides.

               

              Configuring Support for Relay Agent Information Option Encapsulation

              When two relay agents are relaying messages between the DHCP client and the DHCP server, the relay agent closer to the server, by default, replaces the first option 82 information with its own option 82. The remote ID and circuit ID information from the first relay agent is lost. In some deployment scenarios, it is necessary to maintain the initial option 82 from the first relay agent, in addition to the option 82 from the second relay agent, for example, in a situation where an Intelligent Services Gateway (ISG) acting as a second relay agent is connected to a Layer 2 device. The Layer 2 device connects to the household and identifies the household with its own option 82.

              The DHCP Relay Option 82 Encapsulation feature allows the second relay agent to encapsulate option 82 information in a received message from the first relay agent if the second relay agent is configured to add its own option 82 information. This configuration allows the DHCP server to use option 82 information from both relay agents. The DHCP server can use the VPN information from the second relay agent, along with the option 82 information from the first relay agent, to send correct address assignments and other configuration parameters for the client devices based on the VRF, option 60, and encapsulated option 82. The reply message from the DHCP server to the DHCP client traverses the same path as the request messages through the two relay agents to the DHCP client.

              The figure below shows the processing that occurs on the two relay agents and the DHCP server when this feature is configured:

              1. The DHCP client generates a DHCP message (including option 60) and broadcasts it on the network.

              2. The first DHCP relay agent intercepts the broadcast DHCP request packet and inserts its own option 82 in the packet.

              3. The relay agent automatically adds the circuit ID suboption and the remote ID suboption to option 82 and forwards them to the second relay agent.

              4. The second relay agent encapsulates the first relay agent’s option 82 and inserts its own option 82.

              5. The gateway IP address (giaddr) is set to the incoming interface on the second relay agent and the original giaddr from the first relay agent is encapsulated.

              6. The second DHCP relay agent unicasts the DHCP packet to the DHCP server.

              7. The DHCP server receives the packet and uses the VPN suboption information from the second relay agent, along with the option 82 information from the first relay agent, to assign IP addresses and other configuration parameters and forwards the packet back to the second relay agent.

              8. When the second relay agent receives the reply message from the server, it restores the encapsulated option 82 and prior giaddr from the first relay agent. The reply message is then sent to the prior giaddr.

              9. The first relay agent strips option 82 off from the packet before forwarding the packet to the client.

              Figure 2. Processing DHCP Relay Agent Information Option Encapsulation Support

              SUMMARY STEPS

                1.    enable

                2.    configure terminal

                3.    ip dhcp relay information option

                4.    ip dhcp relay information option vpn

                5.    ip dhcp relay information policy encapsulate

                6.    interface type number

                7.    ip dhcp relay information policy-action encapsulate

                8.    end


              DETAILED STEPS
                 Command or ActionPurpose
                Step 1 enable


                Example:
                Device> enable
                 

                Enables privileged EXEC mode.

                • Enter your password if prompted.

                 
                Step 2 configure terminal


                Example:
                Device# configure terminal
                 

                Enters global configuration mode.

                 
                Step 3 ip dhcp relay information option


                Example:
                Device(config)# ip dhcp relay information option
                 

                Enables the system to insert the DHCP relay agent information option (option-82 field) in forwarded BOOTREQUEST messages to a DHCP server.

                • This function is disabled by default.

                 
                Step 4 ip dhcp relay information option vpn


                Example:
                Device(config)# ip dhcp relay information option vpn
                 

                (Optional) Enables the system to insert VPN suboptions into the DHCP relay agent information option in forwarded BOOTREQUEST messages to a DHCP server and sets the gateway address to the outgoing interface toward the DHCP server.

                • The VPN suboptions are also added to the BOOTP broadcast packets when the command is configured.

                 
                Step 5 ip dhcp relay information policy encapsulate


                Example:
                Device(config)# ip dhcp relay information policy encapsulate
                 

                Enables the system to encapsulate the DHCP relay agent information option (option-82 field) received from a prior relay agent in forwarded BOOTREQUEST messages to a DHCP server.

                • Option 82 information from both relay agents will be forwarded to the DHCP server.

                 
                Step 6 interface type number


                Example:
                Device(config)# interface FastEthernet0/0
                 

                (Optional) Configures an interface and enters interface configuration mode.

                • If you configure the global configuration command, there is no need to configure the interface configuration command unless you want to apply a different configuration on a specific interface.

                 
                Step 7 ip dhcp relay information policy-action encapsulate


                Example:
                Device(config-if)# ip dhcp relay information policy-action encapsulate
                 

                (Optional) Enables the system to encapsulate the DHCP relay agent information option (option-82 field) received on an interface from a prior relay agent in forwarded BOOTREQUEST messages to a DHCP server on an interface.

                • This function is disabled by default. This command has precedence over the global configuration command. However, if the relay agent information option encapsulation support is configured in global configuration mode, but not in interface configuration mode, the interface inherits the global configuration.

                 
                Step 8 end


                Example:
                Device(config-if)# end
                 

                Returns to privileged EXEC mode.

                 

                Setting the Gateway Address of the DHCP Broadcast to a Secondary Address Using Smart Relay Agent Forwarding

                You only need to configure helper addresses on the interface where the UDP broadcasts that you want to forward to the DHCP server are being received. You only need to configure the ip dhcp smart-relay command if you have secondary addresses on that interface and you want the device to step through each IP network when forwarding DHCP requests. If smart relay agent forwarding is not configured, all requests are forwarded using the primary IP address on the interface.

                If the ip dhcp smart-relay command is configured, the relay agent counts the number of times that the client retries sending a request to the DHCP server when there is no DHCPOFFER message from the DHCP server. After three retries, the relay agent sets the gateway address to the secondary address. If the DHCP server still does not respond after three more retries, then the next secondary address is used as the gateway address.

                This functionality is useful when the DHCP server cannot be configured to use secondary pools.

                SUMMARY STEPS

                  1.    enable

                  2.    configure terminal

                  3.    ip dhcp smart-relay

                  4.    exit


                DETAILED STEPS
                   Command or ActionPurpose
                  Step 1 enable


                  Example: 
                  Device> enable
                   

                  Enables privileged EXEC mode.

                  • Enter your password if prompted.

                   
                  Step 2 configure terminal


                  Example: 
                  Device# configure terminal
                   

                  Enters global configuration mode.

                   
                  Step 3 ip dhcp smart-relay


                  Example: 
                  Device(config)# ip dhcp smart-relay
                   

                  Allows the DHCP relay agent to switch the gateway address (giaddr field of a DHCP packet) to a secondary address when there is no DHCPOFFER message from a DHCP server.

                   
                  Step 4 exit


                  Example: 
                  Device(config)# exit
                   

                  Returns to privileged EXEC mode.

                   

                  Configuring Support for Private and Standard Suboption Numbers

                  Some features that are not standardized will use the private Cisco relay agent suboption numbers. After the features are standardized, the relay agent suboptions are assigned the Internet Assigned Numbers Authority (IANA) numbers. Cisco software supports both private and IANA numbers for these suboptions.

                  Perform this task to configure the DHCP client to use private or IANA standard relay agent suboption numbers.

                  SUMMARY STEPS

                    1.    enable

                    2.    configure terminal

                    3.    ip dhcp compatibility suboption link-selection {cisco | standard}

                    4.    exit


                  DETAILED STEPS
                     Command or ActionPurpose
                    Step 1 enable


                    Example:
                    Device> enable
                     

                    Enables privileged EXEC mode.

                    • Enter your password if prompted.

                     
                    Step 2 configure terminal


                    Example:
                    Device# configure terminal
                     

                    Enters global configuration mode.

                     
                    Step 3 ip dhcp compatibility suboption link-selection {cisco | standard}


                    Example:
                    Device(config)# ip dhcp compatibility suboption link-selection standard
                     

                    Configures the DHCP client to use private or IANA standard relay agent suboption numbers.

                     
                    Step 4 exit


                    Example:
                    Device(config)# exit
                     

                    (Optional) Exits global configuration mode and returns to privileged EXEC mode.

                     

                    Troubleshooting the DHCP Relay Agent

                    Perform this task to troubleshoot the DHCP relay agent.

                    The show ip route dhcp command is useful to help you understand any problems with the DHCP relay agent adding routes to clients from unnumbered interfaces. All routes added to the routing table by the DHCP server and relay agent are displayed.

                    SUMMARY STEPS

                      1.    enable

                      2.    show ip route dhcp

                      3.    show ip route dhcp ip-address

                      4.    show ip route vrf vrf-name dhcp

                      5.    clear ip route [vrf vrf-name] dhcp [ip-address]


                    DETAILED STEPS
                       Command or ActionPurpose
                      Step 1 enable


                      Example: 
                      Device> enable
                       

                      Enables privileged EXEC mode.

                      • Enter your password if prompted.

                       
                      Step 2 show ip route dhcp


                      Example: 
                      Device# show ip route dhcp
                       

                      Displays all routes added by the DHCP server and relay agent.

                       
                      Step 3 show ip route dhcp ip-address


                      Example: 
                      Device# show ip route dhcp 172.16.1.3
                       

                      Displays all routes added by the DHCP server and relay agent associated with an IP address.

                       
                      Step 4 show ip route vrf vrf-name dhcp


                      Example: 
                      Device# show ip route vrf red dhcp
                       

                      Displays all routes added by the DHCP server and relay agent associated with the named VRF.

                       
                      Step 5 clear ip route [vrf vrf-name] dhcp [ip-address]


                      Example: 
                      Device# clear ip route dhcp
                       

                      Removes routes from the routing table added by the DHCP server and relay agent for the DHCP clients on unnumbered interfaces.

                       

                      Configuration Examples for the Cisco IOS DHCP Relay Agent

                      Example: Configuring Support for the Relay Agent Information Option

                      The following example shows how to enable the DHCP server, the relay agent, and the insertion and removal of the DHCP relay information option (option 82). Note that the Cisco IOS DHCP server is enabled by default. In this example, the DHCP server is disabled: 

                      ! Reenables the DHCP server.
service dhcp
ip dhcp relay information option
!
interface ethernet0/0
 ip address 192.168.100.1 255.255.255.0
 ip helper-address 10.55.11.3

                      Example: Configuring Per-Interface Support for the Relay Agent Information Option

                      The following example shows that for subscribers who are being serviced by the same aggregation device, the relay agent information option for ATM subscribers must be processed differently from that for Ethernet digital subscribers. For ATM subscribers, the relay agent information option is configured to be removed from the packet by the relay agent before forwarding the packet to the client. For Ethernet subscribers, the connected device provides the relay agent information option, and the option is configured to remain in the packet and be forwarded to the client. 

                      ip dhcp relay information trust-all
interface Loopback0
 ip address 10.16.0.1 255.255.255.0
!
interface ATM3/0
 no ip address
!
interface ATM3/0.1
 ip helper-address 10.16.1.2
 ip unnumbered loopback0
 ip dhcp relay information option-insert
!
interface Loopback1
 ip address 10.18.0.1 255.255.255.0
!
interface Ethernet4
 no ip address
!
interface Ethernet4/0.1
 encapsulation dot1q 123
 ip unnumbered loopback1
 ip helper-address 10.18.1.2
 ip dhcp relay information policy-action keep

                      Example: Configuring the Subscriber Identifier Suboption of the Relay Agent Information Option

                      The following example shows how to add a unique identifier to the subscriber-identifier suboption of the relay agent information option: 

                      ip dhcp relay information option
!
interface Loopback0 
 ip address 10.1.1.129 255.255.255.192 
!
interface ATM4/0 
 no ip address 
!
interface ATM4/0.1 point-to-point
 ip helper-address 10.16.1.2
 ip unnumbered Loopback0
 ip dhcp relay information option subscriber-id newperson123
 atm route-bridged ip
 pvc 88/800
 encapsulation aal5snap

                      Example: Configuring DHCP Relay Class Support for Client Identification

                      In the following example, DHCP messages are received from DHCP clients on subnet 10.2.2.0. The relay agent will match and identify the relay class from the relay pool and forward the DHCP message to the appropriate DHCP server identified by the relay target command. 

                      !
ip dhcp class H323
 option 60 hex 010203
!
ip dhcp class SIP
 option 60 hex 040506
! 
! The following is the relay pool:
ip dhcp pool pool1
 relay source 10.2.2.0 255.255.255.0
 class H323
  relay target 192.168.2.1
  relay target 192.168.3.1
!
 class SIP
  relay target 192.168.4.1

                      Example: Configuring DHCP Relay Agent Support for MPLS VPNs

                      In the following example, the DHCP relay agent receives a DHCP request on Ethernet interface 0/1 and sends the request to the DHCP server located at IP helper address 10.44.23.7, which is associated with the VRF named vrf1: 

                      ip dhcp relay information option vpn
!
interface ethernet 0/1
 ip helper-address vrf vrf1 10.44.23.7
!

                      Example: Configuring Support for Relay Agent Information Option Encapsulation

                      In the following example, DHCP relay agent 1 is configured globally to insert the relay agent information option into the DHCP packet. DHCP relay agent 2 is configured to add its own relay agent information option, including the VPN information, and to encapsulate the relay agent information option received from DHCP relay agent 1. The DHCP server receives the relay agent information options from both the relay agents, uses this information to assign IP addresses and other configuration parameters, and forwards them back to the client.

                      DHCP Relay Agent 1

                      ip dhcp relay information option

                      DHCP Relay Agent 2

                      ip dhcp relay information option
ip dhcp relay information option vpn
ip dhcp relay information option encapsulation

                      Example: Setting the Gateway Address of the DHCP Broadcast to a Secondary Address Using Smart Relay Agent Forwarding

                      In the following example, the router will forward the DHCP broadcast received on Ethernet interface 0/0 to the DHCP server (10.55.11.3), by inserting 192.168.100.1 in the giaddr field of the DHCP packet. If the DHCP server has a scope or pool configured for the 192.168.100.0/24 network, the server will respond; otherwise, it will not respond.

                      Because the ip dhcp smart-relay global configuration command is configured, if the router sends three requests using 192.168.100.1 in the giaddr field and does not get a response, the router will move on and start using 172.16.31.254 in the giaddr field instead. Without the smart relay functionality, the router uses only 192.168.100.1 in the giaddr field. 

                      ip dhcp smart-relay
!
interface ethernet0/0
 ip address 192.168.100.1 255.255.255.0
 ip address 172.16.31.254 255.255.255.0
 ip helper-address 10.55.11.3
!

                      Additional References

                      Related Documents

                      Related Topic

                      Document Title

                      Cisco IOS commands

                      Cisco IOS Master Commands List, All Releases

                      IPv6 commands

                      Cisco IOS IPv6 Command Reference

                      IPv6 addressing and connectivity

                      IPv6 Configuration Guide

                      Cisco IOS IPv6 features

                      Cisco IOS IPv6 Feature Mapping

                      Standards and RFCs

                      Standard/RFC

                      Title

                      RFCs for IPv6

                      IPv6 RFCs

                      Technical Assistance

                      Description

                      Link

                      The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password.

                      http:/​/​www.cisco.com/​cisco/​web/​support/​index.html

                      Feature Information for the Cisco IOS DHCP Relay Agent

                      The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.

                      Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to . An account on Cisco.com is not required.
                      Table 1 Feature Information for the Cisco IOS DHCP Relay Agent

                      Feature Name

                      Releases

                      Feature Information

                      DHCP Class Support for Client Identification

                      12.4(11)T

                      The DHCP Class Support for Client Identification feature enhances the DHCP class mechanism to support options 60, 77, 124, and 125. These options identify the type of client that is sending the DHCP message. The DHCP relay agent can make forwarding decisions based on the content of the options in the DHCP message sent by the client.

                      The following command was introduced by this feature: option hex.

                      DHCP Relay MPLS VPN Support

                      12.2(8)

                      12.2(28)SB

                      12.2(33)SRC

                      DHCP relay support for MPLS VPNs enables a network administrator to conserve address space by allowing overlapping addresses. The relay agent can support multiple clients on different VPNs, and many of these clients from different VPNs can share the same IP address.

                      The following commands were modified by this feature: ip dhcp relay information option, and ip helper address.

                      DHCP Relay Option 82 Encapsulation

                      12.2(33)SRD

                      This feature allows a second DHCP relay agent to encapsulate the relay agent information option (option 82) from a prior relay agent, to add its own option 82, and to forward the packet to the DHCP server. The DHCP server can use the VPN information from the second relay agent, along with the option 82 information from the first relay agent, to send correct address assignments and other configuration parameters for the client devices based on the VRF, option 60, and encapsulated option 82.

                      The following commands were modified by this feature: ip dhcp relay information policy, and ip dhcp relay information policy-action.

                      DHCP Relay Option 82 per Interface Support

                      12.2(31)SB2

                      12.2(33)SRC

                      12.4(6)T

                      This feature enables support for the DHCP relay agent information option (option 82) on a per-interface basis. The interface configuration allows different DHCP servers, with different DHCP option 82 requirements to be reached from one Cisco router.

                      The following commands were introduced by this feature: ip dhcp relay information check-reply, ip dhcp relay information option-insert, and ip dhcp relay information policy-action.

                      DHCP Subscriber Identifier Suboption of Option 82

                      12.2(28)SB

                      12.2(33)SRB

                      12.3(14)T

                      This feature enables an ISP to add a unique identifier to the subscriber-identifier suboption of the relay agent information option.

                      The following command was introduced by this feature: ip dhcp relay information option subscriber-id.

                      DHCPv4 Relay per Interface VPN ID Support

                      12.4(11)T

                      The DHCPv4 Relay per Interface VPN ID Support feature allows the Cisco IOS DHCP relay agent to be configured per interface to override the global configuration of the ip dhcp relay information option vpn command. This feature allows subscribers with different relay information option VPN ID requirements on different interfaces to be reached from one Cisco router.

                      The following command was introduced by this feature: ip dhcp relay information option vpn-id.

                      DHCPv6 Bulk Lease Query

                      15.1(1)S

                      The Cisco IOS DHCPv6 relay agent supports bulk lease query in accordance with RFC 5460.

                      The following commands were introduced or modified by this feature: debug ipv6 dhcp relay and ipv6 dhcp-relay bulk-lease.

                      Glossary

                      CPE --customer premises equipment. Terminating equipment, such as terminals, telephones, and modems, supplied by the service provider, installed at customer sites, and connected to the network.

                      DSLAM --digital subscriber line access multiplexer. A device that connects many digital subscriber lines to a network by multiplexing the DSL traffic onto one or more network trunk lines.

                      ISSU --In Service Software Upgrade. ISSU is a process that allows Cisco IOS software to be updated or otherwise modified while packet forwarding continues.

                      ODAP --On-Demand Address Pool. ODAPs enable pools of IP addresses to be dynamically increased or reduced in size depending on the address utilization level. Once configured, the ODAP is populated with one or more subnets leased from a source server and is ready to serve address requests from DHCP clients or from PPP sessions.

                      RP --Route Processor. A generic term for the centralized control unit in a chassis.

                      SSO --Stateful Switchover. SSO refers to the implementation of Cisco IOS software that allows applications and features to maintain a defined state between an active and standby RP. When a switching occurs, forwarding and sessions are maintained. SSO makes an RP failure undetectable to the network.