netgate-neighbor API (24.06)

This YANG module provides a Netgate-defined data-model for neighbor data.

neighbor-config

returns netgate.neighbor.NeighborConfig

Neighbor configuration data.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-config": {"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
},
"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}
}
}

creates netgate.neighbor.NeighborConfig

Neighbor configuration data.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborConfig to be added to list

	object (netgate.neighbor.neighborconfig.NeighborTable) Neighbor mapping table.
	object (netgate.neighbor.neighborconfig.NeighborCacheOptions) Neighbor cache options.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
},
"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}
}

creates or updates netgate.neighbor.NeighborConfig

Neighbor configuration data.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborConfig to be added or updated

object (netgate.neighbor.NeighborConfig)

Neighbor configuration data.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-config": {"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
},
"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}
}
}

removes netgate.neighbor.NeighborConfig

Neighbor configuration data.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-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.neighbor.neighborconfig.NeighborCacheOptions

Neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}
}

creates netgate.neighbor.neighborconfig.NeighborCacheOptions

Neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.NeighborCacheOptions to be added to list

	object (netgate.neighbor.NeighborCacheOptionsConfig) Group of attributes for neighbor cache options state.
	object (netgate.neighbor.NeighborCacheOptionsConfig) Group of attributes for neighbor cache options state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

creates or updates netgate.neighbor.neighborconfig.NeighborCacheOptions

Neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.NeighborCacheOptions to be added or updated

object (netgate.neighbor.neighborconfig.NeighborCacheOptions)

Neighbor cache options.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
},
"netgate-neighbor:ipv6": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}
}

removes netgate.neighbor.neighborconfig.NeighborCacheOptions

Neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options"

	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.neighbor.NeighborCacheOptionsConfig

IPv4 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

creates netgate.neighbor.NeighborCacheOptionsConfig

IPv4 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added to list

object (netgate.neighbor.NeighborCacheOptionsConfig)

Group of attributes for neighbor cache options state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

creates or updates netgate.neighbor.NeighborCacheOptionsConfig

IPv4 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added or updated

object (netgate.neighbor.NeighborCacheOptionsConfig)

Group of attributes for neighbor cache options state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

removes netgate.neighbor.NeighborCacheOptionsConfig

IPv4 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4"

	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.neighbor.NeighborCacheOptionsConfig

IPv6 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

creates netgate.neighbor.NeighborCacheOptionsConfig

IPv6 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added to list

object (netgate.neighbor.NeighborCacheOptionsConfig)

Group of attributes for neighbor cache options state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

creates or updates netgate.neighbor.NeighborCacheOptionsConfig

IPv6 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added or updated

object (netgate.neighbor.NeighborCacheOptionsConfig)

Group of attributes for neighbor cache options state.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:max-age": 300,
"netgate-neighbor:max-number": 50000
}
}

removes netgate.neighbor.NeighborCacheOptionsConfig

IPv6 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6"

	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.neighbor.neighborconfig.NeighborTable

Neighbor mapping table.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
}
}

creates netgate.neighbor.neighborconfig.NeighborTable

Neighbor mapping table.

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.NeighborTable to be added to list

Array of objects (netgate.neighbor.neighborconfig.neighbortable.Interface)

Neighbor table entry.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
}

creates or updates netgate.neighbor.neighborconfig.NeighborTable

Neighbor mapping table.

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.NeighborTable to be added or updated

object (netgate.neighbor.neighborconfig.NeighborTable)

Neighbor mapping table.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
]
}
}

removes netgate.neighbor.neighborconfig.NeighborTable

Neighbor mapping table.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-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.neighbor.neighborconfig.neighbortable.Interface

Neighbor table entry.

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.Interface to be added to list

netgate-neighbor:if-name	string The interface on which the neighbor entry is found.
	object (netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors) Addresses for which there is a neighbor Entry.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}

returns netgate.neighbor.neighborconfig.neighbortable.Interface

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%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

200

Content type

application/yang-data+json

{"netgate-neighbor:interface": {"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
}

creates or updates netgate.neighbor.neighborconfig.neighbortable.Interface

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.Interface to be added or updated

object (netgate.neighbor.neighborconfig.neighbortable.Interface)

Neighbor table entry.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:interface": {"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}
}

removes netgate.neighbor.neighborconfig.neighbortable.Interface

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%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.neighbor.neighborconfig.neighbortable.interface.Neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%7D/neighbors"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}

creates netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors to be added to list

Array of objects (netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry)

Neighbor entry table.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}

creates or updates netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors to be added or updated

object (netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors)

Addresses for which there is a neighbor Entry.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
]
}
}

removes netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%7D/neighbors"

	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.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry

Neighbor entry table.

path Parameters

if-name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry to be added to list

netgate-neighbor:mac-address	string The MAC address of an neighbor entry.
netgate-neighbor:ip-address	string The IP address whose MAC address is stated.
netgate-neighbor:is-no-route-table-entry	boolean True if this neighbor entry is shoud have no entry made in the adjacency route table.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}

returns netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry

Neighbor entry table.

path Parameters

if-name required	string Id of interface
ip-address required	string Id of neighbor-entry

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%7D/neighbors/neighbor-entry=%7Bip-address%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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-entry": {"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
}

creates or updates netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry

Neighbor entry table.

path Parameters

if-name required	string Id of interface
ip-address required	string Id of neighbor-entry

Request Body schema: application/yang-data+json

netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry to be added or updated

object (netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry)

Neighbor entry table.

Responses

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-entry": {"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:is-no-route-table-entry": true
}
}

removes netgate.neighbor.neighborconfig.neighbortable.interface.neighbors.NeighborEntry

Neighbor entry table.

path Parameters

if-name required	string Id of interface
ip-address required	string Id of neighbor-entry

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface=%7Bif-name%7D/neighbors/neighbor-entry=%7Bip-address%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))

}

neighbor-state

returns netgate.neighbor.NeighborState

Neighbor state data.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-state": {"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:age": 0,
"netgate-neighbor:is-static": true
}
]
}
}
]
},
"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
},
"netgate-neighbor:ipv6": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
}
}
}
}

returns netgate.neighbor.neighborstate.NeighborCacheOptions

Neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-cache-options": {"netgate-neighbor:ipv4": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
},
"netgate-neighbor:ipv6": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
}
}
}

returns netgate.neighbor.NeighborCacheOptionsState

IPv4 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv4"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
}
}

returns netgate.neighbor.NeighborCacheOptionsState

IPv6 neighbor cache options.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv6"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:ipv4": {"netgate-neighbor:recycle": true,
"netgate-neighbor:max-age": 0,
"netgate-neighbor:max-number": 0
}
}

returns netgate.neighbor.neighborstate.NeighborTable

Neighbor mapping table.

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-table": {"netgate-neighbor:interface": [{"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:age": 0,
"netgate-neighbor:is-static": true
}
]
}
}
]
}
}

returns netgate.neighbor.neighborstate.neighbortable.Interface

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface=%7Bif-name%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

200

Content type

application/yang-data+json

{"netgate-neighbor:interface": {"netgate-neighbor:if-name": "string",
"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:age": 0,
"netgate-neighbor:is-static": true
}
]
}
}
}

returns netgate.neighbor.neighborstate.neighbortable.interface.Neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface=%7Bif-name%7D/neighbors"

	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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbors": {"netgate-neighbor:neighbor-entry": [{"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:age": 0,
"netgate-neighbor:is-static": true
}
]
}
}

returns netgate.neighbor.neighborstate.neighbortable.interface.neighbors.NeighborEntry

Neighbor entry table.

path Parameters

if-name required	string Id of interface
ip-address required	string Id of neighbor-entry

Responses

Request samples

Go
javascript
Python
Shell

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface=%7Bif-name%7D/neighbors/neighbor-entry=%7Bip-address%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

200

Content type

application/yang-data+json

{"netgate-neighbor:neighbor-entry": {"netgate-neighbor:mac-address": "string",
"netgate-neighbor:ip-address": "string",
"netgate-neighbor:age": 0,
"netgate-neighbor:is-static": true
}
}