cisco.nxos.nxos_snapshot_module.rst

cisco.nxos.nxos_snapshot

Manage snapshots of the running states of selected features.

Version added: 1.0.0

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

Synopsis

• Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots.

Parameters

Parameter	Choices/Defaults	Comments
action string / required	Choices: add compare create delete delete_all	Define what snapshot action the module would perform.
compare_option string	Choices: summary ipv4routes ipv6routes	Snapshot options to be used when action=compare.
comparison_results_file string		Name of the file where snapshots comparison will be stored when action=compare.
description string		Snapshot description to be used when action=create.
element_key1 string		Specify the tags used to distinguish among row entries, to be used when action=add.
element_key2 string		Specify the tags used to distinguish among row entries, to be used when action=add.
path string	Default: "./"	Specify the path of the file where new created snapshot or snapshots comparison will be stored, to be used when action=create and save_snapshot_locally=true or action=compare.
row_id string		Specifies the tag of each row entry of the show command's XML output, to be used when action=add.
save_snapshot_locally boolean	Choices: no ← yes	Specify to locally store a new created snapshot, to be used when action=create.
section string		Used to name the show command output, to be used when action=add.
show_command string		Specify a new show command, to be used when action=add.
snapshot1 string		First snapshot to be used when action=compare.
snapshot2 string		Second snapshot to be used when action=compare.
snapshot_name string		Snapshot name, to be used when action=create or action=delete.

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• transport=cli may cause timeout errors.
• The element_key1 and element_key2 parameter specify the tags used to distinguish among row entries. In most cases, only the element_key1 parameter needs to specified to be able to distinguish among row entries.
• action=compare will always store a comparison report on a local file.
• 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

# Create a snapshot and store it locally
- cisco.nxos.nxos_snapshot:
    action: create
    snapshot_name: test_snapshot
    description: Done with Ansible
    save_snapshot_locally: true
    path: /home/user/snapshots/

# Delete a snapshot
- cisco.nxos.nxos_snapshot:
    action: delete
    snapshot_name: test_snapshot

# Delete all existing snapshots
- cisco.nxos.nxos_snapshot:
    action: delete_all

# Add a show command for snapshots creation
- cisco.nxos.nxos_snapshot:
    section: myshow
    show_command: show ip interface brief
    row_id: ROW_intf
    element_key1: intf-name

# Compare two snapshots
- cisco.nxos.nxos_snapshot:
    action: compare
    snapshot1: pre_snapshot
    snapshot2: post_snapshot
    comparison_results_file: compare_snapshots.txt
    compare_option: summary
    path: ../snapshot_reports/

Return Values

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

Key	Returned	Description
commands list	verbose mode	commands sent to the device Sample: ['snapshot create post_snapshot Post-snapshot']

Status

Authors

• Gabriele Gerbino (@GGabriele)