Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-dataplane API (23.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