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

NX-OS 9.3(x)

Cisco Nexus 3000 and 9000 Series NX-API REST Documentation

Rollback to Checkpoint File

DME

Copy
POST http://<mgmt0_IP>/api/mo/sys/action.json
{
    "actionLSubj": {
        "attributes": {
            "dn": "sys/action/lsubj-[sys]"
        }
        "children" : [{
            "topSystemRollbackLTask": {
                "attributes": {
                        "adminSt": "start",
                        "name": "abcd",
                        "uri": "",
                        "dn": "sys/action/lsubj-[sys]/topSystemRollbackLTask",
                        "freq": "one-shot"
                }
            }
       }]
    }
}
Response

{
    "imdata":[]
}

Configuring Rollbacks

Rollback to Checkpoint File

CLI Commands

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

rollback running-config checkpoint abcd

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

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.

topSystemRollbackLTask Properties

The following table contains information about the topSystemRollbackLTask 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	string:Basic	The name of the object.	RANGE: Min: "0" Max: "512"
uri	string:Basic	The generated path for the data export destination.	RANGE: Min: "0" Max: "512"
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

Rollback to Config File on Bootflash

CLI Commands

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

rollback running-config file 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

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

Rollback to Config File on Volatile

CLI Commands

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

rollback running-config file volatile:ckp

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

Rollback to Config File on Bootflash with Verbose Option

Note: All the rollback examples can be run with verbose option by setting “verbose”: “verbose” in the attributes section of the payloads.

CLI Commands

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

rollback running-config file bootflash:ckp2 verbose

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

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

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.

topSystemRollbackLTask 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)
uri	string:Basic	The generated path for the data export destination.	RANGE: Min: "0" Max: "512"
verbose	string:Basic	NO COMMENTS	RANGE: Min: "0" Max: "512"
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

Rollback to Config File on Bootflash with Stop-At-First-Failure Option

CLI Commands

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

rollback running-config file bootflash:ckp1 stop-at-first-failure

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

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

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.

topSystemRollbackLTask 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)
uri	string:Basic	The generated path for the data export destination.	RANGE: Min: "0" Max: "512"
mode	infra:rollbackmode scalar:Enum8	The BGP Domain mode.	SELECTION: 1 - best-effort 2 - stop-at-first-failure 3 - atomic DEFAULT: atomic(3)
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

Rollback to Config File on Bootflash with Best-Effort Option

CLI Commands

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

rollback running-config file bootflash:ckp1 best-effort

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

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

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.

topSystemRollbackLTask 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)
uri	string:Basic	The generated path for the data export destination.	RANGE: Min: "0" Max: "512"
mode	infra:rollbackmode scalar:Enum8	The BGP Domain mode.	SELECTION: 1 - best-effort 2 - stop-at-first-failure 3 - atomic DEFAULT: atomic(3)
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

Rollback to Config File on Bootflash with Atomic Option

CLI Commands

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

rollback running-config file bootflash:ckp1 atmomic

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

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

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.

topSystemRollbackLTask 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)
uri	string:Basic	The generated path for the data export destination.	RANGE: Min: "0" Max: "512"
mode	infra:rollbackmode scalar:Enum8	The BGP Domain mode.	SELECTION: 1 - best-effort 2 - stop-at-first-failure 3 - atomic DEFAULT: atomic(3)
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