netgate-nat API (19.02)

This YANG module provides a Netgate-defined data-model for Network Address Translation data.

dslite-config

returns netgate.nat.DsliteConfig

get /data/netgate-nat:dslite-config

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config

Dual-Stack Lite (DS-Lite) configuration.

Responses

200

netgate.nat.DsliteConfig

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-nat:dslite-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-nat:dslite-config":
{
- "b4":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  },
- "dynamic":
  {
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "first-address": "string",
    "last-address": "string"
    }
    ]
    }
  },
- "aftr":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  }
}

}

creates netgate.nat.DsliteConfig

post /data/netgate-nat:dslite-config

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config

Dual-Stack Lite (DS-Lite) configuration.

Request Body schema: application/yang-data+json

netgate.nat.DsliteConfig to be added to list

b4	object (netgate.nat.dsliteconfig.B4)
dynamic	object (netgate.nat.dsliteconfig.Dynamic)
aftr	object (netgate.nat.dsliteconfig.Aftr)

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

{

"b4":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
},
"dynamic":
{
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "first-address": "string",
    "last-address": "string"
    }
    ]
  }
},
"aftr":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

creates or updates netgate.nat.DsliteConfig

put /data/netgate-nat:dslite-config

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config

Dual-Stack Lite (DS-Lite) configuration.

Request Body schema: application/yang-data+json

netgate.nat.DsliteConfig to be added or updated

netgate-nat:dslite-config

object (netgate.nat.DsliteConfig)

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-nat:dslite-config":
{
- "b4":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  },
- "dynamic":
  {
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "first-address": "string",
    "last-address": "string"
    }
    ]
    }
  },
- "aftr":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  }
}

}

removes netgate.nat.DsliteConfig

delete /data/netgate-nat:dslite-config

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config

Dual-Stack Lite (DS-Lite) configuration.

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-nat:dslite-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.nat.dsliteconfig.Aftr

get /data/netgate-nat:dslite-config/netgate-nat:aftr

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr

Address Family Transition Router (AFTR) configuration.

Responses

200

netgate.nat.dsliteconfig.Aftr

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-nat:dslite-config/netgate-nat:aftr"

	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-nat:aftr":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

creates netgate.nat.dsliteconfig.Aftr

post /data/netgate-nat:dslite-config/netgate-nat:aftr

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr

Address Family Transition Router (AFTR) configuration.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.Aftr to be added to list

endpoint

object (netgate.nat.dsliteconfig.aftr.Endpoint)

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

{

"endpoint":
{
- "ipv6-address": "string"
}

}

creates or updates netgate.nat.dsliteconfig.Aftr

put /data/netgate-nat:dslite-config/netgate-nat:aftr

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr

Address Family Transition Router (AFTR) configuration.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.Aftr to be added or updated

netgate-nat:aftr

object (netgate.nat.dsliteconfig.Aftr)

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-nat:aftr":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

removes netgate.nat.dsliteconfig.Aftr

delete /data/netgate-nat:dslite-config/netgate-nat:aftr

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr

Address Family Transition Router (AFTR) configuration.

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-nat:dslite-config/netgate-nat:aftr"

	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.nat.dsliteconfig.aftr.Endpoint

get /data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Responses

200

netgate.nat.dsliteconfig.aftr.Endpoint

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-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint"

	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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

creates netgate.nat.dsliteconfig.aftr.Endpoint

post /data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.aftr.Endpoint to be added to list

ipv6-address

string

The IPv6 address of the tunnel endpoint.

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

{

"ipv6-address": "string"

}

creates or updates netgate.nat.dsliteconfig.aftr.Endpoint

put /data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.aftr.Endpoint to be added or updated

netgate-nat:endpoint

object (netgate.nat.dsliteconfig.aftr.Endpoint)

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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

removes netgate.nat.dsliteconfig.aftr.Endpoint

delete /data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint

An IPv6 tunnel endpoint.

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-nat:dslite-config/netgate-nat:aftr/netgate-nat:endpoint"

	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.nat.dsliteconfig.B4

get /data/netgate-nat:dslite-config/netgate-nat:b4

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4

Basic Bridging BroadBand (B4) configuration.

Responses

200

netgate.nat.dsliteconfig.B4

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-nat:dslite-config/netgate-nat:b4"

	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-nat:b4":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

creates netgate.nat.dsliteconfig.B4

post /data/netgate-nat:dslite-config/netgate-nat:b4

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4

Basic Bridging BroadBand (B4) configuration.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.B4 to be added to list

endpoint

object (netgate.nat.dsliteconfig.b4.Endpoint)

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

{

"endpoint":
{
- "ipv6-address": "string"
}

}

creates or updates netgate.nat.dsliteconfig.B4

put /data/netgate-nat:dslite-config/netgate-nat:b4

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4

Basic Bridging BroadBand (B4) configuration.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.B4 to be added or updated

netgate-nat:b4

object (netgate.nat.dsliteconfig.B4)

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-nat:b4":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

removes netgate.nat.dsliteconfig.B4

delete /data/netgate-nat:dslite-config/netgate-nat:b4

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4

Basic Bridging BroadBand (B4) configuration.

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-nat:dslite-config/netgate-nat:b4"

	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.nat.dsliteconfig.b4.Endpoint

get /data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Responses

200

netgate.nat.dsliteconfig.b4.Endpoint

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-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint"

	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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

creates netgate.nat.dsliteconfig.b4.Endpoint

post /data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.b4.Endpoint to be added to list

ipv6-address

string

The IPv6 address of the tunnel endpoint.

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

{

"ipv6-address": "string"

}

creates or updates netgate.nat.dsliteconfig.b4.Endpoint

put /data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.b4.Endpoint to be added or updated

netgate-nat:endpoint

object (netgate.nat.dsliteconfig.b4.Endpoint)

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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

removes netgate.nat.dsliteconfig.b4.Endpoint

delete /data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint

An IPv6 tunnel endpoint.

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-nat:dslite-config/netgate-nat:b4/netgate-nat:endpoint"

	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.nat.dsliteconfig.Dynamic

get /data/netgate-nat:dslite-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic

Dynamic mapping information.

Responses

200

netgate.nat.dsliteconfig.Dynamic

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-nat:dslite-config/netgate-nat:dynamic"

	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-nat:dynamic":
{
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "first-address": "string",
    "last-address": "string"
    }
    ]
  }
}

}

creates netgate.nat.dsliteconfig.Dynamic

post /data/netgate-nat:dslite-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.Dynamic to be added to list

pool-table

object (netgate.nat.dsliteconfig.dynamic.PoolTable)

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

{

"pool-table":
{
- "pool-entry":
  [
  - {
    "first-address": "string",
    "last-address": "string"
    }
  ]
}

}

creates or updates netgate.nat.dsliteconfig.Dynamic

put /data/netgate-nat:dslite-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.Dynamic to be added or updated

netgate-nat:dynamic

object (netgate.nat.dsliteconfig.Dynamic)

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-nat:dynamic":
{
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "first-address": "string",
    "last-address": "string"
    }
    ]
  }
}

}

removes netgate.nat.dsliteconfig.Dynamic

delete /data/netgate-nat:dslite-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic

Dynamic mapping information.

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-nat:dslite-config/netgate-nat:dynamic"

	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.nat.dsliteconfig.dynamic.PoolTable

get /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

DS-Lite address pool table.

Responses

200

netgate.nat.dsliteconfig.dynamic.PoolTable

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-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "first-address": "string",
    "last-address": "string"
    }
  ]
}

}

creates netgate.nat.dsliteconfig.dynamic.PoolTable

post /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

DS-Lite address pool table.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.dynamic.PoolTable to be added to list

pool-entry

Array of objects (netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry)

DS-Lite address range entry.

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

{

"pool-entry":
[
- {
  - "first-address": "string",
  - "last-address": "string"
  }
]

}

creates or updates netgate.nat.dsliteconfig.dynamic.PoolTable

put /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

DS-Lite address pool table.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.dynamic.PoolTable to be added or updated

netgate-nat:pool-table

object (netgate.nat.dsliteconfig.dynamic.PoolTable)

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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "first-address": "string",
    "last-address": "string"
    }
  ]
}

}

removes netgate.nat.dsliteconfig.dynamic.PoolTable

delete /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table

DS-Lite address pool table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-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.nat.dsliteconfig.dynamic.pooltable.PoolEntry

post /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry

DS-Lite address range entry.

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry to be added to list

first-address	string The first IPv4 address in the range.
last-address	string The last IPv4 address in the range.

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

{

"first-address": "string",
"last-address": "string"

}

returns netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry

get /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

DS-Lite address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Responses

200

netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry

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-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Bfirst-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-nat:pool-entry":
{
- "first-address": "string",
- "last-address": "string"
}

}

creates netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry

post /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

DS-Lite address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry to be added to list

first-address	string The first IPv4 address in the range.
last-address	string The last IPv4 address in the range.

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

{

"first-address": "string",
"last-address": "string"

}

creates or updates netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry

put /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

DS-Lite address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Request Body schema: application/yang-data+json

netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry to be added or updated

netgate-nat:pool-entry

object (netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry)

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-nat:pool-entry":
{
- "first-address": "string",
- "last-address": "string"
}

}

removes netgate.nat.dsliteconfig.dynamic.pooltable.PoolEntry

delete /data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

DS-Lite address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:dslite-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Bfirst-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))

}

dslite-state

returns netgate.nat.DsliteState

get /data/netgate-nat:dslite-state

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state

Dual-Stack Lite (DS-Lite) state.

Responses

200

netgate.nat.DsliteState

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-nat:dslite-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-nat:dslite-state":
{
- "b4":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  },
- "dynamic":
  {
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "address": "string"
    }
    ]
    }
  },
- "aftr":
  {
  - "endpoint":
    {
    "ipv6-address": "string"
    }
  }
}

}

returns netgate.nat.dslitestate.Aftr

get /data/netgate-nat:dslite-state/netgate-nat:aftr

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:aftr

Address Family Transition Router (AFTR) configuration.

Responses

200

netgate.nat.dslitestate.Aftr

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-nat:dslite-state/netgate-nat:aftr"

	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-nat:aftr":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

returns netgate.nat.dslitestate.aftr.Endpoint

get /data/netgate-nat:dslite-state/netgate-nat:aftr/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:aftr/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Responses

200

netgate.nat.dslitestate.aftr.Endpoint

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-nat:dslite-state/netgate-nat:aftr/netgate-nat:endpoint"

	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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

returns netgate.nat.dslitestate.B4

get /data/netgate-nat:dslite-state/netgate-nat:b4

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:b4

Basic Bridging BroadBand (B4) configuration.

Responses

200

netgate.nat.dslitestate.B4

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-nat:dslite-state/netgate-nat:b4"

	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-nat:b4":
{
- "endpoint":
  {
  - "ipv6-address": "string"
  }
}

}

returns netgate.nat.dslitestate.b4.Endpoint

get /data/netgate-nat:dslite-state/netgate-nat:b4/netgate-nat:endpoint

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:b4/netgate-nat:endpoint

An IPv6 tunnel endpoint.

Responses

200

netgate.nat.dslitestate.b4.Endpoint

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-nat:dslite-state/netgate-nat:b4/netgate-nat:endpoint"

	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-nat:endpoint":
{
- "ipv6-address": "string"
}

}

returns netgate.nat.dslitestate.Dynamic

get /data/netgate-nat:dslite-state/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:dynamic

Dynamic mapping information.

Responses

200

netgate.nat.dslitestate.Dynamic

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-nat:dslite-state/netgate-nat:dynamic"

	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-nat:dynamic":
{
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "address": "string"
    }
    ]
  }
}

}

returns netgate.nat.dslitestate.dynamic.PoolTable

get /data/netgate-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-table

DS-Lite address pool table.

Responses

200

netgate.nat.dslitestate.dynamic.PoolTable

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-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "address": "string"
    }
  ]
}

}

returns netgate.nat.dslitestate.dynamic.pooltable.PoolEntry

get /data/netgate-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={address}

Example URL

https://hostname/restconf/data/netgate-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={address}

DS-Lite address range entry.

path Parameters

address

required

string

Id of pool-entry

Responses

200

netgate.nat.dslitestate.dynamic.pooltable.PoolEntry

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-nat:dslite-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Baddress%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-nat:pool-entry":
{
- "address": "string"
}

}

nat-config

returns netgate.nat.NatConfig

get /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Responses

200

netgate.nat.NatConfig

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-nat:nat-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-nat:nat-config":
{
- "global-options":
  {
  - "nat44":
    {
    "forwarding-enabled": true
    }
  },
- "ipfix":
  {
  - "logging":
    {
    "logging-entry":
    [
    {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
    ]
    }
  },
- "static":
  {
  - "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
    }
  },
- "nat64":
  {
  - "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
    "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
    }
  },
- "deterministic":
  {
  - "det-mapping-table":
    {
    "det-mapping-entry":
    [
    {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
    ]
    }
  },
- "dynamic":
  {
  - "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
    },
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
    ]
    }
  },
- "reassembly":
  {
  - "address-family":
    [
    {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
    ]
  }
}

}

creates netgate.nat.NatConfig

post /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.nat.NatConfig to be added to list

global-options	object (netgate.nat.natconfig.GlobalOptions)
ipfix	object (netgate.nat.natconfig.Ipfix)
static	object (netgate.nat.natconfig.Static)
nat64	object (netgate.nat.natconfig.Nat64)
deterministic	object (netgate.nat.natconfig.Deterministic)
dynamic	object (netgate.nat.natconfig.Dynamic)
reassembly	object (netgate.nat.natconfig.Reassembly)

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

{

"global-options":
{
- "nat44":
  {
  - "forwarding-enabled": true
  }
},
"ipfix":
{
- "logging":
  {
  - "logging-entry":
    [
    {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
    ]
  }
},
"static":
{
- "mapping-table":
  {
  - "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
  }
},
"nat64":
{
- "map":
  {
  - "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
  - "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
  }
},
"deterministic":
{
- "det-mapping-table":
  {
  - "det-mapping-entry":
    [
    {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
    ]
  }
},
"dynamic":
{
- "pool-if-table":
  {
  - "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
  },
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
    ]
  }
},
"reassembly":
{
- "address-family":
  [
  - {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
  ]
}

}

creates or updates netgate.nat.NatConfig

put /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.nat.NatConfig to be added or updated

netgate-nat:nat-config

object (netgate.nat.NatConfig)

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-nat:nat-config":
{
- "global-options":
  {
  - "nat44":
    {
    "forwarding-enabled": true
    }
  },
- "ipfix":
  {
  - "logging":
    {
    "logging-entry":
    [
    {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
    ]
    }
  },
- "static":
  {
  - "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
    }
  },
- "nat64":
  {
  - "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
    "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
    }
  },
- "deterministic":
  {
  - "det-mapping-table":
    {
    "det-mapping-entry":
    [
    {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
    ]
    }
  },
- "dynamic":
  {
  - "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
    },
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
    ]
    }
  },
- "reassembly":
  {
  - "address-family":
    [
    {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
    ]
  }
}

}

removes netgate.nat.NatConfig

delete /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

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-nat:nat-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.nat.natconfig.Deterministic

get /data/netgate-nat:nat-config/netgate-nat:deterministic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic

Deterministic NAT information.

Responses

200

netgate.nat.natconfig.Deterministic

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-nat:nat-config/netgate-nat:deterministic"

	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-nat:deterministic":
{
- "det-mapping-table":
  {
  - "det-mapping-entry":
    [
    {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
    ]
  }
}

}

creates netgate.nat.natconfig.Deterministic

post /data/netgate-nat:nat-config/netgate-nat:deterministic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic

Deterministic NAT information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Deterministic to be added to list

det-mapping-table

object (netgate.nat.natconfig.deterministic.DetMappingTable)

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

{

"det-mapping-table":
{
- "det-mapping-entry":
  [
  - {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
  ]
}

}

creates or updates netgate.nat.natconfig.Deterministic

put /data/netgate-nat:nat-config/netgate-nat:deterministic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic

Deterministic NAT information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Deterministic to be added or updated

netgate-nat:deterministic

object (netgate.nat.natconfig.Deterministic)

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-nat:deterministic":
{
- "det-mapping-table":
  {
  - "det-mapping-entry":
    [
    {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
    ]
  }
}

}

removes netgate.nat.natconfig.Deterministic

delete /data/netgate-nat:nat-config/netgate-nat:deterministic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic

Deterministic NAT information.

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-nat:nat-config/netgate-nat:deterministic"

	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.nat.natconfig.deterministic.DetMappingTable

get /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Deterministic NAT mapping table.

Responses

200

netgate.nat.natconfig.deterministic.DetMappingTable

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-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-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-nat:det-mapping-table":
{
- "det-mapping-entry":
  [
  - {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
  ]
}

}

creates netgate.nat.natconfig.deterministic.DetMappingTable

post /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Deterministic NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.deterministic.DetMappingTable to be added to list

det-mapping-entry

Array of objects (netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry)

Deterministic NAT Mapping Entry.

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

{

"det-mapping-entry":
[
- {
  - "outside-prefix": "string",
  - "inside-prefix": "string"
  }
]

}

creates or updates netgate.nat.natconfig.deterministic.DetMappingTable

put /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Deterministic NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.deterministic.DetMappingTable to be added or updated

netgate-nat:det-mapping-table

object (netgate.nat.natconfig.deterministic.DetMappingTable)

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-nat:det-mapping-table":
{
- "det-mapping-entry":
  [
  - {
    "outside-prefix": "string",
    "inside-prefix": "string"
    }
  ]
}

}

removes netgate.nat.natconfig.deterministic.DetMappingTable

delete /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table

Deterministic NAT mapping table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-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.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

post /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry

Deterministic NAT Mapping Entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry to be added to list

outside-prefix	string The outside address range.
inside-prefix	string The inside network.

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

{

"outside-prefix": "string",
"inside-prefix": "string"

}

returns netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

get /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Deterministic NAT Mapping Entry.

path Parameters

inside-prefix required	string Id of det-mapping-entry
outside-prefix required	string Id of det-mapping-entry

Responses

200

netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

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-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry=%7Binside-prefix%7D,%7Boutside-prefix%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-nat:det-mapping-entry":
{
- "outside-prefix": "string",
- "inside-prefix": "string"
}

}

creates netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

post /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Deterministic NAT Mapping Entry.

path Parameters

inside-prefix required	string Id of det-mapping-entry
outside-prefix required	string Id of det-mapping-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry to be added to list

outside-prefix	string The outside address range.
inside-prefix	string The inside network.

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

{

"outside-prefix": "string",
"inside-prefix": "string"

}

creates or updates netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

put /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Deterministic NAT Mapping Entry.

path Parameters

inside-prefix required	string Id of det-mapping-entry
outside-prefix required	string Id of det-mapping-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry to be added or updated

netgate-nat:det-mapping-entry

object (netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry)

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-nat:det-mapping-entry":
{
- "outside-prefix": "string",
- "inside-prefix": "string"
}

}

removes netgate.nat.natconfig.deterministic.detmappingtable.DetMappingEntry

delete /data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Deterministic NAT Mapping Entry.

path Parameters

inside-prefix required	string Id of det-mapping-entry
outside-prefix required	string Id of det-mapping-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry=%7Binside-prefix%7D,%7Boutside-prefix%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.nat.natconfig.Dynamic

get /data/netgate-nat:nat-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic

Dynamic mapping information.

Responses

200

netgate.nat.natconfig.Dynamic

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-nat:nat-config/netgate-nat:dynamic"

	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-nat:dynamic":
{
- "pool-if-table":
  {
  - "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
  },
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
    ]
  }
}

}

creates netgate.nat.natconfig.Dynamic

post /data/netgate-nat:nat-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Dynamic to be added to list

pool-if-table	object (netgate.nat.natconfig.dynamic.PoolIfTable)
pool-table	object (netgate.nat.natconfig.dynamic.PoolTable)

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

{

"pool-if-table":
{
- "if-entry":
  [
  - {
    "if-name": "string",
    "twice-nat": true
    }
  ]
},
"pool-table":
{
- "pool-entry":
  [
  - {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
  ]
}

}

creates or updates netgate.nat.natconfig.Dynamic

put /data/netgate-nat:nat-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Dynamic to be added or updated

netgate-nat:dynamic

object (netgate.nat.natconfig.Dynamic)

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-nat:dynamic":
{
- "pool-if-table":
  {
  - "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
  },
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
    ]
  }
}

}

removes netgate.nat.natconfig.Dynamic

delete /data/netgate-nat:nat-config/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic

Dynamic mapping information.

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-nat:nat-config/netgate-nat:dynamic"

	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.nat.natconfig.dynamic.PoolIfTable

get /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

NAT interface pool table.

Responses

200

netgate.nat.natconfig.dynamic.PoolIfTable

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-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-if-table":
{
- "if-entry":
  [
  - {
    "if-name": "string",
    "twice-nat": true
    }
  ]
}

}

creates netgate.nat.natconfig.dynamic.PoolIfTable

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

NAT interface pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolIfTable to be added to list

if-entry

Array of objects (netgate.nat.natconfig.dynamic.pooliftable.IfEntry)

Dynamic pool interface entries.

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

{

"if-entry":
[
- {
  - "if-name": "string",
  - "twice-nat": true
  }
]

}

creates or updates netgate.nat.natconfig.dynamic.PoolIfTable

put /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

NAT interface pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolIfTable to be added or updated

netgate-nat:pool-if-table

object (netgate.nat.natconfig.dynamic.PoolIfTable)

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-nat:pool-if-table":
{
- "if-entry":
  [
  - {
    "if-name": "string",
    "twice-nat": true
    }
  ]
}

}

removes netgate.nat.natconfig.dynamic.PoolIfTable

delete /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table

NAT interface pool table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-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.nat.natconfig.dynamic.pooliftable.IfEntry

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry

Dynamic pool interface entries.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooliftable.IfEntry to be added to list

if-name	string The name of an interface whose IPv4 addresses are added to the pool of addresses used in NAT mappings.
twice-nat	boolean Twice-nat address range for external hosts.

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

{

"if-name": "string",
"twice-nat": true

}

returns netgate.nat.natconfig.dynamic.pooliftable.IfEntry

get /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Dynamic pool interface entries.

path Parameters

if-name

required

string

Id of if-entry

Responses

200

netgate.nat.natconfig.dynamic.pooliftable.IfEntry

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-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry=%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-nat:if-entry":
{
- "if-name": "string",
- "twice-nat": true
}

}

creates netgate.nat.natconfig.dynamic.pooliftable.IfEntry

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Dynamic pool interface entries.

path Parameters

if-name

required

string

Id of if-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooliftable.IfEntry to be added to list

if-name	string The name of an interface whose IPv4 addresses are added to the pool of addresses used in NAT mappings.
twice-nat	boolean Twice-nat address range for external hosts.

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

{

"if-name": "string",
"twice-nat": true

}

creates or updates netgate.nat.natconfig.dynamic.pooliftable.IfEntry

put /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Dynamic pool interface entries.

path Parameters

if-name

required

string

Id of if-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooliftable.IfEntry to be added or updated

netgate-nat:if-entry

object (netgate.nat.natconfig.dynamic.pooliftable.IfEntry)

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-nat:if-entry":
{
- "if-name": "string",
- "twice-nat": true
}

}

removes netgate.nat.natconfig.dynamic.pooliftable.IfEntry

delete /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Dynamic pool interface entries.

path Parameters

if-name

required

string

Id of if-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry=%7Bif-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.nat.natconfig.dynamic.PoolTable

get /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

NAT address pool table.

Responses

200

netgate.nat.natconfig.dynamic.PoolTable

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-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
  ]
}

}

creates netgate.nat.natconfig.dynamic.PoolTable

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

NAT address pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolTable to be added to list

pool-entry

Array of objects (netgate.nat.natconfig.dynamic.pooltable.PoolEntry)

NAT address range entry.

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

{

"pool-entry":
[
- {
  - "route-table-name": "string",
  - "first-address": "string",
  - "last-address": "string",
  - "twice-nat": true
  }
]

}

creates or updates netgate.nat.natconfig.dynamic.PoolTable

put /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

NAT address pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolTable to be added or updated

netgate-nat:pool-table

object (netgate.nat.natconfig.dynamic.PoolTable)

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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": true
    }
  ]
}

}

removes netgate.nat.natconfig.dynamic.PoolTable

delete /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table

NAT address pool table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-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.nat.natconfig.dynamic.pooltable.PoolEntry

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry

NAT address range entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooltable.PoolEntry to be added to list

route-table-name	string The route table name.
first-address	string The first IPv4 address in the range.
last-address	string The last IPv4 address in the range.
twice-nat	boolean Twice-nat address range for external hosts.

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

{

"route-table-name": "string",
"first-address": "string",
"last-address": "string",
"twice-nat": true

}

returns netgate.nat.natconfig.dynamic.pooltable.PoolEntry

get /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

NAT address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Responses

200

netgate.nat.natconfig.dynamic.pooltable.PoolEntry

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-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Bfirst-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-nat:pool-entry":
{
- "route-table-name": "string",
- "first-address": "string",
- "last-address": "string",
- "twice-nat": true
}

}

creates netgate.nat.natconfig.dynamic.pooltable.PoolEntry

post /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

NAT address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooltable.PoolEntry to be added to list

route-table-name	string The route table name.
first-address	string The first IPv4 address in the range.
last-address	string The last IPv4 address in the range.
twice-nat	boolean Twice-nat address range for external hosts.

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

{

"route-table-name": "string",
"first-address": "string",
"last-address": "string",
"twice-nat": true

}

creates or updates netgate.nat.natconfig.dynamic.pooltable.PoolEntry

put /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

NAT address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooltable.PoolEntry to be added or updated

netgate-nat:pool-entry

object (netgate.nat.natconfig.dynamic.pooltable.PoolEntry)

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-nat:pool-entry":
{
- "route-table-name": "string",
- "first-address": "string",
- "last-address": "string",
- "twice-nat": true
}

}

removes netgate.nat.natconfig.dynamic.pooltable.PoolEntry

delete /data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={first-address}

NAT address range entry.

path Parameters

first-address

required

string

Id of pool-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Bfirst-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))

}

returns netgate.nat.natconfig.GlobalOptions

get /data/netgate-nat:nat-config/netgate-nat:global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options

NAT global options

Responses

200

netgate.nat.natconfig.GlobalOptions

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-nat:nat-config/netgate-nat:global-options"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-nat:global-options":
{
- "nat44":
  {
  - "forwarding-enabled": true
  }
}

}

creates netgate.nat.natconfig.GlobalOptions

post /data/netgate-nat:nat-config/netgate-nat:global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options

NAT global options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.GlobalOptions to be added to list

nat44

object (netgate.nat.natconfig.globaloptions.Nat44)

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

{

"nat44":
{
- "forwarding-enabled": true
}

}

creates or updates netgate.nat.natconfig.GlobalOptions

put /data/netgate-nat:nat-config/netgate-nat:global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options

NAT global options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.GlobalOptions to be added or updated

netgate-nat:global-options

object (netgate.nat.natconfig.GlobalOptions)

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-nat:global-options":
{
- "nat44":
  {
  - "forwarding-enabled": true
  }
}

}

removes netgate.nat.natconfig.GlobalOptions

delete /data/netgate-nat:nat-config/netgate-nat:global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options

NAT global options

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.nat.natconfig.globaloptions.Nat44

get /data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

NAT44 options

Responses

200

netgate.nat.natconfig.globaloptions.Nat44

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-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44"

	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-nat:nat44":
{
- "forwarding-enabled": true
}

}

creates netgate.nat.natconfig.globaloptions.Nat44

post /data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

NAT44 options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Nat44 to be added to list

forwarding-enabled

boolean

NAT44 forwarding option. Used 'true' or 'false'.

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

{

"forwarding-enabled": true

}

creates or updates netgate.nat.natconfig.globaloptions.Nat44

put /data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

NAT44 options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Nat44 to be added or updated

netgate-nat:nat44

object (netgate.nat.natconfig.globaloptions.Nat44)

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-nat:nat44":
{
- "forwarding-enabled": true
}

}

removes netgate.nat.natconfig.globaloptions.Nat44

delete /data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44

NAT44 options

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:global-options/netgate-nat:nat44"

	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.nat.natconfig.Ipfix

get /data/netgate-nat:nat-config/netgate-nat:ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix

IPFIX information.

Responses

200

netgate.nat.natconfig.Ipfix

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-nat:nat-config/netgate-nat:ipfix"

	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-nat:ipfix":
{
- "logging":
  {
  - "logging-entry":
    [
    {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
    ]
  }
}

}

creates netgate.nat.natconfig.Ipfix

post /data/netgate-nat:nat-config/netgate-nat:ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix

IPFIX information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Ipfix to be added to list

logging

object (netgate.nat.natconfig.ipfix.Logging)

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

{

"logging":
{
- "logging-entry":
  [
  - {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
  ]
}

}

creates or updates netgate.nat.natconfig.Ipfix

put /data/netgate-nat:nat-config/netgate-nat:ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix

IPFIX information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Ipfix to be added or updated

netgate-nat:ipfix

object (netgate.nat.natconfig.Ipfix)

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-nat:ipfix":
{
- "logging":
  {
  - "logging-entry":
    [
    {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
    ]
  }
}

}

removes netgate.nat.natconfig.Ipfix

delete /data/netgate-nat:nat-config/netgate-nat:ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix

IPFIX information.

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-nat:nat-config/netgate-nat:ipfix"

	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.nat.natconfig.ipfix.Logging

get /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

IPFIX logging information.

Responses

200

netgate.nat.natconfig.ipfix.Logging

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-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging"

	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-nat:logging":
{
- "logging-entry":
  [
  - {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
  ]
}

}

creates netgate.nat.natconfig.ipfix.Logging

post /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

IPFIX logging information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.Logging to be added to list

logging-entry

Array of objects (netgate.nat.natconfig.ipfix.logging.LoggingEntry)

IPFIX logging entry.

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

{

"logging-entry":
[
- {
  - "enable": true,
  - "src-port": 0,
  - "domain": 0
  }
]

}

creates or updates netgate.nat.natconfig.ipfix.Logging

put /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

IPFIX logging information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.Logging to be added or updated

netgate-nat:logging

object (netgate.nat.natconfig.ipfix.Logging)

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-nat:logging":
{
- "logging-entry":
  [
  - {
    "enable": true,
    "src-port": 0,
    "domain": 0
    }
  ]
}

}

removes netgate.nat.natconfig.ipfix.Logging

delete /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging

IPFIX logging information.

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-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging"

	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.nat.natconfig.ipfix.logging.LoggingEntry

post /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry

IPFIX logging entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.logging.LoggingEntry to be added to list

enable	boolean If logging is enabled for this domain and port, this value will be true.
src-port	integer <int32> The logging source port id.
domain	integer <int64> The logging domain id.

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

{

"enable": true,
"src-port": 0,
"domain": 0

}

returns netgate.nat.natconfig.ipfix.logging.LoggingEntry

get /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

IPFIX logging entry.

path Parameters

domain required	integer <int64> Id of logging-entry
src-port required	integer <int32> Id of logging-entry

Responses

200

netgate.nat.natconfig.ipfix.logging.LoggingEntry

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-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry=%7Bdomain%7D,%7Bsrc-port%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-nat:logging-entry":
{
- "enable": true,
- "src-port": 0,
- "domain": 0
}

}

creates netgate.nat.natconfig.ipfix.logging.LoggingEntry

post /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

IPFIX logging entry.

path Parameters

domain required	integer <int64> Id of logging-entry
src-port required	integer <int32> Id of logging-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.logging.LoggingEntry to be added to list

enable	boolean If logging is enabled for this domain and port, this value will be true.
src-port	integer <int32> The logging source port id.
domain	integer <int64> The logging domain id.

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

{

"enable": true,
"src-port": 0,
"domain": 0

}

creates or updates netgate.nat.natconfig.ipfix.logging.LoggingEntry

put /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

IPFIX logging entry.

path Parameters

domain required	integer <int64> Id of logging-entry
src-port required	integer <int32> Id of logging-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.logging.LoggingEntry to be added or updated

netgate-nat:logging-entry

object (netgate.nat.natconfig.ipfix.logging.LoggingEntry)

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-nat:logging-entry":
{
- "enable": true,
- "src-port": 0,
- "domain": 0
}

}

removes netgate.nat.natconfig.ipfix.logging.LoggingEntry

delete /data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry={domain},{src-port}

IPFIX logging entry.

path Parameters

domain required	integer <int64> Id of logging-entry
src-port required	integer <int32> Id of logging-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:ipfix/netgate-nat:logging/netgate-nat:logging-entry=%7Bdomain%7D,%7Bsrc-port%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.nat.natconfig.Nat64

get /data/netgate-nat:nat-config/netgate-nat:nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:nat64

NAT for IPv6/IPv4.

Responses

200

netgate.nat.natconfig.Nat64

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-nat:nat-config/netgate-nat:nat64"

	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-nat:nat64":
{
- "map":
  {
  - "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
  - "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
  }
}

}

creates netgate.nat.natconfig.Nat64

post /data/netgate-nat:nat-config/netgate-nat:nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:nat64

NAT for IPv6/IPv4.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Nat64 to be added to list

map	object (netgate.map.natstate.nat64.Map)

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

{

"map":
{
- "parameters":
  {
  - "tcp":
    {
    "mss": 0
    },
  - "security-check":
    {
    "enable": true,
    "fragments": true
    },
  - "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
  - "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
  - "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
  - "icmp":
    {
    "source-address": "string"
    },
  - "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
  - "icmp6":
    {
    "unreachables": true
    }
  },
- "map-domains":
  {
  - "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
  }
}

}

creates or updates netgate.nat.natconfig.Nat64

put /data/netgate-nat:nat-config/netgate-nat:nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:nat64

NAT for IPv6/IPv4.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Nat64 to be added or updated

netgate-nat:nat64

object (netgate.nat.natconfig.Nat64)

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-nat:nat64":
{
- "map":
  {
  - "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
  - "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
  }
}

}

removes netgate.nat.natconfig.Nat64

delete /data/netgate-nat:nat-config/netgate-nat:nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:nat64

NAT for IPv6/IPv4.

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-nat:nat-config/netgate-nat:nat64"

	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.nat.natconfig.Reassembly

get /data/netgate-nat:nat-config/netgate-nat:reassembly

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly

Attributes that control NAT fragmentation reassembly.

Responses

200

netgate.nat.natconfig.Reassembly

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-nat:nat-config/netgate-nat:reassembly"

	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-nat:reassembly":
{
- "address-family":
  [
  - {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
  ]
}

}

creates netgate.nat.natconfig.Reassembly

post /data/netgate-nat:nat-config/netgate-nat:reassembly

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly

Attributes that control NAT fragmentation reassembly.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Reassembly to be added to list

address-family

Array of objects (netgate.nat.natconfig.reassembly.AddressFamily)

Select either 'ipv4' or 'ipv6'.

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

{

"address-family":
[
- {
  - "family": "ipv4",
  - "max-fragments": 0,
  - "max-concurrent-reassemblies": 0,
  - "enable": true,
  - "timeout": 0
  }
]

}

creates or updates netgate.nat.natconfig.Reassembly

put /data/netgate-nat:nat-config/netgate-nat:reassembly

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly

Attributes that control NAT fragmentation reassembly.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Reassembly to be added or updated

netgate-nat:reassembly

object (netgate.nat.natconfig.Reassembly)

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-nat:reassembly":
{
- "address-family":
  [
  - {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
  ]
}

}

removes netgate.nat.natconfig.Reassembly

delete /data/netgate-nat:nat-config/netgate-nat:reassembly

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly

Attributes that control NAT fragmentation reassembly.

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-nat:nat-config/netgate-nat:reassembly"

	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.nat.natconfig.reassembly.AddressFamily

post /data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family

Select either 'ipv4' or 'ipv6'.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.reassembly.AddressFamily to be added to list

family	string (netgate.common.IpAddressFamily) Enum: "ipv4" "ipv6"
max-fragments	integer <int32> The max number of fragments that can be reassembled.
max-concurrent-reassemblies	integer <int32> The maximum number of concurrent reassemblies.
enable	boolean If true, NAT reassembly is enabled for this address family.
timeout	integer <int64> The period of time in seconds between fragments in a NAT reassembly before the reassmbly expires.

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

{

"family": "ipv4",
"max-fragments": 0,
"max-concurrent-reassemblies": 0,
"enable": true,
"timeout": 0

}

returns netgate.nat.natconfig.reassembly.AddressFamily

get /data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Select either 'ipv4' or 'ipv6'.

path Parameters

family

required

string

Id of address-family

Responses

200

netgate.nat.natconfig.reassembly.AddressFamily

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-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family=%7Bfamily%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-nat:address-family":
{
- "family": "ipv4",
- "max-fragments": 0,
- "max-concurrent-reassemblies": 0,
- "enable": true,
- "timeout": 0
}

}

creates netgate.nat.natconfig.reassembly.AddressFamily

post /data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Select either 'ipv4' or 'ipv6'.

path Parameters

family

required

string

Id of address-family

Request Body schema: application/yang-data+json

netgate.nat.natconfig.reassembly.AddressFamily to be added to list

family	string (netgate.common.IpAddressFamily) Enum: "ipv4" "ipv6"
max-fragments	integer <int32> The max number of fragments that can be reassembled.
max-concurrent-reassemblies	integer <int32> The maximum number of concurrent reassemblies.
enable	boolean If true, NAT reassembly is enabled for this address family.
timeout	integer <int64> The period of time in seconds between fragments in a NAT reassembly before the reassmbly expires.

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

{

"family": "ipv4",
"max-fragments": 0,
"max-concurrent-reassemblies": 0,
"enable": true,
"timeout": 0

}

creates or updates netgate.nat.natconfig.reassembly.AddressFamily

put /data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Select either 'ipv4' or 'ipv6'.

path Parameters

family

required

string

Id of address-family

Request Body schema: application/yang-data+json

netgate.nat.natconfig.reassembly.AddressFamily to be added or updated

netgate-nat:address-family

object (netgate.nat.natconfig.reassembly.AddressFamily)

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-nat:address-family":
{
- "family": "ipv4",
- "max-fragments": 0,
- "max-concurrent-reassemblies": 0,
- "enable": true,
- "timeout": 0
}

}

removes netgate.nat.natconfig.reassembly.AddressFamily

delete /data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family={family}

Select either 'ipv4' or 'ipv6'.

path Parameters

family

required

string

Id of address-family

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-nat:nat-config/netgate-nat:reassembly/netgate-nat:address-family=%7Bfamily%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.nat.natconfig.Static

get /data/netgate-nat:nat-config/netgate-nat:static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static

Static mapping information.

Responses

200

netgate.nat.natconfig.Static

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-nat:nat-config/netgate-nat:static"

	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-nat:static":
{
- "mapping-table":
  {
  - "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
  }
}

}

creates netgate.nat.natconfig.Static

post /data/netgate-nat:nat-config/netgate-nat:static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static

Static mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Static to be added to list

mapping-table

object (netgate.nat.natconfig.static.MappingTable)

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

{

"mapping-table":
{
- "mapping-entry":
  [
  - {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
  ]
}

}

creates or updates netgate.nat.natconfig.Static

put /data/netgate-nat:nat-config/netgate-nat:static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static

Static mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Static to be added or updated

netgate-nat:static

object (netgate.nat.natconfig.Static)

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-nat:static":
{
- "mapping-table":
  {
  - "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
  }
}

}

removes netgate.nat.natconfig.Static

delete /data/netgate-nat:nat-config/netgate-nat:static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static

Static mapping information.

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-nat:nat-config/netgate-nat:static"

	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.nat.natconfig.static.MappingTable

get /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

NAT mapping table.

Responses

200

netgate.nat.natconfig.static.MappingTable

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-nat:nat-config/netgate-nat:static/netgate-nat:mapping-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-nat:mapping-table":
{
- "mapping-entry":
  [
  - {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
  ]
}

}

creates netgate.nat.natconfig.static.MappingTable

post /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.MappingTable to be added to list

mapping-entry

Array of objects (netgate.nat.natconfig.static.mappingtable.MappingEntry)

NAT Mapping Entry.

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

{

"mapping-entry":
[
- {
  - "route-table-name": "string",
  - "external-if-name": "string",
  - "external-port": 0,
  - "local-port": 0,
  - "external-address": "string",
  - "transport-protocol": "string",
  - "out-to-in-only": true,
  - "present": true,
  - "twice-nat": true,
  - "local-address": "string"
  }
]

}

creates or updates netgate.nat.natconfig.static.MappingTable

put /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.MappingTable to be added or updated

netgate-nat:mapping-table

object (netgate.nat.natconfig.static.MappingTable)

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-nat:mapping-table":
{
- "mapping-entry":
  [
  - {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "present": true,
    "twice-nat": true,
    "local-address": "string"
    }
  ]
}

}

removes netgate.nat.natconfig.static.MappingTable

delete /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table

NAT mapping table.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-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.nat.natconfig.static.mappingtable.MappingEntry

post /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry

NAT Mapping Entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.mappingtable.MappingEntry to be added to list

route-table-name	string The name of a Route Table.
external-if-name	string The external interface of the IPv4 packet.
external-port	integer <int32> The external port mapped.
local-port	integer <int32> The local port mapped.
external-address	string The external IPv4 address of the IPv4 packet.
transport-protocol	string Upper-layer protocol associated with this mapping. Should be 'udp', 'tcp', or 'icmp'.
out-to-in-only	boolean Match only out-to-in direction.
present	boolean
twice-nat	boolean NAT translate external address and port for 1:1 NAPT.
local-address	string The local IPv4 address of the IPv4 packet.

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

{

"route-table-name": "string",
"external-if-name": "string",
"external-port": 0,
"local-port": 0,
"external-address": "string",
"transport-protocol": "string",
"out-to-in-only": true,
"present": true,
"twice-nat": true,
"local-address": "string"

}

returns netgate.nat.natconfig.static.mappingtable.MappingEntry

get /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters

transport-protocol required	string Id of mapping-entry
local-address required	string Id of mapping-entry
local-port required	integer <int32> Id of mapping-entry
external-address required	string Id of mapping-entry
external-port required	integer <int32> Id of mapping-entry
route-table-name required	string Id of mapping-entry

Responses

200

netgate.nat.natconfig.static.mappingtable.MappingEntry

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-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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-nat:mapping-entry":
{
- "route-table-name": "string",
- "external-if-name": "string",
- "external-port": 0,
- "local-port": 0,
- "external-address": "string",
- "transport-protocol": "string",
- "out-to-in-only": true,
- "present": true,
- "twice-nat": true,
- "local-address": "string"
}

}

creates netgate.nat.natconfig.static.mappingtable.MappingEntry

post /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

NAT Mapping Entry.

path Parameters

transport-protocol required	string Id of mapping-entry
local-address required	string Id of mapping-entry
local-port required	integer <int32> Id of mapping-entry
external-address required	string Id of mapping-entry
external-port required	integer <int32> Id of mapping-entry
route-table-name required	string Id of mapping-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.mappingtable.MappingEntry to be added to list

route-table-name	string The name of a Route Table.
external-if-name	string The external interface of the IPv4 packet.
external-port	integer <int32> The external port mapped.
local-port	integer <int32> The local port mapped.
external-address	string The external IPv4 address of the IPv4 packet.
transport-protocol	string Upper-layer protocol associated with this mapping. Should be 'udp', 'tcp', or 'icmp'.
out-to-in-only	boolean Match only out-to-in direction.
present	boolean
twice-nat	boolean NAT translate external address and port for 1:1 NAPT.
local-address	string The local IPv4 address of the IPv4 packet.

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

{

"route-table-name": "string",
"external-if-name": "string",
"external-port": 0,
"local-port": 0,
"external-address": "string",
"transport-protocol": "string",
"out-to-in-only": true,
"present": true,
"twice-nat": true,
"local-address": "string"

}

creates or updates netgate.nat.natconfig.static.mappingtable.MappingEntry

put /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

NAT Mapping Entry.

path Parameters

transport-protocol required	string Id of mapping-entry
local-address required	string Id of mapping-entry
local-port required	integer <int32> Id of mapping-entry
external-address required	string Id of mapping-entry
external-port required	integer <int32> Id of mapping-entry
route-table-name required	string Id of mapping-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.mappingtable.MappingEntry to be added or updated

netgate-nat:mapping-entry

object (netgate.nat.natconfig.static.mappingtable.MappingEntry)

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-nat:mapping-entry":
{
- "route-table-name": "string",
- "external-if-name": "string",
- "external-port": 0,
- "local-port": 0,
- "external-address": "string",
- "transport-protocol": "string",
- "out-to-in-only": true,
- "present": true,
- "twice-nat": true,
- "local-address": "string"
}

}

removes netgate.nat.natconfig.static.mappingtable.MappingEntry

delete /data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

NAT Mapping Entry.

path Parameters

transport-protocol required	string Id of mapping-entry
local-address required	string Id of mapping-entry
local-port required	integer <int32> Id of mapping-entry
external-address required	string Id of mapping-entry
external-port required	integer <int32> Id of mapping-entry
route-table-name required	string Id of mapping-entry

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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))

}

nat-state

returns netgate.nat.NatState

get /data/netgate-nat:nat-state

Example URL

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

Network Address Translation (NAT) state data.

Responses

200

netgate.nat.NatState

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-nat:nat-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-nat:nat-state":
{
- "static":
  {
  - "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
    }
  },
- "nat64":
  {
  - "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
    "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
    }
  },
- "deterministic":
  {
  - "det-mapping-table":
    {
    "det-mapping-entry":
    [
    {
    "ses-num": 0,
    "sharing-ratio": 0,
    "outside-prefix": "string",
    "ports-per-host": 0,
    "inside-prefix": "string"
    }
    ]
    }
  },
- "interface-sides":
  {
  - "interface-side":
    [
    {
    "if-name": "string",
    "side": "inside"
    }
    ]
  },
- "dynamic":
  {
  - "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
    },
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "address": "string",
    "twice-nat": true
    }
    ]
    }
  },
- "reassembly":
  {
  - "address-family":
    [
    {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
    ]
  },
- "parameters":
  {
  - "translation-memory-size": 0,
  - "translation-buckets": 0,
  - "inside-route-table-name": "string",
  - "user-buckets": 0,
  - "user-memory-size": 0,
  - "static-mapping-only": true,
  - "outside-route-table-name": "string",
  - "deterministic": true,
  - "max-translations-per-user": 0,
  - "static-mapping-connection-tracking": true,
  - "forwarding-enabled": true
  }
}

}

returns netgate.nat.natstate.Deterministic

get /data/netgate-nat:nat-state/netgate-nat:deterministic

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:deterministic

Deterministic NAT information.

Responses

200

netgate.nat.natstate.Deterministic

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-nat:nat-state/netgate-nat:deterministic"

	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-nat:deterministic":
{
- "det-mapping-table":
  {
  - "det-mapping-entry":
    [
    {
    "ses-num": 0,
    "sharing-ratio": 0,
    "outside-prefix": "string",
    "ports-per-host": 0,
    "inside-prefix": "string"
    }
    ]
  }
}

}

returns netgate.nat.natstate.deterministic.DetMappingTable

get /data/netgate-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-table

Deterministic NAT mapping table.

Responses

200

netgate.nat.natstate.deterministic.DetMappingTable

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-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-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-nat:det-mapping-table":
{
- "det-mapping-entry":
  [
  - {
    "ses-num": 0,
    "sharing-ratio": 0,
    "outside-prefix": "string",
    "ports-per-host": 0,
    "inside-prefix": "string"
    }
  ]
}

}

returns netgate.nat.natstate.deterministic.detmappingtable.DetMappingEntry

get /data/netgate-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry={inside-prefix},{outside-prefix}

Deterministic NAT Mapping Entry.

path Parameters

inside-prefix required	string Id of det-mapping-entry
outside-prefix required	string Id of det-mapping-entry

Responses

200

netgate.nat.natstate.deterministic.detmappingtable.DetMappingEntry

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-nat:nat-state/netgate-nat:deterministic/netgate-nat:det-mapping-table/netgate-nat:det-mapping-entry=%7Binside-prefix%7D,%7Boutside-prefix%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-nat:det-mapping-entry":
{
- "ses-num": 0,
- "sharing-ratio": 0,
- "outside-prefix": "string",
- "ports-per-host": 0,
- "inside-prefix": "string"
}

}

returns netgate.nat.natstate.Dynamic

get /data/netgate-nat:nat-state/netgate-nat:dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:dynamic

Dynamic mapping information.

Responses

200

netgate.nat.natstate.Dynamic

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-nat:nat-state/netgate-nat:dynamic"

	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-nat:dynamic":
{
- "pool-if-table":
  {
  - "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": true
    }
    ]
  },
- "pool-table":
  {
  - "pool-entry":
    [
    {
    "route-table-name": "string",
    "address": "string",
    "twice-nat": true
    }
    ]
  }
}

}

returns netgate.nat.natstate.dynamic.PoolIfTable

get /data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-if-table

NAT interface pool table.

Responses

200

netgate.nat.natstate.dynamic.PoolIfTable

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-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-if-table":
{
- "if-entry":
  [
  - {
    "if-name": "string",
    "twice-nat": true
    }
  ]
}

}

returns netgate.nat.natstate.dynamic.pooliftable.IfEntry

get /data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry={if-name}

Dynamic pool interface entries.

path Parameters

if-name

required

string

Id of if-entry

Responses

200

netgate.nat.natstate.dynamic.pooliftable.IfEntry

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-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-if-table/netgate-nat:if-entry=%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-nat:if-entry":
{
- "if-name": "string",
- "twice-nat": true
}

}

returns netgate.nat.natstate.dynamic.PoolTable

get /data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-table

NAT address pool table.

Responses

200

netgate.nat.natstate.dynamic.PoolTable

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-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-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-nat:pool-table":
{
- "pool-entry":
  [
  - {
    "route-table-name": "string",
    "address": "string",
    "twice-nat": true
    }
  ]
}

}

returns netgate.nat.natstate.dynamic.pooltable.PoolEntry

get /data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry={address}

NAT pool address.

path Parameters

address

required

string

Id of pool-entry

Responses

200

netgate.nat.natstate.dynamic.pooltable.PoolEntry

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-nat:nat-state/netgate-nat:dynamic/netgate-nat:pool-table/netgate-nat:pool-entry=%7Baddress%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-nat:pool-entry":
{
- "route-table-name": "string",
- "address": "string",
- "twice-nat": true
}

}

returns netgate.nat.natstate.InterfaceSides

get /data/netgate-nat:nat-state/netgate-nat:interface-sides

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:interface-sides

Side information for each interface.

Responses

200

netgate.nat.natstate.InterfaceSides

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-nat:nat-state/netgate-nat:interface-sides"

	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-nat:interface-sides":
{
- "interface-side":
  [
  - {
    "if-name": "string",
    "side": "inside"
    }
  ]
}

}

returns netgate.nat.natstate.interfacesides.InterfaceSide

get /data/netgate-nat:nat-state/netgate-nat:interface-sides/netgate-nat:interface-side={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:interface-sides/netgate-nat:interface-side={if-name}

Side information about interfaces.

path Parameters

if-name

required

string

Id of interface-side

Responses

200

netgate.nat.natstate.interfacesides.InterfaceSide

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-nat:nat-state/netgate-nat:interface-sides/netgate-nat:interface-side=%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-nat:interface-side":
{
- "if-name": "string",
- "side": "inside"
}

}

returns netgate.nat.natstate.Nat64

get /data/netgate-nat:nat-state/netgate-nat:nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:nat64

NAT for IPv6/IPv4.

Responses

200

netgate.nat.natstate.Nat64

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-nat:nat-state/netgate-nat:nat64"

	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-nat:nat64":
{
- "map":
  {
  - "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": true,
    "fragments": true
    },
    "fragment":
    {
    "inner": true,
    "ignore-df": true
    },
    "traffic-class":
    {
    "copy": true,
    "tc": 0
    },
    "reassembly":
    {
    "ipv4":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    },
    "ipv6":
    {
    "pool-size": 0,
    "lifetime": 0,
    "ht-ratio": "string",
    "buffers": 0
    }
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": true
    }
    },
  - "map-domains":
    {
    "domain":
    [
    {
    "psid-offset": 0,
    "ea-bits-length": 0,
    "ip6-src-prefix": "string",
    "ip4-prefix": "string",
    "name": "string",
    "description": "string",
    "rules":
    {
    "rule":
    [
    {
    "ip6-destination": "string",
    "psid": 0
    }
    ]
    },
    "psid-length": 0,
    "ip6-prefix": "string",
    "mtu": 0
    }
    ]
    }
  }
}

}

returns netgate.nat.natstate.Parameters

get /data/netgate-nat:nat-state/netgate-nat:parameters

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:parameters

NAT configuration parameters.

Responses

200

netgate.nat.natstate.Parameters

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-nat:nat-state/netgate-nat:parameters"

	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-nat:parameters":
{
- "translation-memory-size": 0,
- "translation-buckets": 0,
- "inside-route-table-name": "string",
- "user-buckets": 0,
- "user-memory-size": 0,
- "static-mapping-only": true,
- "outside-route-table-name": "string",
- "deterministic": true,
- "max-translations-per-user": 0,
- "static-mapping-connection-tracking": true,
- "forwarding-enabled": true
}

}

returns netgate.nat.natstate.Reassembly

get /data/netgate-nat:nat-state/netgate-nat:reassembly

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:reassembly

Attributes that control NAT fragmentation reassembly.

Responses

200

netgate.nat.natstate.Reassembly

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-nat:nat-state/netgate-nat:reassembly"

	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-nat:reassembly":
{
- "address-family":
  [
  - {
    "family": "ipv4",
    "max-fragments": 0,
    "max-concurrent-reassemblies": 0,
    "enable": true,
    "timeout": 0
    }
  ]
}

}

returns netgate.nat.natstate.reassembly.AddressFamily

get /data/netgate-nat:nat-state/netgate-nat:reassembly/netgate-nat:address-family={family}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:reassembly/netgate-nat:address-family={family}

Select either 'ipv4' or 'ipv6'.

path Parameters

family

required

string

Id of address-family

Responses

200

netgate.nat.natstate.reassembly.AddressFamily

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-nat:nat-state/netgate-nat:reassembly/netgate-nat:address-family=%7Bfamily%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-nat:address-family":
{
- "family": "ipv4",
- "max-fragments": 0,
- "max-concurrent-reassemblies": 0,
- "enable": true,
- "timeout": 0
}

}

returns netgate.nat.natstate.Static

get /data/netgate-nat:nat-state/netgate-nat:static

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:static

Static mapping information.

Responses

200

netgate.nat.natstate.Static

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-nat:nat-state/netgate-nat:static"

	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-nat:static":
{
- "mapping-table":
  {
  - "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "twice-nat": true,
    "local-address": "string"
    }
    ]
  }
}

}

returns netgate.nat.natstate.static.MappingTable

get /data/netgate-nat:nat-state/netgate-nat:static/netgate-nat:mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:static/netgate-nat:mapping-table

NAT mapping table.

Responses

200

netgate.nat.natstate.static.MappingTable

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-nat:nat-state/netgate-nat:static/netgate-nat:mapping-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-nat:mapping-table":
{
- "mapping-entry":
  [
  - {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": 0,
    "local-port": 0,
    "external-address": "string",
    "transport-protocol": "string",
    "out-to-in-only": true,
    "twice-nat": true,
    "local-address": "string"
    }
  ]
}

}

returns netgate.nat.natstate.static.mappingtable.MappingEntry

get /data/netgate-nat:nat-state/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters

transport-protocol required	string Id of mapping-entry
local-address required	string Id of mapping-entry
local-port required	integer <int32> Id of mapping-entry
external-address required	string Id of mapping-entry
external-port required	integer <int32> Id of mapping-entry
route-table-name required	string Id of mapping-entry

Responses

200

netgate.nat.natstate.static.mappingtable.MappingEntry

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-nat:nat-state/netgate-nat:static/netgate-nat:mapping-table/netgate-nat:mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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-nat:mapping-entry":
{
- "route-table-name": "string",
- "external-if-name": "string",
- "external-port": 0,
- "local-port": 0,
- "external-address": "string",
- "transport-protocol": "string",
- "out-to-in-only": true,
- "twice-nat": true,
- "local-address": "string"
}

}