netgate-neighbor API (24.02)

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

neighbor-config

returns netgate.neighbor.NeighborConfig

get /data/netgate-neighbor:neighbor-config

Example URL

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

Neighbor configuration data.

Responses

200

netgate.neighbor.NeighborConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates netgate.neighbor.NeighborConfig

post /data/netgate-neighbor:neighbor-config

Example URL

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

Neighbor configuration data.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborConfig to be added to list

netgate-neighbor:neighbor-config

object (netgate.neighbor.NeighborConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates or updates netgate.neighbor.NeighborConfig

put /data/netgate-neighbor:neighbor-config

Example URL

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

Neighbor configuration data.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborConfig to be added or updated

netgate-neighbor:neighbor-config-wrapper

object (netgate.neighbor.NeighborConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.NeighborConfig

delete /data/netgate-neighbor:neighbor-config

Example URL

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

Neighbor configuration data.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

get /data/netgate-neighbor:neighbor-config/neighbor-cache-options

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options

Neighbor cache options.

Responses

200

netgate.neighbor.neighborconfig.NeighborCacheOptions

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates netgate.neighbor.neighborconfig.NeighborCacheOptions

post /data/netgate-neighbor:neighbor-config/neighbor-cache-options

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options

Neighbor cache options.

Request Body schema: application/yang-data+json

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

neighbor-cache-options

object (netgate.neighbor.neighborconfig.NeighborCacheOptions)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates or updates netgate.neighbor.neighborconfig.NeighborCacheOptions

put /data/netgate-neighbor:neighbor-config/neighbor-cache-options

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options

Neighbor cache options.

Request Body schema: application/yang-data+json

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

netgate-neighbor:neighbor-cache-options-wrapper

object (netgate.neighbor.neighborconfig.NeighborCacheOptionsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.neighborconfig.NeighborCacheOptions

delete /data/netgate-neighbor:neighbor-config/neighbor-cache-options

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options

Neighbor cache options.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

get /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

IPv4 neighbor cache options.

Responses

200

netgate.neighbor.NeighborCacheOptionsConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates netgate.neighbor.NeighborCacheOptionsConfig

post /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

IPv4 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added to list

ipv4	object (netgate.neighbor.NeighborCacheOptionsConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates or updates netgate.neighbor.NeighborCacheOptionsConfig

put /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

IPv4 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added or updated

ipv4	object (netgate.neighbor.NeighborCacheOptionsConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.NeighborCacheOptionsConfig

delete /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv4

IPv4 neighbor cache options.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

get /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

IPv6 neighbor cache options.

Responses

200

netgate.neighbor.NeighborCacheOptionsConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates netgate.neighbor.NeighborCacheOptionsConfig

post /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

IPv6 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added to list

ipv4	object (netgate.neighbor.NeighborCacheOptionsConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates or updates netgate.neighbor.NeighborCacheOptionsConfig

put /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

IPv6 neighbor cache options.

Request Body schema: application/yang-data+json

netgate.neighbor.NeighborCacheOptionsConfig to be added or updated

ipv4	object (netgate.neighbor.NeighborCacheOptionsConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.NeighborCacheOptionsConfig

delete /data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-cache-options/ipv6

IPv6 neighbor cache options.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

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

Example URL

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

Neighbor mapping table.

Responses

200

netgate.neighbor.neighborconfig.NeighborTable

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates netgate.neighbor.neighborconfig.NeighborTable

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

Example URL

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

Neighbor mapping table.

Request Body schema: application/yang-data+json

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

neighbor-table

object (netgate.neighbor.neighborconfig.NeighborTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

creates or updates netgate.neighbor.neighborconfig.NeighborTable

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

Example URL

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

Neighbor mapping table.

Request Body schema: application/yang-data+json

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

netgate-neighbor:neighbor-table-wrapper

object (netgate.neighbor.neighborconfig.NeighborTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.neighborconfig.NeighborTable

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

Example URL

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

Neighbor mapping table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

post /data/netgate-neighbor:neighbor-config/neighbor-table/interface

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface

Neighbor table entry.

Request Body schema: application/yang-data+json

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

interface

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

returns netgate.neighbor.neighborconfig.neighbortable.Interface

get /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

200

netgate.neighbor.neighborconfig.neighbortable.Interface

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

put /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

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

netgate-neighbor:interface-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

removes netgate.neighbor.neighborconfig.neighbortable.Interface

delete /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

get /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

200

netgate.neighbor.neighborconfig.neighbortable.interface.Neighbors

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

post /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/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

neighbors

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

put /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/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

netgate-neighbor:neighbors-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

delete /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

post /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry

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

neighbor-entry

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

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

get /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Neighbor entry table.

path Parameters

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

Responses

200

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

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

put /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

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

netgate-neighbor:neighbor-entry-wrapper

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

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

delete /data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-config/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Neighbor entry table.

path Parameters

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

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

get /data/netgate-neighbor:neighbor-state

Example URL

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

Neighbor state data.

Responses

200

netgate.neighbor.NeighborState

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

returns netgate.neighbor.neighborstate.NeighborCacheOptions

get /data/netgate-neighbor:neighbor-state/neighbor-cache-options

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options

Neighbor cache options.

Responses

200

netgate.neighbor.neighborstate.NeighborCacheOptions

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

returns netgate.neighbor.NeighborCacheOptionsState

get /data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv4

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv4

IPv4 neighbor cache options.

Responses

200

netgate.neighbor.NeighborCacheOptionsState

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-neighbor:neighbor-cache-options-state-wrapper":
{
- "ipv4":
  {
  - "recycle": false,
  - "max-age": 0,
  - "max-number": 0
  }
}

}

returns netgate.neighbor.NeighborCacheOptionsState

get /data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv6

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-cache-options/ipv6

IPv6 neighbor cache options.

Responses

200

netgate.neighbor.NeighborCacheOptionsState

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-neighbor:neighbor-cache-options-state-wrapper":
{
- "ipv4":
  {
  - "recycle": false,
  - "max-age": 0,
  - "max-number": 0
  }
}

}

returns netgate.neighbor.neighborstate.NeighborTable

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

Example URL

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

Neighbor mapping table.

Responses

200

netgate.neighbor.neighborstate.NeighborTable

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

returns netgate.neighbor.neighborstate.neighbortable.Interface

get /data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}

Neighbor table entry.

path Parameters

if-name

required

string

Id of interface

Responses

200

netgate.neighbor.neighborstate.neighbortable.Interface

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

get /data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}/neighbors

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}/neighbors

Addresses for which there is a neighbor Entry.

path Parameters

if-name

required

string

Id of interface

Responses

200

netgate.neighbor.neighborstate.neighbortable.interface.Neighbors

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}

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

get /data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-neighbor:neighbor-state/neighbor-table/interface={if-name}/neighbors/neighbor-entry={ip-address}

Neighbor entry table.

path Parameters

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

Responses

200

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

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

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

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

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

}