Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-kea API (19.02)

This YANG module provides a data model for the Kea DHCP server.

Copyright 2019 Rubicon Communications, LLC.

kea-config

returns netgate.kea.KeaConfig

get /data/netgate-kea:kea-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config

returns netgate.kea.KeaConfig

Responses

200

netgate.kea.KeaConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-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
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-config":
    {
    }
}

creates netgate.kea.KeaConfig

post /data/netgate-kea:kea-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config

creates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added to list

dhcp4-server
object (netgate.kea.keaconfig.Dhcp4Server)
keactrl
object (netgate.kea.keaconfig.Keactrl)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dhcp4-server":
    {
    },
  • "keactrl":
    {
    }
}

creates or updates netgate.kea.KeaConfig

put /data/netgate-kea:kea-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config

creates or updates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added or updated

netgate-kea:kea-config
object (netgate.kea.KeaConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-config":
    {
    }
}

removes netgate.kea.KeaConfig

delete /data/netgate-kea:kea-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config

removes netgate.kea.KeaConfig

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-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))

}

returns netgate.kea.keaconfig.Dhcp4Server

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Responses

200

netgate.kea.keaconfig.Dhcp4Server

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-server":
    {
    }
}

creates netgate.kea.keaconfig.Dhcp4Server

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Dhcp4Server to be added to list

Logging
object (netgate.kea.KeaLoggingGroup)
Dhcp4
object (netgate.kea.keaconfig.dhcp4server.Dhcp4)

Configuration for the Kea DHCP IPv4 Server

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "Logging":
    {
    },
  • "Dhcp4":
    {
    }
}

creates or updates netgate.kea.keaconfig.Dhcp4Server

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Dhcp4Server to be added or updated

netgate-kea:dhcp4-server
object (netgate.kea.keaconfig.Dhcp4Server)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-server":
    {
    }
}

removes netgate.kea.keaconfig.Dhcp4Server

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server"

	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.kea.keaconfig.dhcp4server.Dhcp4

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

200

netgate.kea.keaconfig.dhcp4server.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.Dhcp4

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Configuration for the Kea DHCP IPv4 Server

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.Dhcp4 to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

interfaces-config
object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig)
valid-lifetime
integer <int64>

The valid duration for an assigned lease in seconds.

lease-database
object (netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase)
renew-timer
integer <int64>

The RFC-2131 T1 renewal value in seconds.

next-server
string

This next-server IPv4 address is used as the siaddr field.

description
string

A user-supplied description of the server.

decline-probation-period
integer <int64>

The decline-probation-period specifies the period in seconds in which the server will recycle declined leases. The default period is 86400 seconds (24 hours).

subnet4
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4)

An IPv4 subnet configuration within the DHCPv4 server.

rebind-timer
integer <int64>

The RFC-2131 T2 rebind value in seconds.

match-client-id
boolean

If match-client-id is false, the DHCP server will match clients using the 'chaddr' field.

echo-client-id
boolean

The echo-client-id boolean value specifies that the server should or should-not reply with the client-id if the client sent it. Setting this to false enables RFC-2131 backward compatibitlity.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "interfaces-config":
    {
    },
  • "valid-lifetime": 0,
  • "lease-database":
    {
    },
  • "renew-timer": 0,
  • "next-server": "string",
  • "description": "string",
  • "decline-probation-period": 0,
  • "subnet4":
    [
    ],
  • "rebind-timer": 0,
  • "match-client-id": true,
  • "echo-client-id": true
}

creates or updates netgate.kea.keaconfig.dhcp4server.Dhcp4

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Configuration for the Kea DHCP IPv4 Server

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.Dhcp4 to be added or updated

netgate-kea:dhcp4
object (netgate.kea.keaconfig.dhcp4server.Dhcp4)

Configuration for the Kea DHCP IPv4 Server

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.Dhcp4

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4"

	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.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-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
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces-config":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig to be added to list

dhcp-socket-type
string
Default: "raw"

Sockets used for listening on the set of interfaces will be opened as either'raw' IP sockets, or 'udp' sockets.

interfaces
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces)

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dhcp-socket-type": "raw",
  • "interfaces":
    [
    ]
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig to be added or updated

netgate-kea:interfaces-config
object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces-config":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-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.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces to be added to list

interface
string

The name of an interface on which the server will listen for IPv4 DHCP requests.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "interface": "string"
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces=%7Binterface%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces to be added to list

interface
string

The name of an interface on which the server will listen for IPv4 DHCP requests.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "interface": "string"
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces to be added or updated

netgate-kea:interfaces
object (netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces=%7Binterface%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.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

returns netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:lease-database":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

creates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase to be added to list

name
string

Name of the DHCPv4 leases file on disk. This should be a name ending in '.csv'. FIXME: We should probably make this file be permanently stored under /var/kea/leases/ or something.

persist
boolean
Default: true

If set to TRUE, new leases and updates to existing leases are written to the leases file on disk. If leases aren't written to disk, no assurance can be made that leases will persist across a server restart.

type
string
Default: "memfile"

The database type used to store the lease information. Currently only the type 'memfile' is supported.

lfc-interval
integer <int64>
Default: 0

The lfc-interval specifies the interval in seconds at which the server will perform a lease file cleanup to remove the unused, historical information from the lease file. The default, 0, disables the LFC operation.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "persist": true,
  • "type": "memfile",
  • "lfc-interval": 0
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase to be added or updated

netgate-kea:lease-database
object (netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:lease-database":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

removes netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database"

	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.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data

List of DHCPv4 options and values.

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data=%7Bname%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.kea.keaconfig.dhcp4server.dhcp4.Subnet4

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4

An IPv4 subnet configuration within the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4 to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

subnet
string

The IPv4 subnet prefix.

pools
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools)

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

id
integer <int64>

Manually assigned subnet id.

reservations
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations)

List of host reservations.

interface
string

Interface on which subnet is located.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "subnet": "string",
  • "pools":
    [
    ],
  • "id": 0,
  • "reservations":
    [
    ],
  • "interface": "string"
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:subnet4":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4 to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

subnet
string

The IPv4 subnet prefix.

pools
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools)

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

id
integer <int64>

Manually assigned subnet id.

reservations
Array of objects (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations)

List of host reservations.

interface
string

Interface on which subnet is located.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "subnet": "string",
  • "pools":
    [
    ],
  • "id": 0,
  • "reservations":
    [
    ],
  • "interface": "string"
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4 to be added or updated

netgate-kea:subnet4
object (netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4)

An IPv4 subnet configuration within the DHCPv4 server.

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:subnet4":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%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.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:option-data=%7Bname%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.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

pool
string

A pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

pool-present
boolean

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "pool": "string",
  • "pool-present": true
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:pools":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

pool
string

A pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

pool-present
boolean

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "pool": "string",
  • "pool-present": true
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools to be added or updated

netgate-kea:pools
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools)

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:pools":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%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.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%7D/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%7D/netgate-kea:option-data=%7Bname%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.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

hostname
string

The host name of the identified host.

ip-address
string

The IPv4 address for the host.

hw-address
string

The host's MAC address.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "hostname": "string",
  • "ip-address": "string",
  • "hw-address": "string"
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:reservations=%7Bip-address%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:reservations":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations to be added to list

option-data
Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

hostname
string

The host name of the identified host.

ip-address
string

The IPv4 address for the host.

hw-address
string

The host's MAC address.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    [
    ],
  • "hostname": "string",
  • "ip-address": "string",
  • "hw-address": "string"
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations to be added or updated

netgate-kea:reservations
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations)

List of host reservations.

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:reservations":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:reservations=%7Bip-address%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.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:reservations=%7Bip-address%7D/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

name
string

The server requires an option name to identify an option.

csv-format
boolean

If this value is not specified the server will assume that the option data is specified as a list of comma separated values to be assigned to individual fields of the DHCP option.

always-send
boolean

To enforce the addition of a particular option set the always-send flag to true.

data
string

If the option data is unspecified it defaults to an empty value. The empty value is mostly used for the options which have no payload (boolean options), but it is legal to specify empty values for some options which carry variable length data and which the specification allows for the length of 0. For such options, the data parameter may be omitted in the configuration.

space
string

If the option space is unspecified it will default to 'dhcp4' which is an option space holding DHCPv4 standard options

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "csv-format": true,
  • "always-send": true,
  • "data": "string",
  • "space": "string"
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:reservations=%7Bip-address%7D/netgate-kea:option-data=%7Bname%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.kea.KeaLoggingGroup

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Configuration for the Kea Logging

Responses

200

netgate.kea.KeaLoggingGroup

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-logging-group":
    {
    }
}

creates netgate.kea.KeaLoggingGroup

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Configuration for the Kea Logging

Request Body schema: application/yang-data+json

netgate.kea.KeaLoggingGroup to be added to list

loggers
Array of objects (netgate.kea.kealogginggroup.Loggers)

List of logging facilities and parameters.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "loggers":
    [
    ]
}

creates or updates netgate.kea.KeaLoggingGroup

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Configuration for the Kea Logging

Request Body schema: application/yang-data+json

netgate.kea.KeaLoggingGroup to be added or updated

netgate-kea:kea-logging-group
object (netgate.kea.KeaLoggingGroup)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-logging-group":
    {
    }
}

removes netgate.kea.KeaLoggingGroup

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging

Configuration for the Kea Logging

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging"

	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.kea.kealogginggroup.Loggers

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers

List of logging facilities and parameters.

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.Loggers to be added to list

debuglevel
integer <int32>

A Kea debug level.

severity
string (netgate.kea.KeaLoggerSeverity)
Enum: "fatal" "error" "warn" "info" "debug"
name
string (netgate.kea.KeaLoggerName)
Enum: "*" "kea-ctrl-agent" "kea-ctrl-agent.http" "kea-dhcp4" "kea-dhcp4.alloc-engine" "kea-dhcp4.bad-packets" "kea-dhcp4.callouts" "kea-dhcp4.commands" "kea-dhcp4.ddns" "kea-dhcp4.dhcp4" "kea-dhcp4.dhcpsrv" "kea-dhcp4.eval" "kea-dhcp4.hooks" "kea-dhcp4.hosts" "kea-dhcp4.leases" "kea-dhcp4.options" "kea-dhcp4.packets" "kea-dhcp4.stat-cmds-hooks" "kea-dhcp6" "kea-dhcp6.alloc-engine" "kea-dhcp6.bad-packets" "kea-dhcp6.callouts" "kea-dhcp6.commands" "kea-dhcp6.ddns" "kea-dhcp6.dhcp6" "kea-dhcp6.dhcpsrv" "kea-dhcp6.eval" "kea-dhcp6.hooks" "kea-dhcp6.hosts" "kea-dhcp6.leases" "kea-dhcp6.options" "kea-dhcp6.packets" "kea-dhcp6.stat-cmds-hooks" "kea-dhcp-ddns" "kea-dhcp-ddns.dctl" "kea-dhcp-ddns.dhcpddns" "kea-dhcp-ddns.dhcp-to-d2" "kea-dhcp-ddns.d2-to-dns"
output_options
Array of objects (netgate.kea.kealogginggroup.loggers.OutputOptions)

List of output options for a logger.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "debuglevel": 0,
  • "severity": "fatal",
  • "name": "*",
  • "output_options":
    [
    ]
}

returns netgate.kea.kealogginggroup.Loggers

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

200

netgate.kea.kealogginggroup.Loggers

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:loggers":
    {
    }
}

creates netgate.kea.kealogginggroup.Loggers

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.Loggers to be added to list

debuglevel
integer <int32>

A Kea debug level.

severity
string (netgate.kea.KeaLoggerSeverity)
Enum: "fatal" "error" "warn" "info" "debug"
name
string (netgate.kea.KeaLoggerName)
Enum: "*" "kea-ctrl-agent" "kea-ctrl-agent.http" "kea-dhcp4" "kea-dhcp4.alloc-engine" "kea-dhcp4.bad-packets" "kea-dhcp4.callouts" "kea-dhcp4.commands" "kea-dhcp4.ddns" "kea-dhcp4.dhcp4" "kea-dhcp4.dhcpsrv" "kea-dhcp4.eval" "kea-dhcp4.hooks" "kea-dhcp4.hosts" "kea-dhcp4.leases" "kea-dhcp4.options" "kea-dhcp4.packets" "kea-dhcp4.stat-cmds-hooks" "kea-dhcp6" "kea-dhcp6.alloc-engine" "kea-dhcp6.bad-packets" "kea-dhcp6.callouts" "kea-dhcp6.commands" "kea-dhcp6.ddns" "kea-dhcp6.dhcp6" "kea-dhcp6.dhcpsrv" "kea-dhcp6.eval" "kea-dhcp6.hooks" "kea-dhcp6.hosts" "kea-dhcp6.leases" "kea-dhcp6.options" "kea-dhcp6.packets" "kea-dhcp6.stat-cmds-hooks" "kea-dhcp-ddns" "kea-dhcp-ddns.dctl" "kea-dhcp-ddns.dhcpddns" "kea-dhcp-ddns.dhcp-to-d2" "kea-dhcp-ddns.d2-to-dns"
output_options
Array of objects (netgate.kea.kealogginggroup.loggers.OutputOptions)

List of output options for a logger.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "debuglevel": 0,
  • "severity": "fatal",
  • "name": "*",
  • "output_options":
    [
    ]
}

creates or updates netgate.kea.kealogginggroup.Loggers

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.Loggers to be added or updated

netgate-kea:loggers
object (netgate.kea.kealogginggroup.Loggers)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:loggers":
    {
    }
}

removes netgate.kea.kealogginggroup.Loggers

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%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.kea.kealogginggroup.loggers.OutputOptions

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.loggers.OutputOptions to be added to list

maxver
integer <int64>

The maximum number of rotation log files to keep.

output
string

The logger's file or keyword output location.

maxsize
integer <int64>

The maximum size of a rotating log file. The default is 10MB.

flush
boolean

If true, each log message is flushed as it is logged at a slight performance penalty.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "maxver": 0,
  • "output": "string",
  • "maxsize": 0,
  • "flush": true
}

returns netgate.kea.kealogginggroup.loggers.OutputOptions

get /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

200

netgate.kea.kealogginggroup.loggers.OutputOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%7D/netgate-kea:output_options=%7Boutput%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:output-options":
    {
    }
}

creates netgate.kea.kealogginggroup.loggers.OutputOptions

post /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.loggers.OutputOptions to be added to list

maxver
integer <int64>

The maximum number of rotation log files to keep.

output
string

The logger's file or keyword output location.

maxsize
integer <int64>

The maximum size of a rotating log file. The default is 10MB.

flush
boolean

If true, each log message is flushed as it is logged at a slight performance penalty.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "maxver": 0,
  • "output": "string",
  • "maxsize": 0,
  • "flush": true
}

creates or updates netgate.kea.kealogginggroup.loggers.OutputOptions

put /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.loggers.OutputOptions to be added or updated

netgate-kea:output-options
object (netgate.kea.kealogginggroup.loggers.OutputOptions)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:output-options":
    {
    }
}

removes netgate.kea.kealogginggroup.loggers.OutputOptions

delete /data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%7D/netgate-kea:output_options=%7Boutput%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.kea.keaconfig.Keactrl

get /data/netgate-kea:kea-config/netgate-kea:keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl

This section contains parameters for the keactrl configuration file.

Responses

200

netgate.kea.keaconfig.Keactrl

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:keactrl":
    {
    }
}

creates netgate.kea.keaconfig.Keactrl

post /data/netgate-kea:kea-config/netgate-kea:keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl

This section contains parameters for the keactrl configuration file.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Keactrl to be added to list

dhcp4
object (netgate.kea.keaconfig.keactrl.Dhcp4)
verbose
boolean

If true, the Kea Control daemon will be verbose.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dhcp4":
    {
    },
  • "verbose": true
}

creates or updates netgate.kea.keaconfig.Keactrl

put /data/netgate-kea:kea-config/netgate-kea:keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl

This section contains parameters for the keactrl configuration file.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Keactrl to be added or updated

netgate-kea:keactrl
object (netgate.kea.keaconfig.Keactrl)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:keactrl":
    {
    }
}

removes netgate.kea.keaconfig.Keactrl

delete /data/netgate-kea:kea-config/netgate-kea:keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl

This section contains parameters for the keactrl configuration file.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl"

	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.kea.keaconfig.keactrl.Dhcp4

get /data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Parameters for the DHCP IPv4 server.

Responses

200

netgate.kea.keaconfig.keactrl.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

creates netgate.kea.keaconfig.keactrl.Dhcp4

post /data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.keactrl.Dhcp4 to be added to list

enable
boolean

If true, the Kea dhcp4 server is enabled.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "enable": true
}

creates or updates netgate.kea.keaconfig.keactrl.Dhcp4

put /data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.keactrl.Dhcp4 to be added or updated

netgate-kea:dhcp4
object (netgate.kea.keaconfig.keactrl.Dhcp4)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

removes netgate.kea.keaconfig.keactrl.Dhcp4

delete /data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4

Parameters for the DHCP IPv4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/netgate-kea:keactrl/netgate-kea:dhcp4"

	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))

}

kea-state

returns netgate.kea.KeaState

get /data/netgate-kea:kea-state

Example URL

https://hostname/restconf/data/netgate-kea:kea-state

returns netgate.kea.KeaState

Responses

200

netgate.kea.KeaState

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-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
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-state":
    {
    }
}

returns netgate.kea.keastate.Dhcp4Server

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Responses

200

netgate.kea.keastate.Dhcp4Server

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-server":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.Dhcp4

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

200

netgate.kea.keastate.dhcp4server.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.InterfacesConfig

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.InterfacesConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-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
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces-config":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.interfacesconfig.Interfaces

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.interfacesconfig.Interfaces

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:interfaces-config/netgate-kea:interfaces=%7Binterface%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.LeaseDatabase

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database

returns netgate.kea.keastate.dhcp4server.dhcp4.LeaseDatabase

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.LeaseDatabase

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:lease-database"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:lease-database":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.Subnet4

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.Subnet4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:subnet4":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.subnet4.Pools

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}

A list of leased address pools. Each pool is specfied as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.subnet4.Pools

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:pools":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:pools={pool}/netgate-kea:option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:pools=%7Bpool%7D/netgate-kea:option-data=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-data":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.dhcp4.subnet4.Reservations

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4={subnet}/netgate-kea:reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

200

netgate.kea.keastate.dhcp4server.dhcp4.subnet4.Reservations

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Dhcp4/netgate-kea:subnet4=%7Bsubnet%7D/netgate-kea:reservations=%7Bip-address%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:reservations":
    {
    }
}

returns netgate.kea.KeaLoggingGroup

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging

Configuration for the Kea Logging

Responses

200

netgate.kea.KeaLoggingGroup

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-logging-group":
    {
    }
}

returns netgate.kea.kealogginggroup.Loggers

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

200

netgate.kea.kealogginggroup.Loggers

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:loggers":
    {
    }
}

returns netgate.kea.kealogginggroup.loggers.OutputOptions

get /data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers={name}/netgate-kea:output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

200

netgate.kea.kealogginggroup.loggers.OutputOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:dhcp4-server/netgate-kea:Logging/netgate-kea:loggers=%7Bname%7D/netgate-kea:output_options=%7Boutput%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
Copy
 Expand all Collapse all
{
  • "netgate-kea:output-options":
    {
    }
}

returns netgate.kea.keastate.Keactrl

get /data/netgate-kea:kea-state/netgate-kea:keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:keactrl

This section contains parameters for the keactrl configuration file.

Responses

200

netgate.kea.keastate.Keactrl

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:keactrl"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:keactrl":
    {
    }
}

returns netgate.kea.keastate.keactrl.Dhcp4

get /data/netgate-kea:kea-state/netgate-kea:keactrl/netgate-kea:dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:keactrl/netgate-kea:dhcp4

Parameters for the DHCP IPv4 server.

Responses

200

netgate.kea.keastate.keactrl.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/netgate-kea:keactrl/netgate-kea:dhcp4"

	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
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4":
    {
    }
}

kea-control

creates netgate.kea.KeaControl

post /operations/netgate-kea:kea-control

Example URL

https://hostname/restconf/operations/netgate-kea:kea-control

creates netgate.kea.KeaControl

Request Body schema: application/yang-data+json
input
object (netgate.kea.keacontrol.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

kea-show

creates netgate.kea.KeaShow

post /operations/netgate-kea:kea-show

Example URL

https://hostname/restconf/operations/netgate-kea:kea-show

creates netgate.kea.KeaShow

Request Body schema: application/yang-data+json
input
object (netgate.kea.keashow.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}