DHCP

DHCP configuration manages both IPv4 and IPv6 relay, snooping, and related services on NX-OS devices, enabling centralized IP address assignment and security enforcement across network segments. Global settings are organized under hierarchical sub-sections: ip_dhcp_relay controls relay enablement, information options, VPN awareness, trust, server ID override, circuit ID customization, sub-option formatting, DHCPv4-over-v6, and the relay source interface; ipv6_dhcp_relay controls IPv6 relay enablement, option79, VPN awareness, smart relay, IAPD route addition, and the relay source interface; ip_dhcp_snooping controls snooping enablement, MAC address verification, information options, the VLANs with DHCP snooping enabled (optionally extended to EVPN), and the VLANs excluded from IP Source Guard; ip_source_bindings defines static IP source bindings. DHCP interface-level relay configuration provides per-interface control over relay addresses with VRF support, trusted information options, smart relay, subnet broadcast, relay source interfaces, and IPv6 relay addresses across loopback, VLAN, Ethernet, and port-channel interfaces. Layer 2 Ethernet and port-channel interfaces can be marked as DHCP snooping trusted and can enable IP Source Guard (verify_source_dhcp_snooping_vlan), which requires the ipsg TCAM region.

DHCP configuration manages both IPv4 and IPv6 relay, snooping, and related services on NX-OS devices, enabling centralized IP address assignment and security enforcement across network segments. Global settings are organized under hierarchical sub-sections: ip_dhcp_relay controls relay enablement, information options, VPN awareness, trust, server ID override, circuit ID customization, sub-option formatting, and DHCPv4-over-v6; ipv6_dhcp_relay controls IPv6 relay enablement, option79, VPN awareness, smart relay, and IAPD route addition; ip_dhcp_snooping controls snooping enablement, MAC address verification, and information options. DHCP interface-level relay configuration provides per-interface control over relay addresses with VRF support, trusted information options, smart relay, subnet broadcast, and IPv6 relay addresses across loopback, VLAN, Ethernet, and port-channel interfaces.

Diagram

Diagram

Classes

nxos

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No
templates	List	templates	No

devices (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

templates (nxos)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
dhcp	Class	dhcp	No

configuration (nxos.devices)

Name	Type	Constraint	Mandatory	Default Value
interfaces	Class	interfaces	No
dhcp	Class	dhcp	No

dhcp (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ip_dhcp_relay	Class	ip_dhcp_relay	No
ipv6_dhcp_relay	Class	ipv6_dhcp_relay	No
ip_dhcp_snooping	Class	ip_dhcp_snooping	No
ip_dhcp_relay	Class	ip_dhcp_relay	No
ip_dhcp_smart_relay_global	Boolean	true, false	No
ip_dhcp_packet_strict_validation	Boolean	true, false	No
ipv6_dhcp_relay	Class	ipv6_dhcp_relay	No
ip_dhcp_snooping	Class	ip_dhcp_snooping	No
ip_source_bindings	List	ip_source_bindings	No

dhcp (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
ip_dhcp_relay	Class	ip_dhcp_relay	No
ipv6_dhcp_relay	Class	ipv6_dhcp_relay	No
ip_dhcp_snooping	Class	ip_dhcp_snooping	No
ip_dhcp_relay	Class	ip_dhcp_relay	No
ip_dhcp_smart_relay_global	Boolean	true, false	No
ip_dhcp_packet_strict_validation	Boolean	true, false	No
ipv6_dhcp_relay	Class	ipv6_dhcp_relay	No
ip_dhcp_snooping	Class	ip_dhcp_snooping	No

ip_dhcp_relay (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
information_option_trust	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
information_trust_all	Boolean	true, false	No
information_option_server_id_override	Boolean	true, false	No
sub_option_circuit_id_customized	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
sub_option_type_cisco	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
v4_over_v6	Boolean	true, false	No
source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
source_interface_id	Any	String or Integer[min: 0]	No
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
information_option_trust	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
information_trust_all	Boolean	true, false	No
information_option_server_id_override	Boolean	true, false	No
sub_option_circuit_id_customized	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
sub_option_type_cisco	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
v4_over_v6	Boolean	true, false	No
source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
source_interface_id	Any	String or Integer[min: 0]	No

ip_dhcp_relay (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
information_option_trust	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
information_trust_all	Boolean	true, false	No
information_option_server_id_override	Boolean	true, false	No
sub_option_circuit_id_customized	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
sub_option_type_cisco	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
v4_over_v6	Boolean	true, false	No
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
information_option_trust	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
information_trust_all	Boolean	true, false	No
information_option_server_id_override	Boolean	true, false	No
sub_option_circuit_id_customized	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
sub_option_type_cisco	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
v4_over_v6	Boolean	true, false	No

ipv6_dhcp_relay (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
option_type_cisco	Boolean	true, false	No
option79	Boolean	true, false	No
iapd_route_add	Boolean	true, false	No
smart_relay_global	Boolean	true, false	No
source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
source_interface_id	Any	String or Integer[min: 0]	No
enabled	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
option_type_cisco	Boolean	true, false	No
option79	Boolean	true, false	No
iapd_route_add	Boolean	true, false	No
smart_relay_global	Boolean	true, false	No
source_interface_type	Choice	ethernet, loopback, mgmt, port-channel, vlan, vni	No
source_interface_id	Any	String or Integer[min: 0]	No

ipv6_dhcp_relay (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
option_type_cisco	Boolean	true, false	No
option79	Boolean	true, false	No
iapd_route_add	Boolean	true, false	No
smart_relay_global	Boolean	true, false	No
enabled	Boolean	true, false	No
information_option_vpn	Boolean	true, false	No
option_type_cisco	Boolean	true, false	No
option79	Boolean	true, false	No
iapd_route_add	Boolean	true, false	No
smart_relay_global	Boolean	true, false	No

ip_dhcp_snooping (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
verify_mac_address	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
vlans	List	vlans	No
ipsg_excluded_vlans	Class	ipsg_excluded_vlans	No
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
verify_mac_address	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
vlans	List	vlans	No
ipsg_excluded_vlans	Class	ipsg_excluded_vlans	No

ip_dhcp_snooping (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
verify_mac_address	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No
enabled	Boolean	true, false	No
information_option	Boolean	true, false	No
verify_mac_address	Boolean	true, false	No
sub_option_format_non_tlv	Boolean	true, false	No
sub_option_circuit_id_format_string	String		No

ip_source_bindings (nxos.devices.configuration.dhcp)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		Yes
mac	MAC		Yes
vlan	Integer	min: 1, max: 4094	Yes
interface_type	Choice	ethernet, port-channel	Yes
interface_id	Any	String or Integer[min: 0]	Yes

vlans (nxos.devices.configuration.dhcp.ip_dhcp_snooping)

Name	Type	Constraint	Mandatory	Default Value
vlans	Class	vlans	Yes
evpn	Boolean	true, false	No
vlans	Class	vlans	Yes
evpn	Boolean	true, false	No

ipsg_excluded_vlans (nxos.devices.configuration.dhcp.ip_dhcp_snooping)

Name	Type	Constraint	Mandatory	Default Value
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No

vlans (nxos.devices.configuration.dhcp.ip_dhcp_snooping.vlans)

Name	Type	Constraint	Mandatory	Default Value
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No

ranges (nxos.devices.configuration.dhcp.ip_dhcp_snooping.ipsg_excluded_vlans)

Name	Type	Constraint	Mandatory	Default Value
from	Integer	min: 1, max: 4094	Yes
to	Integer	min: 1, max: 4094	Yes
from	Integer	min: 1, max: 4094	Yes
to	Integer	min: 1, max: 4094	Yes

interfaces (nxos.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
loopbacks	List	loopbacks	No
vlans	List	vlans	No
ethernets	List	ethernets	No
port_channels	List	port_channels	No

loopbacks (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
loopbacks	List	loopbacks	No

vlans (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
vlans	List	vlans	No

ethernets (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
ethernets	List	ethernets	No

port_channels (nxos.devices.configuration.interfaces)

Name	Type	Constraint	Mandatory	Default Value
port_channels	List	port_channels	No

ip_dhcp_relay (nxos.devices.configuration.interfaces.loopbacks)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 0	Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
description	String		No
logging_event_port_link_status	Boolean	true, false	No
vrf	String		No
ip	Class	ip	No
ipv6	Class	ipv6	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
bfd	Class	bfd	No
nd	Class	nd	No

ip_dhcp_relay (nxos.devices.configuration.interfaces.vlans)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 1, max: 4094	Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
autostate	Boolean	true, false	No
bandwidth	Integer	min: 1, max: 400000000	No
carrier_delay	Integer	min: 0, max: 60000	No
delay	Integer	min: 1, max: 16777215	No
description	String		No
management	Boolean	true, false	No
load_interval_counter_1	Integer	min: 60, max: 600	No
load_interval_counter_2	Integer	min: 60, max: 600	No
load_interval_counter_3	Integer	min: 60, max: 600	No
mac_address	MAC		No
medium	Choice	broadcast, p2p	No
mtu	Integer	min: 64, max: 9216	No
snmp_trap_link_status	Boolean	true, false	No
vrf	String		No
ip	Class	ip	No
ipv6	Class	ipv6	No
fabric_forwarding_mode	Choice	anycast-gw, proxy-gw	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
service_policy_type_qos_input	String		No
service_policy_type_qos_input_statistics	Boolean	true, false	No
nd	Class	nd	No
evpn_multisite_dci_tracking	Boolean	true, false	No
evpn_multisite_fabric_tracking	Boolean	true, false	No

ip_dhcp_relay (nxos.devices.configuration.interfaces.ethernets)

Name	Type	Constraint	Mandatory	Default Value
id	String		Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
shutdown_lan	Boolean	true, false	No
negotiate_auto	Choice	on, off, 25000	No
bandwidth	Integer	min: 0, max: 3200000000	No
beacon	Boolean	true, false	No
buffer_boost	Boolean	true, false	No
delay	Integer	min: 1, max: 16777215	No
description	String		No
dfe_adaptive_tuning	Boolean	true, false	No
dfe_tuning_delay	Integer	min: 100, max: 10000	No
dot1q_ethertype	Integer	min: 1536, max: 65535	No
duplex	Choice	auto, full, half	No
fec	Choice	fc-fec, rs-fec, fec-off, auto, rs-ieee, rs-cons16, kp-fec	No
flowcontrol_receive	Boolean	true, false	No
flowcontrol_send	Boolean	true, false	No
itu_channel	Integer	min: 1, max: 96	No
link_active_jitter_management	Boolean	true, false	No
link_debounce_time	Integer	min: 0, max: 20000	No
link_debounce_link_up	Integer	min: 0, max: 20000	No
link_flap_error_disable	Boolean	true, false	No
link_flap_error_disable_count	Integer	min: 2, max: 30	No
link_flap_error_disable_interval	Integer	min: 5, max: 420	No
logging_event_port_link_status	Boolean	true, false	No
link_loopback	Boolean	true, false	No
link_mac_up_timer	Integer	min: 0, max: 120	No
link_max_bring_up_timer	Integer	min: 0, max: 120	No
link_transmit_reset	Boolean	true, false	No
mac_address	MAC		No
mdix	Choice	auto, mdi, mdi-x	No
media_type	Choice	none, 10g-tx	No
medium	Choice	broadcast, p2p	No
mtu	Integer	min: 576, max: 9216	No
packet_timestamp_egress_source_id	Integer	min: 0, max: 8388606	No
packet_timestamp_ingress_source_id	Integer	min: 0, max: 8388606	No
packet_timestamp	Choice	disable, enable-ingress, enable-egress, enable-both	No
snmp_trap_link_status	Boolean	true, false	No
speed	Choice	unknown, 100m, 1g, 10g, 40g, auto, auto-100m, auto-100m-1g, 100g, 25000, 10m, 50g, 200g, 400g, 2.5g, 5g, auto-2.5g-5g-10g, auto-100m-1g-2.5g-5g, 800g	No
speed_group	Choice	unknown, 1000, 10000, 40000, auto, 25000	No
squelch	Boolean	true, false	No
logging_event_port_trunk_status	Boolean	true, false	No
uni_directional_ethernet	Choice	disable, send-only, receive-only	No
vrf	String		No
switchport	Class	switchport	No
ip	Class	ip	No
ipv6	Class	ipv6	No
channel_group	Integer	min: 1, max: 4096	No
channel_group_mode	Choice	on, static, active, passive, mac-pin	No
channel_group_force	Boolean	true, false	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
ptp	Class	ptp	No
service_policy_type_qos_input	String		No
service_policy_type_qos_input_statistics	Boolean	true, false	No
nd	Class	nd	No
subinterfaces	List	subinterfaces	No
spanning_tree	Class	spanning_tree	No
storm_control	Class	storm_control	No
cdp	Boolean	true, false	No
lldp_receive	Boolean	true, false	No
lldp_transmit	Boolean	true, false	No
lldp_tlv_set_management_address	IP		No
lldp_tlv_set_management_address_ipv6	IP		No
lldp_tlv_set_vlan	Integer	min: 0, max: 4094	No
lldp_dcbx_version	Choice	auto, CEE, IEEE	No
udld	Boolean	true, false	No
udld_aggressive	Boolean	true, false	No
evpn_multisite_dci_tracking	Boolean	true, false	No
evpn_multisite_fabric_tracking	Boolean	true, false	No
ttag	Boolean	true, false	No
ttag_inner	Boolean	true, false	No
ttag_marker	Boolean	true, false	No
ttag_strip	Boolean	true, false	No
port_type_fabric	Boolean	true, false	No
priority_flow_control_mode	Choice	auto, on, off	No
priority_flow_control_send_tlv	Boolean	true, false	No
priority_flow_control_watch_dog_interval	Boolean	true, false	No
priority_flow_control_watch_dog_disable_action	Boolean	true, false	No
priority_flow_control_watch_dog_interface_multiplier	Integer	min: 0, max: 40	No

ip_dhcp_relay (nxos.devices.configuration.interfaces.port_channels)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 1, max: 4096	Yes
interface_groups	List	String	No
lacp_min_links	Integer	min: 1, max: 32	No
lacp_max_bundle	Integer	min: 1, max: 32	No
lacp_suspend_individual	Boolean	true, false	No
lacp_graceful_convergence	Boolean	true, false	No
port_channel_hash_distribution	Choice	none, adaptive, fixed	No
lacp_mode_delay	Boolean	true, false	No
lacp_vpc_convergence	Boolean	true, false	No
port_channel_load_defer	Boolean	true, false	No
shutdown	Boolean	true, false	No
shutdown_lan	Boolean	true, false	No
negotiate_auto	Choice	on, off, 25000	No
bandwidth	Integer	min: 0, max: 3200000000	No
buffer_boost	Boolean	true, false	No
delay	Integer	min: 1, max: 16777215	No
description	String		No
dot1q_ethertype	Integer	min: 1536, max: 65535	No
duplex	Choice	auto, full, half	No
flowcontrol_receive	Boolean	true, false	No
flowcontrol_send	Boolean	true, false	No
itu_channel	Integer	min: 1, max: 96	No
link_debounce_time	Integer	min: 0, max: 20000	No
logging_event_port_link_status	Boolean	true, false	No
mdix	Choice	auto, mdi, mdi-x	No
medium	Choice	broadcast, p2p	No
mtu	Integer	min: 576, max: 9216	No
mac_address	MAC		No
snmp_trap_link_status	Boolean	true, false	No
speed	Choice	unknown, 100m, 1g, 10g, 40g, auto, auto-100m, auto-100m-1g, 100g, 25000, 10m, 50g, 200g, 400g, 2.5g, 5g, auto-2.5g-5g-10g, auto-100m-1g-2.5g-5g, 800g	No
squelch	Boolean	true, false	No
logging_event_port_trunk_status	Boolean	true, false	No
vrf	String		No
switchport	Class	switchport	No
ip	Class	ip	No
ipv6	Class	ipv6	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
ptp	Class	ptp	No
nd	Class	nd	No
vpc_id	Integer	min: 1, max: 16384	No
service_policy_type_qos_input	String		No
service_policy_type_qos_input_statistics	Boolean	true, false	No
subinterfaces	List	subinterfaces	No
spanning_tree	Class	spanning_tree	No
storm_control	Class	storm_control	No
cdp	Boolean	true, false	No
lldp_receive	Boolean	true, false	No
lldp_transmit	Boolean	true, false	No
lldp_tlv_set_management_address	IP		No
lldp_tlv_set_management_address_ipv6	IP		No
lldp_tlv_set_vlan	Integer	min: 0, max: 4094	No
lldp_dcbx_version	Choice	auto, CEE, IEEE	No
evpn_multisite_dci_tracking	Boolean	true, false	No
evpn_multisite_fabric_tracking	Boolean	true, false	No
ttag	Boolean	true, false	No
ttag_inner	Boolean	true, false	No
ttag_marker	Boolean	true, false	No
ttag_strip	Boolean	true, false	No
port_type_fabric	Boolean	true, false	No
priority_flow_control_mode	Choice	auto, on, off	No
priority_flow_control_send_tlv	Boolean	true, false	No
priority_flow_control_watch_dog_interval	Boolean	true, false	No
priority_flow_control_watch_dog_disable_action	Boolean	true, false	No
priority_flow_control_watch_dog_interface_multiplier	Integer	min: 0, max: 40	No

ip (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
address	IP		No
tag	Integer	min: 0, max: 4294967295	No
secondary_addresses	List	secondary_addresses	No
forward	Boolean	true, false	No
drop_glean	Boolean	true, false	No
unnumbered	String		No
directed_broadcast	Boolean	true, false	No
directed_broadcast_acl	String		No
redirects	Boolean	true, false	No
unreachables	Boolean	true, false	No
port_unreachable	Boolean	true, false	No
verify_unicast_source_reachable_via	Choice	disabled, rx, any, any-allow-default, rx-allow-vni-hosts	No
access_group_in	String		No
access_group_out	String		No
dhcp_relay_information_trusted	Boolean	true, false	No
dhcp_relay_smart_relay	Boolean	true, false	No
dhcp_relay_subnet_broadcast	Boolean	true, false	No
dhcp_relay_information_option	Boolean	true, false	No
dhcp_relay_source_subnet	String		No
dhcp_relay_addresses	List	dhcp_relay_addresses	No

ipv6 (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
address_autoconfig	Boolean	true, false	No
nd_default_route	Boolean	true, false	No
forward	Boolean	true, false	No
link_local_use_bia	Boolean	true, false	No
address_use_link_local_only	Boolean	true, false	No
verify_unicast_source_reachable_via	Choice	disabled, rx, any, any-allow-default, rx-allow-vni-hosts	No
address_link_local	IP		No
addresses	List	addresses	No
dhcp_smart_relay	Boolean	true, false	No
dhcp_relay_addresses	List	dhcp_relay_addresses	No
redirects	Boolean	true, false	No
unreachables	Boolean	true, false	No

ospf (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
process	String		Yes
advertise_secondaries	Boolean	true, false	No
advertise_subnet	Boolean	true, false	No
area	Any	IP or Integer[min: 0, max: 4294967295]	No
bfd	Boolean	true, false	No
cost	Integer	min: 0, max: 65535	No
dead_interval	Integer	min: 0, max: 65535	No
hello_interval	Integer	min: 0, max: 65535	No
mtu_ignore	Boolean	true, false	No
network	Choice	point-to-point, broadcast	No
prefix_attributes_n_flag_clear	Choice	unspecified, clear	No
passive_interface	Boolean	true, false	No
priority	Integer	min: 0, max: 255	No
retransmit_interval	Integer	min: 1, max: 65535	No
transmit_delay	Integer	min: 1, max: 450	No
authentication_key	String		No
message_digest_key_id	Integer	min: 0, max: 255	No
authentication_key_secure_mode	Boolean	true, false	No
authentication_key_chain	String		No
message_digest_key	String		No
message_digest_key_secure_mode	Boolean	true, false	No
authentication	Choice	simple, md5, none	No

ospfv3 (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
process	String		Yes
advertise_secondaries	Boolean	true, false	No
area	Any	IP or Integer[min: 0, max: 4294967295]	No
bfd	Boolean	true, false	No
cost	Integer	min: 0, max: 65535	No
dead_interval	Integer	min: 0, max: 65535	No
hello_interval	Integer	min: 1, max: 65535	No
network	Choice	none, p2p, bcast	No
passive_interface	Boolean	true, false	No
priority	Integer	min: 0, max: 255	No
instance_id	Integer	min: 0, max: 255	No
mtu_ignore	Boolean	true, false	No
retransmit_interval	Integer	min: 1, max: 65535	No
transmit_delay	Integer	min: 1, max: 450	No

pim (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
bfd_instance	Boolean	true, false	No
dr_priority	Integer	min: 1, max: 4294967295	No
passive	Boolean	true, false	No
sparse_mode	Boolean	true, false	No
border	Boolean	true, false	No
dr_delay	Integer	min: 1, max: 65535	No
jp_policy	String		No
neighbor_policy	String		No
neighbor_policy_prefix_list	String		No
strict_rfc_compliant	Boolean	true, false	No

isis (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
instance_name	String		Yes
circuit_type	Choice	level-1, level-2, level-1-2	No
ipv4	Boolean	true, false	No
ipv6	Boolean	true, false	No
network_point_to_point	Boolean	true, false	No
passive_interface	Choice	level-1, level-2, level-1-2, no-level-1, no-level-2, no-level-1-2	No
metric_level_1	Integer	min: 0, max: 16777216	No
metric_level_2	Integer	min: 0, max: 16777216	No
ipv6_metric_level_1	Integer	min: 0, max: 16777216	No
ipv6_metric_level_2	Integer	min: 0, max: 16777216	No
priority_level_1	Integer	min: 0, max: 127	No
priority_level_2	Integer	min: 0, max: 127	No
hello_interval	Integer	min: 1, max: 65535	No
hello_interval_level_1	Integer	min: 1, max: 65535	No
hello_interval_level_2	Integer	min: 1, max: 65535	No
hello_multiplier	Integer	min: 3, max: 1000	No
hello_multiplier_level_1	Integer	min: 3, max: 1000	No
hello_multiplier_level_2	Integer	min: 3, max: 1000	No
hello_padding	Choice	always, transient, never	No
authentication_check	Boolean	true, false	No
authentication_check_level_1	Boolean	true, false	No
authentication_check_level_2	Boolean	true, false	No
authentication_key_chain	String		No
authentication_key_chain_level_1	String		No
authentication_key_chain_level_2	String		No
authentication_type	Choice	clear, md5, unknown	No
authentication_type_level_1	Choice	clear, md5, unknown	No
authentication_type_level_2	Choice	clear, md5, unknown	No
mtu_check	Boolean	true, false	No
mtu_check_level_1	Boolean	true, false	No
mtu_check_level_2	Boolean	true, false	No
bfd	Boolean	true, false	No
ipv6_bfd	Boolean	true, false	No
csnp_interval_level_1	Integer	min: 1, max: 65535	No
csnp_interval_level_2	Integer	min: 1, max: 65535	No
lsp_interval	Integer	min: 10, max: 65535	No
retransmit_interval	Integer	min: 1, max: 65535	No
retransmit_throttle_interval	Integer	min: 20, max: 65535	No
mesh_group	Integer	min: 0, max: 4294967295	No
mesh_group_blocked	Boolean	true, false	No
prefix_attributes_n_flag_clear	Boolean	true, false	No
suppressed	Boolean	true, false	No

bfd (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
interval	Integer	min: 0, max: 999	No
min_rx	Integer	min: 0, max: 999	No
multiplier	Integer	min: 0, max: 50	No
echo	Boolean	true, false	No
echo_rx_interval	Integer	min: 0, max: 999	No
optimize_subinterface	Boolean	true, false	No
per_link	Boolean	true, false	No
source_ip	IP		No
vpc_watch	Boolean	true, false	No
track_member_link	Boolean	true, false	No
authentication_type	Choice	none, keyed-sha1, meticulous-keyed-sha1	No
authentication_key_id	Integer	min: 1, max: 255	No
authentication_key	String		No
authentication_interop	Boolean	true, false	No

nd (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
ra_bootfile_url	String		No
suppress_ra	Boolean	true, false	No
suppress_ra_mtu	Boolean	true, false	No
managed_config_flag	Boolean	true, false	No
other_config_flag	Boolean	true, false	No
redirects	Boolean	true, false	No
dad_attempts	Integer	min: 0, max: 15	No
dadns_interval	Integer	min: 1000, max: 6000	No
delete_adj_on_mac_delete	Boolean	true, false	No
ra_dns_search_list_suppress	Boolean	true, false	No
ra_dns_server_suppress	Boolean	true, false	No
hop_limit	Integer	min: 0, max: 255	No
mac_extract	Choice	none, nud-phase, exclude-nud-phase	No
mtu	Integer	min: 1280, max: 65535	No
ns_interval	Integer	min: 1000, max: 3600000	No
ra_interval	Integer	min: 4, max: 1800	No
ra_interval_minimum	Integer	min: 3, max: 1350	No
ra_lifetime	Integer	min: 0, max: 9000	No
reachable_time	Integer	min: 0, max: 3600000	No
retrans_timer	Integer	min: 0, max: 4294967295	No
ra_route_suppress	Boolean	true, false	No
router_preference	Choice	low, medium, high	No

hsrp (nxos.devices.configuration.interfaces.vlans.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
version	Integer	min: 1, max: 2	No
bfd	Boolean	true, false	No
use_bia	Boolean	true, false	No
use_bia_scope	Choice	global, local	No
delay_minimum	Integer	min: 0, max: 10000	No
delay_reload	Integer	min: 0, max: 10000	No
mac_refresh	Integer	min: 0, max: 10000	No
groups	List	groups	No

switchport (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
enabled	Boolean	true, false	No
mode	Choice	access, trunk, fex-fabric, dot1q-tunnel, promiscuous, host, trunk-secondary, trunk-promiscuous, vntag	No
access_vlan	Integer	min: 1, max: 4094	No
autostate_exclude_vlans	Class	autostate_exclude_vlans	No
block	List	Choice[unicast, multicast]	No
isolated	Boolean	true, false	No
mac_learning	Boolean	true, false	No
trunk_native_vlan	Integer	min: 1, max: 4094	No
trunk_allowed_vlans	Class	trunk_allowed_vlans	No
monitor	Boolean	true, false	No
priority_extend_cos	Integer	min: -1, max: 7	No
priority_extend_trust	Boolean	true, false	No
voice_vlan	Integer	min: 1, max: 4092	No
voice_vlan_type	Choice	none, tagged, dot1p, untagged	No

ptp (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
admin_state	Boolean	true, false	No
announce_interval	Integer	min: -3, max: 4	No
announce_interval_profile	Choice	none, aes67, smpte-2059-2	No
announce_timeout	Integer	min: 2, max: 10	No
announce_timeout_profile	Choice	none, aes67, smpte-2059-2	No
sync_interval	Integer	min: -7, max: 1	No
sync_interval_profile	Choice	none, aes67, smpte-2059-2	No
delay_request_minimum_interval	Integer	min: -4, max: 6	No
delay_request_minimum_interval_profile	Choice	none, aes67, smpte-2059-2	No
transmission	Choice	multicast, unicast	No
transport	Choice	ipv4, ipv6, ethernet	No
role	Choice	master, slave, dynamic	No
cost	Integer	min: 0, max: 255	No
vlan	Integer	min: 1, max: 4094	No
domain	Integer	min: 0, max: 127	No
profile_override	Boolean	true, false	No
destination_mac	Choice	forwardable, non-forwardable	No
receive_no_match	Choice	accept, drop, follow-rx	No
transmission_unicast_negotiation_schema	String		No
neighbor_propagation_delay_threshold	Integer	min: 5, max: 2000000	No
asymmetric_delay_value	Integer	min: 0, max: 512000000	No
asymmetric_delay_direction	Choice	none, forward-path, reverse-path	No
ucast_source	IP		No
ucast_source_ipv6	IP		No
ucast_source_vrf	String		No
ucast_source_vrf_ipv6	String		No
ipv6_multicast_scope_tx	Integer	min: 0, max: 65535	No
ipv6_multicast_scope_rx	Integer	min: 0, max: 65535	No
ucast_peers	List	ucast_peers	No

subinterfaces (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 1, max: 4093	Yes
interface_groups	List	String	No
shutdown	Boolean	true, false	No
bandwidth	Integer	min: 0, max: 3200000000	No
delay	Integer	min: 1, max: 16777215	No
description	String		No
encapsulation	String		No
logging_event_port_link_status	Boolean	true, false	No
medium	Choice	broadcast, p2p	No
mtu	Integer	min: 576, max: 9216	No
mac_address	MAC		No
mac_address_ipv6_extract	Boolean	true, false	No
snmp_trap_link_status	Boolean	true, false	No
vrf	String		No
ip	Class	ip	No
ipv6	Class	ipv6	No
ospf	Class	ospf	No
ospfv3	Class	ospfv3	No
pim	Class	pim	No
isis	Class	isis	No
hsrp	Class	hsrp	No
bfd	Class	bfd	No
nd	Class	nd	No

spanning_tree (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
bpdufilter	Boolean	true, false	No
bpduguard	Boolean	true, false	No
cost	Integer	min: 0, max: 200000000	No
guard	Choice	root, loop, none	No
link_type	Choice	auto, point-to-point, shared	No
port_type	Choice	edge, network, normal	No
port_priority	Integer	min: 0, max: 224	No
mst_pre_standard	Boolean	true, false	No
mst_simulate_pvst	Boolean	true, false	No

storm_control (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay)

Name	Type	Constraint	Mandatory	Default Value
action	List	Choice[none, shutdown, trap]	No
broadcast_level	List	Number	No
broadcast_pps	Integer	min: 0, max: 4294967295	No
multicast_level	List	Number	No
multicast_pps	Integer	min: 0, max: 4294967295	No
unicast_level	List	Number	No
unicast_pps	Integer	min: 0, max: 4294967295	No

secondary_addresses (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay.ip)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
tag	Integer	min: 0, max: 4294967295	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay.ip)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
vrf	String		No

addresses (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
type	Choice	primary, secondary	No
tag	Integer	min: 0, max: 4294967295	No
eui64	Boolean	true, false	No
route_preference	Integer	min: 0, max: 255	No

dhcp_relay_addresses (nxos.devices.configuration.interfaces.loopbacks.ip_dhcp_relay.ipv6)

Name	Type	Constraint	Mandatory	Default Value
address	IP		Yes
vrf	String		No

groups (nxos.devices.configuration.interfaces.vlans.ip_dhcp_relay.hsrp)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: 0, max: 4095	Yes
address_family	Choice	ipv4, ipv6	Yes
authentication_md5_compatibility	Boolean	true, false	No
authentication_md5_key_chain	String		No
authentication_md5_key_string	String		No
authentication_md5_key_string_type	Choice	unencrypted, hidden	No
authentication_md5_timeout	Integer	min: 0, max: 32767	No
authentication_md5_type	Choice	key-chain, key-string	No
authentication_text	String		No
authentication_type	Choice	simple, md5	No
follow	String		No
forwarding_threshold_lower	Integer	min: 0, max: 255	No
timers_hello	Integer	min: 250, max: 254000	No
timers_hold	Integer	min: 750, max: 255000	No
ip	IP		No
mac_address	MAC		No
name	String		No
preempt	Boolean	true, false	No
preempt_delay_minimum	Integer	min: 0, max: 3600	No
preempt_delay_reload	Integer	min: 0, max: 3600	No
preempt_delay_sync	Integer	min: 0, max: 3600	No
priority	Integer	min: 0, max: 255	No

autostate_exclude_vlans (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay.switchport)

Name	Type	Constraint	Mandatory	Default Value
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No

trunk_allowed_vlans (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay.switchport)

Name	Type	Constraint	Mandatory	Default Value
ids	List	Integer[min: 1, max: 4094]	No
ranges	List	ranges	No

ucast_peers (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay.ptp)

Name	Type	Constraint	Mandatory	Default Value
ip	IP		Yes
transmission_unicast_negotiation_schema	String		No

ranges (nxos.devices.configuration.interfaces.ethernets.ip_dhcp_relay.switchport.autostate_exclude_vlans)

Name	Type	Constraint	Mandatory	Default Value
from	Integer	min: 1, max: 4094	Yes
to	Integer	min: 1, max: 4094	Yes

Examples

Example 1: Basic DHCP relay with option 82 insertion for a leaf switch

nxos:
  devices:
    - name: LEAF1
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_vpn: true

Example 2: DHCP snooping with MAC verification for access layer security

nxos:
  devices:
    - name: LEAF2
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_trust: true
          ip_dhcp_snooping:
            enabled: true
            information_option: true
            verify_mac_address: true

Example 3: Full DHCP configuration with IPv6 relay, smart relay, and custom circuit ID

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_vpn: true
            information_option_trust: true
            information_option_server_id_override: true
            sub_option_circuit_id_customized: true
            sub_option_circuit_id_format_string: "%p:%v"
            sub_option_type_cisco: true
          ipv6_dhcp_relay:
            enabled: true
            option79: true
            smart_relay_global: true
          ip_dhcp_snooping:
            enabled: true
            verify_mac_address: true
          ip_dhcp_packet_strict_validation: true

Example 4: Interface-level DHCP relay with IPv4 and IPv6 relay addresses on a VLAN SVI

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          vlans:
            - id: 100
              ip:
                dhcp_relay_addresses:
                  - address: 10.1.1.1
                  - address: 10.1.1.2
                    vrf: management
              ipv6:
                dhcp_relay_addresses:
                  - address: 2001:db8::1
                    vrf: management

Example 5: DHCP relay with global and per-interface IPv4 and IPv6 relay source interfaces

nxos:
  devices:
    - name: LEAF1
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            source_interface_type: loopback
            source_interface_id: 0
          ipv6_dhcp_relay:
            enabled: true
            source_interface_type: loopback
            source_interface_id: 0
        interfaces:
          vlans:
            - id: 200
              ip:
                dhcp_relay_source_interface_type: loopback
                dhcp_relay_source_interface_id: 1
                dhcp_relay_addresses:
                  - address: 10.1.1.1
              ipv6:
                dhcp_relay_source_interface_type: loopback
                dhcp_relay_source_interface_id: 1
                dhcp_relay_addresses:
                  - address: 2001:db8::1

Example 6: DHCP snooping on access VLANs with trusted uplinks, IP Source Guard and a static IP source binding

nxos:
  devices:
    - name: ACCESS-LEAF1
      configuration:
        dhcp:
          ip_dhcp_snooping:
            enabled: true
            vlans:
              - vlans:
                  ids: [10, 20]
              - vlans:
                  ranges:
                    - from: 100
                      to: 110
                evpn: true
            ipsg_excluded_vlans:
              ids: [20]
          ip_source_bindings:
            - ip: 10.1.10.50
              mac: 00:00:11:11:22:22
              vlan: 10
              interface_type: ethernet
              interface_id: 1/10
        interfaces:
          ethernets:
            - id: 1/10
              ip:
                verify_source_dhcp_snooping_vlan: true
          port_channels:
            - id: 1
              ip:
                dhcp_snooping_trust: true

Examples

Example 1: Basic DHCP relay with option 82 insertion for a leaf switch

nxos:
  devices:
    - name: LEAF1
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_vpn: true

Example 2: DHCP snooping with MAC verification for access layer security

nxos:
  devices:
    - name: LEAF2
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_trust: true
          ip_dhcp_snooping:
            enabled: true
            information_option: true
            verify_mac_address: true

Example 3: Full DHCP configuration with IPv6 relay, smart relay, and custom circuit ID

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        dhcp:
          ip_dhcp_relay:
            enabled: true
            information_option: true
            information_option_vpn: true
            information_option_trust: true
            information_option_server_id_override: true
            sub_option_circuit_id_customized: true
            sub_option_circuit_id_format_string: "%p:%v"
            sub_option_type_cisco: true
          ipv6_dhcp_relay:
            enabled: true
            option79: true
            smart_relay_global: true
          ip_dhcp_snooping:
            enabled: true
            verify_mac_address: true
          ip_dhcp_packet_strict_validation: true

Example 4: Interface-level DHCP relay with IPv4 and IPv6 relay addresses on a VLAN SVI

nxos:
  devices:
    - name: LEAF1
      configuration:
        interfaces:
          vlans:
            - id: 100
              ip_dhcp_relay:
                addresses:
                  - address: 10.1.1.1
                  - address: 10.1.1.2
                    vrf: management
              ipv6_dhcp_relay_addresses:
                - address: 2001:db8::1
                  vrf: management