Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-bfd API (24.02)

This YANG module provides a Netgate-defined data-model for Bidirectional Forwarding Detection (BFD) data.

Copyright 2017-2020 Rubicon Communications, LLC.

bfd-config

returns netgate.bfd.BfdConfig

get /data/netgate-bfd:bfd-config

Example URL

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

The bfd-config node contains BFD keys and session.

Responses

200

netgate.bfd.BfdConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.bfd.BfdConfig

post /data/netgate-bfd:bfd-config

Example URL

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

The bfd-config node contains BFD keys and session.

Request Body schema: application/yang-data+json

netgate.bfd.BfdConfig to be added to list

netgate-bfd:bfd-config
object (netgate.bfd.BfdConfig)

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

creates or updates netgate.bfd.BfdConfig

put /data/netgate-bfd:bfd-config

Example URL

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

The bfd-config node contains BFD keys and session.

Request Body schema: application/yang-data+json

netgate.bfd.BfdConfig to be added or updated

netgate-bfd:bfd-config-wrapper
object (netgate.bfd.BfdConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.bfd.BfdConfig

delete /data/netgate-bfd:bfd-config

Example URL

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

The bfd-config node contains BFD keys and session.

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-bfd:bfd-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.bfd.bfdconfig.BfdTable

get /data/netgate-bfd:bfd-config/bfd-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table

Host BFD interface configuration table.

Responses

200

netgate.bfd.bfdconfig.BfdTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table"

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

creates netgate.bfd.bfdconfig.BfdTable

post /data/netgate-bfd:bfd-config/bfd-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table

Host BFD interface configuration table.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.BfdTable to be added to list

bfd-table
object (netgate.bfd.bfdconfig.BfdTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.bfd.bfdconfig.BfdTable

put /data/netgate-bfd:bfd-config/bfd-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table

Host BFD interface configuration table.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.BfdTable to be added or updated

netgate-bfd:bfd-table-wrapper
object (netgate.bfd.bfdconfig.BfdTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-bfd:bfd-table-wrapper":
    {
    }
}

removes netgate.bfd.bfdconfig.BfdTable

delete /data/netgate-bfd:bfd-config/bfd-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table

Host BFD interface configuration table.

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-bfd:bfd-config/bfd-table"

	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.bfd.bfdconfig.bfdtable.BfdSession

post /data/netgate-bfd:bfd-config/bfd-table/bfd-session

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table/bfd-session

Each session has its own unique name.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.bfdtable.BfdSession to be added to list

bfd-session
object (netgate.bfd.bfdconfig.bfdtable.BfdSession)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.bfd.bfdconfig.bfdtable.BfdSession

get /data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Each session has its own unique name.

path Parameters
name
required
string

Id of bfd-session

Responses

200

netgate.bfd.bfdconfig.bfdtable.BfdSession

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table/bfd-session=%7Bname%7D"

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

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

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

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

}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-bfd:bfd-session-wrapper":
    {
    }
}

creates or updates netgate.bfd.bfdconfig.bfdtable.BfdSession

put /data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Each session has its own unique name.

path Parameters
name
required
string

Id of bfd-session

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.bfdtable.BfdSession to be added or updated

netgate-bfd:bfd-session-wrapper
object (netgate.bfd.bfdconfig.bfdtable.BfdSessionWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-bfd:bfd-session-wrapper":
    {
    }
}

removes netgate.bfd.bfdconfig.bfdtable.BfdSession

delete /data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/bfd-table/bfd-session={name}

Each session has its own unique name.

path Parameters
name
required
string

Id of bfd-session

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-bfd:bfd-config/bfd-table/bfd-session=%7Bname%7D"

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

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

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

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

}

returns netgate.bfd.bfdconfig.KeyTable

get /data/netgate-bfd:bfd-config/key-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table

This table contains BFD Conf Keys.

Responses

200

netgate.bfd.bfdconfig.KeyTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-config/key-table"

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

creates netgate.bfd.bfdconfig.KeyTable

post /data/netgate-bfd:bfd-config/key-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table

This table contains BFD Conf Keys.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.KeyTable to be added to list

key-table
object (netgate.bfd.bfdconfig.KeyTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.bfd.bfdconfig.KeyTable

put /data/netgate-bfd:bfd-config/key-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table

This table contains BFD Conf Keys.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.KeyTable to be added or updated

netgate-bfd:key-table-wrapper
object (netgate.bfd.bfdconfig.KeyTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-bfd:key-table-wrapper":
    {
    }
}

removes netgate.bfd.bfdconfig.KeyTable

delete /data/netgate-bfd:bfd-config/key-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table

This table contains BFD Conf Keys.

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-bfd:bfd-config/key-table"

	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.bfd.bfdconfig.keytable.KeyEntry

post /data/netgate-bfd:bfd-config/key-table/key-entry

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table/key-entry

BFD Conf Key Entry.

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.keytable.KeyEntry to be added to list

key-entry
object (netgate.bfd.bfdconfig.keytable.KeyEntry)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.bfd.bfdconfig.keytable.KeyEntry

get /data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

BFD Conf Key Entry.

path Parameters
conf-key-id
required
integer <int64>

Id of key-entry

Responses

200

netgate.bfd.bfdconfig.keytable.KeyEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-config/key-table/key-entry=%7Bconf-key-id%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-bfd:key-entry-wrapper":
    {
    }
}

creates or updates netgate.bfd.bfdconfig.keytable.KeyEntry

put /data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

BFD Conf Key Entry.

path Parameters
conf-key-id
required
integer <int64>

Id of key-entry

Request Body schema: application/yang-data+json

netgate.bfd.bfdconfig.keytable.KeyEntry to be added or updated

netgate-bfd:key-entry-wrapper
object (netgate.bfd.bfdconfig.keytable.KeyEntryWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-bfd:key-entry-wrapper":
    {
    }
}

removes netgate.bfd.bfdconfig.keytable.KeyEntry

delete /data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-config/key-table/key-entry={conf-key-id}

BFD Conf Key Entry.

path Parameters
conf-key-id
required
integer <int64>

Id of key-entry

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-bfd:bfd-config/key-table/key-entry=%7Bconf-key-id%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))

}

bfd-state

returns netgate.bfd.BfdState

get /data/netgate-bfd:bfd-state

Example URL

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

The bfd-config node contains BFD keys and session.

Responses

200

netgate.bfd.BfdState

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.bfd.bfdstate.BfdTable

get /data/netgate-bfd:bfd-state/bfd-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-state/bfd-table

Host BFD interface configuration table.

Responses

200

netgate.bfd.bfdstate.BfdTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-state/bfd-table"

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

returns netgate.bfd.bfdstate.bfdtable.BfdSession

get /data/netgate-bfd:bfd-state/bfd-table/bfd-session={session-number}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-state/bfd-table/bfd-session={session-number}

Each session has its own unique name.

path Parameters
session-number
required
integer <int64>

Id of bfd-session

Responses

200

netgate.bfd.bfdstate.bfdtable.BfdSession

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-state/bfd-table/bfd-session=%7Bsession-number%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-bfd:bfd-session-wrapper":
    {
    }
}

returns netgate.bfd.bfdstate.KeyTable

get /data/netgate-bfd:bfd-state/key-table

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-state/key-table

This table contains BFD Conf Keys.

Responses

200

netgate.bfd.bfdstate.KeyTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-state/key-table"

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

returns netgate.bfd.bfdstate.keytable.KeyEntry

get /data/netgate-bfd:bfd-state/key-table/key-entry={conf-key-id}

Example URL

https://hostname/restconf/data/netgate-bfd:bfd-state/key-table/key-entry={conf-key-id}

BFD Conf Key Entry.

path Parameters
conf-key-id
required
integer <int64>

Id of key-entry

Responses

200

netgate.bfd.bfdstate.keytable.KeyEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-bfd:bfd-state/key-table/key-entry=%7Bconf-key-id%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-bfd:key-entry-wrapper":
    {
    }
}