DHCP Relay

The nv unset commands remove the configuration you set with the equivalent nv set commands. This guide only describes an nv unset command if it differs from the nv set command.

nv set service dhcp-relay <vrf-id> agent enable

Enables DHCP Agent Information Option 82, which allows a DHCP relay to insert circuit or relay specific information into a request that the switch forwards to a DHCP server. You can specify on or off.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.

Version History

Introduced in Cumulus Linux 5.7.0

Example

cumulus@switch:~$ nv set service dhcp-relay default agent enable on

nv set service dhcp-relay <vrf-id> agent remote-id <remote-id>

Sets the remote ID DHCP Agent Information Option 82, which includes information that identifies the relay agent, such as the MAC address. By default, this is the system MAC address of the device on which DHCP relay is running.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<remote-id>`	The remote ID, which includes information that identifies the relay agent, such as the MAC address.

Version History

Introduced in Cumulus Linux 5.7.0

Example

cumulus@switch:~$ nv set service dhcp-relay default agent remote-id 44:38:39:BE:EF:AA

nv set service dhcp-relay <vrf-id> agent use-pif-circuit-id enable

Enables Circuit ID DHCP Agent Information Option 82, which includes information about the circuit on which the request comes in, such as the SVI or physical port. By default, this is the printable name of the interface that receives the client request. You can specify on or off.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.

Version History

Introduced in Cumulus Linux 5.7.0

Example

cumulus@switch:~$ nv set service dhcp-relay default agent use-pif-circuit-id enable on

nv set service dhcp-relay <vrf-id> gateway-interface <interface-id>

Configures the gateway IPv4 address on an interface.

In Cumulus Linux 5.4 and earlier, this command is nv set service dhcp-relay <vrf-id> giaddress-interface <interface-id>

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The gateway interface.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay default gateway-interface lo

nv set service dhcp-relay <vrf-id> gateway-interface <interface-id> address

Configures the IPv4 address on the gateway interface.

In Cumulus Linux 5.4 and earlier, this command is nv set service dhcp-relay <vrf-id> giaddress-interface <interface-id> address <ipv4-address>.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The gateway IP address.
`<ipv4-address>`	The IPv4 address on the gateway interface.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay default gateway-address-interface address lo 10.10.10.1

nv set service dhcp-relay <vrf-id> interface <interface-id>

Configures the interfaces on which to configure DHCP relay.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The interface you want to configure.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay default interface swp51

nv set service dhcp-relay <vrf-id> server <server-id>

Configures the DHCP server.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<server-id>`	The IPv4 address of the DHCP server.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay default server 172.16.1.102

nv set service dhcp-relay <vrf-id> source-ip

Configures the source IP address to use on the relayed packet.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay default source-ip gateway

nv set service dhcp-relay6 <vrf-id> interface downstream <interface-id>

Configures the DHCP relay downstream interface.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The DHCP relay interface.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay6 default interface downstream swp1

nv set service dhcp-relay6 <vrf-id> interface downstream <interface-id> link-address <ipv6>

Configures the IPv6 address on DHCP relay downstream interface.

In Cumulus Linux 5.4 and earlier, the command is nv set service dhcp-relay6 <vrf-id> interface downstream <interface-id> address <ipv6>.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The DHCP relay downstream interface.
`<ipv6>`	The IPv6 address.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay6 default interface downstream swp1 address 2001:db8::1

nv set service dhcp-relay6 <vrf-id> interface upstream <interface-id>

Configures the upstream interface for DHCP relay for IPv6.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The DHCP relay upstream interface.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay6 default interface upstream swp51

nv set service dhcp-relay6 <vrf-id> interface upstream <interface-id> server-address <ipv6>

Configures the IPv6 address on the DHCP relay upstream interface.

In Cumulus Linux 5.4 and earlier, the command is nv set service dhcp-relay6 <vrf-id> interface upstream <interface-id> address <ipv6>.

Command Syntax

Syntax	Description
`<vrf-id>`	The VRF you want to configure.
`<interface-id>`	The DHCP relay interface.
`<ipv6>`	The IPv6 address.

Version History

Introduced in Cumulus Linux 5.0.0

Example

cumulus@switch:~$ nv set service dhcp-relay6 default interface upstream swp51 server-address 2001:db8:0002::0a00:0002