netgate-interface API (23.06)

This YANG module provides a data model for network interfaces.

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

Go
javascript
Python
Shell

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-wrapper":
{
- "netgate-interface:interfaces-config":
  {
  - "vhost-user-interfaces":
    {
    "vhost-user-interface":
    [
    {
    "disable-indirect-desc": false,
    "sock-filename": "string",
    "instance": 0,
    "disable-merge-rx-buf": false,
    "is-server": false,
    "enable-packed-ring": false,
    "enable-event-index": false,
    "enable-gso": false
    }
    ]
    },
  - "wireguard-interfaces":
    {
    "interface":
    [
    {
    "instance": 0,
    "port": 0,
    "private-key":
    {
    "base64": "string"
    },
    "peers":
    {
    "peer":
    [
    {
    "peer-id": 0,
    "keep-alive": 0,
    "route-table": "string",
    "port": 0,
    "endpoint-address": "string",
    "public-key": "string",
    "description": "string",
    "allowed-prefixes":
    {
    "prefix":
    [
    "string"
    ]
    }
    }
    ]
    },
    "description": "string",
    "source-address": "string"
    }
    ]
    },
  - "bond-table":
    {
    "bond":
    [
    {
    "mode": "round-robin",
    "mac-address": "string",
    "load-balance": "l2",
    "instance": 0
    }
    ]
    },
  - "loopback-table":
    {
    "loopback":
    [
    {
    "name": "string",
    "mac-address": "string",
    "description": "string",
    "instance": 0
    }
    ]
    },
  - "bridge-table":
    {
    "bridge-entry":
    [
    {
    "learn": false,
    "forward": false,
    "bdi": 0,
    "mac-age": 0,
    "description": "string",
    "bridge-arp-table":
    {
    "bridge-arp-entry":
    [
    {
    "mac-address": "string",
    "ip-address": "string"
    }
    ]
    },
    "arp-term": false,
    "uu-flood": false,
    "flood": false
    }
    ]
    },
  - "subinterfaces":
    {
    "subif-entry":
    [
    {
    "subid": 0,
    "if-name": "string",
    "vlan":
    {
    "exact-match": false,
    "default-subif": false,
    "inner-vlan-id": "string",
    "dot1ad": false,
    "outer-vlan-id": 0
    }
    }
    ]
    },
  - "tap-table":
    {
    "tap":
    [
    {
    "mac-address": "string",
    "instance": 0,
    "tx-ring-size": 0,
    "host-mac-address": "string",
    "host-name": "string",
    "host-namespace": "host",
    "host-ipv6-prefix": "string",
    "host-ipv4-gateway": "string",
    "host-ipv4-prefix": "string",
    "rx-ring-size": 0,
    "host-ipv6-gateway": "string",
    "host-bridge": "string"
    }
    ]
    },
  - "interface":
    [
    {
    "rx-queues":
    {
    "rx-queue":
    [
    {
    "rx-mode": "string",
    "rx-queue-id": 0,
    "pinned-cpu-id": 0
    }
    ]
    },
    "mac-address": "string",
    "host-tap-name": "string",
    "description": "string",
    "collect-detailed-stats": false,
    "vrf": "string",
    "bond":
    {
    "instance": 0,
    "passive": false,
    "long-timeout": false
    },
    "enabled": false,
    "mtu": 0,
    "rx-mode": "polling",
    "ipv4":
    {
    "vrrp":
    {
    "vrrp-instance":
    [
    {
    "vrid": 0,
    "priority": 100,
    "accept-mode": false,
    "version": "vrrp-v3",
    "preempt":
    {
    "enabled": true
    },
    "virtual-ipv4-addresses":
    {
    "virtual-ipv4-address":
    [
    {
    "ipv4-address": "string"
    }
    ]