Netgate TNSR Logo
API docs by Redocly

netgate-dhcp-relay API (24.10)

This YANG module provides a Netgate-defined data-model for DHCP data.

Copyright 2024 Rubicon Communications, LLC.

dhcp-relay-config

returns netgate.dhcp.relay.DhcpRelayConfig

Configuration data of DHCP relay.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:dhcp-relay-config": {
    }
}

creates netgate.dhcp.relay.DhcpRelayConfig

Configuration data of DHCP relay.

Request Body schema: application/yang-data+json

netgate.dhcp.relay.DhcpRelayConfig to be added to list

Array of objects (netgate.dhcp.relay.dhcprelayconfig.RelayList)

List of configuration

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": [
    ]
}

creates or updates netgate.dhcp.relay.DhcpRelayConfig

Configuration data of DHCP relay.

Request Body schema: application/yang-data+json

netgate.dhcp.relay.DhcpRelayConfig to be added or updated

object (netgate.dhcp.relay.DhcpRelayConfig)

Configuration data of DHCP relay.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:dhcp-relay-config": {
    }
}

removes netgate.dhcp.relay.DhcpRelayConfig

Configuration data of DHCP relay.

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelayconfig.RelayList

List of configuration

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.RelayList to be added to list

netgate-dhcp-relay:description
string

Brief description of the DHCP Relay.

object (netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers)

IPv4 and IPv6 DHCP servers for the source VRF.

netgate-dhcp-relay:source-ipv4-address
string

The IPv4 source address used when forwarding DHCP packets.

netgate-dhcp-relay:source-ipv6-address
string

The IPv6 source address used when forwarding DHCPv6 packets.

netgate-dhcp-relay:source-vrf
string

Source VRF serviced by DHCP Relay

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:description": "string",
  • "netgate-dhcp-relay:servers": {
    },
  • "netgate-dhcp-relay:source-ipv4-address": "string",
  • "netgate-dhcp-relay:source-ipv6-address": "string",
  • "netgate-dhcp-relay:source-vrf": "string"
}

returns netgate.dhcp.relay.dhcprelayconfig.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelayconfig.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.RelayList to be added or updated

object (netgate.dhcp.relay.dhcprelayconfig.RelayList)

List of configuration

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": {
    }
}

removes netgate.dhcp.relay.dhcprelayconfig.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:servers": {
    }
}

creates netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers to be added to list

Array of objects (netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4)

DHCP relay server VRF table id and address

Array of objects (netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6)

DHCPv6 relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": [
    ],
  • "netgate-dhcp-relay:server-ipv6": [
    ]
}

creates or updates netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers to be added or updated

object (netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers)

IPv4 and IPv6 DHCP servers for the source VRF.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:servers": {
    }
}

removes netgate.dhcp.relay.dhcprelayconfig.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4 to be added to list

netgate-dhcp-relay:ip
string

The IPv4 address of the DHCP server.

netgate-dhcp-relay:vrf
string
Default: "default"

The VRF which the DHCP server can be reached on.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:ip": "string",
  • "netgate-dhcp-relay:vrf": "default"
}

returns netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers/server-ipv4=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4 to be added or updated

object (netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4)

DHCP relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": {
    }
}

removes netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers/server-ipv4=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6 to be added to list

netgate-dhcp-relay:ip
string

The IPv6 address of the DHCPv6 server.

netgate-dhcp-relay:vrf
string
Default: "default"

The VRF which the DHCPv6 server can be reached on.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:ip": "string",
  • "netgate-dhcp-relay:vrf": "default"
}

returns netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers/server-ipv6=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv6": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6 to be added or updated

object (netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6)

DHCPv6 relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv6": {
    }
}

removes netgate.dhcp.relay.dhcprelayconfig.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-config/relay-list=%7Bsource-vrf%7D/servers/server-ipv6=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

dhcp-relay-state

returns netgate.dhcp.relay.DhcpRelayState

DHCP relay state information

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:dhcp-relay-state": {
    }
}

creates netgate.dhcp.relay.DhcpRelayState

DHCP relay state information

Request Body schema: application/yang-data+json

netgate.dhcp.relay.DhcpRelayState to be added to list

Array of objects (netgate.dhcp.relay.dhcprelaystate.RelayList)

List of configuration

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": [
    ]
}

creates or updates netgate.dhcp.relay.DhcpRelayState

DHCP relay state information

Request Body schema: application/yang-data+json

netgate.dhcp.relay.DhcpRelayState to be added or updated

object (netgate.dhcp.relay.DhcpRelayState)

DHCP relay state information

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:dhcp-relay-state": {
    }
}

removes netgate.dhcp.relay.DhcpRelayState

DHCP relay state information

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelaystate.RelayList

List of configuration

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.RelayList to be added to list

object (netgate.dhcp.relay.dhcprelaystate.relaylist.Servers)

IPv4 and IPv6 DHCP servers for the source VRF.

netgate-dhcp-relay:source-ipv4-address
string

The IPv4 source address used when forwarding DHCP packets.

netgate-dhcp-relay:source-ipv6-address
string

The IPv6 source address used when forwarding DHCPv6 packets.

netgate-dhcp-relay:source-vrf
string

Source VRF serviced by DHCP Relay

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:servers": {
    },
  • "netgate-dhcp-relay:source-ipv4-address": "string",
  • "netgate-dhcp-relay:source-ipv6-address": "string",
  • "netgate-dhcp-relay:source-vrf": "string"
}

returns netgate.dhcp.relay.dhcprelaystate.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelaystate.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.RelayList to be added or updated

object (netgate.dhcp.relay.dhcprelaystate.RelayList)

List of configuration

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:relay-list": {
    }
}

removes netgate.dhcp.relay.dhcprelaystate.RelayList

List of configuration

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.dhcp.relay.dhcprelaystate.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:servers": {
    }
}

creates netgate.dhcp.relay.dhcprelaystate.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.Servers to be added to list

Array of objects (netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4)

DHCP relay server VRF table id and address

Array of objects (netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6)

DHCPv6 relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": [
    ],
  • "netgate-dhcp-relay:server-ipv6": [
    ]
}

creates or updates netgate.dhcp.relay.dhcprelaystate.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.Servers to be added or updated

object (netgate.dhcp.relay.dhcprelaystate.relaylist.Servers)

IPv4 and IPv6 DHCP servers for the source VRF.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:servers": {
    }
}

removes netgate.dhcp.relay.dhcprelaystate.relaylist.Servers

IPv4 and IPv6 DHCP servers for the source VRF.

path Parameters
source-vrf
required
string

Id of relay-list

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4 to be added to list

netgate-dhcp-relay:ip
string

The IPv4 address of the DHCP server.

netgate-dhcp-relay:vrf
string

The VRF which the DHCP server can be reached on.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:ip": "string",
  • "netgate-dhcp-relay:vrf": "string"
}

returns netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers/server-ipv4=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4 to be added or updated

object (netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4)

DHCP relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv4": {
    }
}

removes netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv4

DHCP relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv4

ip
required
string

Id of server-ipv4

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers/server-ipv4=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6 to be added to list

netgate-dhcp-relay:ip
string

The IPv6 address of the DHCPv6 server.

netgate-dhcp-relay:vrf
string

The VRF which the DHCPv6 server can be reached on.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:ip": "string",
  • "netgate-dhcp-relay:vrf": "string"
}

returns netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers/server-ipv6=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv6": {
    }
}

creates or updates netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Request Body schema: application/yang-data+json

netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6 to be added or updated

object (netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6)

DHCPv6 relay server VRF table id and address

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-dhcp-relay:server-ipv6": {
    }
}

removes netgate.dhcp.relay.dhcprelaystate.relaylist.servers.ServerIpv6

DHCPv6 relay server VRF table id and address

path Parameters
source-vrf
required
string

Id of relay-list

vrf
required
string

Id of server-ipv6

ip
required
string

Id of server-ipv6

Responses

Request samples 

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-dhcp-relay:dhcp-relay-state/relay-list=%7Bsource-vrf%7D/servers/server-ipv6=%7Bvrf%7D,%7Bip%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}