This YANG module provides a Netgate-defined data-model for Bidirectional Forwarding Detection (BFD) data.
Copyright 2017-2019 Rubicon Communications, LLC.
Example URL
The bfd-config node contains BFD keys and session.
netgate.bfd.BfdConfig
Internal error
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)) }
Example URL
The bfd-config node contains BFD keys and session.
netgate.bfd.BfdConfig to be added to list
key-table | object (netgate.bfd.bfdconfig.KeyTable) |
bfd-table | object (netgate.bfd.bfdconfig.BfdTable) |
Object created
Internal error
Object already exists
Example URL
The bfd-config node contains BFD keys and session.
netgate.bfd.BfdConfig to be added or updated
netgate-bfd:bfd-config | object (netgate.bfd.BfdConfig) |
Object created
Object modified
Internal error
Example URL
The bfd-config node contains BFD keys and session.
Object deleted
Internal error
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)) }
Example URL
Host BFD interface configuration table.
netgate.bfd.bfdconfig.BfdTable
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd: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)) }
Example URL
Host BFD interface configuration table.
netgate.bfd.bfdconfig.BfdTable to be added to list
bfd-session | Array of objects (netgate.bfd.bfdconfig.bfdtable.BfdSession) Each session has its own unique name. |
Object created
Internal error
Object already exists
Example URL
Host BFD interface configuration table.
netgate.bfd.bfdconfig.BfdTable to be added or updated
netgate-bfd:bfd-table | object (netgate.bfd.bfdconfig.BfdTable) |
Object created
Object modified
Internal error
Example URL
Host BFD interface configuration table.
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd: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)) }
Example URL
Each session has its own unique name.
netgate.bfd.bfdconfig.bfdtable.BfdSession to be added to list
detect-multiplier | integer <int32> The desired Detection Time multiplier for BFD Control packets on the local system. This variable MUST be a nonzero integer. This value is (roughly speaking, due to jitter) the number of packets that have to be missed in a row to declare the session to be down. |
peer-ip-address | string The session's peer IPv4 or IPv6 address. |
enable | boolean If true, BFD is enabled on this interface. |
local-ip-address | string The session's local IPv4 or IPv6 address. |
name | string This is the name of the BFD session. |
required-min-rx | integer <int64> This is the minimum interval, in microseconds, between received BFD Control packets that this system is capable of supporting, less any jitter applied by the sender. If this value is zero, the transmitting system does not want the remote system to send any periodic BFD Control packets. |
desired-min-tx | integer <int64> This is the minimum interval, in microseconds, that the local system would like to use when transmitting BFD Control packets, less any jitter applied. The value zero is reserved. |
delayed | boolean If true, authentication begins when a packet is received from the peer. |
bfd-key-id | integer <int64> The BFD key. |
conf-key-id | integer <int64> The conf authentication key id. |
interface | string The session's interface name. |
Object created
Internal error
Object already exists
Example URL
Each session has its own unique name.
name required | string Id of bfd-session |
netgate.bfd.bfdconfig.bfdtable.BfdSession
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd:bfd-table/netgate-bfd: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)) }
Example URL
Each session has its own unique name.
name required | string Id of bfd-session |
netgate.bfd.bfdconfig.bfdtable.BfdSession to be added to list
detect-multiplier | integer <int32> The desired Detection Time multiplier for BFD Control packets on the local system. This variable MUST be a nonzero integer. This value is (roughly speaking, due to jitter) the number of packets that have to be missed in a row to declare the session to be down. |
peer-ip-address | string The session's peer IPv4 or IPv6 address. |
enable | boolean If true, BFD is enabled on this interface. |
local-ip-address | string The session's local IPv4 or IPv6 address. |
name | string This is the name of the BFD session. |
required-min-rx | integer <int64> This is the minimum interval, in microseconds, between received BFD Control packets that this system is capable of supporting, less any jitter applied by the sender. If this value is zero, the transmitting system does not want the remote system to send any periodic BFD Control packets. |
desired-min-tx | integer <int64> This is the minimum interval, in microseconds, that the local system would like to use when transmitting BFD Control packets, less any jitter applied. The value zero is reserved. |
delayed | boolean If true, authentication begins when a packet is received from the peer. |
bfd-key-id | integer <int64> The BFD key. |
conf-key-id | integer <int64> The conf authentication key id. |
interface | string The session's interface name. |
Object created
Internal error
Object already exists
Example URL
Each session has its own unique name.
name required | string Id of bfd-session |
netgate.bfd.bfdconfig.bfdtable.BfdSession to be added or updated
netgate-bfd:bfd-session | object (netgate.bfd.bfdconfig.bfdtable.BfdSession) |
Object created
Object modified
Internal error
Example URL
Each session has its own unique name.
name required | string Id of bfd-session |
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd:bfd-table/netgate-bfd: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)) }
Example URL
This table contains BFD Conf Keys.
netgate.bfd.bfdconfig.KeyTable
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd: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)) }
Example URL
This table contains BFD Conf Keys.
netgate.bfd.bfdconfig.KeyTable to be added to list
key-entry | Array of objects (netgate.bfd.bfdconfig.keytable.KeyEntry) BFD Conf Key Entry. |
Object created
Internal error
Object already exists
Example URL
This table contains BFD Conf Keys.
netgate.bfd.bfdconfig.KeyTable to be added or updated
netgate-bfd:key-table | object (netgate.bfd.bfdconfig.KeyTable) |
Object created
Object modified
Internal error
Example URL
This table contains BFD Conf Keys.
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd: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)) }
Example URL
BFD Conf Key Entry.
netgate.bfd.bfdconfig.keytable.KeyEntry to be added to list
secret | string This is the hex encoded secret with maximum length 20 bytes. |
type | string (netgate.bfd.BfdAuthKeyType) Enum: "keyed-sha1" "meticulous-keyed-sha1" |
conf-key-id | integer <int64> This is the unique integer Id of the BFD key. |
Object created
Internal error
Object already exists
Example URL
BFD Conf Key Entry.
conf-key-id required | integer <int64> Id of key-entry |
netgate.bfd.bfdconfig.keytable.KeyEntry
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd:key-table/netgate-bfd: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)) }
Example URL
BFD Conf Key Entry.
conf-key-id required | integer <int64> Id of key-entry |
netgate.bfd.bfdconfig.keytable.KeyEntry to be added to list
secret | string This is the hex encoded secret with maximum length 20 bytes. |
type | string (netgate.bfd.BfdAuthKeyType) Enum: "keyed-sha1" "meticulous-keyed-sha1" |
conf-key-id | integer <int64> This is the unique integer Id of the BFD key. |
Object created
Internal error
Object already exists
Example URL
BFD Conf Key Entry.
conf-key-id required | integer <int64> Id of key-entry |
netgate.bfd.bfdconfig.keytable.KeyEntry to be added or updated
netgate-bfd:key-entry | object (netgate.bfd.bfdconfig.keytable.KeyEntry) |
Object created
Object modified
Internal error
Example URL
BFD Conf Key Entry.
conf-key-id required | integer <int64> Id of key-entry |
Object deleted
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-config/netgate-bfd:key-table/netgate-bfd: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)) }
Example URL
The bfd-config node contains BFD keys and session.
netgate.bfd.BfdState
Internal error
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)) }
Example URL
Host BFD interface configuration table.
netgate.bfd.bfdstate.BfdTable
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-state/netgate-bfd: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)) }
Example URL
Each session has its own unique name.
session-number required | integer <int64> Id of bfd-session |
netgate.bfd.bfdstate.bfdtable.BfdSession
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-state/netgate-bfd:bfd-table/netgate-bfd: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)) }
Example URL
This table contains BFD Conf Keys.
netgate.bfd.bfdstate.KeyTable
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-state/netgate-bfd: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)) }
Example URL
BFD Conf Key Entry.
conf-key-id required | integer <int64> Id of key-entry |
netgate.bfd.bfdstate.keytable.KeyEntry
Internal error
package main import ( "fmt" "net/http" "io/ioutil" ) func main() { url := "http://hostname/restconf/data/netgate-bfd:bfd-state/netgate-bfd:key-table/netgate-bfd: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)) }