Netgate TNSR Logo
API docs by Redocly

netgate-kea API (24.06)

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

Copyright 2019-2023 Rubicon Communications, LLC.

kea-config

returns netgate.kea.KeaConfig

returns netgate.kea.KeaConfig

Responses

Request samples 

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
{
  • "netgate-kea:kea-config": {
    }
}

creates netgate.kea.KeaConfig

creates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added to list

object (netgate.kea.keaconfig.Dhcp4Server)

Gather all the parts that contribute to the DHCP4 server.

object (netgate.kea.keaconfig.Keactrl)

This section contains parameters for the keactrl configuration file.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:dhcp4-server": {
    },
  • "netgate-kea:keactrl": {
    }
}

creates or updates netgate.kea.KeaConfig

creates or updates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added or updated

object (netgate.kea.KeaConfig)

Responses

Request samples

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

removes netgate.kea.KeaConfig

removes netgate.kea.KeaConfig

Responses

Request samples 

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

Gather all the parts that contribute to the DHCP4 server.

Responses

Request samples 

package main

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

func main() {

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

creates netgate.kea.keaconfig.Dhcp4Server

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

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

Kea DHCPv4 custom option definition information.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:Dhcp4": {
    }
}

creates or updates netgate.kea.keaconfig.Dhcp4Server

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

object (netgate.kea.keaconfig.Dhcp4Server)

Gather all the parts that contribute to the DHCP4 server.

Responses

Request samples

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

removes netgate.kea.keaconfig.Dhcp4Server

Gather all the parts that contribute to the DHCP4 server.

Responses

Request samples 

package main

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

func main() {

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

Configuration for the Kea DHCP IPv4 Server

Responses

Request samples 

package main

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

func main() {

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

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

Array of objects (netgate.kea.keadhcp4optiondefgroup.OptionDef)

List of DHCPv4 custom option definition.

Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

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

List of logging facilities and parameters.

object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig)

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

valid-lifetime
integer <int64>

The valid duration for an assigned lease in seconds.

authoritative
boolean
Default: true

Global flag to determine whether to send a NAK in response to requests by clients for unknown IP addresses. Defaults to true.

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

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

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-def": [
    ],
  • "netgate-kea:option-data": [
    ],
  • "netgate-kea:loggers": [
    ],
  • "interfaces-config": {
    },
  • "valid-lifetime": 0,
  • "authoritative": true,
  • "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

Configuration for the Kea DHCP IPv4 Server

Request Body schema: application/yang-data+json

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

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

Kea DHCPv4 custom option definition information.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:Dhcp4": {
    }
}

removes netgate.kea.keaconfig.dhcp4server.Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

Request samples 

package main

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

func main() {

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

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

Responses

Request samples 

package main

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

func main() {

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

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

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

netgate-kea: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.

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

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:dhcp-socket-type": "raw",
  • "netgate-kea:interfaces": [
    ]
}

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

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

object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig)

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

Responses

Request samples

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

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

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

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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

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

netgate-kea:interface
string

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:interface": "string"
}

returns 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.

path Parameters
interface
required
string

Id of interfaces

Responses

Request samples 

package main

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

func main() {

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

creates or updates 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.

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

object (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

Request samples

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

removes 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.

path Parameters
interface
required
string

Id of interfaces

Responses

Request samples 

package main

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

func main() {

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

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

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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
{
  • "netgate-kea:lease-database": {
    }
}

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

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

netgate-kea:name
string

Name of the DHCPv4 leases file on disk. This should be a name ending in '.csv'.

netgate-kea: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.

netgate-kea:type
string
Default: "memfile"

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

netgate-kea:lfc-interval
integer <int64>
Default: 3600

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 is one hour (3600). Zero disables the LFC operation.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:name": "string",
  • "netgate-kea:persist": true,
  • "netgate-kea:type": "memfile",
  • "netgate-kea:lfc-interval": 3600
}

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

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

object (netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase)

Responses

Request samples

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

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

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

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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.kealogginggroup.Loggers

List of logging facilities and parameters.

Request Body schema: application/yang-data+json

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

netgate-kea:debuglevel
integer <int32>

A Kea debug level.

netgate-kea:severity
string (netgate.kea.KeaLoggerSeverity)
Enum: "fatal" "error" "warn" "info" "debug"
netgate-kea:name
string (netgate.kea.KeaLoggerName)
Enum: "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"
Array of objects (netgate.kea.kealogginggroup.loggers.OutputOptions)

List of output options for a logger.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:debuglevel": 0,
  • "netgate-kea:severity": "fatal",
  • "netgate-kea:name": "kea-dhcp4",
  • "netgate-kea:output_options": [
    ]
}

returns netgate.kea.kealogginggroup.Loggers

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.kealogginggroup.Loggers

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

object (netgate.kea.kealogginggroup.Loggers)

List of logging facilities and parameters.

Responses

Request samples

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

removes netgate.kea.kealogginggroup.Loggers

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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

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

netgate-kea:maxver
integer <int64>

The maximum number of rotation log files to keep. The default value is 1.

netgate-kea:output
string

The logger's file or keyword output location.

netgate-kea:maxsize
integer <int64>

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

netgate-kea:flush
boolean

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:maxver": 0,
  • "netgate-kea:output": "string",
  • "netgate-kea:maxsize": 0,
  • "netgate-kea:flush": true
}

returns netgate.kea.kealogginggroup.loggers.OutputOptions

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%7D/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
{
  • "netgate-kea:output_options": {
    }
}

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

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

object (netgate.kea.kealogginggroup.loggers.OutputOptions)

List of output options for a logger.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:output_options": {
    }
}

removes netgate.kea.kealogginggroup.loggers.OutputOptions

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%7D/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))

}

creates netgate.kea.keadhcp4optiongroup.OptionData

List of DHCPv4 options and values.

Request Body schema: application/yang-data+json

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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.keadhcp4optiondefgroup.OptionDef

List of DHCPv4 custom option definition.

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiondefgroup.OptionDef to be added to list

netgate-kea:code
integer <int32>

The numeric uint8 option code.

netgate-kea:array
boolean

If true, specifies an array of values. If false, specifies a singular datum or record.

netgate-kea:name
string

The server requires an option name to identify an option definition.

netgate-kea:type
string (netgate.kea.KeaDhcp4OptionDefType)
Enum: "binary" "boolean" "empty" "fqdn" "ipv4-address" "ipv6-address" "ipv6-prefix" "psid" "record" "string" "tuple" "uint8" "uint16" "uint32" "int8" "int16" "int32"
netgate-kea:encapsulate
string

The name of the option space being encapsulated by the particular option.

netgate-kea:space
string

The namespace for the option definition.

netgate-kea:record-types
string

A comma separated list of record field types.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:code": 0,
  • "netgate-kea:array": true,
  • "netgate-kea:name": "string",
  • "netgate-kea:type": "binary",
  • "netgate-kea:encapsulate": "string",
  • "netgate-kea:space": "string",
  • "netgate-kea:record-types": "string"
}

returns netgate.kea.keadhcp4optiondefgroup.OptionDef

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Responses

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.keadhcp4optiondefgroup.OptionDef

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiondefgroup.OptionDef to be added or updated

object (netgate.kea.keadhcp4optiondefgroup.OptionDef)

List of DHCPv4 custom option definition.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-def": {
    }
}

removes netgate.kea.keadhcp4optiondefgroup.OptionDef

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Responses

Request samples 

package main

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

func main() {

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

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

Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

subnet
string

The IPv4 subnet prefix.

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

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

authoritative
boolean

Per-subnet flag to determine whether to send a NAK in response to requests by clients for unknown IP addresses.

id
integer <int64>

Manually assigned subnet id.

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

List of host reservations.

interface
string

Interface on which subnet is located.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": [
    ],
  • "subnet": "string",
  • "pools": [
    ],
  • "authoritative": true,
  • "id": 0,
  • "reservations": [
    ],
  • "interface": "string"
}

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

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

Request samples 

package main

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

func main() {

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

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

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

object (netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4)

Kea DHCPv4 option information.

Responses

Request samples

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

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

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/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

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

Request samples 

package main

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

func main() {

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

A list of leased address pools. Each pool is specified 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

Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

pool
string

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": [
    ],
  • "pool": "string"
}

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

A list of leased address pools. Each pool is specified 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

Request samples 

package main

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

func main() {

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

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

A list of leased address pools. Each pool is specified 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

object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools)

Kea DHCPv4 option information.

Responses

Request samples

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

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

A list of leased address pools. Each pool is specified 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

Request samples 

package main

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

func main() {

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

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

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

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

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

Request samples 

package main

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

func main() {

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

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

Array of objects (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

hw-address
string

The host's MAC address.

hostname
string

The host name of the identified host.

ip-address
string

The IPv4 address for the host.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": [
    ],
  • "hw-address": "string",
  • "hostname": "string",
  • "ip-address": "string"
}

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

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

Request samples 

package main

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

func main() {

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

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

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

object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations)

Kea DHCPv4 option information.

Responses

Request samples

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

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

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

Request samples 

package main

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

func main() {

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

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

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

Request samples 

package main

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

func main() {

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

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

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

object (netgate.kea.keadhcp4optiongroup.OptionData)

List of DHCPv4 options and values.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:option-data": {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

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

Request samples 

package main

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

func main() {

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

This section contains parameters for the keactrl configuration file.

Responses

Request samples 

package main

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

func main() {

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

creates netgate.kea.keaconfig.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

object (netgate.kea.keaconfig.keactrl.Dhcp4)

Parameters for the DHCP IPv4 server.

netgate-kea:verbose
boolean

If true, the Kea Control daemon will be verbose.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:dhcp4": {
    },
  • "netgate-kea:verbose": true
}

creates or updates netgate.kea.keaconfig.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

object (netgate.kea.keaconfig.Keactrl)

This section contains parameters for the keactrl configuration file.

Responses

Request samples

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

removes netgate.kea.keaconfig.Keactrl

This section contains parameters for the keactrl configuration file.

Responses

Request samples 

package main

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

func main() {

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

Parameters for the DHCP IPv4 server.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/keactrl/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
{
  • "netgate-kea:dhcp4": {
    }
}

creates netgate.kea.keaconfig.keactrl.Dhcp4

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

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

netgate-kea:enable
boolean

If true, the Kea dhcp4 server is enabled.

Responses

Request samples

Content type
application/yang-data+json
{
  • "netgate-kea:enable": true
}

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

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

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

object (netgate.kea.keaconfig.keactrl.Dhcp4)

Parameters for the DHCP IPv4 server.

Responses

Request samples

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

removes netgate.kea.keaconfig.keactrl.Dhcp4

Parameters for the DHCP IPv4 server.

Responses

Request samples 

package main

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

func main() {

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

Kea state.

Responses

Request samples 

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
{
  • "netgate-kea:kea-state": {
    }
}

returns netgate.kea.keastate.Dhcp4Server

DHCPv4 state.

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/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
{
  • "netgate-kea:dhcp4-server": {
    }
}

returns netgate.kea.keastate.dhcp4server.Leases

List of Kea DHCPv4 leases.

Responses

Request samples 

package main

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

func main() {

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

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

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

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

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

}

Response samples

Content type
application/yang-data+json
{
  • "netgate-kea:leases": {
    }
}

returns netgate.kea.keastate.dhcp4server.leases.Lease

Kea DHCPv4 lease.

path Parameters
ip-address
required
string

Id of lease

Responses

Request samples 

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server/leases/lease=%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
{
  • "netgate-kea:lease": {
    }
}

kea-control

operates on netgate.kea.KeaControl

operates on netgate.kea.KeaControl

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}

kea-coredump

operates on netgate.kea.KeaCoredump

operates on netgate.kea.KeaCoredump

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}

kea-show

operates on netgate.kea.KeaShow

operates on netgate.kea.KeaShow

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

Responses

Request samples

Content type
application/yang-data+json
{
  • "input": {
    }
}

Response samples

Content type
application/yang-data+json
{
  • "output": {
    }
}