netgate-nat API (23.06)

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

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-wrapper":
{
- "netgate-nat:nat-config":
  {
  - "global-options":
    {
    "timeouts":
    {
    "udp": 0,
    "tcp_established": 0,
    "icmp": 0,
    "tcp_transitory": 0
    },
    "nat44":
    {
    "out2in-dpo": false,
    "max-translations-per-thread": 128000,
    "max-users-per-thread": 0,
    "static-mapping-only": false,
    "endpoint-dependent": false,
    "max-translations-per-user": 0,
    "forwarding-enabled": false,
    "enabled": false
    }
    },
  - "ipfix":
    {
    "logging":
    {
    "enable": false,
    "src-port": 4739,
    "domain": 1
    }
    },
  - "dynamic":
    {
    "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": false
    }
    ]
    },
    "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": false
    }
    ]
    }
    },
  - "static":
    {
    "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": "string",
    "local-port": "string",
    "external-address": "string",
    "transport-protocol": "icmp",
    "out-to-in-only": false,
    "twice-nat": false,
    "local-address": "string"
    }
    ]
    }
    },
  - "nat64":
    {
    "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": false,
    "fragments": false
    },
    "fragment":
    {
    "inner": false,
    "ignore-df": false
    },
    "traffic-class":
    {
    "copy": false,
    "tc": 0
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": false
    }
    },
    "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

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

netgate-nat:nat-config

object (netgate.nat.NatConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-nat:nat-config":
{
- "global-options":
  {
  - "timeouts":
    {
    "udp": 0,
    "tcp_established": 0,
    "icmp": 0,
    "tcp_transitory": 0
    },
  - "nat44":
    {
    "out2in-dpo": false,
    "max-translations-per-thread": 128000,
    "max-users-per-thread": 0,
    "static-mapping-only": false,
    "endpoint-dependent": false,
    "max-translations-per-user": 0,
    "forwarding-enabled": false,
    "enabled": false
    }
  },
- "ipfix":
  {
  - "logging":
    {
    "enable": false,
    "src-port": 4739,
    "domain": 1
    }
  },
- "dynamic":
  {
  - "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": false
    }
    ]
    },
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": false
    }
    ]
    }
  },
- "static":
  {
  - "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": "string",
    "local-port": "string",
    "external-address": "string",
    "transport-protocol": "icmp",
    "out-to-in-only": false,
    "twice-nat": false,
    "local-address": "string"
    }
    ]
    }
  },
- "nat64":
  {
  - "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": false,
    "fragments": false
    },
    "fragment":
    {
    "inner": false,
    "ignore-df": false
    },
    "traffic-class":
    {
    "copy": false,
    "tc": 0
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": false
    }
    },
    "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

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-wrapper

object (netgate.nat.NatConfigWrapper)

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-wrapper":
{
- "netgate-nat:nat-config":
  {
  - "global-options":
    {
    "timeouts":
    {
    "udp": 0,
    "tcp_established": 0,
    "icmp": 0,
    "tcp_transitory": 0
    },
    "nat44":
    {
    "out2in-dpo": false,
    "max-translations-per-thread": 128000,
    "max-users-per-thread": 0,
    "static-mapping-only": false,
    "endpoint-dependent": false,
    "max-translations-per-user": 0,
    "forwarding-enabled": false,
    "enabled": false
    }
    },
  - "ipfix":
    {
    "logging":
    {
    "enable": false,
    "src-port": 4739,
    "domain": 1
    }
    },
  - "dynamic":
    {
    "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": false
    }
    ]
    },
    "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": false
    }
    ]
    }
    },
  - "static":
    {
    "mapping-table":
    {
    "mapping-entry":
    [
    {
    "route-table-name": "string",
    "external-if-name": "string",
    "external-port": "string",
    "local-port": "string",
    "external-address": "string",
    "transport-protocol": "icmp",
    "out-to-in-only": false,
    "twice-nat": false,
    "local-address": "string"
    }
    ]
    }
    },
  - "nat64":
    {
    "map":
    {
    "parameters":
    {
    "tcp":
    {
    "mss": 0
    },
    "security-check":
    {
    "enable": false,
    "fragments": false
    },
    "fragment":
    {
    "inner": false,
    "ignore-df": false
    },
    "traffic-class":
    {
    "copy": false,
    "tc": 0
    },
    "icmp":
    {
    "source-address": "string"
    },
    "pre-resolve":
    {
    "ipv4":
    {
    "next-hop": "string"
    },
    "ipv6":
    {
    "next-hop": "string"
    }
    },
    "icmp6":
    {
    "unreachables": false
    }
    },
    "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

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

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

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/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/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-wrapper":
{
- "dynamic":
  {
  - "pool-if-table":
    {
    "if-entry":
    [
    {
    "if-name": "string",
    "twice-nat": false
    }
    ]
    },
  - "pool-table":
    {
    "pool-entry":
    [
    {
    "route-table-name": "string",
    "first-address": "string",
    "last-address": "string",
    "twice-nat": false
    }
    ]
    }
  }
}

}

creates netgate.nat.natconfig.Dynamic

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

Example URL

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

Dynamic mapping information.

Request Body schema: application/yang-data+json

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

dynamic

object (netgate.nat.natconfig.Dynamic)

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

{

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