Configuring Network Address Translation (NAT)

Enable Network Address Translation (NAT)

Network Address Translation (NAT) enables private IP internetworks that use nonregistered IP addresses to connect to the Internet. NAT operates on a device, usually connecting two networks, and translates private (not globally unique) IP addresses in the internal network into legal IP addresses before packets are forwarded to another network.

Before you can use the NX-API REST NAT configuration APIs, you must enable NAT on the switch.

Follow these steps to enable NAT.

  1. Enter global configuration mode:

    config t

  2. Enable the NAT feature:

    switch(config)# feature nat

NAT configuration mode is now active. You can now issue NX-API REST NAT configuration calls.

Configuring tcp-timeout for NAT Translation Table

Configuring tcp-timeout for NAT Translation Table
POST http://<mgmt0_ip>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "tcpTimeout": "100"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <tcpTimeout>100</tcpTimeout>
    </inst-items>
  </nat-items>
</System>


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat translation tcp-timeout 100

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
tcpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT tcp timeout values
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring udp-timeout for NAT Translation Table

Configuring udp-timeout for NAT Translation Table
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "udpTimeout": "101"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <udpTimeout>101</udpTimeout>
    </inst-items>
  </nat-items>
</System>

Configures udp-timeout for a NAT translation table.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat translation udp-timeout 101

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
udpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT udp timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Timeout for NAT Translation Table

Configuring Timeout for NAT Translation Table
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "timeout": "102"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <timeout>102</timeout>
    </inst-items>
  </nat-items>
</System>

Configures timeout for NAT translation table.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat translation timeout 102

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
timeoutnat:NatTimeout
(scalar:Uint32)
NAT timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Maximum Size of NAT Table for All Hosts

Configuring Maximum Size of NAT Table for All Hosts
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "allhost": "103"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <allhost>103</allhost>
    </inst-items>
  </nat-items>
</System>

Configures the maximum size of NAT the table for all hosts.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat translation max-entries all-host 103

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
allhostnat:NatMaxTranslationAllHost
(scalar:Uint32)
NAT max translations all host
RANGE: [0 , 1023]
DEFAULT: 0


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Maximum Size of NAT Table

Configuring Maximum Size of NAT Table
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "maxtranslation": "104"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <maxtranslation>104</maxtranslation>
    </inst-items>
  </nat-items>
</System>

Configures the maximum size of the NAT table.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat translation max-entries 104

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
maxtranslationnat:NatMaxTranslation
(scalar:Uint32)
NAT max translations
RANGE: [1 , 1023]
DEFAULT: 80


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Creating a NAT Pool with Network Mask

Creating a NAT Pool with Network Mask
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natPool": {
          "attributes": {
            "mask": "255.0.255.0",
            "poolname": "pool5"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list>
          <poolname>pool5</poolname>
          <mask>255.0.255.0</mask>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Creates a NAT pool with a network mask.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat pool pool5 netmask 255.0.255.0

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natPool sys/nat/inst/pool-{poolname}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
maskaddress:Ip
NAT netmask for pool-range Value must match ipv4 or ipv6 known format
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a NAT Pool with Network Mask

Deleting a NAT Pool with Network Mask
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natPool": {
          "attributes": {
            "poolname": "pool5",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list xc:operation="delete">
          <poolname>pool5</poolname>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Deletes a NAT pool with a network mask.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

no ip nat pool pool5 netmask 255.0.255.0

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natPool sys/nat/inst/pool-{poolname}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Creating a NAT Pool with Prefix Length

Creating a NAT Pool with Prefix Length
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natPool": {
          "attributes": {
            "poolname": "pool5",
            "prefixlen": "24"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list xc:operation="delete">
          <poolname>pool5</poolname>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Creates a NAT pool with a prefix length.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat pool pool5 prefix-length 24

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natPool sys/nat/inst/pool-{poolname}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63
prefixlennat:NatPrefixType
(scalar:Uint32)
NAT prefix len for pool-range
RANGE: [0 , 32]
DEFAULT: 0


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a NAT Pool with Prefix Length

Deleting a NAT Pool with Prefix Length
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natPool": {
          "attributes": {
            "poolname": "pool5",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list xc:operation="delete">
          <poolname>pool5</poolname>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Deletes a NAT pool with a prefix length.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

no ip nat pool pool5 prefix-length 24

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natPool sys/nat/inst/pool-{poolname}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Creating a NAT Pool with Network Mask

Creating a NAT Pool with Network Mask
POST http://<mgmt0_IP>/api/mo/sys/nat/inst/pool-pool5.json
{
  "natPool": {
    "attributes": {
      "mask": "255.0.255.0",
      "poolname": "pool5"
    },
    "children": [
      {
        "natPoolAddress": {
          "attributes": {
            "endip": "20.1.1.5",
            "startip": "20.1.1.1"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list>
          <poolname>pool5</poolname>
          <mask>255.0.255.0</mask>
          <startip-items>
            <PoolAddress-list>
              <startip>20.1.1.1</startip>
              <endip>20.1.1.5</endip>
            </PoolAddress-list>
          </startip-items>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Creates a NAT pool with a network mask.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat pool pool5 20.1.1.1 20.1.1.5 netmask 255.0.255.0

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natPool sys/nat/inst/pool-{poolname}
natPoolAddress sys/nat/inst/pool-{poolname}/startip-{[startip]}-endip-{[endip]}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
maskaddress:Ip
NAT netmask for pool-range Value must match ipv4 or ipv6 known format
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63


natPoolAddress Properties

The following table contains information about the natPoolAddress properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
endipaddress:Ip
NAT end ip address for pool-rangeValue must match ipv4 or ipv6 known format
startipaddress:Ip
NAT start ip address for pool-rangeValue must match ipv4 or ipv6 known format


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a NAT Pool with Network Mask

Deleting a NAT Pool with Network Mask
POST http://<mgmt0_IP>/api/mo/sys/nat/inst/pool-pool5.json
{
"natPool": {
  "attributes": {
    "poolname": "pool5"
  },
  "children": [
    {
      "natPoolAddress": {
        "attributes": {
          "endip": "20.1.1.5",
          "startip": "20.1.1.1",
          "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
 <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list>
          <poolname>pool5</poolname>
          <startip-items>
            <PoolAddress-list xc:operation="delete">
              <startip>20.1.1.1</startip>
              <endip>20.1.1.5</endip>
            </PoolAddress-list>
          </startip-items>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Deletes a NAT pool with a network mask.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

no ip nat pool pool5 20.1.1.1 20.1.1.5 netmask 255.0.255.0

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natPool sys/nat/inst/pool-{poolname}
natPoolAddress sys/nat/inst/pool-{poolname}/startip-{[startip]}-endip-{[endip]}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63


natPoolAddress Properties

The following table contains information about the natPoolAddress properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
endipaddress:Ip
NAT end ip address for pool-rangeValue must match ipv4 or ipv6 known format
startipaddress:Ip
NAT start ip address for pool-rangeValue must match ipv4 or ipv6 known format
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Creating NAT Pool with Prefix Length

Creating a NAT Pool with Prefix Length
POST http://<mgmt0_IP>/api/mo/sys/nat/inst/pool-pool5.json
{
  "natPool": {
    "attributes": {
      "poolname": "pool5",
      "prefixlen": "3"
    },
    "children": [
      {
        "natPoolAddress": {
          "attributes": {
            "endip": "20.1.1.5",
            "startip": "20.1.1.1"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list>
          <poolname>pool5</poolname>
          <prefixlen>3</prefixlen>
          <startip-items>
            <PoolAddress-list>
              <startip>20.1.1.1</startip>
              <endip>20.1.1.5</endip>
            </PoolAddress-list>
          </startip-items>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Creates a NAT pool with a prefix length.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

ip nat pool pool5 20.1.1.1 20.1.1.5 prefix-length 3

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natPool sys/nat/inst/pool-{poolname}
natPoolAddress sys/nat/inst/pool-{poolname}/startip-{[startip]}-endip-{[endip]}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63
prefixlennat:NatPrefixType
(scalar:Uint32)
NAT prefix len for pool-range
RANGE: [0 , 32]
DEFAULT: 0


natPoolAddress Properties

The following table contains information about the natPoolAddress properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
endipaddress:Ip
NAT end ip address for pool-rangeValue must match ipv4 or ipv6 known format
startipaddress:Ip
NAT start ip address for pool-rangeValue must match ipv4 or ipv6 known format


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a NAT Pool with Prefix Length

Deleting a NAT Pool with Prefix Length
POST http://<mgmt0_IP>/api/mo/sys/nat/inst/pool-pool5.json
{
"natPool": {
  "attributes": {
    "poolname": "pool5"
  },
  "children": [
    {
      "natPoolAddress": {
        "attributes": {
          "endip": "20.1.1.5",
          "startip": "20.1.1.1",
          "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <pool-items>
        <Pool-list>
          <poolname>pool5</poolname>
          <startip-items>
            <PoolAddress-list xc:operation="delete">
              <startip>20.1.1.1</startip>
              <endip>20.1.1.5</endip>
            </PoolAddress-list>
          </startip-items>
        </Pool-list>
      </pool-items>
    </inst-items>
  </nat-items>
</System>

Deletes a NAT pool with a prefix length.


CLI Commands

The CLI commands and options listed below are the equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload or the YANG tab to view the XML payload.

no ip nat pool pool5 20.1.1.1 20.1.1.5 prefix-length 3

Note: The property information for this example was added in Release 9.3(3).


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natPool sys/nat/inst/pool-{poolname}
natPoolAddress sys/nat/inst/pool-{poolname}/startip-{[startip]}-endip-{[endip]}


natPool Properties

The following table contains information about the natPool properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
poolnamenat:NatPoolname
(string:Basic)
Defines set of address
MAX SIZE: 63


natPoolAddress Properties

The following table contains information about the natPoolAddress properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
endipaddress:Ip
NAT end ip address for pool-rangeValue must match ipv4 or ipv6 known format
startipaddress:Ip
NAT start ip address for pool-rangeValue must match ipv4 or ipv6 known format
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.SELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring A Static Rule For Inside Local Address (TCP)

Configuring A Static Rule For Inside Local Address (TCP)
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "inside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "addRoute": "yes",
                        "dynamic": "yes",
                        "globalIp": "1.2.3.4",
                        "globalPort": "60634",
                        "groupId": "746",
                        "localIp": "1.2.3.4",
                        "localPort": "60634",
                        "matchInVrf": "yes",
                        "noAlias": "yes",
                        "protocol": "tcp"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>inside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list>
                  <protocol>tcp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>60634</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>60634</globalPort>
                  <addRoute>true</addRoute>
                  <dynamic>true</dynamic>
                  <groupId>746</groupId>
                  <matchInVrf>true</matchInVrf>
                  <noAlias>true</noAlias>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat inside source static tcp 1.2.3.4 60634 1.2.3.4 60634 vrf SampleString_123 match-in-vrf group 746 dynamic no-alias add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
addRoutenat:booltype
(scalar:Bool)
Adds route for translationsSELECTION: true or false
DEFAULT: 0
dynamicnat:booltype
(scalar:Bool)
Dynamic flag for Twice-NatSELECTION: true or false
DEFAULT: 0
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
groupIdnat:twicenatgroup
(scalar:Uint32)
Group id for Twice-Nat
RANGE: [1 , 1024]
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
matchInVrfnat:booltype
(scalar:Bool)
Match in vrf, flag used in vrf-aware NatSELECTION: true or false
DEFAULT: 0
noAliasnat:booltype
(scalar:Bool)
no-alias flag disables addition of aliasSELECTION: true or false
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting A Static Rule For Inside Local Address (TCP)

Deleting A Static Rule For Inside Local Address (TCP)
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "inside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "globalIp": "1.2.3.4",
                        "globalPort": "60634",
                        "localIp": "1.2.3.4",
                        "localPort": "60634",
                        "protocol": "tcp",
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>inside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list xc:operation="delete">
                  <protocol>tcp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>60634</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>60634</globalPort>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat inside source static tcp 1.2.3.4 60634 1.2.3.4 60634 vrf SampleString_123 match-in-vrf group 746 dynamic no-alias add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-udp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 or ipv6 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 or ipv6 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring A Static Rule For Inside Local Address (UDP)

Configuring A Static Rule For Inside Local Address (UDP)  
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "inside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "addRoute": "yes",
                        "dynamic": "yes",
                        "globalIp": "1.2.3.4",
                        "globalPort": "60634",
                        "groupId": "746",
                        "localIp": "1.2.3.4",
                        "localPort": "60634",
                        "matchInVrf": "yes",
                        "noAlias": "yes",
                        "protocol": "udp"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>inside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list>
                  <protocol>udp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>60634</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>60634</globalPort>
                  <addRoute>true</addRoute>
                  <dynamic>true</dynamic>
                  <groupId>746</groupId>
                  <matchInVrf>true</matchInVrf>
                  <noAlias>true</noAlias>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat inside source static udp 1.2.3.4 60634 1.2.3.4 60634 vrf SampleString_123 match-in-vrf group 746 dynamic no-alias add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
addRoutenat:booltype
(scalar:Bool)
Adds route for translationsSELECTION: true or false
DEFAULT: 0
dynamicnat:booltype
(scalar:Bool)
Dynamic flag for Twice-NatSELECTION: true or false
DEFAULT: 0
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 or ipv6 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
groupIdnat:twicenatgroup
(scalar:Uint32)
Group id for Twice-Nat
RANGE: [1 , 1024]
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 or ipv6 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
matchInVrfnat:booltype
(scalar:Bool)
Match in vrf, flag used in vrf-aware NatSELECTION: true or false
DEFAULT: 0
noAliasnat:booltype
(scalar:Bool)
no-alias flag disables addition of aliasSELECTION: true or false
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting A Static Rule For Inside Local Address (UDP)

Deleting A Static Rule For Inside Local Addres (UDP)  
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "inside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "globalIp": "1.2.3.4",
                        "globalPort": "60634",
                        "localIp": "1.2.3.4",
                        "localPort": "60634",
                        "protocol": "udp",
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>inside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list xc:operation="delete">
                  <protocol>udp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>60634</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>60634</globalPort>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat inside source static udp 1.2.3.4 60634 1.2.3.4 60634 vrf SampleString_123 match-in-vrf group 746 dynamic no-alias add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static/protocol-udp-localip-[1.2.3.4]-localport-60634-globalip-[1.2.3.4]-globalport-60634


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 or ipv6 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 or ipv6 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring a Static Rule for Outside Global Address (TCP)

Configuring a Static Rule for Outside Global Address (TCP)
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "outside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "addRoute": "yes",
                        "dynamic": "yes",
                        "globalIp": "1.2.3.4",
                        "globalPort": "32741",
                        "groupId": "212",
                        "localIp": "1.2.3.4",
                        "localPort": "32741",
                        "matchInVrf": "yes",
                        "noAlias": "yes",
                        "protocol": "tcp"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>outside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list>
                  <protocol>tcp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>32741</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>32741</globalPort>
                  <addRoute>true</addRoute>
                  <dynamic>true</dynamic>
                  <groupId>212</groupId>
                  <matchInVrf>true</matchInVrf>
                  <noAlias>true</noAlias>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat outside source static tcp 1.2.3.4 32741 1.2.3.4 32741 vrf SampleString_123 match-in-vrf group 212 dynamic no-alias add-route add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-32741-globalip-[1.2.3.4]-globalport-32741


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
addRoutenat:booltype
(scalar:Bool)
Adds route for translationsSELECTION: true or false
DEFAULT: 0
dynamicnat:booltype
(scalar:Bool)
Dynamic flag for Twice-NatSELECTION: true or false
DEFAULT: 0
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 or ipv6 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
groupIdnat:twicenatgroup
(scalar:Uint32)
Group id for Twice-Nat
RANGE: [1 , 1024]
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 or ipv6 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
matchInVrfnat:booltype
(scalar:Bool)
Match in vrf, flag used in vrf-aware NatSELECTION: true or false
DEFAULT: 0
noAliasnat:booltype
(scalar:Bool)
no-alias flag disables addition of aliasSELECTION: true or false
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Static Rule for Outside Global Address (TCP)

Deleting a Static Rule for Outside Global Address (TCP) 
POST http://<mgmt0_IP>/api/mo/sys/nat/inst.json
{
  "natInst": {
    "children": [
      {
        "natDom": {
          "attributes": {
            "name": "SampleString_123"
          },
          "children": [
            {
              "natIpNat": {
                "attributes": {
                  "xlateType": "outside-source-static"
                },
                "children": [
                  {
                    "natStaticNat": {
                      "attributes": {
                        "globalIp": "1.2.3.4",
                        "globalPort": "32741",
                        "localIp": "1.2.3.4",
                        "localPort": "32741",
                        "protocol": "tcp",
                        "status": "deleted"
}}}]}}]}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <dom-items>
        <Dom-list>
          <name>SampleString_123</name>
          <xlate-items>
            <IpNat-list>
              <xlateType>outside-source-static</xlateType>
              <protocol-items>
                <StaticNat-list xc:operation="delete">
                  <protocol>tcp</protocol>
                  <localIp>1.2.3.4</localIp>
                  <localPort>32741</localPort>
                  <globalIp>1.2.3.4</globalIp>
                  <globalPort>32741</globalPort>
                </StaticNat-list>
              </protocol-items>
            </IpNat-list>
          </xlate-items>
        </Dom-list>
      </dom-items>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat outside source static tcp 1.2.3.4 32741 1.2.3.4 32741 vrf SampleString_123 match-in-vrf group 212 dynamic no-alias add-route add-route


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natDomsys/nat/inst/dom-SampleString_123
natInstsys/nat/inst
natIpNatsys/nat/inst/dom-SampleString_123/xlate-inside-source-static
natIpNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static
natStaticNatsys/nat/inst/dom-SampleString_123/xlate-outside-source-static/protocol-tcp-localip-[1.2.3.4]-localport-32741-globalip-[1.2.3.4]-globalport-32741


natDom Properties

The following table contains information about the natDom properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
name
naming:Name256
string:Basic
The name of the object. RANGE: Min: "1" Max: "128"


natIpNat Properties

The following table contains information about the natIpNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
xlateTypenat:InterfaceType
(scalar:Enum8)
Xlate type to define translationSELECTION:
0 - inside-source-static
1 - outside-source-static
2 - inside-source-dynamic
3 - outside-source-dynamic


natStaticNat Properties

The following table contains information about the natStaticNat properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
globalIpaddress:Ip
Global ip address of a networkValue must match ipv4 or ipv6 known format
globalPortnat:port
(scalar:Uint32)
Port number for global ip
RANGE: [0 , 65535]
DEFAULT: 0
localIpaddress:Ip
Local ip address of a networkValue must match ipv4 or ipv6 known format
localPortnat:port
(scalar:Uint32)
Port number for localip
RANGE: [0 , 65535]
DEFAULT: 0
protocolnat:ProtocolType
(scalar:Enum8)
Specifies tcp/udp/any protocolSELECTION:
0 - any
1 - tcp
2 - udp
DEFAULT: any
statusmo:ModificationStatus
(scalar:Bitmask32)
Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Translation Entries Creation Delay Due To Batching Before Program To TCAM

Configuring Translation Entries Creation Delay Due To Batching Before Program To TCAM
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "creationDelay": "250"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <creationDelay>250</creationDelay>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation creation-delay 250


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natEntity sys/nat


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
creationDelaynat:BatchTimeout
(scalar:Enum32)
Creation delay timeout for NATSELECTION:
0 - 0
250 - 250
500 - 500
750 - 750
1000 - 1000
DEFAULT: 1000


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Translation Entries Creation Delay Due To Batching Before Program To TCAM

Deleting Translation Entries Creation Delay Due To Batching Before Program To TCAM
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "creationDelay": "1000"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <creationDelay>1000</creationDelay>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation creation-delay 250


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natInst sys/nat/inst
natEntity sys/nat


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
creationDelaynat:BatchTimeout
(scalar:Enum32)
Creation delay timeout for NATSELECTION:
0 - 0
250 - 250
500 - 500
750 - 750
1000 - 1000
DEFAULT: 1000


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Sampling Timeout for NAT

Configuring Sampling Timeout for NAT
POST http://<mgmt0_IP>/api/mo/sys/nat.json
  
{
    "natEntity": {
        "children": [
            {
                "natInst": {
                    "attributes": {
                        "samplingTimeout": "1775"
                    }
                }
            }
        ]
    }
}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <samplingTimeout>1775</samplingTimeout>
    </inst-items>
  </nat-items>
</System>

Note:

  • This example is specifically for the Cisco Nexus 3000 platform.
  • This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation sampling-timeout 1775


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
samplingTimeoutnat:SamplingTimeout
(scalar:Uint32)
Sampling Timeout value
RANGE: [120 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Sampling Timeout for NAT

Deleting Sampling Timeout for NAT
POST http://<mgmt0_IP>/api/mo/sys/nat.json
  
{
    "natEntity": {
        "children": [
            {
                "natInst": {
                    "attributes": {
                        "samplingTimeout": "3600"
                    }
                }
            }
        ]
    }
}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <samplingTimeout>3600</samplingTimeout>
    </inst-items>
  </nat-items>
</System>

Note:

  • This example is specifically for the Cisco Nexus 3000 platform.
  • This example was added in Release 9.3(1)


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation sampling-timeout 1775


Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
samplingTimeoutnat:SamplingTimeout
(scalar:Uint32)
Sampling Timeout value
RANGE: [120 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Timeout for NAT ICMP Flows

 Configuring Timeout for NAT ICMP Flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "icmpTimeout": "66551"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <icmpTimeout>66551</icmpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation icmp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
icmpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT icmp timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Timeout for NAT ICMP Flows

 Deleting Timeout for NAT ICMP Flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "icmpTimeout": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <icmpTimeout>3600</icmpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation icmp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
icmpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT icmp timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Timeout for NAT TCP Flows

 Configuring Timeout for NAT TCP Flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "tcpTimeout": "66551"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <tcpTimeout>66551</tcpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation tcp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
tcpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT tcp timeout values
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Timeout for NAT TCP Flows

 Deleting Timeout for NAT TCP Flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "tcpTimeout": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <tcpTimeout>3600</tcpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation tcp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
tcpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT tcp timeout values
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring Timeout for NAT UDP Flows

 Configuring Timeout for NAT UDP Flows
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "udpTimeout": "66551"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <udpTimeout>66551</udpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation udp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
udpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT udp timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Timeout for NAT UDP Flows

 Deleting Timeout for NAT UDP Flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "udpTimeout": "3600"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <udpTimeout>3600</udpTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation udp-timeout 66551


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
udpTimeoutnat:NatTimeout
(scalar:Uint32)
NAT udp timeout value
RANGE: [60 , 172800]
DEFAULT: 3600


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Specifying FINRST Timeout for NAT TCP Flows

Specifying FINRST Timeout for NAT TCP Flows
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "finRstTimeout": "85545"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <finRstTimeout>85545</finRstTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation finrst-timeout 85545


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
finRstTimeoutnat:FinSynTimeout
(scalar:Sint32)
FIN or RST wait timeout
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting a Specified FINRST Timeout for NAT TCP flows

Deleting a Specified FINRST Timeout for NAT TCP flows 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "finRstTimeout": "60"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <finRstTimeout>60</finRstTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation finrst-timeout 85545


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
finRstTimeoutnat:FinSynTimeout
(scalar:Sint32)
FIN or RST wait timeout
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Specifying FINRST Timeout as NEVER

Specifying FINRST Timeout as NEVER 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "finRstTimeout": "never"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <finRstTimeout>-1</finRstTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation finrst-timeout never


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
finRstTimeoutnat:FinSynTimeout
(scalar:Sint32)
FIN or RST wait timeout
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting FINRST Timeout as NEVER

Deleting FINRST Timeout as NEVER 
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "finRstTimeout": "60"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <finRstTimeout>60</finRstTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation finrst-timeout never


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
finRstTimeoutnat:FinSynTimeout
(scalar:Sint32)
FIN or RST wait timeout
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Specifying Syn-Timeout for NAT TCP FLOWS

Specifying Syn-Timeout for NAT TCP FLOWS
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "synTimeout": "85545"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <synTimeout>85545</synTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

ip nat translation syn-timeout 85545


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
synTimeoutnat:FinSynTimeout
(scalar:Sint32)
SYN wait timeout value
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting Specified Syn-Timeout for NAT TCP FLOWS

Deleting Specified Syn-Timeout for NAT TCP FLOWS
POST http://<mgmt0_IP>/api/mo/sys/nat.json
{
  "natEntity": {
    "children": [
      {
        "natInst": {
          "attributes": {
            "synTimeout": "60"
}}}]}}
{
    imdata:[]
}
<System>
  <nat-items>
    <inst-items>
      <synTimeout>60</synTimeout>
    </inst-items>
  </nat-items>
</System>

Note: This example was added in Release 9.3(1).


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.

no ip nat translation syn-timeout 85545


Verifying a DME Configuration

The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.

MODN
natEntity sys/nat
natInst sys/nat/inst


natInst Properties

The following table contains information about the natInst properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.

Property NameData TypeDescriptionValues
synTimeoutnat:FinSynTimeout
(scalar:Sint32)
SYN wait timeout value
RANGE: [-1 , 172800]
DEFAULT: 60


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:

https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/

For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html