Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Clear All Checkpoint Databases
DME
Copy
POST http://<mgmt0_IP>/api/mo/sys/action.json

{
                "actionLSubj": {
                    "attributes": {
                        "dn": "sys/action/lsubj-[sys]"
                    }
                    "children" : [{
                        "topSystemClearCheckpointDBLTask": {
                            "attributes": {
                                    "adminSt": "start",
                                    "mode": "all",
                                    "dn": "sys/action/lsubj-[sys]/topSystemClearCheckpointDBLTask",
                                    "freq": "one-shot"
                            }
                        }
                    }]
                }
            }

Response

{	
    "imdata":[]
}

Clearing Checkpoints

Clearing All Checkpoint Databases

Clear All Checkpoint Databases


CLI Commands

The CLI commands are equivalent to the payload examples displayed in the pane on the right.

clear checkpoint database

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
actionLSubj sys/action/lsubj-{[oDn]}
topSystemClearCheckpointDBLTask sys/action/lsubj-{[oDn]}/topSystemClearCheckpointDBLTask


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
dn
reference:BinRef		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


topSystemClearCheckpointDBLTask Properties

The following table contains information about the topSystemClearCheckpointDBLTask 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)
    • mode
    infra:clearmode
    scalar:Enum8    		The BGP Domain mode.SELECTION:
  • 1 - all
  • 2 - user
  • 3 - system
  • DEFAULT: all(1)
    • dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    freq
    action:Freq
    scalar:Time    		Frequency at which tasks are executedSELECTION:
  • 0ull - one-shot
  • 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

    Clearing the System Checkpoint Database

    Clearing the System Checkpoint Database


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    clear checkpoint database

    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
    actionLSubj sys/action/lsubj-{[oDn]}
    topSystemClearCheckpointDBLTask sys/action/lsubj-{[oDn]}/topSystemClearCheckpointDBLTask


    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
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


    topSystemClearCheckpointDBLTask Properties

    The following table contains information about the topSystemClearCheckpointDBLTask 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)
    • mode
    infra:clearmode
    scalar:Enum8    		The BGP Domain mode.SELECTION:
  • 1 - all
  • 2 - user
  • 3 - system
  • DEFAULT: all(1)
    • dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    freq
    action:Freq
    scalar:Time    		Frequency at which tasks are executedSELECTION:
  • 0ull - one-shot
  • 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

    Clearing the System Checkpoint Database

    Clearing the System Checkpoint Database


    CLI Commands

    The CLI commands are equivalent to the payload examples displayed in the pane on the right.

    clear checkpoint database

    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
    actionLSubj sys/action/lsubj-{[oDn]}
    topSystemClearCheckpointDBLTask sys/action/lsubj-{[oDn]}/topSystemClearCheckpointDBLTask


    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
    dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.


    topSystemClearCheckpointDBLTask Properties

    The following table contains information about the topSystemClearCheckpointDBLTask 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)
    • mode
    infra:clearmode
    scalar:Enum8    		The BGP Domain mode.SELECTION:
  • 1 - all
  • 2 - user
  • 3 - system
  • DEFAULT: all(1)
    • dn
    reference:BinRef    		A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.
    freq
    action:Freq
    scalar:Time    		Frequency at which tasks are executedSELECTION:
  • 0ull - one-shot
  • 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

    Next