Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-dataplane API (19.02)

This module defines startup configuration settings for VPP.

This includes items related to how VPP itself is run, such as memory allocations, which devices to manage, which drivers to use.

This does not include dataplane configurations such as the IP address assigned to an interface or IP routes. to the underlying data-model elements for the Netgate router.

Copyright 2018-2019 Rubicon Communications, LLC.

dataplane-config

returns netgate.dataplane.DataplaneConfig

get /data/netgate-dataplane:dataplane-config

Example URL

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

dataplane startup configurations

Responses

200

netgate.dataplane.DataplaneConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.dataplane.DataplaneConfig

post /data/netgate-dataplane:dataplane-config

Example URL

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

dataplane startup configurations

Request Body schema: application/yang-data+json

netgate.dataplane.DataplaneConfig to be added to list

nat
object (netgate.dataplane.dataplaneconfig.Nat)
cpu
object (netgate.dataplane.dataplaneconfig.Cpu)
dpdk
object (netgate.dataplane.dataplaneconfig.Dpdk)
ip6
object (netgate.dataplane.dataplaneconfig.Ip6)
ip
object (netgate.dataplane.dataplaneconfig.Ip)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "nat":
    {
    },
  • "cpu":
    {
    },
  • "dpdk":
    {
    },
  • "ip6":
    {
    },
  • "ip":
    {
    }
}

creates or updates netgate.dataplane.DataplaneConfig

put /data/netgate-dataplane:dataplane-config

Example URL

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

dataplane startup configurations

Request Body schema: application/yang-data+json

netgate.dataplane.DataplaneConfig to be added or updated

netgate-dataplane:dataplane-config
object (netgate.dataplane.DataplaneConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.DataplaneConfig

delete /data/netgate-dataplane:dataplane-config

Example URL

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

dataplane startup configurations

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-dataplane:dataplane-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.dataplane.dataplaneconfig.Cpu

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

cpu stanza

Responses

200

netgate.dataplane.dataplaneconfig.Cpu

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu"

	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-dataplane:cpu":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Cpu

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

cpu stanza

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Cpu to be added to list

workers
integer <int32>

Number of worker threads

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Cpu

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

cpu stanza

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Cpu to be added or updated

netgate-dataplane:cpu
object (netgate.dataplane.dataplaneconfig.Cpu)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.Cpu

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:cpu

cpu stanza

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-dataplane:dataplane-config/netgate-dataplane:cpu"

	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.dataplane.dataplaneconfig.Dpdk

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

dpdk stanza

Responses

200

netgate.dataplane.dataplaneconfig.Dpdk

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk"

	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-dataplane:dpdk":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Dpdk

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

dpdk stanza

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Dpdk to be added to list

vdev
Array of objects (netgate.dataplane.dataplaneconfig.dpdk.Vdev)

Configs for a software cryptodev

uio-driver
string (netgate.dataplane.UioDriverT)
Enum: "igb_uio" "uio_pci_generic" "vfio-pci"
dev
Array of objects (netgate.dataplane.dataplaneconfig.dpdk.Dev)

Configs for a NIC or crypto device

no-tx-checksum-offload
boolean

Disable transmit checksum offload.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "vdev":
    [
    ],
  • "uio-driver": "igb_uio",
  • "dev":
    [
    ],
  • "no-tx-checksum-offload": true
}

creates or updates netgate.dataplane.dataplaneconfig.Dpdk

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

dpdk stanza

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Dpdk to be added or updated

netgate-dataplane:dpdk
object (netgate.dataplane.dataplaneconfig.Dpdk)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.Dpdk

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk

dpdk stanza

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-dataplane:dataplane-config/netgate-dataplane:dpdk"

	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.dataplane.dataplaneconfig.dpdk.Dev

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev

Configs for a NIC or crypto device

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Dev to be added to list

num-tx-queues
integer <int32>

Number of transmit queues.

device-type
string (netgate.dataplane.DeviceTypeT)
Enum: "network" "crypto"
num-rx-queues
integer <int32>

Number of receive queues.

id
string

The PCI ID for a device or 'default'.

vlan-strip-offload
string

VLAN strip offload on/off

present
boolean

Device enabled, no attributes necessarily set

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "num-tx-queues": 0,
  • "device-type": "network",
  • "num-rx-queues": 0,
  • "id": "string",
  • "vlan-strip-offload": "string",
  • "present": true
}

returns netgate.dataplane.dataplaneconfig.dpdk.Dev

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Configs for a NIC or crypto device

path Parameters
id
required
string

Id of dev

Responses

200

netgate.dataplane.dataplaneconfig.dpdk.Dev

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev=%7Bid%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-dataplane:dev":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.dpdk.Dev

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Configs for a NIC or crypto device

path Parameters
id
required
string

Id of dev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Dev to be added to list

num-tx-queues
integer <int32>

Number of transmit queues.

device-type
string (netgate.dataplane.DeviceTypeT)
Enum: "network" "crypto"
num-rx-queues
integer <int32>

Number of receive queues.

id
string

The PCI ID for a device or 'default'.

vlan-strip-offload
string

VLAN strip offload on/off

present
boolean

Device enabled, no attributes necessarily set

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "num-tx-queues": 0,
  • "device-type": "network",
  • "num-rx-queues": 0,
  • "id": "string",
  • "vlan-strip-offload": "string",
  • "present": true
}

creates or updates netgate.dataplane.dataplaneconfig.dpdk.Dev

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Configs for a NIC or crypto device

path Parameters
id
required
string

Id of dev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Dev to be added or updated

netgate-dataplane:dev
object (netgate.dataplane.dataplaneconfig.dpdk.Dev)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.dpdk.Dev

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev={id}

Configs for a NIC or crypto device

path Parameters
id
required
string

Id of dev

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-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:dev=%7Bid%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.dataplane.dataplaneconfig.dpdk.Vdev

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev

Configs for a software cryptodev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Vdev to be added to list

vdev-type
string (netgate.dataplane.VdevTypeT)
Enum: "aesni_mb" "aesni_gcm"

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.dataplane.dataplaneconfig.dpdk.Vdev

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Configs for a software cryptodev

path Parameters
vdev-type
required
string

Id of vdev

Responses

200

netgate.dataplane.dataplaneconfig.dpdk.Vdev

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev=%7Bvdev-type%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-dataplane:vdev":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.dpdk.Vdev

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Configs for a software cryptodev

path Parameters
vdev-type
required
string

Id of vdev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Vdev to be added to list

vdev-type
string (netgate.dataplane.VdevTypeT)
Enum: "aesni_mb" "aesni_gcm"

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.dpdk.Vdev

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Configs for a software cryptodev

path Parameters
vdev-type
required
string

Id of vdev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.Vdev to be added or updated

netgate-dataplane:vdev
object (netgate.dataplane.dataplaneconfig.dpdk.Vdev)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.dpdk.Vdev

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev={vdev-type}

Configs for a software cryptodev

path Parameters
vdev-type
required
string

Id of vdev

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-dataplane:dataplane-config/netgate-dataplane:dpdk/netgate-dataplane:vdev=%7Bvdev-type%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.dataplane.dataplaneconfig.Ip

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

IPv4 settings

Responses

200

netgate.dataplane.dataplaneconfig.Ip

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip"

	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-dataplane:ip":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Ip

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

IPv4 settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Ip to be added to list

heap-size
string

Size of heap for IPv4 FIB. Should be a number. Optionally followed by a specified of k, m, or g, to indicate kilo, mega, or giga bytes.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Ip

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

IPv4 settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Ip to be added or updated

netgate-dataplane:ip
object (netgate.dataplane.dataplaneconfig.Ip)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.Ip

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip

IPv4 settings

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-dataplane:dataplane-config/netgate-dataplane:ip"

	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.dataplane.dataplaneconfig.Ip6

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

IPv6 settings

Responses

200

netgate.dataplane.dataplaneconfig.Ip6

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6"

	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-dataplane:ip6":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Ip6

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

IPv6 settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Ip6 to be added to list

heap-size
string

Size of heap for IPv6 FIB. Should be a number. Optionally followed by a specified of k, m, or g, to indicate kilo, mega, or giga bytes.

hash-buckets
integer <int64>

Number of hash buckets for IPv6 lookup table.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "heap-size": "string",
  • "hash-buckets": 0
}

creates or updates netgate.dataplane.dataplaneconfig.Ip6

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

IPv6 settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Ip6 to be added or updated

netgate-dataplane:ip6
object (netgate.dataplane.dataplaneconfig.Ip6)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.Ip6

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:ip6

IPv6 settings

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-dataplane:dataplane-config/netgate-dataplane:ip6"

	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.dataplane.dataplaneconfig.Nat

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

global NAT settings

Responses

200

netgate.dataplane.dataplaneconfig.Nat

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat"

	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-dataplane:nat":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Nat

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

global NAT settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Nat to be added to list

max-translations-per-user
integer <int32>

max translations per user

nat-mode
string (netgate.dataplane.NatModeT)
Enum: "simple" "deterministic" "endpoint-dependent"
dslite-ce
boolean

dslite ce

mode-options
object (netgate.dataplane.dataplaneconfig.nat.ModeOptions)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "max-translations-per-user": 0,
  • "nat-mode": "simple",
  • "dslite-ce": true,
  • "mode-options":
    {
    }
}

creates or updates netgate.dataplane.dataplaneconfig.Nat

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

global NAT settings

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.Nat to be added or updated

netgate-dataplane:nat
object (netgate.dataplane.dataplaneconfig.Nat)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.Nat

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat

global NAT settings

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-dataplane:dataplane-config/netgate-dataplane:nat"

	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.dataplane.dataplaneconfig.nat.ModeOptions

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

returns netgate.dataplane.dataplaneconfig.nat.ModeOptions

Responses

200

netgate.dataplane.dataplaneconfig.nat.ModeOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options"

	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-dataplane:mode-options":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.nat.ModeOptions

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

creates netgate.dataplane.dataplaneconfig.nat.ModeOptions

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.nat.ModeOptions to be added to list

simple
object (netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.nat.ModeOptions

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

creates or updates netgate.dataplane.dataplaneconfig.nat.ModeOptions

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.nat.ModeOptions to be added or updated

netgate-dataplane:mode-options
object (netgate.dataplane.dataplaneconfig.nat.ModeOptions)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.nat.ModeOptions

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options

removes netgate.dataplane.dataplaneconfig.nat.ModeOptions

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-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options"

	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.dataplane.dataplaneconfig.nat.modeoptions.Simple

get /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

returns netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

Responses

200

netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple"

	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-dataplane:simple":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

post /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

creates netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple to be added to list

out2in-dpo
boolean

out2in dpo

static-mapping-only
boolean

static mapping only

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "out2in-dpo": true,
  • "static-mapping-only": true
}

creates or updates netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

put /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

creates or updates netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple to be added or updated

netgate-dataplane:simple
object (netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

delete /data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple

removes netgate.dataplane.dataplaneconfig.nat.modeoptions.Simple

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-dataplane:dataplane-config/netgate-dataplane:nat/netgate-dataplane:mode-options/netgate-dataplane:simple"

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

}

dataplane-control

creates netgate.dataplane.DataplaneControl

post /operations/netgate-dataplane:dataplane-control

Example URL

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

creates netgate.dataplane.DataplaneControl

Request Body schema: application/yang-data+json
input
object (netgate.dataplane.dataplanecontrol.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":
    {
    }
}