Cisco Nexus 3000 and 9000 Series NX-API REST SDK API, Release 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Creating a Checkpoint to a File

DME

Copy
POST http://<mgmt0_IP>/api/mo/sys/action.json
{
                "actionLSubj": {
                    "attributes": {
                        "dn": "sys/action/lsubj-[sys]"
                    }
                    "children" : [{
                        "topSystemCreateCheckpointLTask": {
                            "attributes": {
                                    "adminSt": "start",
                                    "name": "xyz",
                                    "description": "",
                                    "filename": "",
                                    "delete": "no",
                                    "dn": "sys/action/lsubj-[sys]/topSystemCreateCheckpointLTask",
                                    "freq": "one-shot"
                            }
                        }
                    }]
                }
            }


Response

{
"imdata":[]
}

Creating Checkpoints

Creating a Checkpoint to a File

CLI Commands

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

checkpoint xyz

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.

MO	DN
actionLSubj	sys/action/lsubj-{[oDn]}
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

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

topSystemCreateCheckpointLTask Properties

The following table contains information about the topSystemCreateCheckpointLTask 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 Name	Data Type	Description	Values
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)
name	infra:checkpointStr string:Basic	The name of the object.	RANGE: Min: "0" Max: "79"
description	infra:checkpointStr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "79"
filename	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
delete	infra:deletemode scalar:Enum8	NO COMMENTS	SELECTION: 1 - yes 2 - no DEFAULT: no(2)
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 executed	SELECTION: 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

Creating a Checkpoint to a Bootflash File

CLI Commands

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

checkpoint bootflash:ckp1

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

MO	DN
actionLSubj	sys/action/lsubj-{[oDn]}
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

actionLSubj Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

topSystemCreateCheckpointLTask Properties

Property Name	Data Type	Description	Values
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)
name	infra:checkpointStr string:Basic	The name of the object.	RANGE: Min: "0" Max: "79"
description	infra:checkpointStr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "79"
filename	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
delete	infra:deletemode scalar:Enum8	NO COMMENTS	SELECTION: 1 - yes 2 - no DEFAULT: no(2)
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 executed	SELECTION: 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

Creating a Checkpoint to a Volatile File

CLI Commands

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

checkpoint volatile:ckp2

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

MO	DN
actionLSubj	sys/action/lsubj-{[oDn]}
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

actionLSubj Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

topSystemCreateCheckpointLTask Properties

Property Name	Data Type	Description	Values
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)
name	infra:checkpointStr string:Basic	The name of the object.	RANGE: Min: "0" Max: "79"
description	infra:checkpointStr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "79"
filename	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
delete	infra:deletemode scalar:Enum8	NO COMMENTS	SELECTION: 1 - yes 2 - no DEFAULT: no(2)
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 executed	SELECTION: 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

Creating a Checkpoint

CLI Commands

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

checkpoint

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

MO	DN
actionLSubj	sys/action/lsubj-{[oDn]}
topSystemCreateCheckpointLTask	sys/action/lsubj-{[oDn]}/topSystemCreateCheckpointLTask

actionLSubj Properties

Property Name	Data Type	Description	Values
dn	reference:BinRef	A tag or metadata is a non-hierarchical keyword or term assigned to the fabric module.

topSystemCreateCheckpointLTask Properties

Property Name	Data Type	Description	Values
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)
name	infra:checkpointStr string:Basic	The name of the object.	RANGE: Min: "0" Max: "79"
description	infra:checkpointStr string:Basic	The description of this configuration item.	RANGE: Min: "0" Max: "79"
filename	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
delete	infra:deletemode scalar:Enum8	NO COMMENTS	SELECTION: 1 - yes 2 - no DEFAULT: no(2)
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 executed	SELECTION: 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