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.
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)) }
{- "netgate-dataplane:dataplane-config": {
- "netgate-dataplane:ethernet": {
- "netgate-dataplane:default-mtu": 1500
}, - "netgate-dataplane:vhost-user": {
- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}, - "netgate-dataplane:memory": {
- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}, - "netgate-dataplane:api-segment": {
- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}, - "netgate-dataplane:buffers": {
- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}, - "netgate-dataplane:plugins": {
- "netgate-dataplane:plugin": [
- "string"
]
}, - "netgate-dataplane:logging": {
- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}, - "netgate-dataplane:cpu": {
- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}, - "netgate-dataplane:linux-cp": {
- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}, - "netgate-dataplane:dpdk": {
- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}, - "netgate-dataplane:statseg": {
- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}, - "netgate-dataplane:ip6": {
- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
}
}
dataplane startup configurations
netgate.dataplane.DataplaneConfig to be added to list
object (netgate.dataplane.dataplaneconfig.Ethernet) Ethernet common configuration | |
object (netgate.dataplane.dataplaneconfig.VhostUser) vhost-user startup configuration parameters. | |
object (netgate.dataplane.dataplaneconfig.Memory) Main heap configuration | |
object (netgate.dataplane.dataplaneconfig.ApiSegment) VPP API segment configuration | |
object (netgate.dataplane.dataplaneconfig.Buffers) VPP pre-allocated buffers configuration | |
object (netgate.dataplane.dataplaneconfig.Plugins) VPP plugins | |
object (netgate.dataplane.dataplaneconfig.Logging) Logging segment settings | |
object (netgate.dataplane.dataplaneconfig.Cpu) cpu stanza | |
object (netgate.dataplane.dataplaneconfig.LinuxCp) Linux-cp (host stack connectivity) settings | |
object (netgate.dataplane.dataplaneconfig.Dpdk) dpdk stanza | |
object (netgate.dataplane.dataplaneconfig.Statseg) Statistics segment settings | |
object (netgate.dataplane.dataplaneconfig.Ip6) IPv6 settings |
{- "netgate-dataplane:ethernet": {
- "netgate-dataplane:default-mtu": 1500
}, - "netgate-dataplane:vhost-user": {
- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}, - "netgate-dataplane:memory": {
- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}, - "netgate-dataplane:api-segment": {
- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}, - "netgate-dataplane:buffers": {
- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}, - "netgate-dataplane:plugins": {
- "netgate-dataplane:plugin": [
- "string"
]
}, - "netgate-dataplane:logging": {
- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}, - "netgate-dataplane:cpu": {
- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}, - "netgate-dataplane:linux-cp": {
- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}, - "netgate-dataplane:dpdk": {
- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}, - "netgate-dataplane:statseg": {
- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}, - "netgate-dataplane:ip6": {
- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
}
dataplane startup configurations
netgate.dataplane.DataplaneConfig to be added or updated
object (netgate.dataplane.DataplaneConfig) dataplane startup configurations |
{- "netgate-dataplane:dataplane-config": {
- "netgate-dataplane:ethernet": {
- "netgate-dataplane:default-mtu": 1500
}, - "netgate-dataplane:vhost-user": {
- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}, - "netgate-dataplane:memory": {
- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}, - "netgate-dataplane:api-segment": {
- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}, - "netgate-dataplane:buffers": {
- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}, - "netgate-dataplane:plugins": {
- "netgate-dataplane:plugin": [
- "string"
]
}, - "netgate-dataplane:logging": {
- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}, - "netgate-dataplane:cpu": {
- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}, - "netgate-dataplane:linux-cp": {
- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}, - "netgate-dataplane:dpdk": {
- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}, - "netgate-dataplane:statseg": {
- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}, - "netgate-dataplane:ip6": {
- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
}
}
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)) }
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)) }
{- "netgate-dataplane:api-segment": {
- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}
}
VPP API segment configuration
netgate.dataplane.dataplaneconfig.ApiSegment to be added to list
netgate-dataplane:api-size | string Default: "16M" The API shared memory size in bytes. An optional K, M, or G suffix is allowed. Default is 16M. The API memory size must be smaller than the global-size. |
netgate-dataplane:global-size | string Default: "64M" The global memory size in bytes. An optional K, M, or G suffix is allowed. Default is 64M. The global memory size must be larger than the api-size. |
netgate-dataplane:api-pvt-heap-size | string Default: "128K" The API private heap size in bytes. An optional K, M, or G suffix is allowed. Default is 128K. |
netgate-dataplane:global-pvt-heap-size | string Default: "128K" The global private heap size in bytes. An optional K, M, or G suffix is allowed. Default is 128K. |
{- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}
VPP API segment configuration
netgate.dataplane.dataplaneconfig.ApiSegment to be added or updated
object (netgate.dataplane.dataplaneconfig.ApiSegment) VPP API segment configuration |
{- "netgate-dataplane:api-segment": {
- "netgate-dataplane:api-size": "16M",
- "netgate-dataplane:global-size": "64M",
- "netgate-dataplane:api-pvt-heap-size": "128K",
- "netgate-dataplane:global-pvt-heap-size": "128K"
}
}
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)) }
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)) }
{- "netgate-dataplane:buffers": {
- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}
}
VPP pre-allocated buffers configuration
netgate.dataplane.dataplaneconfig.Buffers to be added to list
netgate-dataplane:default-data-size | integer <int64> Amount of memory allocated per-buffer |
netgate-dataplane:buffers-per-numa | integer <int64> Default: 32768 Pre-allocated buffers count |
{- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}
VPP pre-allocated buffers configuration
netgate.dataplane.dataplaneconfig.Buffers to be added or updated
object (netgate.dataplane.dataplaneconfig.Buffers) VPP pre-allocated buffers configuration |
{- "netgate-dataplane:buffers": {
- "netgate-dataplane:default-data-size": 0,
- "netgate-dataplane:buffers-per-numa": 32768
}
}
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)) }
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)) }
{- "netgate-dataplane:cpu": {
- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}
}
cpu stanza
netgate.dataplane.dataplaneconfig.Cpu to be added to list
object (netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers) | |
netgate-dataplane:skip-cores | integer <int64> Sets number of CPU core(s) to be skipped. |
netgate-dataplane:main-core | integer <int64> Assign main thread to a specific core. |
netgate-dataplane:workers | integer <int32> Number of worker threads |
{- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}
cpu stanza
netgate.dataplane.dataplaneconfig.Cpu to be added or updated
object (netgate.dataplane.dataplaneconfig.Cpu) cpu stanza |
{- "netgate-dataplane:cpu": {
- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}, - "netgate-dataplane:skip-cores": 0,
- "netgate-dataplane:main-core": 0,
- "netgate-dataplane:workers": 0
}
}
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
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)) }
{- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}
}
creates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers
netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers to be added to list
netgate-dataplane:corelist-worker | Array of integers <int64> [ items <int64 > ] Place worker threads according to the list of cores. |
{- "netgate-dataplane:corelist-worker": [
- 0
]
}
creates or updates netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers
netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers to be added or updated
object (netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers) |
{- "netgate-dataplane:corelist-workers": {
- "netgate-dataplane:corelist-worker": [
- 0
]
}
}
removes netgate.dataplane.dataplaneconfig.cpu.CorelistWorkers
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)) }
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)) }
{- "netgate-dataplane:dpdk": {
- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}
}
dpdk stanza
netgate.dataplane.dataplaneconfig.Dpdk to be added to list
netgate-dataplane:uio-driver | string (netgate.dataplane.UioDriver) Enum: "igb_uio" "uio_pci_generic" "vfio-pci" |
object (netgate.dataplane.dataplaneconfig.dpdk.Blacklists) | |
netgate-dataplane:lro | boolean Enable large receive offload. |
netgate-dataplane:dpdk-log-level | string (netgate.dataplane.DpdkLogLevelTypeT) Enum: "emergency" "alert" "critical" "error" "warning" "notice" "info" "debug" |
netgate-dataplane:no-pci | boolean Disable PCI bus. |
netgate-dataplane:outer-checksum-offload | boolean Enable hardware checksum offload for tunnel packets. |
netgate-dataplane:no-multi-seg | boolean Disable mutli-segment buffers. |
Array of objects (netgate.dataplane.dataplaneconfig.dpdk.Dev) Configs for a NIC or crypto device | |
netgate-dataplane:no-tx-checksum-offload | boolean Disable transmit checksum offload. |
netgate-dataplane:tcp-udp-checksum | boolean Enable hardware l4 checksums. |
netgate-dataplane:iova-mode | string (netgate.dataplane.IovaModeT) Enum: "pa" "va" |
netgate-dataplane:telemetry | boolean On/off telemetry in DPDK. |
netgate-dataplane:decimal-interface-names | boolean Use decimal values of the PCI address instead of hexadecimal for devices |
{- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}
dpdk stanza
netgate.dataplane.dataplaneconfig.Dpdk to be added or updated
object (netgate.dataplane.dataplaneconfig.Dpdk) dpdk stanza |
{- "netgate-dataplane:dpdk": {
- "netgate-dataplane:uio-driver": "igb_uio",
- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}, - "netgate-dataplane:lro": true,
- "netgate-dataplane:dpdk-log-level": "emergency",
- "netgate-dataplane:no-pci": true,
- "netgate-dataplane:outer-checksum-offload": true,
- "netgate-dataplane:no-multi-seg": true,
- "netgate-dataplane:dev": [
- {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
], - "netgate-dataplane:no-tx-checksum-offload": true,
- "netgate-dataplane:tcp-udp-checksum": true,
- "netgate-dataplane:iova-mode": "pa",
- "netgate-dataplane:telemetry": true,
- "netgate-dataplane:decimal-interface-names": true
}
}
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
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)) }
{- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}
}
creates netgate.dataplane.dataplaneconfig.dpdk.Blacklists
netgate.dataplane.dataplaneconfig.dpdk.Blacklists to be added to list
netgate-dataplane:blacklist | Array of strings Blacklist devices by PCI vendor and device ID |
{- "netgate-dataplane:blacklist": [
- "string"
]
}
creates or updates netgate.dataplane.dataplaneconfig.dpdk.Blacklists
netgate.dataplane.dataplaneconfig.dpdk.Blacklists to be added or updated
object (netgate.dataplane.dataplaneconfig.dpdk.Blacklists) |
{- "netgate-dataplane:blacklists": {
- "netgate-dataplane:blacklist": [
- "string"
]
}
}
removes netgate.dataplane.dataplaneconfig.dpdk.Blacklists
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)) }
Configs for a NIC or crypto device
netgate.dataplane.dataplaneconfig.dpdk.Dev to be added to list
netgate-dataplane:tso | string TCP segmentation offload. on/off |
netgate-dataplane:num-rx-desc | integer <int32> Number of receive descriptors. |
netgate-dataplane:num-tx-queues | integer <int32> Number of transmit queues. |
object (netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs) A list of name=value pairs provided to a white-listed device. | |
netgate-dataplane:name | string Given name for a dpdk device. |
netgate-dataplane:device-type | string (netgate.dataplane.DeviceTypeT) Enum: "network" "crypto" "crypto-vf" |
netgate-dataplane:num-rx-queues | integer <int32> Number of receive queues. |
netgate-dataplane:id | string The PCI ID for a device or 'default'. |
netgate-dataplane:num-tx-desc | integer <int32> Number of transmit descriptors. |
{- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
Configs for a NIC or crypto device
id required | string Id of dev |
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)) }
{- "netgate-dataplane:dev": {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
}
Configs for a NIC or crypto device
id required | string Id of dev |
netgate.dataplane.dataplaneconfig.dpdk.Dev to be added or updated
object (netgate.dataplane.dataplaneconfig.dpdk.Dev) Configs for a NIC or crypto device |
{- "netgate-dataplane:dev": {
- "netgate-dataplane:tso": "string",
- "netgate-dataplane:num-rx-desc": 0,
- "netgate-dataplane:num-tx-queues": 0,
- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}, - "netgate-dataplane:name": "string",
- "netgate-dataplane:device-type": "network",
- "netgate-dataplane:num-rx-queues": 0,
- "netgate-dataplane:id": "string",
- "netgate-dataplane:num-tx-desc": 0
}
}
Configs for a NIC or crypto device
id required | string Id of dev |
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)) }
A list of name=value pairs provided to a white-listed device.
id required | string Id of dev |
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)) }
{- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}
}
A list of name=value pairs provided to a white-listed device.
id required | string Id of dev |
netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs to be added to list
netgate-dataplane:arg | Array of strings A single name=value pair. |
{- "netgate-dataplane:arg": [
- "string"
]
}
A list of name=value pairs provided to a white-listed device.
id required | string Id of dev |
netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs to be added or updated
object (netgate.dataplane.dataplaneconfig.dpdk.dev.Devargs) A list of name=value pairs provided to a white-listed device. |
{- "netgate-dataplane:devargs": {
- "netgate-dataplane:arg": [
- "string"
]
}
}
A list of name=value pairs provided to a white-listed device.
id required | string Id of dev |
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)) }
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)) }
{- "netgate-dataplane:ethernet": {
- "netgate-dataplane:default-mtu": 1500
}
}
Ethernet common configuration
netgate.dataplane.dataplaneconfig.Ethernet to be added to list
netgate-dataplane:default-mtu | integer <int64> Default: 1500 Default ethernet MTU |
{- "netgate-dataplane:default-mtu": 1500
}
Ethernet common configuration
netgate.dataplane.dataplaneconfig.Ethernet to be added or updated
object (netgate.dataplane.dataplaneconfig.Ethernet) Ethernet common configuration |
{- "netgate-dataplane:ethernet": {
- "netgate-dataplane:default-mtu": 1500
}
}
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)) }
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)) }
{- "netgate-dataplane:ip6": {
- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
}
IPv6 settings
netgate.dataplane.dataplaneconfig.Ip6 to be added to list
netgate-dataplane: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. |
netgate-dataplane:hash-buckets | integer <int64> Number of hash buckets for IPv6 lookup table. |
{- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
IPv6 settings
netgate.dataplane.dataplaneconfig.Ip6 to be added or updated
object (netgate.dataplane.dataplaneconfig.Ip6) IPv6 settings |
{- "netgate-dataplane:ip6": {
- "netgate-dataplane:heap-size": "string",
- "netgate-dataplane:hash-buckets": 0
}
}
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)) }
Linux-cp (host stack connectivity) settings
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)) }
{- "netgate-dataplane:linux-cp": {
- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}
}
Linux-cp (host stack connectivity) settings
netgate.dataplane.dataplaneconfig.LinuxCp to be added to list
netgate-dataplane:nl-batch-delay-ms | integer <int64> Delay in ms between processing batches of netlink messages. |
netgate-dataplane:nl-batch-size | integer <int64> Number of netlink messages to process at a time. |
netgate-dataplane:nl-rx-buffer-size | integer <int64> Size of netlink socket receive buffer. |
{- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}
Linux-cp (host stack connectivity) settings
netgate.dataplane.dataplaneconfig.LinuxCp to be added or updated
object (netgate.dataplane.dataplaneconfig.LinuxCp) Linux-cp (host stack connectivity) settings |
{- "netgate-dataplane:linux-cp": {
- "netgate-dataplane:nl-batch-delay-ms": 0,
- "netgate-dataplane:nl-batch-size": 0,
- "netgate-dataplane:nl-rx-buffer-size": 0
}
}
Linux-cp (host stack connectivity) settings
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)) }
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)) }
{- "netgate-dataplane:logging": {
- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}
}
Logging segment settings
netgate.dataplane.dataplaneconfig.Logging to be added to list
netgate-dataplane:unthrottle-time | integer <int32> Message unthrottling time (in seconds). |
netgate-dataplane:size | integer <int32> Number of log messages in fifo bufer. |
netgate-dataplane:default-log-level | string (netgate.dataplane.LogLevelTypeT) Enum: "emerg" "alert" "crit" "err" "warn" "notice" "info" "debug" "disabled" |
netgate-dataplane:default-syslog-log-level | string (netgate.dataplane.DefaultSyslogLogLevel) Enum: "emerg" "alert" "crit" "err" "warn" "notice" "info" "debug" "disabled" |
{- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}
Logging segment settings
netgate.dataplane.dataplaneconfig.Logging to be added or updated
object (netgate.dataplane.dataplaneconfig.Logging) Logging segment settings |
{- "netgate-dataplane:logging": {
- "netgate-dataplane:unthrottle-time": 0,
- "netgate-dataplane:size": 0,
- "netgate-dataplane:default-log-level": "emerg",
- "netgate-dataplane:default-syslog-log-level": "emerg"
}
}
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)) }
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)) }
{- "netgate-dataplane:memory": {
- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}
}
Main heap configuration
netgate.dataplane.dataplaneconfig.Memory to be added to list
netgate-dataplane:main-heap-size | string Size of main heap. Should be a number. Optionally followed by a specified of k, m, or g, to indicate kilo, mega, or giga bytes. |
netgate-dataplane:main-heap-page-size | string (netgate.dataplane.MainHeapPageSize) Enum: "4k" "2m" "1g" "default" |
{- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}
Main heap configuration
netgate.dataplane.dataplaneconfig.Memory to be added or updated
object (netgate.dataplane.dataplaneconfig.Memory) Main heap configuration |
{- "netgate-dataplane:memory": {
- "netgate-dataplane:main-heap-size": "string",
- "netgate-dataplane:main-heap-page-size": "4k"
}
}
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)) }
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/plugins" 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)) }
{- "netgate-dataplane:plugins": {
- "netgate-dataplane:plugin": [
- "string"
]
}
}
VPP plugins
netgate.dataplane.dataplaneconfig.Plugins to be added to list
netgate-dataplane:plugin | Array of strings List of additional VPP plugins. Short plugin name matches name_plugin.so file |
{- "netgate-dataplane:plugin": [
- "string"
]
}
VPP plugins
netgate.dataplane.dataplaneconfig.Plugins to be added or updated
object (netgate.dataplane.dataplaneconfig.Plugins) VPP plugins |
{- "netgate-dataplane:plugins": {
- "netgate-dataplane:plugin": [
- "string"
]
}
}
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-dataplane:dataplane-config/plugins" 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)) }
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)) }
{- "netgate-dataplane:statseg": {
- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}
}
Statistics segment settings
netgate.dataplane.dataplaneconfig.Statseg to be added to list
netgate-dataplane:heap-size | string Default: "96M" Size of heap for stats segment. Should be a number. Optionally followed by a specified of k, m, or g, to indicate kilo, mega, or giga bytes. |
netgate-dataplane:socket-name | string Absolute filesystem path to stats segment unix socket |
object (netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters) |
{- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}
Statistics segment settings
netgate.dataplane.dataplaneconfig.Statseg to be added or updated
object (netgate.dataplane.dataplaneconfig.Statseg) Statistics segment settings |
{- "netgate-dataplane:statseg": {
- "netgate-dataplane:heap-size": "96M",
- "netgate-dataplane:socket-name": "string",
- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}
}
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
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)) }
{- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}
creates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters
netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters to be added to list
netgate-dataplane:enabled | boolean Default: false Whether to enable per-node counters in the stats segment |
{- "netgate-dataplane:enabled": false
}
creates or updates netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters
netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters to be added or updated
object (netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters) |
{- "netgate-dataplane:per-node-counters": {
- "netgate-dataplane:enabled": false
}
}
removes netgate.dataplane.dataplaneconfig.statseg.PerNodeCounters
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)) }
vhost-user startup configuration parameters.
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)) }
{- "netgate-dataplane:vhost-user": {
- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}
}
vhost-user startup configuration parameters.
netgate.dataplane.dataplaneconfig.VhostUser to be added to list
netgate-dataplane:coalesce-frames | integer <int64> Minimum number of packet frames before transmission. Default is 32 frames. |
netgate-dataplane:coalesce-time | integer <int64> Maximum time in microseconds to hold packet frames before transmission. Default is 1000 microseconds. |
netgate-dataplane:dont-dump-memory | boolean If true, vhost-user shared memory segments will not be added to corefiles. Default is false. |
{- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}
vhost-user startup configuration parameters.
netgate.dataplane.dataplaneconfig.VhostUser to be added or updated
object (netgate.dataplane.dataplaneconfig.VhostUser) vhost-user startup configuration parameters. |
{- "netgate-dataplane:vhost-user": {
- "netgate-dataplane:coalesce-frames": 0,
- "netgate-dataplane:coalesce-time": 0,
- "netgate-dataplane:dont-dump-memory": true
}
}
vhost-user startup configuration parameters.
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)) }
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)) }
{- "netgate-dataplane:dataplane-state": {
- "netgate-dataplane:cpu": {
- "netgate-dataplane:threads": {
- "netgate-dataplane:thread": [
- {
- "netgate-dataplane:core": 0,
- "netgate-dataplane:name": "string",
- "netgate-dataplane:cpu-socket": 0,
- "netgate-dataplane:pid": 0,
- "netgate-dataplane:id": 0,
- "netgate-dataplane:type": "string",
- "netgate-dataplane:cpu-id": 0
}
]
}
}
}
}
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)) }
{- "netgate-dataplane:cpu": {
- "netgate-dataplane:threads": {
- "netgate-dataplane:thread": [
- {
- "netgate-dataplane:core": 0,
- "netgate-dataplane:name": "string",
- "netgate-dataplane:cpu-socket": 0,
- "netgate-dataplane:pid": 0,
- "netgate-dataplane:id": 0,
- "netgate-dataplane:type": "string",
- "netgate-dataplane:cpu-id": 0
}
]
}
}
}
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)) }
{- "netgate-dataplane:threads": {
- "netgate-dataplane:thread": [
- {
- "netgate-dataplane:core": 0,
- "netgate-dataplane:name": "string",
- "netgate-dataplane:cpu-socket": 0,
- "netgate-dataplane:pid": 0,
- "netgate-dataplane:id": 0,
- "netgate-dataplane:type": "string",
- "netgate-dataplane:cpu-id": 0
}
]
}
}
Thread data.
id required | integer <int64> Id of thread |
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)) }
{- "netgate-dataplane:thread": {
- "netgate-dataplane:core": 0,
- "netgate-dataplane:name": "string",
- "netgate-dataplane:cpu-socket": 0,
- "netgate-dataplane:pid": 0,
- "netgate-dataplane:id": 0,
- "netgate-dataplane:type": "string",
- "netgate-dataplane:cpu-id": 0
}
}
operates on netgate.dataplane.DataplaneControl
object (netgate.dataplane.dataplanecontrol.Input) |
{- "input": {
- "netgate-dataplane:operation": "start"
}
}
{- "output": {
- "netgate-dataplane:stdout": "string"
}
}
operates on netgate.dataplane.DataplaneCoredump
object (netgate.dataplane.dataplanecoredump.Input) |
{- "input": {
- "netgate-dataplane:operation": "enable"
}
}
{- "output": {
- "netgate-dataplane:stdout": "string"
}
}