DHCP Relay

DHCP (Dynamic Host Configuration Protocol) Relay.

URLs Summary

URL	GET	POST	PATCH	PUT	DELETE
/rest/v1/running/dhcp-relay/{name}	Y	Y	Y	N	Y
/rest/v1/running/dhcp-relay/{name}/downlink-vlans/{vlan}	Y	Y	N	N	Y
/rest/v1/rpc/show-dhcp-relay	N	Y	N	N	N

Examples

Create a DHCP relay instance.

POST HTTPS://{switch IP}/rest/v1/running/dhcp-relay
{
    "name": "test1",
    "type": "v4",
    "vrf": "Vrf1",
    "downlink-vlans": [
        {"vlan": "Vlan100", "option82-sub5": "100.0.0.1"},
        {"vlan": "Vlan300", "gateway-ip-address": "3.3.3.4"},
    ],
    "uplink-interfaces": ["Vlan200"],
    "server-ips": ["12.3.3.3", "15.3.3.3"]
}

Create a downlink vlan for a DHCP relay instance named {name}

POST HTTPS://{switch IP}/rest/v1/running/dhcp-relay/test/downlink-vlans/Vlan100
{
    "gateway-ip-address": "10.0.0.1"
}

Properties Descriptions

DHCP Relay instance

Tree Diagrams

  +--rw dhcp-relay
     +--rw dhcp-relay-agent* [name]
        +--rw name
        +--rw type?
        +--rw vrf?
        +--rw downlink-vlans* [vlan]
        |  +--rw vlan
        |  +--rw gateway-ip-address?
        |  +--rw option82-sub5?
        |  +--rw rfc6939_support?
        +--rw uplink-interfaces*
        +--rw gateway-interface?
        +--rw server-ips*

Table of Properties

Name	Required	Type/Range	Description
dhcp-relay	M		Path-only node, has no configurable value. DHCP relay.
name	M	word not contain ’_‘	(sub-property of dhcp-relay) DHCP relay name.
type	O	”v4""v6”	(sub-property of dhcp-relay) Default value: “v4”
vrf	O	”default” vrf name	(sub-property of dhcp-relay) Set DHCP relay VRF.
downlink-vlans	M		(sub-property of dhcp-relay) Path-only node, has no configurable value.
vlan	M	Vlan1..4094	(sub-property of downlink-vlans) Downlink vlan
gateway-ip-address	O	A.B.C.D	(sub-property of downlink-vlans) IP address of DHCP relay agent. Default value: “0.0.0.0”
option82-sub5	O	A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX	(sub-property of downlink-vlans) One IP address of downlink vlan. Default value: “0.0.0.0”
rfc6939_support	O	”true""false”	(sub-property of downlink-vlans) Set rfc6939 for the relay. Default value: “false”
uplink-interfaces	O	Ethernet name VLAN name	(sub-property of dhcp-relay) Uplink interface
gateway-interface	O	Loopback0..199	(sub-property of dhcp-relay) Set loopback interface as DHCP relay gateway
server-ips	O	A.B.C.D XX:XX:XX:XX:XX:XX:XX:XX	(sub-property of dhcp-relay) The IP address of DHCP server.

Show dhcp relay

Tree Diagrams

    +---x show-dhcp-relay
       +--ro output
          +--ro data?

Table of Properties

Name	Required	Type/Range	Description
show-dhcp-relay	M		Path-only node, has no configurable value. Show DHCP relay info.
data	RO		(sub-property of output)