cisco.nxos.nxos_rollback_module.rst

cisco.nxos.nxos_rollback

Set a checkpoint or rollback to a checkpoint.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches.

Parameters

Parameter	Choices/Defaults	Comments
checkpoint_file string		Name of checkpoint file to create. Mutually exclusive with rollback_to.
rollback_to string		Name of checkpoint file to rollback to. Mutually exclusive with checkpoint_file.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• Sometimes transport=nxapi may cause a timeout error.
• For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
• For more information on using Ansible to manage Cisco devices see the Cisco integration page.

Examples

- cisco.nxos.nxos_rollback:
    checkpoint_file: backup.cfg
    username: '{{ un }}'
    password: '{{ pwd }}'
    host: '{{ inventory_hostname }}'
- cisco.nxos.nxos_rollback:
    rollback_to: backup.cfg
    username: '{{ un }}'
    password: '{{ pwd }}'
    host: '{{ inventory_hostname }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
filename string	success	The filename of the checkpoint/rollback file. Sample: backup.cfg
status string	success	Which operation took place and whether it was successful. Sample: rollback executed

Status

Authors

• Jason Edelman (@jedelman8)
• Gabriele Gerbino (@GGabriele)