Create NAT Policy Rule (v2.0)

POST 
/sdwan/v2.0/api/natpolicysets/:nat_policy_set_id/natpolicyrules

Create a new NAT policy rule.

Request

Path Parameters

nat_policy_set_id stringrequired

ID of the NAT policy set.

application/json

Body

Details of NAT Policy Rule to be created

actions NATAction[]required
The actions for the configured NAT policy rule/set. A maximum 4 actions can be specified in a NAT policy rule/set.
Array [
nat_pool_id string
The ID of the the NAT pool used in policy rules and bound to interfaces.
port integer
The port range of the action in the NAT policy rule.
protocols string[]
The protocol of the action for the NAT policy rule. Supports max 4 protocols.
type stringrequired
Possible values: [NO_NAT, SOURCE_NAT_DYNAMIC, SOURCE_NAT_STATIC, DESTINATION_NAT_DYNAMIC, DESTINATION_NAT_STATIC, ALG_DISABLE]
The type of action for NAT policy.
]
description

The description of the NAT policy rule/set. Max size = 256.

destination_ports PortRange[]
The start and end port for Port Ranges. A maximum of 16 port ranges is allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
destination_prefixes BasePolicyPrefixS

Lists the details of the destination prefixes.

description

The description for the source/destination prefixes.

id string

The ID of the source/destination prefix.

ipv4_prefixes string[]

Lists the IP prefixes.

ipv6_prefixes string[]

Ipv6 Prefixes

name string

The name of the source/destination prefix.

tags string[]

A information field that can be added to identify the source/destination prefix.

destination_prefixes_id string

The ID of the destination prefix.

destination_zone NATPolicyZone

List the details of the destination zone.

default_for_public_interfaces boolean

The default source/destination zone for public interfaces.

description

The description for the source/destination zone. Max size = 128.

disabled boolean

Lists if the source/destination zone set is disabled.

disabled_reason string

Reason the source/destination zone is disabled.

id string

The ID of the source/destination zone.

inactive boolean

Lists if the source/destination zone is inactive.

inactive_reason string

Reason the source/destination zone is inactive.

name stringrequired

The name of the source/destination zone.

region string

The region of the site.

tags string[]

A information field that can be added to identify the source/destination zone.

destination_zone_id string

The ID of the destination zone. Destination zone is based on the direction of the traffic with respect to the ION device.

disabled boolean

Lists if the NAT policy rule/set is disabled.

disabled_reason string

Reason the NAT policy rule/set is disabled.

enabled boolean

Lists if the NAT policy rule/set is enabled.

id string

The ID of the policy rule/set.

inactive boolean

Lists if the NAT policy rule/set is inactive.

inactive_reason string

Reason the NAT policy rule/set is inactive.

name stringrequired

The name of the NAT policy rule/set.

natpolicypools NATPolicyPool[]
Lists the details of the NAT policy pools.
Array [
description
The description for the NAT policy pool. Max size = 256.
id string
The ID of the NAT policy pool.
name stringrequired
The name of the NAT policy pool. Max size = 128.
tags string[]
A information field that can be added to identify the NAT policy pool. Maximum 10 unique tags of length 1024 each are allowed.
]
policyset_id string

The ID of the NAT policy set. NAT policy sets contain policy rules and are a part of NAT policy set stacks.

protocol integer

The protocol for the NAT policy set. TCP or UDP.

region string

Region

source_ports PortRange[]
List the details of the source port range. A maximum of 16 port ranges are allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
source_prefixes BasePolicyPrefixS

List the details of the source prefixes.

description

The description for the source/destination prefixes.

id string

The ID of the source/destination prefix.

ipv4_prefixes string[]

Lists the IP prefixes.

ipv6_prefixes string[]

Ipv6 Prefixes

name string

The name of the source/destination prefix.

tags string[]

A information field that can be added to identify the source/destination prefix.

source_prefixes_id string

The ID of the source prefixes.

source_zone NATPolicyZone

Lists the details of the source zone used in policy rules and bound to interfaces.

default_for_public_interfaces boolean

The default source/destination zone for public interfaces.

description

The description for the source/destination zone. Max size = 128.

disabled boolean

Lists if the source/destination zone set is disabled.

disabled_reason string

Reason the source/destination zone is disabled.

id string

The ID of the source/destination zone.

inactive boolean

Lists if the source/destination zone is inactive.

inactive_reason string

Reason the source/destination zone is inactive.

name stringrequired

The name of the source/destination zone.

region string

The region of the site.

tags string[]

A information field that can be added to identify the source/destination zone.

source_zone_id string

The ID of the NAT policy source zone. Source zones identify traffic that is sourced from a zone.

tags string[]

A information field that can be added to identify the NAT policy rule/set. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

actions NATAction[]required
The actions for the configured NAT policy rule/set. A maximum 4 actions can be specified in a NAT policy rule/set.
Array [
nat_pool_id string
The ID of the the NAT pool used in policy rules and bound to interfaces.
port integer
The port range of the action in the NAT policy rule.
protocols string[]
The protocol of the action for the NAT policy rule. Supports max 4 protocols.
type stringrequired
Possible values: [NO_NAT, SOURCE_NAT_DYNAMIC, SOURCE_NAT_STATIC, DESTINATION_NAT_DYNAMIC, DESTINATION_NAT_STATIC, ALG_DISABLE]
The type of action for NAT policy.
]
description

The description of the NAT policy rule/set. Max size = 256.

destination_ports PortRange[]
The start and end port for Port Ranges. A maximum of 16 port ranges is allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
destination_prefixes BasePolicyPrefixS

Lists the details of the destination prefixes.

description

The description for the source/destination prefixes.

id string

The ID of the source/destination prefix.

ipv4_prefixes string[]

Lists the IP prefixes.

ipv6_prefixes string[]

Ipv6 Prefixes

name string

The name of the source/destination prefix.

tags string[]

A information field that can be added to identify the source/destination prefix.

destination_prefixes_id string

The ID of the destination prefix.

destination_zone NATPolicyZone

List the details of the destination zone.

default_for_public_interfaces boolean

The default source/destination zone for public interfaces.

description

The description for the source/destination zone. Max size = 128.

disabled boolean

Lists if the source/destination zone set is disabled.

disabled_reason string

Reason the source/destination zone is disabled.

id string

The ID of the source/destination zone.

inactive boolean

Lists if the source/destination zone is inactive.

inactive_reason string

Reason the source/destination zone is inactive.

name stringrequired

The name of the source/destination zone.

region string

The region of the site.

tags string[]

A information field that can be added to identify the source/destination zone.

destination_zone_id string

The ID of the destination zone. Destination zone is based on the direction of the traffic with respect to the ION device.

disabled boolean

Lists if the NAT policy rule/set is disabled.

disabled_reason string

Reason the NAT policy rule/set is disabled.

enabled boolean

Lists if the NAT policy rule/set is enabled.

id string

The ID of the policy rule/set.

inactive boolean

Lists if the NAT policy rule/set is inactive.

inactive_reason string

Reason the NAT policy rule/set is inactive.

name stringrequired

The name of the NAT policy rule/set.

natpolicypools NATPolicyPool[]
Lists the details of the NAT policy pools.
Array [
description
The description for the NAT policy pool. Max size = 256.
id string
The ID of the NAT policy pool.
name stringrequired
The name of the NAT policy pool. Max size = 128.
tags string[]
A information field that can be added to identify the NAT policy pool. Maximum 10 unique tags of length 1024 each are allowed.
]
policyset_id string

The ID of the NAT policy set. NAT policy sets contain policy rules and are a part of NAT policy set stacks.

protocol integer

The protocol for the NAT policy set. TCP or UDP.

region string

Region

source_ports PortRange[]
List the details of the source port range. A maximum of 16 port ranges are allowed, and port ranges can only be added for TCP or UDP protocols.
Array [
from integer
The start port of the destination/source port range.
to integer
The end port of the destination/source port range.
]
source_prefixes BasePolicyPrefixS

List the details of the source prefixes.

description

The description for the source/destination prefixes.

id string

The ID of the source/destination prefix.

ipv4_prefixes string[]

Lists the IP prefixes.

ipv6_prefixes string[]

Ipv6 Prefixes

name string

The name of the source/destination prefix.

tags string[]

A information field that can be added to identify the source/destination prefix.

source_prefixes_id string

The ID of the source prefixes.

source_zone NATPolicyZone

Lists the details of the source zone used in policy rules and bound to interfaces.

default_for_public_interfaces boolean

The default source/destination zone for public interfaces.

description

The description for the source/destination zone. Max size = 128.

disabled boolean

Lists if the source/destination zone set is disabled.

disabled_reason string

Reason the source/destination zone is disabled.

id string

The ID of the source/destination zone.

inactive boolean

Lists if the source/destination zone is inactive.

inactive_reason string

Reason the source/destination zone is inactive.

name stringrequired

The name of the source/destination zone.

region string

The region of the site.

tags string[]

A information field that can be added to identify the source/destination zone.

source_zone_id string

The ID of the NAT policy source zone. Source zones identify traffic that is sourced from a zone.

tags string[]

A information field that can be added to identify the NAT policy rule/set. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "actions": [
    {
      "nat_pool_id": "string",
      "port": 0,
      "protocols": [
        "string"
      ],
      "type": "NO_NAT"
    }
  ],
  "destination_ports": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "destination_prefixes": {
    "id": "string",
    "ipv4_prefixes": [
      "string"
    ],
    "ipv6_prefixes": [
      "string"
    ],
    "name": "string",
    "tags": [
      "string"
    ]
  },
  "destination_prefixes_id": "string",
  "destination_zone": {
    "default_for_public_interfaces": true,
    "disabled": true,
    "disabled_reason": "string",
    "id": "string",
    "inactive": true,
    "inactive_reason": "string",
    "name": "string",
    "region": "string",
    "tags": [
      "string"
    ]
  },
  "destination_zone_id": "string",
  "disabled": true,
  "disabled_reason": "string",
  "enabled": true,
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "name": "string",
  "natpolicypools": [
    {
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "policyset_id": "string",
  "protocol": 0,
  "region": "string",
  "source_ports": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "source_prefixes": {
    "id": "string",
    "ipv4_prefixes": [
      "string"
    ],
    "ipv6_prefixes": [
      "string"
    ],
    "name": "string",
    "tags": [
      "string"
    ]
  },
  "source_prefixes_id": "string",
  "source_zone": {
    "default_for_public_interfaces": true,
    "disabled": true,
    "disabled_reason": "string",
    "id": "string",
    "inactive": true,
    "inactive_reason": "string",
    "name": "string",
    "region": "string",
    "tags": [
      "string"
    ]
  },
  "source_zone_id": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_DUPLICATE_KEY"
      },
      {
        "code": "NAT_POLICY_SET_NOT_PRESENT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "NAT_POLICY_RULE_INVALID"
      },
      {
        "code": "NAT_POLICY_RULE_NAME_REQD"
      },
      {
        "code": "NAT_POLICY_RULE_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "NAT_POLICY_RULE_DESCRIPTION_EXCEEDS_LIMIT"
      },
      {
        "code": "NAT_RULE_INVALID_PROTOCOL"
      },
      {
        "code": "NAT_RULE_SOURCE_PORTS_EXCEEDS_LIMIT"
      },
      {
        "code": "NAT_RULE_INVALID_SOURCE_ZONE_ID"
      },
      {
        "code": "NAT_RULE_INVALID_DESTINATION_ZONE_ID"
      },
      {
        "code": "NAT_RULE_INVALID_DESTINATION_PREFIXES_ID"
      },
      {
        "code": "NAT_RULE_DESTINATION_PORTS_EXCEEDS_LIMIT"
      },
      {
        "code": "NAT_RULE_ACTIONS_MISSING"
      },
      {
        "code": "NAT_RULE_INVALID_SOURCE_PREFIXES_ID"
      },
      {
        "code": "NAT_RULE_INVALID_ACTION_LIMIT"
      }
    ]
  }
}

Loading...