Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Querying NAT ITD
DME
Copy
GET http://<IP_Address>/api/mo/sys/action.json?rsp-subtree=full    

Response
{
    "totalCount": "1",
    "imdata": [
        {
            "actionLCont": {
                "attributes": {
                    "childAction": "",
                    "dn": "sys/action",
                    "modTs": "2019-02-01T05:17:36.505+00:00",
                    "persistentOnReload": "true",
                    "status": ""
                },
                "children": [
                    {
                        "actionLSubj": {
                            "attributes": {
                                "childAction": "",
                                "modTs": "2019-03-15T10:46:16.575+00:00",
                                "oCl": "unspecified",
                                "oDn": "sys/nat",
                                "persistentOnReload": "true",
                                "rn": "lsubj-[sys/nat]",
                                "status": ""
                            },
                            "children": [
                                {
                                    "natInstNatItdConfigRslt": {
                                        "attributes": {
                                            "ack": "no",
                                            "childAction": "",
                                            "descr": "",
                                            "endTs": "2019-03-18T06:06:48.605+00:00",
                                            "modTs": "never",
                                            "operSt": "completed",
                                            "peerClassId": "natInstNatItdConfigLTask",
                                            "persistentOnReload": "true",
                                            "qual": "",
                                            "rSz": "100",
                                            "rTm": "00:00:00:00.000",
                                            "rn": "natInstNatItdConfigRslt",
                                            "startTs": "2019-03-18T06:06:48.597+00:00",
                                            "status": "",
                                            "type": "clear"
                                        }
                                    }
                                },
                                {
                                    "natInstNatItdConfigLTask": {
                                        "attributes": {
                                            "aclName": "test_itd_vip_1_bucket_3",
                                            "adminSt": "unknown",
                                            "all": "disabled",
                                            "childAction": "",
                                            "descr": "",
                                            "freq": "one-shot",
                                            "modTs": "2019-03-18T06:06:48.605+00:00",
                                            "peerClassId": "natInstNatItdConfigRslt",
                                            "persistentOnReload": "true",
                                            "rSz": "100",
                                            "rTm": "00:00:00:00.000",
                                            "rn": "natInstNatItdConfigLTask",
                                            "startTs": "2019-03-18T06:06:48.597+00:00",
                                            "status": "",
                                            "type": "clear"
                                        }
                                    }
                                },
                                {
                                    "natInstIpNatTranslationLTask": {
                                        "attributes": {
                                            "adminSt": "unknown",
                                            "all": "enabled",
                                            "childAction": "",
                                            "descr": "",
                                            "entryId": "0",
                                            "freq": "one-shot",
                                            "modTs": "2019-03-15T10:46:16.583+00:00",
                                            "peerClassId": "natInstIpNatTranslationRslt",
                                            "persistentOnReload": "true",
                                            "rSz": "100",
                                            "rTm": "00:00:00:00.000",
                                            "rn": "natInstIpNatTranslationLTask",
                                            "startTs": "2019-03-15T10:46:16.581+00:00",
                                            "status": "",
                                            "type": "clear"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

Querying NAT ITD

Querying NAT ITD

Note: This example was added in Cisco NX-OS Release 9.3(3).

CLI Output
Switch(config-itd)# show nat itd
        ACL (Bucket_List)           Global_IP(Node_IP):Port    Local_IP(Virtual_
IP):Port    Protocol
-----------------------------------+--------------------------+-----------------
-----------+----------
test_itd_vip_1_bucket_1                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_2                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_4                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_5                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_6                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_7                    1.1.1.1:0                 100.1.1.1:0
                 IP
test_itd_vip_1_bucket_8                    1.1.1.1:0                 100.1.1.1:0
                 IP

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


actionLCont Properties

The following table contains information about the actionLCont 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
childAction
mo:ModificationChildAction
scalar:Bitmask32		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    actionLSubj Properties

    The following table contains information about the actionLSubj 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
    childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • modTsmo:TStamp
    (scalar:Date)    		The time when this object was last modified.SELECTION:
    0 - never
    DEFAULT: never
    oClmo:MoClassId
    		Target Object's subject Class id
    oDnreference:BinRef
    		Target Object's Subject DN
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    statusmo:ModificationStatus
    (scalar:Bitmask32)    		The upgrade status. This property is for internal use only.SELECTION:
    2 - created
    4 - modified
    8 - deleted
    16 - replaced


    natInstNatItdConfigRslt Properties

    The following table contains information about the natInstNatItdConfigRslt 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
    ack
    scalar:Bool    		The acknowledgement status of the fault. If a fault is acknowledged and cleared, it is immediately deleted. If a fault is not acknowledged and cleared, it is deleted after the retention interval.SELECTION:
  • false - no
  • true - yes
  • DEFAULT: no(false)
    • childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descr
    action:Descr
    string:Basic    		 RANGE: Min: "0" Max: "128"
    endTs
    mo:TStamp
    scalar:Date    		The date and time when the task ended.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • modTs
    mo:TStamp
    scalar:Date    		The time when this object was last modified.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • operSt
    action:OperSt
    scalar:Enum8    		The runtime state of the object or policy.SELECTION:
  • 0 - scheduled
  • 1 - processing
  • 2 - completed
  • 3 - cancelled
  • 4 - failed
  • 5 - indeterminate
  • 6 - suspended
  • 7 - crashsuspect
  • DEFAULT: scheduled(0)
    • peerClassId
    mo:MoClassId    		The BGP neighbor.DEFAULT: natInstNatItdConfigLTask
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • qual
    action:Qual
    string:Basic    		The qualifier for the component status. RANGE: Min: "0" Max: "512"
    rSz
    action:RetentionSize
    scalar:Uint16    		The retention size of the task results. RANGE: Min: 1 Max: 1024
  • DEFAULT: 100
    • rTm
    action:RetentionTime
    scalar:Time    		The retention time of the task results.
    rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    startTs
    mo:TStamp
    scalar:Date    		The date and time when the task began.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • status
    mo:ModificationStatus
    scalar:Bitmask32    		The upgrade status. This property is for internal use only.SELECTION:
  • 16u - replaced
  • 2u - created
  • 4u - modified
  • 8u - deleted
  • DEFAULT: 0
    • type
    action:Type
    scalar:Enum8    		The specific type of the object or component.SELECTION:
  • 1 - clear
  • 2 - reset
  • 3 - reload
  • 4 - locate
  • 5 - install
  • 6 - test
  • 7 - collect
  • 8 - interface-in-service
  • DEFAULT: clear(1)


    • natInstIpNatTranslationLTask Properties

    The following table contains information about the natInstIpNatTranslationLTask 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
    adminSt
    action:AdminSt
    scalar:Enum8    		The administrative state of the object or policy.SELECTION:
  • 0 - unknown
  • 1 - start
  • 2 - stop
  • 3 - suspend
  • DEFAULT: unknown(0)
    • all
    nw:AdminSt
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 1 - enabled
  • 2 - disabled
  • DEFAULT: enabled(1)
    • childAction
    mo:ModificationChildAction
    scalar:Bitmask32    		Delete or ignore. For internal use only.SELECTION:
  • 16384u - deleteAll
  • 4096u - ignore
  • 8192u - deleteNonPresent
  • DEFAULT: 0
    • descr
    action:Descr
    string:Basic    		 RANGE: Min: "0" Max: "128"
    entryId
    scalar:Uint32    		NO COMMENTS
    freq
    action:Freq
    scalar:Time    		Frequency at which tasks are executedSELECTION:
  • 0ull - one-shot
  • DEFAULT: 0
    • modTs
    mo:TStamp
    scalar:Date    		The time when this object was last modified.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • peerClassId
    mo:MoClassId    		The BGP neighbor.DEFAULT: natInstIpNatTranslationLTask
    persistentOnReload
    mo:Persistent
    scalar:Enum8    		NO COMMENTSSELECTION:
  • 0 - false
  • 1 - true
  • DEFAULT: true(1)
    • rSz
    action:RetentionSize
    scalar:Uint16    		The retention size of the task results. RANGE: Min: 1 Max: 1024
  • DEFAULT: 100
    • rTm
    action:RetentionTime
    scalar:Time    		The retention time of the task results.
    rn
    reference:BinRN    		Identifies an object from its siblings within the context of its parent object. The distinguished name contains a sequence of relative names.
    startTs
    mo:TStamp
    scalar:Date    		The date and time when the task began.SELECTION:
  • 0ull - never
  • DEFAULT: never(0ull)
    • status
    mo:ModificationStatus
    scalar:Bitmask32    		The upgrade status. This property is for internal use only.SELECTION:
  • 16u - replaced
  • 2u - created
  • 4u - modified
  • 8u - deleted
  • DEFAULT: 0
    • type
    action:Type
    scalar:Enum8    		The specific type of the object or component.SELECTION:
  • 1 - clear
  • 2 - reset
  • 3 - reload
  • 4 - locate
  • 5 - install
  • 6 - test
  • 7 - collect
  • 8 - interface-in-service
  • DEFAULT: clear(1)


    • 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

    Next