netgate-dataplane API (24.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-2020 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-wrapper":
    {
    }
}

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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

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-wrapper
object (netgate.dataplane.DataplaneConfigWrapper)

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

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

get /data/netgate-dataplane:dataplane-config/api-segment

Example URL

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

VPP API segment configuration

Responses

200

netgate.dataplane.dataplaneconfig.ApiSegment

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/api-segment"

	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:api-segment-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.ApiSegment

post /data/netgate-dataplane:dataplane-config/api-segment

Example URL

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

VPP API segment configuration

Request Body schema: application/yang-data+json

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

api-segment
object (netgate.dataplane.dataplaneconfig.ApiSegment)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.ApiSegment

put /data/netgate-dataplane:dataplane-config/api-segment

Example URL

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

VPP API segment configuration

Request Body schema: application/yang-data+json

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

netgate-dataplane:api-segment-wrapper
object (netgate.dataplane.dataplaneconfig.ApiSegmentWrapper)

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:api-segment-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.ApiSegment

delete /data/netgate-dataplane:dataplane-config/api-segment

Example URL

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

VPP API segment configuration

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/api-segment"

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

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

Example URL

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

VPP pre-allocated buffers configuration

Responses

200

netgate.dataplane.dataplaneconfig.Buffers

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/buffers"

	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:buffers-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Buffers

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

Example URL

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

VPP pre-allocated buffers configuration

Request Body schema: application/yang-data+json

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

buffers
object (netgate.dataplane.dataplaneconfig.Buffers)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Buffers

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

Example URL

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

VPP pre-allocated buffers configuration

Request Body schema: application/yang-data+json

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

netgate-dataplane:buffers-wrapper
object (netgate.dataplane.dataplaneconfig.BuffersWrapper)

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:buffers-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.Buffers

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

Example URL

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

VPP pre-allocated buffers configuration

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/buffers"

	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/cpu

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Cpu

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

Example URL

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

cpu stanza

Request Body schema: application/yang-data+json

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

cpu
object (netgate.dataplane.dataplaneconfig.Cpu)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Cpu

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

Example URL

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

cpu stanza

Request Body schema: application/yang-data+json

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

netgate-dataplane:cpu-wrapper
object (netgate.dataplane.dataplaneconfig.CpuWrapper)

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

removes netgate.dataplane.dataplaneconfig.Cpu

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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.cpu.CorelistWorkers

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

Example URL

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

returns netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

Responses

200

netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

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/cpu/corelist-workers"

	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:corelist-workers-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

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

Example URL

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

creates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers to be added to list

corelist-workers
object (netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

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

Example URL

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

creates or updates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers to be added or updated

netgate-dataplane:corelist-workers-wrapper
object (netgate.dataplane.dataplaneconfig.cpu.CorelistWorkersWrapper)

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:corelist-workers-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

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

Example URL

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

removes netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers

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/cpu/corelist-workers"

	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/dpdk

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Dpdk

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

Example URL

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

dpdk stanza

Request Body schema: application/yang-data+json

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

dpdk
object (netgate.dataplane.dataplaneconfig.Dpdk)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Dpdk

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

Example URL

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

dpdk stanza

Request Body schema: application/yang-data+json

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

netgate-dataplane:dpdk-wrapper
object (netgate.dataplane.dataplaneconfig.DpdkWrapper)

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

removes netgate.dataplane.dataplaneconfig.Dpdk

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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))

}

returns netgate.dataplane.dataplaneconfig.dpdk.Blacklists

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

Example URL

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

returns netgate.dataplane.dataplaneconfig.dpdk.Blacklists

Responses

200

netgate.dataplane.dataplaneconfig.dpdk.Blacklists

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/dpdk/blacklists"

	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:blacklists-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.dpdk.Blacklists

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

Example URL

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

creates netgate.dataplane.dataplaneconfig.dpdk.Blacklists

Request Body schema: application/yang-data+json

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

blacklists
object (netgate.dataplane.dataplaneconfig.dpdk.Blacklists)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

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

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

Example URL

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

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

Request Body schema: application/yang-data+json

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

netgate-dataplane:blacklists-wrapper
object (netgate.dataplane.dataplaneconfig.dpdk.BlacklistsWrapper)

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:blacklists-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.dpdk.Blacklists

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

Example URL

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

removes netgate.dataplane.dataplaneconfig.dpdk.Blacklists

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/dpdk/blacklists"

	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/dpdk/dev

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/dpdk/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

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.dataplane.dataplaneconfig.dpdk.Dev

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/dpdk/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/dpdk/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-wrapper":
    {
    }
}

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

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/dpdk/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-wrapper
object (netgate.dataplane.dataplaneconfig.dpdk.DevWrapper)

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

removes netgate.dataplane.dataplaneconfig.dpdk.Dev

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/dpdk/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/dpdk/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))

}

returns netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs

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

Example URL

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

A list of name=value pairs provided to a white-listed device.

path Parameters
id
required
string

Id of dev

Responses

200

netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs

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/dpdk/dev=%7Bid%7D/devargs"

	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:devargs-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs

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

Example URL

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

A list of name=value pairs provided to a white-listed device.

path Parameters
id
required
string

Id of dev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs to be added to list

devargs
object (netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs

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

Example URL

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

A list of name=value pairs provided to a white-listed device.

path Parameters
id
required
string

Id of dev

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs to be added or updated

netgate-dataplane:devargs-wrapper
object (netgate.dataplane.dataplaneconfig.dpdk.dev.DevargsWrapper)

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:devargs-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs

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

Example URL

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

A list of name=value pairs provided to a white-listed 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/dpdk/dev=%7Bid%7D/devargs"

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

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

Example URL

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

Ethernet common configuration

Responses

200

netgate.dataplane.dataplaneconfig.Ethernet

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/ethernet"

	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:ethernet-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Ethernet

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

Example URL

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

Ethernet common configuration

Request Body schema: application/yang-data+json

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

ethernet
object (netgate.dataplane.dataplaneconfig.Ethernet)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Ethernet

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

Example URL

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

Ethernet common configuration

Request Body schema: application/yang-data+json

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

netgate-dataplane:ethernet-wrapper
object (netgate.dataplane.dataplaneconfig.EthernetWrapper)

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:ethernet-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.Ethernet

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

Example URL

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

Ethernet common configuration

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/ethernet"

	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/ip6

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Ip6

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

Example URL

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

IPv6 settings

Request Body schema: application/yang-data+json

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

ip6
object (netgate.dataplane.dataplaneconfig.Ip6)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Ip6

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

Example URL

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

IPv6 settings

Request Body schema: application/yang-data+json

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

netgate-dataplane:ip6-wrapper
object (netgate.dataplane.dataplaneconfig.Ip6Wrapper)

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

removes netgate.dataplane.dataplaneconfig.Ip6

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

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/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/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.LinuxCp

get /data/netgate-dataplane:dataplane-config/linux-cp

Example URL

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

Linux-cp (host stack connectivity) settings

Responses

200

netgate.dataplane.dataplaneconfig.LinuxCp

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/linux-cp"

	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:linux-cp-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.LinuxCp

post /data/netgate-dataplane:dataplane-config/linux-cp

Example URL

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

Linux-cp (host stack connectivity) settings

Request Body schema: application/yang-data+json

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

linux-cp
object (netgate.dataplane.dataplaneconfig.LinuxCp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.LinuxCp

put /data/netgate-dataplane:dataplane-config/linux-cp

Example URL

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

Linux-cp (host stack connectivity) settings

Request Body schema: application/yang-data+json

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

netgate-dataplane:linux-cp-wrapper
object (netgate.dataplane.dataplaneconfig.LinuxCpWrapper)

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:linux-cp-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.LinuxCp

delete /data/netgate-dataplane:dataplane-config/linux-cp

Example URL

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

Linux-cp (host stack connectivity) 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/linux-cp"

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

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

Example URL

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

Logging segment settings

Responses

200

netgate.dataplane.dataplaneconfig.Logging

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/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-dataplane:logging-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Logging

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

Example URL

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

Logging segment settings

Request Body schema: application/yang-data+json

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

logging
object (netgate.dataplane.dataplaneconfig.Logging)

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

creates or updates netgate.dataplane.dataplaneconfig.Logging

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

Example URL

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

Logging segment settings

Request Body schema: application/yang-data+json

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

netgate-dataplane:logging-wrapper
object (netgate.dataplane.dataplaneconfig.LoggingWrapper)

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:logging-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.Logging

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

Example URL

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

Logging segment 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/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))

}

returns netgate.dataplane.dataplaneconfig.Memory

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

Example URL

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

Main heap configuration

Responses

200

netgate.dataplane.dataplaneconfig.Memory

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/memory"

	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:memory-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Memory

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

Example URL

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

Main heap configuration

Request Body schema: application/yang-data+json

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

memory
object (netgate.dataplane.dataplaneconfig.Memory)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Memory

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

Example URL

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

Main heap configuration

Request Body schema: application/yang-data+json

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

netgate-dataplane:memory-wrapper
object (netgate.dataplane.dataplaneconfig.MemoryWrapper)

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:memory-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.Memory

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

Example URL

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

Main heap configuration

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/memory"

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

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

Example URL

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

Statistics segment settings

Responses

200

netgate.dataplane.dataplaneconfig.Statseg

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/statseg"

	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:statseg-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.Statseg

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

Example URL

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

Statistics segment settings

Request Body schema: application/yang-data+json

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

statseg
object (netgate.dataplane.dataplaneconfig.Statseg)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.Statseg

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

Example URL

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

Statistics segment settings

Request Body schema: application/yang-data+json

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

netgate-dataplane:statseg-wrapper
object (netgate.dataplane.dataplaneconfig.StatsegWrapper)

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:statseg-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.Statseg

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

Example URL

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

Statistics segment 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/statseg"

	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.statseg.PerNodeCounters

get /data/netgate-dataplane:dataplane-config/statseg/per-node-counters

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/statseg/per-node-counters

returns netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

Responses

200

netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

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/statseg/per-node-counters"

	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:per-node-counters-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

post /data/netgate-dataplane:dataplane-config/statseg/per-node-counters

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/statseg/per-node-counters

creates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters to be added to list

per-node-counters
object (netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

put /data/netgate-dataplane:dataplane-config/statseg/per-node-counters

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/statseg/per-node-counters

creates or updates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

Request Body schema: application/yang-data+json

netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters to be added or updated

netgate-dataplane:per-node-counters-wrapper
object (netgate.dataplane.dataplaneconfig.statseg.PerNodeCountersWrapper)

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:per-node-counters-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

delete /data/netgate-dataplane:dataplane-config/statseg/per-node-counters

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-config/statseg/per-node-counters

removes netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters

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/statseg/per-node-counters"

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

get /data/netgate-dataplane:dataplane-config/vhost-user

Example URL

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

vhost-user startup configuration parameters.

Responses

200

netgate.dataplane.dataplaneconfig.VhostUser

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/vhost-user"

	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:vhost-user-wrapper":
    {
    }
}

creates netgate.dataplane.dataplaneconfig.VhostUser

post /data/netgate-dataplane:dataplane-config/vhost-user

Example URL

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

vhost-user startup configuration parameters.

Request Body schema: application/yang-data+json

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

vhost-user
object (netgate.dataplane.dataplaneconfig.VhostUser)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.dataplane.dataplaneconfig.VhostUser

put /data/netgate-dataplane:dataplane-config/vhost-user

Example URL

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

vhost-user startup configuration parameters.

Request Body schema: application/yang-data+json

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

netgate-dataplane:vhost-user-wrapper
object (netgate.dataplane.dataplaneconfig.VhostUserWrapper)

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:vhost-user-wrapper":
    {
    }
}

removes netgate.dataplane.dataplaneconfig.VhostUser

delete /data/netgate-dataplane:dataplane-config/vhost-user

Example URL

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

vhost-user startup configuration parameters.

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/vhost-user"

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

returns netgate.dataplane.DataplaneState

get /data/netgate-dataplane:dataplane-state

Example URL

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

dataplane state

Responses

200

netgate.dataplane.DataplaneState

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.dataplane.dataplanestate.Cpu

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

Example URL

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

cpu stanza

Responses

200

netgate.dataplane.dataplanestate.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-state/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-wrapper":
    {
    }
}

returns netgate.dataplane.dataplanestate.cpu.Threads

get /data/netgate-dataplane:dataplane-state/cpu/threads

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-state/cpu/threads

Threads.

Responses

200

netgate.dataplane.dataplanestate.cpu.Threads

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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:threads-wrapper":
    {
    }
}

returns netgate.dataplane.dataplanestate.cpu.threads.Thread

get /data/netgate-dataplane:dataplane-state/cpu/threads/thread={id}

Example URL

https://hostname/restconf/data/netgate-dataplane:dataplane-state/cpu/threads/thread={id}

Thread data.

path Parameters
id
required
integer <int64>

Id of thread

Responses

200

netgate.dataplane.dataplanestate.cpu.threads.Thread

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-dataplane:dataplane-state/cpu/threads/thread=%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:thread-wrapper":
    {
    }
}

dataplane-control

operates on netgate.dataplane.DataplaneControl

post /operations/netgate-dataplane:dataplane-control

Example URL

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

operates on 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":
    {
    }
}

dataplane-coredump

operates on netgate.dataplane.DataplaneCoredump

post /operations/netgate-dataplane:dataplane-coredump

Example URL

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

operates on netgate.dataplane.DataplaneCoredump

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