use-interface-description
Syntax
use-interface-description (logical | device);
Hierarchy Level
[edit forwarding-options dhcp-relay dhcpv6 (relay-agent-interface-id | relay-agent-remote-id)], [edit forwarding-options dhcp-relay dhcpv6 group group-name (relay-agent-interface-id | relay-agent-remote-id)], [edit forwarding-options dhcp-relay relay-option-82 (circuit-id | remote-id)], [edit forwarding-options dhcp-relay group group-name relay-option-82 (circuit-id | remote-id)], [edit logical-systems logical-system-name forwarding-options dhcp-relay dhcpv6 (relay-agent-interface-id | relay-agent-remote-id)], [edit logical-systems logical-system-name forwarding-options dhcp-relay relay-option-82 (circuit-id | remote-id)], [edit routing-instances routing-instance-name forwarding-options dhcp-relay dhcpv6 (relay-agent-interface-id | relay-agent-remote-id)], [edit routing-instances routing-instance-name forwarding-options dhcp-relay relay-option-82 (circuit-id | remote-id)], [edit vlans vlan-name forwarding-options dhcp-security dhcpv6-options option-18], [edit vlans vlan-name forwarding-options dhcp-security dhcpv6-options option-37]
Description
Use the textual interface description instead of the interface identifier in the DHCP base option 82 Agent Circuit ID (suboption 1) or Agent Remote ID (suboption 2) information, or in the DHCPv6 option 18 (Relay Agent Interface ID) or option 37 (Relay Agent Remote ID) information in DHCP packets that the DHCP relay agent sends to a DHCP server.
For integrated routing and bridging (IRB) interfaces, the option 82 field must be able to uniquely identify the incoming interface based on either the Agent Circuit ID or Agent Remote ID. You can modify the information in the textual interface description to match the raw IFD (physical interface without a subunit) name and configure the option 82 field to use the interface description.
The
textual description is configured using the description statement at the [edit
interfaces interface-name] hierarchy level. If you specify that
the textual description be used and no description is configured for the interface, DHCP relay
defaults to using the Layer 2 interface name. When you use the interface description rather
than the interface name, the interface description has to be specified under interface unit
("set interfaces ge-0/0/0 unit 0 description "client"). If you do not do this, then the interface
name is used.
In the case of integrated routing and bridging (IRB) interfaces, the textual description
of the Layer 2 interface is used instead of the IRB interface. If there is no description
configured, the Layer 2 logical interface name is used. To include the IRB interface description
instead of the Layer 2 interface description, configure the use-interface-description and the no-vlan-interface-name statements. If no description is configured for
the IRB interface, DHCP relay defaults to using the IRB interface name.
The use-interface-description statement is mutually exclusive with
the use-vlan-id statement.
If you specify the textual interface description, rather than accepting the default syntax, the identification is for packets returned from the server, and only for instances where that identification would be required by the DHCP relay, such as a stateless pass-through.
By default, DHCP relay accepts a maximum of 253 ASCII characters. If the textual interface description exceeds 253 characters, DHCP relay drops the packet, which results in the DHCP client failing to bind.
Options
logical—Use the textual description that is configured
for the logical interface.
device—Use the textual description that is configured for the device
interface.
Required Privilege Level
interface—To view this statement in the configuration.
interface-control—To add this statement to the configuration.
Release Information
Statement introduced in Junos OS Release 9.6.
Support at the [edit ... dhcpv6] hierarchy levels introduced in Junos OS
Release 11.4.
Support at the [edit ... relay-agent-remote-id] and [edit ... remote-id] hierarchy levels introduced in Junos OS Release 14.1.
Support at the [edit vlans vlan-name dhcp-security dhcpv6-options
option-18] and [edit vlans vlan-name dhcp-security dhcpv6-options
option-37] hierarchy levels introduced in Junos OS Release 14.1X53-D10 for EX Series
switches.