netgate-host-interface API (23.02)

This YANG module provides a data model for host interfaces.

host-if-config

returns netgate.host.interface.HostIfConfig

get /data/netgate-host-interface:host-if-config

Example URL

https://hostname/restconf/data/netgate-host-interface:host-if-config

Interface configuration parameters.

Responses

200

netgate.host.interface.HostIfConfig

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-host-interface:host-if-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-host-interface:host-if-config-wrapper":
{
- "netgate-host-interface:host-if-config":
  {
  - "interface":
    [
    {
    "ipv4":
    {
    "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "ipv6":
    {
    "dhcp-client":
    {
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "name": "string",
    "description": "string",
    "enabled": false,
    "mtu": 0
    }
    ]
  }
}

}

creates netgate.host.interface.HostIfConfig

post /data/netgate-host-interface:host-if-config

Example URL

https://hostname/restconf/data/netgate-host-interface:host-if-config

Interface configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.interface.HostIfConfig to be added to list

netgate-host-interface:host-if-config

object (netgate.host.interface.HostIfConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-interface:host-if-config":
{
- "interface":
  [
  - {
    "ipv4":
    {
    "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "ipv6":
    {
    "dhcp-client":
    {
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "name": "string",
    "description": "string",
    "enabled": false,
    "mtu": 0
    }
  ]
}

}

creates or updates netgate.host.interface.HostIfConfig

put /data/netgate-host-interface:host-if-config

Example URL

https://hostname/restconf/data/netgate-host-interface:host-if-config

Interface configuration parameters.

Request Body schema: application/yang-data+json

netgate.host.interface.HostIfConfig to be added or updated

netgate-host-interface:host-if-config-wrapper

object (netgate.host.interface.HostIfConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-interface:host-if-config-wrapper":
{
- "netgate-host-interface:host-if-config":
  {
  - "interface":
    [
    {
    "ipv4":
    {
    "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "ipv6":
    {
    "dhcp-client":
    {
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
    "name": "string",
    "description": "string",
    "enabled": false,
    "mtu": 0
    }
    ]
  }
}

}

removes netgate.host.interface.HostIfConfig

delete /data/netgate-host-interface:host-if-config

Example URL

https://hostname/restconf/data/netgate-host-interface:host-if-config

Interface configuration parameters.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-interface:host-if-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))

}

creates netgate.host.interface.hostifconfig.Interface

post /data/netgate-host-interface:host-if-config/interface

Example URL

https://hostname/restconf/data/netgate-host-interface:host-if-config/interface

The list of configured host interfaces on the device.

Request Body schema: application/yang-data+json

netgate.host.interface.hostifconfig.Interface to be added to list

interface

object (netgate.host.interface.hostifconfig.Interface)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"interface":
{
- "ipv4":
  {
  - "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
  - "address":
    {
    "ip":
    [
    "string"
    ]
    }
  },
- "ipv6":
  {
  - "dhcp-client":
    {
    "enabled": false
    },
  - "address":
    {
    "ip":
    [
    "string"
    ]
    }
  },
- "name": "string",
- "description": "string",
- "enabled": false,
- "mtu": 0
}

}

returns netgate.host.interface.hostifconfig.Interface

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

Example URL

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

The list of configured host interfaces on the device.

path Parameters

name

required

string

Id of interface

Responses

200

netgate.host.interface.hostifconfig.Interface

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-interface:host-if-config/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-host-interface:interface-wrapper":
{
- "interface":
  {
  - "ipv4":
    {
    "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
  - "ipv6":
    {
    "dhcp-client":
    {
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
  - "name": "string",
  - "description": "string",
  - "enabled": false,
  - "mtu": 0
  }
}

}

creates or updates netgate.host.interface.hostifconfig.Interface

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

Example URL

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

The list of configured host interfaces on the device.

path Parameters

name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.host.interface.hostifconfig.Interface to be added or updated

netgate-host-interface:interface-wrapper

object (netgate.host.interface.hostifconfig.InterfaceWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-interface:interface-wrapper":
{
- "interface":
  {
  - "ipv4":
    {
    "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
  - "ipv6":
    {
    "dhcp-client":
    {
    "enabled": false
    },
    "address":
    {
    "ip":
    [
    "string"
    ]
    }
    },
  - "name": "string",
  - "description": "string",
  - "enabled": false,
  - "mtu": 0
  }
}

}

removes netgate.host.interface.hostifconfig.Interface

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

Example URL

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

The list of configured host interfaces on the device.

path Parameters

name

required

string

Id of interface

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-interface:host-if-config/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.host.interface.hostifconfig.interface.Ipv4

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

Example URL

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

Parameters for the IPv4 address family.

path Parameters

name

required

string

Id of interface

Responses

200

netgate.host.interface.hostifconfig.interface.Ipv4

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-host-interface:host-if-config/interface=%7Bname%7D/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-host-interface:ipv4-wrapper":
{
- "ipv4":
  {
  - "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
  - "address":
    {
    "ip":
    [
    "string"
    ]
    }
  }
}

}

creates netgate.host.interface.hostifconfig.interface.Ipv4

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

Example URL

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

Parameters for the IPv4 address family.

path Parameters

name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.host.interface.hostifconfig.interface.Ipv4 to be added to list

ipv4	object (netgate.host.interface.hostifconfig.interface.Ipv4)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"ipv4":
{
- "dhcp-client":
  {
  - "hostname": "string",
  - "enabled": false
  },
- "address":
  {
  - "ip":
    [
    "string"
    ]
  }
}

}

creates or updates netgate.host.interface.hostifconfig.interface.Ipv4

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

Example URL

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

Parameters for the IPv4 address family.

path Parameters

name

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.host.interface.hostifconfig.interface.Ipv4 to be added or updated

netgate-host-interface:ipv4-wrapper

object (netgate.host.interface.hostifconfig.interface.Ipv4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-host-interface:ipv4-wrapper":
{
- "ipv4":
  {
  - "dhcp-client":
    {
    "hostname": "string",
    "enabled": false
    },
  - "address":
    {
    "ip":
    [
    "string"
    ]
    }
  }
}

}

removes netgate.host.interface.hostifconfig.interface.Ipv4

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

Example URL

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

Parameters for the IPv4 address family.

path Parameters

name

required

string

Id of interface

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-host-interface:host-if-config/interface=%7Bname%7D/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.host.interface.hostifconfig.interface.ipv4.addresstype.static.Address

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

Example URL

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

returns netgate.host.interface.hostifconfig.interface.ipv4.addresstype.static.Address

path Parameters

name

required

string

Id of interface

Responses

200

netgate.host.interface.hostifconfig.interface.ipv4.addresstype.static.Address

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

	req, _ := http