Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-interface API (19.02)

This YANG module provides a data model for network interfaces.

Copyright 2017-2019 Rubicon Communications, LLC.

interfaces-config

returns netgate.interface.InterfacesConfig

get /data/netgate-interface:interfaces-config

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config

Interface configuration parameters.

Responses

200

netgate.interface.InterfacesConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.interface.InterfacesConfig

post /data/netgate-interface:interfaces-config

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config

Interface configuration parameters.

Request Body schema: application/yang-data+json

netgate.interface.InterfacesConfig to be added to list

bond-table
object (netgate.interface.interfacesconfig.BondTable)
loopback-table
object (netgate.interface.interfacesconfig.LoopbackTable)
bridge-table
object (netgate.interface.interfacesconfig.BridgeTable)
subinterfaces
object (netgate.interface.interfacesconfig.Subinterfaces)
tap-table
object (netgate.interface.interfacesconfig.TapTable)
interface
Array of objects (netgate.interface.interfacesconfig.Interface)

The list of configured interfaces on the device.

memif-table
object (netgate.interface.interfacesconfig.MemifTable)
socket-table
object (netgate.interface.interfacesconfig.SocketTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "bond-table":
    {
    },
  • "loopback-table":
    {
    },
  • "bridge-table":
    {
    },
  • "subinterfaces":
    {
    },
  • "tap-table":
    {
    },
  • "interface":
    [
    ],
  • "memif-table":
    {
    },
  • "socket-table":
    {
    }
}

creates or updates netgate.interface.InterfacesConfig

put /data/netgate-interface:interfaces-config

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config

Interface configuration parameters.

Request Body schema: application/yang-data+json

netgate.interface.InterfacesConfig to be added or updated

netgate-interface:interfaces-config
object (netgate.interface.InterfacesConfig)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.InterfacesConfig

delete /data/netgate-interface:interfaces-config

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config

Interface configuration parameters.

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-interface:interfaces-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.interface.interfacesconfig.BondTable

get /data/netgate-interface:interfaces-config/netgate-interface:bond-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table

Bond interface configuration table.

Responses

200

netgate.interface.interfacesconfig.BondTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-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-interface:bond-table":
    {
    }
}

creates netgate.interface.interfacesconfig.BondTable

post /data/netgate-interface:interfaces-config/netgate-interface:bond-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table

Bond interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.BondTable to be added to list

bond
Array of objects (netgate.interface.interfacesconfig.bondtable.Bond)

Bond interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "bond":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.BondTable

put /data/netgate-interface:interfaces-config/netgate-interface:bond-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table

Bond interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.BondTable to be added or updated

netgate-interface:bond-table
object (netgate.interface.interfacesconfig.BondTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.BondTable

delete /data/netgate-interface:interfaces-config/netgate-interface:bond-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table

Bond 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-interface:interfaces-config/netgate-interface:bond-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.interface.interfacesconfig.bondtable.Bond

post /data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond

Bond interface.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bondtable.Bond to be added to list

mode
string (netgate.interface.BondMode)
Enum: "round-robin" "active-backup" "xor" "broadcast" "lacp"
mac-address
string

The MAC address for the interface.

load-balance
string (netgate.interface.LoadBalance)
Enum: "l2" "l23" "l34"
instance
integer <int64>

The identifier. A unique number for this bond interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mode": "round-robin",
  • "mac-address": "string",
  • "load-balance": "l2",
  • "instance": 0
}

returns netgate.interface.interfacesconfig.bondtable.Bond

get /data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Bond interface.

path Parameters
instance
required
integer <int64>

Id of bond

Responses

200

netgate.interface.interfacesconfig.bondtable.Bond

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond=%7Binstance%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-interface:bond":
    {
    }
}

creates netgate.interface.interfacesconfig.bondtable.Bond

post /data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Bond interface.

path Parameters
instance
required
integer <int64>

Id of bond

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bondtable.Bond to be added to list

mode
string (netgate.interface.BondMode)
Enum: "round-robin" "active-backup" "xor" "broadcast" "lacp"
mac-address
string

The MAC address for the interface.

load-balance
string (netgate.interface.LoadBalance)
Enum: "l2" "l23" "l34"
instance
integer <int64>

The identifier. A unique number for this bond interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mode": "round-robin",
  • "mac-address": "string",
  • "load-balance": "l2",
  • "instance": 0
}

creates or updates netgate.interface.interfacesconfig.bondtable.Bond

put /data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Bond interface.

path Parameters
instance
required
integer <int64>

Id of bond

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bondtable.Bond to be added or updated

netgate-interface:bond
object (netgate.interface.interfacesconfig.bondtable.Bond)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:bond":
    {
    }
}

removes netgate.interface.interfacesconfig.bondtable.Bond

delete /data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond={instance}

Bond interface.

path Parameters
instance
required
integer <int64>

Id of bond

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-interface:interfaces-config/netgate-interface:bond-table/netgate-interface:bond=%7Binstance%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.interface.interfacesconfig.BridgeTable

get /data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Bridge mapping table.

Responses

200

netgate.interface.interfacesconfig.BridgeTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-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-interface:bridge-table":
    {
    }
}

creates netgate.interface.interfacesconfig.BridgeTable

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Bridge mapping table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.BridgeTable to be added to list

bridge-entry
Array of objects (netgate.interface.interfacesconfig.bridgetable.BridgeEntry)

Bridge Domain Id.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.interface.interfacesconfig.BridgeTable

put /data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Bridge mapping table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.BridgeTable to be added or updated

netgate-interface:bridge-table
object (netgate.interface.interfacesconfig.BridgeTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.BridgeTable

delete /data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table

Bridge mapping 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-interface:interfaces-config/netgate-interface:bridge-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.interface.interfacesconfig.bridgetable.BridgeEntry

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry

Bridge Domain Id.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.BridgeEntry to be added to list

learn
boolean

Learning on all interfaces in the bd

forward
boolean

Forwarding on all interfaces in the bd

bdi
integer <int64>

The Bridge Domain Identifier. A unique number for this entry.

mac-age
integer <int32>

MAC aging time in min, 0 for disabled.

bridge-arp-table
object (netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable)
arp-term
boolean

ARP termination in the bd

uu-flood
boolean

Unknown unicast flood in the bd

flood
boolean

Broadcast/multicast flooding in the bd

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "learn": true,
  • "forward": true,
  • "bdi": 0,
  • "mac-age": 0,
  • "bridge-arp-table":
    {
    },
  • "arp-term": true,
  • "uu-flood": true,
  • "flood": true
}

returns netgate.interface.interfacesconfig.bridgetable.BridgeEntry

get /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Bridge Domain Id.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Responses

200

netgate.interface.interfacesconfig.bridgetable.BridgeEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%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-interface:bridge-entry":
    {
    }
}

creates netgate.interface.interfacesconfig.bridgetable.BridgeEntry

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Bridge Domain Id.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.BridgeEntry to be added to list

learn
boolean

Learning on all interfaces in the bd

forward
boolean

Forwarding on all interfaces in the bd

bdi
integer <int64>

The Bridge Domain Identifier. A unique number for this entry.

mac-age
integer <int32>

MAC aging time in min, 0 for disabled.

bridge-arp-table
object (netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable)
arp-term
boolean

ARP termination in the bd

uu-flood
boolean

Unknown unicast flood in the bd

flood
boolean

Broadcast/multicast flooding in the bd

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "learn": true,
  • "forward": true,
  • "bdi": 0,
  • "mac-age": 0,
  • "bridge-arp-table":
    {
    },
  • "arp-term": true,
  • "uu-flood": true,
  • "flood": true
}

creates or updates netgate.interface.interfacesconfig.bridgetable.BridgeEntry

put /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Bridge Domain Id.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.BridgeEntry to be added or updated

netgate-interface:bridge-entry
object (netgate.interface.interfacesconfig.bridgetable.BridgeEntry)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.bridgetable.BridgeEntry

delete /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Bridge Domain Id.

path Parameters
bdi
required
integer <int64>

Id of bridge-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-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%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.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable

get /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Bridge ARP Entry Table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Responses

200

netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-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-interface:bridge-arp-table":
    {
    }
}

creates netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Bridge ARP Entry Table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable to be added to list

bridge-arp-entry
Array of objects (netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry)

Bridge ARP entry table.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "bridge-arp-entry":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable

put /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Bridge ARP Entry Table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable to be added or updated

netgate-interface:bridge-arp-table
object (netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.bridgetable.bridgeentry.BridgeArpTable

delete /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Bridge ARP Entry Table.

path Parameters
bdi
required
integer <int64>

Id of bridge-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-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-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.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry to be added to list

mac-address
string

The MAC address of an ARP entry.

ip-address
string

The IPv4 or IPv6 address of an ARP entry.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "ip-address": "string"
}

returns netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

get /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

ip-address
required
string

Id of bridge-arp-entry

Responses

200

netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-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-interface:bridge-arp-entry":
    {
    }
}

creates netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

post /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

ip-address
required
string

Id of bridge-arp-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry to be added to list

mac-address
string

The MAC address of an ARP entry.

ip-address
string

The IPv4 or IPv6 address of an ARP entry.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "ip-address": "string"
}

creates or updates netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

put /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

ip-address
required
string

Id of bridge-arp-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry to be added or updated

netgate-interface:bridge-arp-entry
object (netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:bridge-arp-entry":
    {
    }
}

removes netgate.interface.interfacesconfig.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

delete /data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

ip-address
required
string

Id of bridge-arp-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-interface:interfaces-config/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-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))

}

creates netgate.interface.interfacesconfig.Interface

post /data/netgate-interface:interfaces-config/netgate-interface:interface

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface

The list of configured interfaces on the device.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.Interface to be added to list

mac-address
string

The Media Access Control (MAC) address of the interface.

host-tap-name
string

If this interface is associated with a host tap, this field names that host tap interface.

description
string

A textual description of the interface.

inside
boolean

If set true, this interface is used as a NAT inside interface.

bond
object (netgate.interface.interfacesconfig.interface.Bond)
enabled
boolean

This leaf contains the configured, desired state of the interface.

mtu
integer <int32>

The size, in octets, of the largest packet that the interface will send and receive.

ipv4
object (netgate.interface.interfacesconfig.interface.Ipv4)
access-list
object (netgate.interface.interfacesconfig.interface.AccessList)
dhcp-client
object (netgate.interface.interfacesconfig.interface.DhcpClient)
ipv6
object (netgate.interface.interfacesconfig.interface.Ipv6)
outside
boolean

If set true, this interface is used as a NAT outside interface.

name
string

The name of the interface.

bridge
object (netgate.interface.interfacesconfig.interface.Bridge)
map
object (netgate.interface.interfacesconfig.interface.Map)
lldp
object (netgate.interface.interfacesconfig.interface.Lldp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "host-tap-name": "string",
  • "description": "string",
  • "inside": true,
  • "bond":
    {
    },
  • "enabled": true,
  • "mtu": 0,
  • "ipv4":
    {
    },
  • "access-list":
    {
    },
  • "dhcp-client":
    {
    },
  • "ipv6":
    {
    },
  • "outside": true,
  • "name": "string",
  • "bridge":
    {
    },
  • "map":
    {
    },
  • "lldp":
    {
    }
}

returns netgate.interface.interfacesconfig.Interface

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}

The list of configured interfaces on the device.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.Interface

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.interface.interfacesconfig.Interface

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}

The list of configured interfaces on the device.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.Interface to be added to list

mac-address
string

The Media Access Control (MAC) address of the interface.

host-tap-name
string

If this interface is associated with a host tap, this field names that host tap interface.

description
string

A textual description of the interface.

inside
boolean

If set true, this interface is used as a NAT inside interface.

bond
object (netgate.interface.interfacesconfig.interface.Bond)
enabled
boolean

This leaf contains the configured, desired state of the interface.

mtu
integer <int32>

The size, in octets, of the largest packet that the interface will send and receive.

ipv4
object (netgate.interface.interfacesconfig.interface.Ipv4)
access-list
object (netgate.interface.interfacesconfig.interface.AccessList)
dhcp-client
object (netgate.interface.interfacesconfig.interface.DhcpClient)
ipv6
object (netgate.interface.interfacesconfig.interface.Ipv6)
outside
boolean

If set true, this interface is used as a NAT outside interface.

name
string

The name of the interface.

bridge
object (netgate.interface.interfacesconfig.interface.Bridge)
map
object (netgate.interface.interfacesconfig.interface.Map)
lldp
object (netgate.interface.interfacesconfig.interface.Lldp)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "host-tap-name": "string",
  • "description": "string",
  • "inside": true,
  • "bond":
    {
    },
  • "enabled": true,
  • "mtu": 0,
  • "ipv4":
    {
    },
  • "access-list":
    {
    },
  • "dhcp-client":
    {
    },
  • "ipv6":
    {
    },
  • "outside": true,
  • "name": "string",
  • "bridge":
    {
    },
  • "map":
    {
    },
  • "lldp":
    {
    }
}

creates or updates netgate.interface.interfacesconfig.Interface

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}

The list of configured interfaces on the device.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.Interface to be added or updated

netgate-interface:interface
object (netgate.interface.interfacesconfig.Interface)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.Interface

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}

The list of configured interfaces on the device.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%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.interface.interfacesconfig.interface.AccessList

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

If the interface has any Access Control Lists, they are listed here in two groups: those that apply to packet ingress and those that apply to egresss. The two sets of ACLs are sorted independenty and applied in ascending sequence-number order.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.AccessList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list"

	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-interface:access-list":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.AccessList

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

If the interface has any Access Control Lists, they are listed here in two groups: those that apply to packet ingress and those that apply to egresss. The two sets of ACLs are sorted independenty and applied in ascending sequence-number order.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.AccessList to be added to list

output
object (netgate.interface.interfacesconfig.interface.accesslist.Output)
input
object (netgate.interface.interfacesconfig.interface.accesslist.Input)
macip
object (netgate.interface.interfacesconfig.interface.accesslist.Macip)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    },
  • "input":
    {
    },
  • "macip":
    {
    }
}

creates or updates netgate.interface.interfacesconfig.interface.AccessList

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

If the interface has any Access Control Lists, they are listed here in two groups: those that apply to packet ingress and those that apply to egresss. The two sets of ACLs are sorted independenty and applied in ascending sequence-number order.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.AccessList to be added or updated

netgate-interface:access-list
object (netgate.interface.interfacesconfig.interface.AccessList)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:access-list":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.AccessList

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list

If the interface has any Access Control Lists, they are listed here in two groups: those that apply to packet ingress and those that apply to egresss. The two sets of ACLs are sorted independenty and applied in ascending sequence-number order.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list"

	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.interface.interfacesconfig.interface.accesslist.Input

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

These are the ACL rule-sets that apply to ingress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.accesslist.Input

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input"

	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-interface:input":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.accesslist.Input

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

These are the ACL rule-sets that apply to ingress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Input to be added to list

acl-list
Array of objects (netgate.interface.interfacesconfig.interface.accesslist.input.AclList)

Each ACL rule-set can appear at most once within the input list.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-list":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.interface.accesslist.Input

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

These are the ACL rule-sets that apply to ingress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Input to be added or updated

netgate-interface:input
object (netgate.interface.interfacesconfig.interface.accesslist.Input)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:input":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.accesslist.Input

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

These are the ACL rule-sets that apply to ingress packets.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input"

	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.interface.interfacesconfig.interface.accesslist.input.AclList

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.input.AclList to be added to list

sequence
integer <int64>

Rules are applied in ascending sequence number.

acl-name
string

This is the name of an ACL rule-set that will be be applied to packets on this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "sequence": 0,
  • "acl-name": "string"
}

returns netgate.interface.interfacesconfig.interface.accesslist.input.AclList

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Responses

200

netgate.interface.interfacesconfig.interface.accesslist.input.AclList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list=%7Bacl-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-interface:acl-list":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.accesslist.input.AclList

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.input.AclList to be added to list

sequence
integer <int64>

Rules are applied in ascending sequence number.

acl-name
string

This is the name of an ACL rule-set that will be be applied to packets on this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "sequence": 0,
  • "acl-name": "string"
}

creates or updates netgate.interface.interfacesconfig.interface.accesslist.input.AclList

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.input.AclList to be added or updated

netgate-interface:acl-list
object (netgate.interface.interfacesconfig.interface.accesslist.input.AclList)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:acl-list":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.accesslist.input.AclList

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list=%7Bacl-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.interface.interfacesconfig.interface.accesslist.Macip

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

An interface may also have at most one ACL based upon a combination of MAC address and IP. If that ACL is present, it is always on the ingress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.accesslist.Macip

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:macip"

	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-interface:macip":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.accesslist.Macip

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

An interface may also have at most one ACL based upon a combination of MAC address and IP. If that ACL is present, it is always on the ingress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Macip to be added to list

macip-name
string

This name references at most one MACIP ingress rule-set from the ACL MACIP tables.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "macip-name": "string"
}

creates or updates netgate.interface.interfacesconfig.interface.accesslist.Macip

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

An interface may also have at most one ACL based upon a combination of MAC address and IP. If that ACL is present, it is always on the ingress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Macip to be added or updated

netgate-interface:macip
object (netgate.interface.interfacesconfig.interface.accesslist.Macip)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:macip":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.accesslist.Macip

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

An interface may also have at most one ACL based upon a combination of MAC address and IP. If that ACL is present, it is always on the ingress packets.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:macip"

	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.interface.interfacesconfig.interface.accesslist.Output

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

These are the ACL rule-sets that apply to egress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.accesslist.Output

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output"

	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-interface:output":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.accesslist.Output

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

These are the ACL rule-sets that apply to egress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Output to be added to list

acl-list
Array of objects (netgate.interface.interfacesconfig.interface.accesslist.output.AclList)

Each ACL rule-set can appear at most once within the output list.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "acl-list":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.interface.accesslist.Output

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

These are the ACL rule-sets that apply to egress packets.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.Output to be added or updated

netgate-interface:output
object (netgate.interface.interfacesconfig.interface.accesslist.Output)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:output":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.accesslist.Output

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

These are the ACL rule-sets that apply to egress packets.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output"

	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.interface.interfacesconfig.interface.accesslist.output.AclList

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.output.AclList to be added to list

sequence
integer <int64>

Rules are applied in ascending sequence number.

acl-name
string

This is the name of an ACL rule-set that will be be applied to packets on this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "sequence": 0,
  • "acl-name": "string"
}

returns netgate.interface.interfacesconfig.interface.accesslist.output.AclList

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Responses

200

netgate.interface.interfacesconfig.interface.accesslist.output.AclList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list=%7Bacl-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-interface:acl-list":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.accesslist.output.AclList

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.output.AclList to be added to list

sequence
integer <int64>

Rules are applied in ascending sequence number.

acl-name
string

This is the name of an ACL rule-set that will be be applied to packets on this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "sequence": 0,
  • "acl-name": "string"
}

creates or updates netgate.interface.interfacesconfig.interface.accesslist.output.AclList

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.accesslist.output.AclList to be added or updated

netgate-interface:acl-list
object (netgate.interface.interfacesconfig.interface.accesslist.output.AclList)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:acl-list":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.accesslist.output.AclList

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list=%7Bacl-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.interface.interfacesconfig.interface.Bond

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

If the interface is being used as a slave, this node contains the corresponding bond ID and slave options.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Bond

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:bond"

	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-interface:bond":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Bond

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

If the interface is being used as a slave, this node contains the corresponding bond ID and slave options.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Bond to be added to list

instance
integer <int64>

Bond unique identifier.

passive
boolean
Default: false

The slave interface does not initiate the LACP protocol, remote must be active speaker.

long-timeout
boolean
Default: false

90 seconds VS default 3 seconds neighbor timeout.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "instance": 0,
  • "passive": false,
  • "long-timeout": false
}

creates or updates netgate.interface.interfacesconfig.interface.Bond

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

If the interface is being used as a slave, this node contains the corresponding bond ID and slave options.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Bond to be added or updated

netgate-interface:bond
object (netgate.interface.interfacesconfig.interface.Bond)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:bond":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Bond

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bond

If the interface is being used as a slave, this node contains the corresponding bond ID and slave options.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:bond"

	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.interface.interfacesconfig.interface.Bridge

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

If the interface is being used as a bridge, this node contains the corresponding Bridge Domain Id, Split Horizon, and/or Bridge Virtual Id information.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Bridge

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:bridge"

	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-interface:bridge":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Bridge

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

If the interface is being used as a bridge, this node contains the corresponding Bridge Domain Id, Split Horizon, and/or Bridge Virtual Id information.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Bridge to be added to list

shg
integer <int32>

Split Horizon Group.

bvi
boolean

Set up the interface as a BVI.

bdi
integer <int64>

Bridge Domain Id.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "shg": 0,
  • "bvi": true,
  • "bdi": 0
}

creates or updates netgate.interface.interfacesconfig.interface.Bridge

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

If the interface is being used as a bridge, this node contains the corresponding Bridge Domain Id, Split Horizon, and/or Bridge Virtual Id information.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Bridge to be added or updated

netgate-interface:bridge
object (netgate.interface.interfacesconfig.interface.Bridge)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:bridge":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Bridge

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:bridge

If the interface is being used as a bridge, this node contains the corresponding Bridge Domain Id, Split Horizon, and/or Bridge Virtual Id information.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:bridge"

	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.interface.interfacesconfig.interface.DhcpClient

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

If the interface is configured using a DHCP client, that configuration is contained here.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.DhcpClient

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:dhcp-client"

	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-interface:dhcp-client":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.DhcpClient

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

If the interface is configured using a DHCP client, that configuration is contained here.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.DhcpClient to be added to list

hostname
string

An optional hostname to use.

enable
boolean
Default: false

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "hostname": "string",
  • "enable": false
}

creates or updates netgate.interface.interfacesconfig.interface.DhcpClient

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

If the interface is configured using a DHCP client, that configuration is contained here.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.DhcpClient to be added or updated

netgate-interface:dhcp-client
object (netgate.interface.interfacesconfig.interface.DhcpClient)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:dhcp-client":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.DhcpClient

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:dhcp-client

If the interface is configured using a DHCP client, that configuration is contained here.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:dhcp-client"

	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.interface.interfacesconfig.interface.Ipv4

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Parameters for the IPv4 address family.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Ipv4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface: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-interface:ipv4":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Ipv4

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Parameters for the IPv4 address family.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Ipv4 to be added to list

route-table-name
string

If present, this is the name of the IPv4 Route Table to which this interface is bound. If not present, the IF uses the Default Route Table.

address
object (netgate.interface.interfacesconfig.interface.ipv4.Address)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "route-table-name": "string",
  • "address":
    {
    }
}

creates or updates netgate.interface.interfacesconfig.interface.Ipv4

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Parameters for the IPv4 address family.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Ipv4 to be added or updated

netgate-interface:ipv4
object (netgate.interface.interfacesconfig.interface.Ipv4)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:ipv4":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Ipv4

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4

Parameters for the IPv4 address family.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface: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.interface.interfacesconfig.interface.ipv4.Address

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

returns netgate.interface.interfacesconfig.interface.ipv4.Address

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.ipv4.Address

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv4/netgate-interface:address"

	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-interface:address":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.ipv4.Address

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

creates netgate.interface.interfacesconfig.interface.ipv4.Address

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.ipv4.Address to be added to list

ip
Array of strings

An IPv4 address on the interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ip":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.interface.ipv4.Address

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

creates or updates netgate.interface.interfacesconfig.interface.ipv4.Address

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.ipv4.Address to be added or updated

netgate-interface:address
object (netgate.interface.interfacesconfig.interface.ipv4.Address)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:address":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.ipv4.Address

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

removes netgate.interface.interfacesconfig.interface.ipv4.Address

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv4/netgate-interface:address"

	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.interface.interfacesconfig.interface.Ipv6

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Parameters for the IPv6 address family.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Ipv6

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface: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-interface:ipv6":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Ipv6

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Parameters for the IPv6 address family.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Ipv6 to be added to list

route-table-name
string

If present, this is the name of the IPv6 Route Table to which this interface is bound. If not present, the IF uses the Default Route Table.

address
object (netgate.interface.interfacesconfig.interface.ipv6.Address)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "route-table-name": "string",
  • "address":
    {
    }
}

creates or updates netgate.interface.interfacesconfig.interface.Ipv6

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Parameters for the IPv6 address family.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Ipv6 to be added or updated

netgate-interface:ipv6
object (netgate.interface.interfacesconfig.interface.Ipv6)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:ipv6":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Ipv6

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6

Parameters for the IPv6 address family.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface: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.interface.interfacesconfig.interface.ipv6.Address

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

returns netgate.interface.interfacesconfig.interface.ipv6.Address

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.ipv6.Address

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv6/netgate-interface:address"

	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-interface:address":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.ipv6.Address

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

creates netgate.interface.interfacesconfig.interface.ipv6.Address

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.ipv6.Address to be added to list

ip
Array of strings

An IPv6 address on the interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "ip":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.interface.ipv6.Address

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

creates or updates netgate.interface.interfacesconfig.interface.ipv6.Address

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.ipv6.Address to be added or updated

netgate-interface:address
object (netgate.interface.interfacesconfig.interface.ipv6.Address)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:address":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.ipv6.Address

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

removes netgate.interface.interfacesconfig.interface.ipv6.Address

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv6/netgate-interface:address"

	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.interface.interfacesconfig.interface.Lldp

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

returns netgate.interface.interfacesconfig.interface.Lldp

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Lldp

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:lldp"

	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-interface:lldp":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Lldp

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

creates netgate.interface.interfacesconfig.interface.Lldp

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Lldp to be added to list

management
object (netgate.interface.interfacesconfig.interface.lldp.Management)
port-name
string

Port name used in LLDP packet.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "management":
    {
    },
  • "port-name": "string"
}

creates or updates netgate.interface.interfacesconfig.interface.Lldp

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

creates or updates netgate.interface.interfacesconfig.interface.Lldp

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Lldp to be added or updated

netgate-interface:lldp
object (netgate.interface.interfacesconfig.interface.Lldp)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:lldp":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Lldp

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp

removes netgate.interface.interfacesconfig.interface.Lldp

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:lldp"

	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.interface.interfacesconfig.interface.lldp.Management

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

returns netgate.interface.interfacesconfig.interface.lldp.Management

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.lldp.Management

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:lldp/netgate-interface:management"

	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-interface:management":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.lldp.Management

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

creates netgate.interface.interfacesconfig.interface.lldp.Management

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.lldp.Management to be added to list

oid
string

Management object ID.

ipv4-address
string

IPv4 management address.

ipv6-address
string

IPv6 management address.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "oid": "string",
  • "ipv4-address": "string",
  • "ipv6-address": "string"
}

creates or updates netgate.interface.interfacesconfig.interface.lldp.Management

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

creates or updates netgate.interface.interfacesconfig.interface.lldp.Management

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.lldp.Management to be added or updated

netgate-interface:management
object (netgate.interface.interfacesconfig.interface.lldp.Management)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:management":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.lldp.Management

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:lldp/netgate-interface:management

removes netgate.interface.interfacesconfig.interface.lldp.Management

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:lldp/netgate-interface:management"

	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.interface.interfacesconfig.interface.Map

get /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Per-interface parameters for MAP-E and MAP-T.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesconfig.interface.Map

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:map"

	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-interface:map":
    {
    }
}

creates netgate.interface.interfacesconfig.interface.Map

post /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Per-interface parameters for MAP-E and MAP-T.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Map to be added to list

is-translation
boolean

If true, this interface is performing MAP-T translations. If false, this interface is performing encapsuations. Valid only when also enabled.

enabled
boolean

If true, MAP-E encapsulation or MAP-T translations are enabled on this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "is-translation": true,
  • "enabled": true
}

creates or updates netgate.interface.interfacesconfig.interface.Map

put /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Per-interface parameters for MAP-E and MAP-T.

path Parameters
name
required
string

Id of interface

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.interface.Map to be added or updated

netgate-interface:map
object (netgate.interface.interfacesconfig.interface.Map)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:map":
    {
    }
}

removes netgate.interface.interfacesconfig.interface.Map

delete /data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:interface={name}/netgate-interface:map

Per-interface parameters for MAP-E and MAP-T.

path Parameters
name
required
string

Id of interface

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-interface:interfaces-config/netgate-interface:interface=%7Bname%7D/netgate-interface:map"

	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.interface.interfacesconfig.LoopbackTable

get /data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Loopback name table.

Responses

200

netgate.interface.interfacesconfig.LoopbackTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-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-interface:loopback-table":
    {
    }
}

creates netgate.interface.interfacesconfig.LoopbackTable

post /data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Loopback name table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.LoopbackTable to be added to list

loopback
Array of objects (netgate.interface.interfacesconfig.loopbacktable.Loopback)

Loopback name.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "loopback":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.LoopbackTable

put /data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Loopback name table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.LoopbackTable to be added or updated

netgate-interface:loopback-table
object (netgate.interface.interfacesconfig.LoopbackTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.LoopbackTable

delete /data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table

Loopback name 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-interface:interfaces-config/netgate-interface:loopback-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.interface.interfacesconfig.loopbacktable.Loopback

post /data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback

Loopback name.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.loopbacktable.Loopback to be added to list

name
string

The identifier. A unique name for this Loopback entry.

mac-address
string

The MAC address for the interface.

description
string

A user description of the Loopback.

instance
integer <int32>

Each Loopback creates an interface. The interface will be named 'loopback', where the is the instance number. The instance number must be unique across all Loopback interfaces.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "mac-address": "string",
  • "description": "string",
  • "instance": 0
}

returns netgate.interface.interfacesconfig.loopbacktable.Loopback

get /data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Loopback name.

path Parameters
name
required
string

Id of loopback

Responses

200

netgate.interface.interfacesconfig.loopbacktable.Loopback

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback=%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-interface:loopback":
    {
    }
}

creates netgate.interface.interfacesconfig.loopbacktable.Loopback

post /data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Loopback name.

path Parameters
name
required
string

Id of loopback

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.loopbacktable.Loopback to be added to list

name
string

The identifier. A unique name for this Loopback entry.

mac-address
string

The MAC address for the interface.

description
string

A user description of the Loopback.

instance
integer <int32>

Each Loopback creates an interface. The interface will be named 'loopback', where the is the instance number. The instance number must be unique across all Loopback interfaces.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "mac-address": "string",
  • "description": "string",
  • "instance": 0
}

creates or updates netgate.interface.interfacesconfig.loopbacktable.Loopback

put /data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Loopback name.

path Parameters
name
required
string

Id of loopback

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.loopbacktable.Loopback to be added or updated

netgate-interface:loopback
object (netgate.interface.interfacesconfig.loopbacktable.Loopback)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:loopback":
    {
    }
}

removes netgate.interface.interfacesconfig.loopbacktable.Loopback

delete /data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback={name}

Loopback name.

path Parameters
name
required
string

Id of loopback

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-interface:interfaces-config/netgate-interface:loopback-table/netgate-interface:loopback=%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.interface.interfacesconfig.MemifTable

get /data/netgate-interface:interfaces-config/netgate-interface:memif-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table

Host memif interface configuration table.

Responses

200

netgate.interface.interfacesconfig.MemifTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-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-interface:memif-table":
    {
    }
}

creates netgate.interface.interfacesconfig.MemifTable

post /data/netgate-interface:interfaces-config/netgate-interface:memif-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table

Host memif interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.MemifTable to be added to list

memif-entry
Array of objects (netgate.interface.interfacesconfig.memiftable.MemifEntry)

A unique 32-bit integer identifying this interface.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.interface.interfacesconfig.MemifTable

put /data/netgate-interface:interfaces-config/netgate-interface:memif-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table

Host memif interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.MemifTable to be added or updated

netgate-interface:memif-table
object (netgate.interface.interfacesconfig.MemifTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.MemifTable

delete /data/netgate-interface:interfaces-config/netgate-interface:memif-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table

Host memif 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-interface:interfaces-config/netgate-interface:memif-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.interface.interfacesconfig.memiftable.MemifEntry

post /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry

A unique 32-bit integer identifying this interface.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.memiftable.MemifEntry to be added to list

slave
object (netgate.interface.interfacesconfig.memiftable.memifentry.Slave)
mode
string

Should be 'ethernet', 'IP' or 'punt/inject'.

socket-id
integer <int64>

The socket-id of the socket filename to use in establishing a connection.

mac-address
string

The MAC address for the interface.

buffer-size
integer <int64>

The size of the buffer allocated for each ring entry. Default 2048.

memif-id
integer <int64>

This is the user assigned id of the memif interface.

secret
string

The secret is used to match and authenticate the other end of the connection.

ring-size
integer <int32>

The number of entries in the rx/tx rings. The number of entries must be a power of 2 This number is that power of 2, between 8 and 32. The default is 10, for 1024 entries.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "slave":
    {
    },
  • "mode": "string",
  • "socket-id": 0,
  • "mac-address": "string",
  • "buffer-size": 0,
  • "memif-id": 0,
  • "secret": "string",
  • "ring-size": 0
}

returns netgate.interface.interfacesconfig.memiftable.MemifEntry

get /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

A unique 32-bit integer identifying this interface.

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Responses

200

netgate.interface.interfacesconfig.memiftable.MemifEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry=%7Bmemif-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-interface:memif-entry":
    {
    }
}

creates netgate.interface.interfacesconfig.memiftable.MemifEntry

post /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

A unique 32-bit integer identifying this interface.

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.memiftable.MemifEntry to be added to list

slave
object (netgate.interface.interfacesconfig.memiftable.memifentry.Slave)
mode
string

Should be 'ethernet', 'IP' or 'punt/inject'.

socket-id
integer <int64>

The socket-id of the socket filename to use in establishing a connection.

mac-address
string

The MAC address for the interface.

buffer-size
integer <int64>

The size of the buffer allocated for each ring entry. Default 2048.

memif-id
integer <int64>

This is the user assigned id of the memif interface.

secret
string

The secret is used to match and authenticate the other end of the connection.

ring-size
integer <int32>

The number of entries in the rx/tx rings. The number of entries must be a power of 2 This number is that power of 2, between 8 and 32. The default is 10, for 1024 entries.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "slave":
    {
    },
  • "mode": "string",
  • "socket-id": 0,
  • "mac-address": "string",
  • "buffer-size": 0,
  • "memif-id": 0,
  • "secret": "string",
  • "ring-size": 0
}

creates or updates netgate.interface.interfacesconfig.memiftable.MemifEntry

put /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

A unique 32-bit integer identifying this interface.

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.memiftable.MemifEntry to be added or updated

netgate-interface:memif-entry
object (netgate.interface.interfacesconfig.memiftable.MemifEntry)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.memiftable.MemifEntry

delete /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

A unique 32-bit integer identifying this interface.

path Parameters
memif-id
required
integer <int64>

Id of memif-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-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry=%7Bmemif-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))

}

returns netgate.interface.interfacesconfig.memiftable.memifentry.Slave

get /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

returns netgate.interface.interfacesconfig.memiftable.memifentry.Slave

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Responses

200

netgate.interface.interfacesconfig.memiftable.memifentry.Slave

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry=%7Bmemif-id%7D/netgate-interface:slave"

	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-interface:slave":
    {
    }
}

creates netgate.interface.interfacesconfig.memiftable.memifentry.Slave

post /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

creates netgate.interface.interfacesconfig.memiftable.memifentry.Slave

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.memiftable.memifentry.Slave to be added to list

tx-queues
integer <int32>

The number of slave tx queues.

rx-queues
integer <int32>

The number of slave rx queues.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "tx-queues": 0,
  • "rx-queues": 0
}

creates or updates netgate.interface.interfacesconfig.memiftable.memifentry.Slave

put /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

creates or updates netgate.interface.interfacesconfig.memiftable.memifentry.Slave

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.memiftable.memifentry.Slave to be added or updated

netgate-interface:slave
object (netgate.interface.interfacesconfig.memiftable.memifentry.Slave)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:slave":
    {
    }
}

removes netgate.interface.interfacesconfig.memiftable.memifentry.Slave

delete /data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}/netgate-interface:slave

removes netgate.interface.interfacesconfig.memiftable.memifentry.Slave

path Parameters
memif-id
required
integer <int64>

Id of memif-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-interface:interfaces-config/netgate-interface:memif-table/netgate-interface:memif-entry=%7Bmemif-id%7D/netgate-interface:slave"

	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.interface.interfacesconfig.SocketTable

get /data/netgate-interface:interfaces-config/netgate-interface:socket-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table

Host memif socket table.

Responses

200

netgate.interface.interfacesconfig.SocketTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-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-interface:socket-table":
    {
    }
}

creates netgate.interface.interfacesconfig.SocketTable

post /data/netgate-interface:interfaces-config/netgate-interface:socket-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table

Host memif socket table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.SocketTable to be added to list

socket
Array of objects (netgate.interface.interfacesconfig.sockettable.Socket)

A unique 32-bit integer identifying this socket filename.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "socket":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.SocketTable

put /data/netgate-interface:interfaces-config/netgate-interface:socket-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table

Host memif socket table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.SocketTable to be added or updated

netgate-interface:socket-table
object (netgate.interface.interfacesconfig.SocketTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.SocketTable

delete /data/netgate-interface:interfaces-config/netgate-interface:socket-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table

Host memif socket 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-interface:interfaces-config/netgate-interface:socket-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.interface.interfacesconfig.sockettable.Socket

post /data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket

A unique 32-bit integer identifying this socket filename.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.sockettable.Socket to be added to list

filename
string

The path to a socket file used for establishing memif connections. A socket can be used for either master or slave interfaces, but not both. A socket can have more than one master using it, or it can have more than one slave using it.

id
integer <int64>

This is the user assigned id of the socket filename.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "filename": "string",
  • "id": 0
}

returns netgate.interface.interfacesconfig.sockettable.Socket

get /data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

A unique 32-bit integer identifying this socket filename.

path Parameters
id
required
integer <int64>

Id of socket

Responses

200

netgate.interface.interfacesconfig.sockettable.Socket

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket=%7Bid%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-interface:socket":
    {
    }
}

creates netgate.interface.interfacesconfig.sockettable.Socket

post /data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

A unique 32-bit integer identifying this socket filename.

path Parameters
id
required
integer <int64>

Id of socket

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.sockettable.Socket to be added to list

filename
string

The path to a socket file used for establishing memif connections. A socket can be used for either master or slave interfaces, but not both. A socket can have more than one master using it, or it can have more than one slave using it.

id
integer <int64>

This is the user assigned id of the socket filename.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "filename": "string",
  • "id": 0
}

creates or updates netgate.interface.interfacesconfig.sockettable.Socket

put /data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

A unique 32-bit integer identifying this socket filename.

path Parameters
id
required
integer <int64>

Id of socket

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.sockettable.Socket to be added or updated

netgate-interface:socket
object (netgate.interface.interfacesconfig.sockettable.Socket)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:socket":
    {
    }
}

removes netgate.interface.interfacesconfig.sockettable.Socket

delete /data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket={id}

A unique 32-bit integer identifying this socket filename.

path Parameters
id
required
integer <int64>

Id of socket

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-interface:interfaces-config/netgate-interface:socket-table/netgate-interface:socket=%7Bid%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.interface.interfacesconfig.Subinterfaces

get /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

An interface may have subinterfaces.

Responses

200

netgate.interface.interfacesconfig.Subinterfaces

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces"

	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-interface:subinterfaces":
    {
    }
}

creates netgate.interface.interfacesconfig.Subinterfaces

post /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

An interface may have subinterfaces.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.Subinterfaces to be added to list

subif-entry
Array of objects (netgate.interface.interfacesconfig.subinterfaces.SubifEntry)

Each subinterface entry represents a VLAN.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.interface.interfacesconfig.Subinterfaces

put /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

An interface may have subinterfaces.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.Subinterfaces to be added or updated

netgate-interface:subinterfaces
object (netgate.interface.interfacesconfig.Subinterfaces)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:subinterfaces":
    {
    }
}

removes netgate.interface.interfacesconfig.Subinterfaces

delete /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces

An interface may have subinterfaces.

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-interface:interfaces-config/netgate-interface:subinterfaces"

	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.interface.interfacesconfig.subinterfaces.SubifEntry

post /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry

Each subinterface entry represents a VLAN.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.SubifEntry to be added to list

subid
integer <int64>

The subinterface id. It is often also the (outer) VLAN tag value, though they can be different.

if-name
string

The interface on which this subinterface exists.

vlan
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan)
vlan-tag-rewrite
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "subid": 0,
  • "if-name": "string",
  • "vlan":
    {
    },
  • "vlan-tag-rewrite":
    {
    }
}

returns netgate.interface.interfacesconfig.subinterfaces.SubifEntry

get /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Each subinterface entry represents a VLAN.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Responses

200

netgate.interface.interfacesconfig.subinterfaces.SubifEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%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-interface:subif-entry":
    {
    }
}

creates netgate.interface.interfacesconfig.subinterfaces.SubifEntry

post /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Each subinterface entry represents a VLAN.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.SubifEntry to be added to list

subid
integer <int64>

The subinterface id. It is often also the (outer) VLAN tag value, though they can be different.

if-name
string

The interface on which this subinterface exists.

vlan
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan)
vlan-tag-rewrite
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "subid": 0,
  • "if-name": "string",
  • "vlan":
    {
    },
  • "vlan-tag-rewrite":
    {
    }
}

creates or updates netgate.interface.interfacesconfig.subinterfaces.SubifEntry

put /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Each subinterface entry represents a VLAN.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.SubifEntry to be added or updated

netgate-interface:subif-entry
object (netgate.interface.interfacesconfig.subinterfaces.SubifEntry)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.subinterfaces.SubifEntry

delete /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}

Each subinterface entry represents a VLAN.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-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-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%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.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

get /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

returns netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Responses

200

netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%7D/netgate-interface:vlan-tag-rewrite"

	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-interface:vlan-tag-rewrite":
    {
    }
}

creates netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

post /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

creates netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite to be added to list

push-dot1q
boolean

If true the first pushed tag is of type dot1q, otherwise it will be of type dot1ad.

tag1
integer <int64>

The first pushed tag value.

operation
string (netgate.interface.IntfTagRewriteOp)
Enum: "disable" "pop-1" "pop-2" "push-1" "push-2" "translate-1-1" "translate-1-2" "translate-2-1" "translate-2-2"
tag2
integer <int64>

The second pushed tag value.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "push-dot1q": true,
  • "tag1": 0,
  • "operation": "disable",
  • "tag2": 0
}

creates or updates netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

put /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

creates or updates netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite to be added or updated

netgate-interface:vlan-tag-rewrite
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:vlan-tag-rewrite":
    {
    }
}

removes netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

delete /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan-tag-rewrite

removes netgate.interface.interfacesconfig.subinterfaces.subifentry.VlanTagRewrite

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-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-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%7D/netgate-interface:vlan-tag-rewrite"

	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.interface.interfacesconfig.subinterfaces.subifentry.Vlan

get /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

These fields all contribute to the subinterface definition for VLAN handling.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Responses

200

netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%7D/netgate-interface:vlan"

	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-interface:vlan":
    {
    }
}

creates netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan

post /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

These fields all contribute to the subinterface definition for VLAN handling.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan to be added to list

exact-match
boolean

By default matching is non-exact. If this value is true, matching is exact.

default-subif
boolean

The default subinterface is associated with a packet that did not match any other configured subinterface on this interface.

inner-vlan-id
string

The inner vlan tag id. It can be an integer between 1 and 4095 inclusive, or the word 'any'.

dot1ad
boolean

By default the outer tag is dot1q. If this value is true, it is instead dot1ad.

outer-vlan-id
string

The outer vlan tag id. It can be an integer between 1 and 4095 inclusive, or the word 'any'.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "exact-match": true,
  • "default-subif": true,
  • "inner-vlan-id": "string",
  • "dot1ad": true,
  • "outer-vlan-id": "string"
}

creates or updates netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan

put /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

These fields all contribute to the subinterface definition for VLAN handling.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-entry

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan to be added or updated

netgate-interface:vlan
object (netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:vlan":
    {
    }
}

removes netgate.interface.interfacesconfig.subinterfaces.subifentry.Vlan

delete /data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry={if-name},{subid}/netgate-interface:vlan

These fields all contribute to the subinterface definition for VLAN handling.

path Parameters
if-name
required
string

Id of subif-entry

subid
required
integer <int64>

Id of subif-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-interface:interfaces-config/netgate-interface:subinterfaces/netgate-interface:subif-entry=%7Bif-name%7D,%7Bsubid%7D/netgate-interface:vlan"

	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.interface.interfacesconfig.TapTable

get /data/netgate-interface:interfaces-config/netgate-interface:tap-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table

Host Tap interface configuration table.

Responses

200

netgate.interface.interfacesconfig.TapTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-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-interface:tap-table":
    {
    }
}

creates netgate.interface.interfacesconfig.TapTable

post /data/netgate-interface:interfaces-config/netgate-interface:tap-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table

Host Tap interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.TapTable to be added to list

tap
Array of objects (netgate.interface.interfacesconfig.taptable.Tap)

Unique identifing host tap name.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "tap":
    [
    ]
}

creates or updates netgate.interface.interfacesconfig.TapTable

put /data/netgate-interface:interfaces-config/netgate-interface:tap-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table

Host Tap interface configuration table.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.TapTable to be added or updated

netgate-interface:tap-table
object (netgate.interface.interfacesconfig.TapTable)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.interface.interfacesconfig.TapTable

delete /data/netgate-interface:interfaces-config/netgate-interface:tap-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table

Host Tap 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-interface:interfaces-config/netgate-interface:tap-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.interface.interfacesconfig.taptable.Tap

post /data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap

Unique identifing host tap name.

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.taptable.Tap to be added to list

mac-address
string

The MAC address of the interface.

instance
integer <int64>

The tap instance number.

tx-ring-size
integer <int32>

A power of 2 between 0 and 15 inclusive yielding a transmit ring size 32 to 32768 entries. The default is 8 (256 entries).

host-mac-address
string

The MAC address of the host tap interface.

host-name
string

The name of the tap on the host system.

host-namespace
string

The host namespace in which the tap will be made.

host-ipv6-prefix
string

The IPv6 prefix on the interface.

host-ipv4-gateway
string

The IPv4 gateway address on the interface.

host-ipv4-prefix
string

The IPv4 prefix on the interface.

rx-ring-size
integer <int32>

A power of 2 between 0 and 15 inclusive yielding a receive ring size 32 to 32768 entries. The default is 8 (256 entries).

host-ipv6-gateway
string

The IPv6 gateway address on the interface.

host-bridge
string

The host bridge to which the tap will be attached.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "instance": 0,
  • "tx-ring-size": 0,
  • "host-mac-address": "string",
  • "host-name": "string",
  • "host-namespace": "string",
  • "host-ipv6-prefix": "string",
  • "host-ipv4-gateway": "string",
  • "host-ipv4-prefix": "string",
  • "rx-ring-size": 0,
  • "host-ipv6-gateway": "string",
  • "host-bridge": "string"
}

returns netgate.interface.interfacesconfig.taptable.Tap

get /data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Unique identifing host tap name.

path Parameters
host-name
required
string

Id of tap

Responses

200

netgate.interface.interfacesconfig.taptable.Tap

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap=%7Bhost-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-interface:tap":
    {
    }
}

creates netgate.interface.interfacesconfig.taptable.Tap

post /data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Unique identifing host tap name.

path Parameters
host-name
required
string

Id of tap

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.taptable.Tap to be added to list

mac-address
string

The MAC address of the interface.

instance
integer <int64>

The tap instance number.

tx-ring-size
integer <int32>

A power of 2 between 0 and 15 inclusive yielding a transmit ring size 32 to 32768 entries. The default is 8 (256 entries).

host-mac-address
string

The MAC address of the host tap interface.

host-name
string

The name of the tap on the host system.

host-namespace
string

The host namespace in which the tap will be made.

host-ipv6-prefix
string

The IPv6 prefix on the interface.

host-ipv4-gateway
string

The IPv4 gateway address on the interface.

host-ipv4-prefix
string

The IPv4 prefix on the interface.

rx-ring-size
integer <int32>

A power of 2 between 0 and 15 inclusive yielding a receive ring size 32 to 32768 entries. The default is 8 (256 entries).

host-ipv6-gateway
string

The IPv6 gateway address on the interface.

host-bridge
string

The host bridge to which the tap will be attached.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "mac-address": "string",
  • "instance": 0,
  • "tx-ring-size": 0,
  • "host-mac-address": "string",
  • "host-name": "string",
  • "host-namespace": "string",
  • "host-ipv6-prefix": "string",
  • "host-ipv4-gateway": "string",
  • "host-ipv4-prefix": "string",
  • "rx-ring-size": 0,
  • "host-ipv6-gateway": "string",
  • "host-bridge": "string"
}

creates or updates netgate.interface.interfacesconfig.taptable.Tap

put /data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Unique identifing host tap name.

path Parameters
host-name
required
string

Id of tap

Request Body schema: application/yang-data+json

netgate.interface.interfacesconfig.taptable.Tap to be added or updated

netgate-interface:tap
object (netgate.interface.interfacesconfig.taptable.Tap)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-interface:tap":
    {
    }
}

removes netgate.interface.interfacesconfig.taptable.Tap

delete /data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap={host-name}

Unique identifing host tap name.

path Parameters
host-name
required
string

Id of tap

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-interface:interfaces-config/netgate-interface:tap-table/netgate-interface:tap=%7Bhost-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))

}

interfaces-state

returns netgate.interface.InterfacesState

get /data/netgate-interface:interfaces-state

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state

Interface state information.

Responses

200

netgate.interface.InterfacesState

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.interface.interfacesstate.BondTable

get /data/netgate-interface:interfaces-state/netgate-interface:bond-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table

Bond interface state table.

Responses

200

netgate.interface.interfacesstate.BondTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-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-interface:bond-table":
    {
    }
}

returns netgate.interface.interfacesstate.bondtable.Bond

get /data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}

Bond interface.

path Parameters
instance
required
integer <int64>

Id of bond

Responses

200

netgate.interface.interfacesstate.bondtable.Bond

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond=%7Binstance%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-interface:bond":
    {
    }
}

returns netgate.interface.interfacesstate.bondtable.bond.SlaveIfTable

get /data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}/netgate-interface:slave-if-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}/netgate-interface:slave-if-table

The list of slave interfaces.

path Parameters
instance
required
integer <int64>

Id of bond

Responses

200

netgate.interface.interfacesstate.bondtable.bond.SlaveIfTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond=%7Binstance%7D/netgate-interface:slave-if-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-interface:slave-if-table":
    {
    }
}

returns netgate.interface.interfacesstate.bondtable.bond.slaveiftable.SlaveIf

get /data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}/netgate-interface:slave-if-table/netgate-interface:slave-if={if-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond={instance}/netgate-interface:slave-if-table/netgate-interface:slave-if={if-name}

Slave interface.

path Parameters
instance
required
integer <int64>

Id of bond

if-name
required
string

Id of slave-if

Responses

200

netgate.interface.interfacesstate.bondtable.bond.slaveiftable.SlaveIf

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bond-table/netgate-interface:bond=%7Binstance%7D/netgate-interface:slave-if-table/netgate-interface:slave-if=%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-interface:slave-if":
    {
    }
}

returns netgate.interface.interfacesstate.BridgeTable

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table

Bridge mapping table.

Responses

200

netgate.interface.interfacesstate.BridgeTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-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-interface:bridge-table":
    {
    }
}

returns netgate.interface.interfacesstate.bridgetable.BridgeEntry

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}

Bridge Domain Id.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Responses

200

netgate.interface.interfacesstate.bridgetable.BridgeEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%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-interface:bridge-entry":
    {
    }
}

returns netgate.interface.interfacesstate.bridgetable.bridgeentry.BridgeArpTable

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table

Bridge ARP Entry Table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Responses

200

netgate.interface.interfacesstate.bridgetable.bridgeentry.BridgeArpTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-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-interface:bridge-arp-table":
    {
    }
}

returns netgate.interface.interfacesstate.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-entry={ip-address}

Bridge ARP entry table.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

ip-address
required
string

Id of bridge-arp-entry

Responses

200

netgate.interface.interfacesstate.bridgetable.bridgeentry.bridgearptable.BridgeArpEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:bridge-arp-table/netgate-interface:bridge-arp-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-interface:bridge-arp-entry":
    {
    }
}

returns netgate.interface.interfacesstate.bridgetable.bridgeentry.DomainIfMembers

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:domain-if-members

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:domain-if-members

Bridge Domain Interface Members.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

Responses

200

netgate.interface.interfacesstate.bridgetable.bridgeentry.DomainIfMembers

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:domain-if-members"

	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-interface:domain-if-members":
    {
    }
}

returns netgate.interface.interfacesstate.bridgetable.bridgeentry.domainifmembers.DomainIf

get /data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:domain-if-members/netgate-interface:domain-if={if-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry={bdi}/netgate-interface:domain-if-members/netgate-interface:domain-if={if-name}

Bridge domain interface members.

path Parameters
bdi
required
integer <int64>

Id of bridge-entry

if-name
required
string

Id of domain-if

Responses

200

netgate.interface.interfacesstate.bridgetable.bridgeentry.domainifmembers.DomainIf

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:bridge-table/netgate-interface:bridge-entry=%7Bbdi%7D/netgate-interface:domain-if-members/netgate-interface:domain-if=%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-interface:domain-if":
    {
    }
}

returns netgate.interface.interfacesstate.Interface

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}

The list of interfaces on the device.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.Interface

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.interface.interfacesstate.interface.AccessList

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list

If the interface has any Access Control Lists, they are listed here in two groups: those that apply to packet ingress and those that apply to egresss. The two sets of ACLs are sorted independenty and applied in ascending sequence-number order.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.AccessList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list"

	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-interface:access-list":
    {
    }
}

returns netgate.interface.interfacesstate.interface.accesslist.Input

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input

These are the ACL rule-sets that apply to ingress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.accesslist.Input

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input"

	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-interface:input":
    {
    }
}

returns netgate.interface.interfacesstate.interface.accesslist.input.AclList

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the input list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Responses

200

netgate.interface.interfacesstate.interface.accesslist.input.AclList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:input/netgate-interface:acl-list=%7Bacl-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-interface:acl-list":
    {
    }
}

returns netgate.interface.interfacesstate.interface.accesslist.Macip

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:macip

An interface may also have at most one ACL based upon a combination of MAC address and IP. If that ACL is present, it is always on the ingress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.accesslist.Macip

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:macip"

	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-interface:macip":
    {
    }
}

returns netgate.interface.interfacesstate.interface.accesslist.Output

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output

These are the ACL rule-sets that apply to egress packets.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.accesslist.Output

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output"

	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-interface:output":
    {
    }
}

returns netgate.interface.interfacesstate.interface.accesslist.output.AclList

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list={acl-name}

Each ACL rule-set can appear at most once within the output list.

path Parameters
name
required
string

Id of interface

acl-name
required
string

Id of acl-list

Responses

200

netgate.interface.interfacesstate.interface.accesslist.output.AclList

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:access-list/netgate-interface:output/netgate-interface:acl-list=%7Bacl-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-interface:acl-list":
    {
    }
}

returns netgate.interface.interfacesstate.interface.Bond

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:bond

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:bond

If the interface is being used as a slave, this node contains the corresponding bond interface.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.Bond

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:bond"

	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-interface:bond":
    {
    }
}

returns netgate.interface.interfacesstate.interface.Counters

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:counters

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:counters

Per-interface counters from VPP.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.Counters

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:counters"

	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-interface:counters":
    {
    }
}

returns netgate.interface.interfacesstate.interface.Ipv4

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv4

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv4

IPv4 address family state information.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.Ipv4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface: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-interface:ipv4":
    {
    }
}

returns netgate.interface.interfacesstate.interface.ipv4.Address

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv4/netgate-interface:address

returns netgate.interface.interfacesstate.interface.ipv4.Address

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.ipv4.Address

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv4/netgate-interface:address"

	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-interface:address":
    {
    }
}

returns netgate.interface.interfacesstate.interface.Ipv6

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv6

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv6

IPv6 address family state information.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.Ipv6

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface: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-interface:ipv6":
    {
    }
}

returns netgate.interface.interfacesstate.interface.ipv6.Address

get /data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface={name}/netgate-interface:ipv6/netgate-interface:address

returns netgate.interface.interfacesstate.interface.ipv6.Address

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.ipv6.Address

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:ipv6/netgate-interface:address"

	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-interface:address":
    {
    }
}

returns netgate.interface.interfacesstate.interface.SlaveIfTable

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

Example URL

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

If the interface is a bond interface, this node contains the list of its slave interfaces.

path Parameters
name
required
string

Id of interface

Responses

200

netgate.interface.interfacesstate.interface.SlaveIfTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:slave-if-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-interface:slave-if-table":
    {
    }
}

returns netgate.interface.interfacesstate.interface.slaveiftable.SlaveIf

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

Example URL

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

Slave interface.

path Parameters
name
required
string

Id of interface

if-name
required
string

Id of slave-if

Responses

200

netgate.interface.interfacesstate.interface.slaveiftable.SlaveIf

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:interface=%7Bname%7D/netgate-interface:slave-if-table/netgate-interface:slave-if=%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-interface:slave-if":
    {
    }
}

returns netgate.interface.interfacesstate.LacpTable

get /data/netgate-interface:interfaces-state/netgate-interface:lacp-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table

Link Aggregation Control Protocol (LACP) state table.

Responses

200

netgate.interface.interfacesstate.LacpTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-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-interface:lacp-table":
    {
    }
}

returns netgate.interface.interfacesstate.lacptable.LacpEntry

get /data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}

LACP entry.

path Parameters
slave-if-name
required
string

Id of lacp-entry

Responses

200

netgate.interface.interfacesstate.lacptable.LacpEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry=%7Bslave-if-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-interface:lacp-entry":
    {
    }
}

returns netgate.interface.interfacesstate.lacptable.lacpentry.Actor

get /data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}/netgate-interface:actor

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}/netgate-interface:actor

The actor parameters.

path Parameters
slave-if-name
required
string

Id of lacp-entry

Responses

200

netgate.interface.interfacesstate.lacptable.lacpentry.Actor

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry=%7Bslave-if-name%7D/netgate-interface:actor"

	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-interface:actor":
    {
    }
}

returns netgate.interface.interfacesstate.lacptable.lacpentry.Partner

get /data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}/netgate-interface:partner

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry={slave-if-name}/netgate-interface:partner

The partner parameters.

path Parameters
slave-if-name
required
string

Id of lacp-entry

Responses

200

netgate.interface.interfacesstate.lacptable.lacpentry.Partner

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:lacp-table/netgate-interface:lacp-entry=%7Bslave-if-name%7D/netgate-interface:partner"

	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-interface:partner":
    {
    }
}

returns netgate.interface.interfacesstate.LoopbackTable

get /data/netgate-interface:interfaces-state/netgate-interface:loopback-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:loopback-table

Loopback name table.

Responses

200

netgate.interface.interfacesstate.LoopbackTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:loopback-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-interface:loopback-table":
    {
    }
}

returns netgate.interface.interfacesstate.loopbacktable.Loopback

get /data/netgate-interface:interfaces-state/netgate-interface:loopback-table/netgate-interface:loopback={name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:loopback-table/netgate-interface:loopback={name}

Loopback name.

path Parameters
name
required
string

Id of loopback

Responses

200

netgate.interface.interfacesstate.loopbacktable.Loopback

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:loopback-table/netgate-interface:loopback=%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-interface:loopback":
    {
    }
}

returns netgate.interface.interfacesstate.MemifTable

get /data/netgate-interface:interfaces-state/netgate-interface:memif-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:memif-table

Host memif interface state table.

Responses

200

netgate.interface.interfacesstate.MemifTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:memif-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-interface:memif-table":
    {
    }
}

returns netgate.interface.interfacesstate.memiftable.MemifEntry

get /data/netgate-interface:interfaces-state/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:memif-table/netgate-interface:memif-entry={memif-id}

A unique 32-bit integer identifying this interface.

path Parameters
memif-id
required
integer <int64>

Id of memif-entry

Responses

200

netgate.interface.interfacesstate.memiftable.MemifEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:memif-table/netgate-interface:memif-entry=%7Bmemif-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-interface:memif-entry":
    {
    }
}

returns netgate.interface.interfacesstate.SocketTable

get /data/netgate-interface:interfaces-state/netgate-interface:socket-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:socket-table

Host memif socket table.

Responses

200

netgate.interface.interfacesstate.SocketTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:socket-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-interface:socket-table":
    {
    }
}

returns netgate.interface.interfacesstate.sockettable.Socket

get /data/netgate-interface:interfaces-state/netgate-interface:socket-table/netgate-interface:socket={id}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:socket-table/netgate-interface:socket={id}

A unique 32-bit integer identifying this socket filename.

path Parameters
id
required
integer <int64>

Id of socket

Responses

200

netgate.interface.interfacesstate.sockettable.Socket

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:socket-table/netgate-interface:socket=%7Bid%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-interface:socket":
    {
    }
}

returns netgate.interface.interfacesstate.TapTable

get /data/netgate-interface:interfaces-state/netgate-interface:tap-table

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:tap-table

Host Tap table.

Responses

200

netgate.interface.interfacesstate.TapTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:tap-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-interface:tap-table":
    {
    }
}

returns netgate.interface.interfacesstate.taptable.Tap

get /data/netgate-interface:interfaces-state/netgate-interface:tap-table/netgate-interface:tap={host-name}

Example URL

https://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:tap-table/netgate-interface:tap={host-name}

Unique identifing host tap name.

path Parameters
host-name
required
string

Id of tap

Responses

200

netgate.interface.interfacesstate.taptable.Tap

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-interface:interfaces-state/netgate-interface:tap-table/netgate-interface:tap=%7Bhost-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-interface:tap":
    {
    }
}

clear-interface-counters

creates netgate.interface.ClearInterfaceCounters

post /operations/netgate-interface:clear-interface-counters

Example URL

https://hostname/restconf/operations/netgate-interface:clear-interface-counters

creates netgate.interface.ClearInterfaceCounters

Request Body schema: application/yang-data+json
input
object (netgate.interface.clearinterfacecounters.Input)

Responses

201

No response

400

Internal error

Request samples

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

packet-counters

<no summary>

post /operations/netgate-interface:packet-counters

Example URL

https://hostname/restconf/operations/netgate-interface:packet-counters

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/operations/netgate-interface:packet-counters"

	req, _ := http.NewRequest("POST", 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
{
  • "output":
    {
    }
}