cisco.nxos.nxos_snapshot 模块 – 管理所选功能的运行状态快照。

注意

此模块是 cisco.nxos 集合（版本 9.2.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.nxos。

要在 playbook 中使用它，请指定：cisco.nxos.nxos_snapshot。

cisco.nxos 1.0.0 中的新功能

概要 

创建所选功能的运行状态快照，添加新的 show 命令以进行快照创建，删除和比较现有快照。

参数 

参数	注释
action 字符串 / 必需	定义模块将执行的快照操作。选项 `"add"` `"compare"` `"create"` `"delete"` `"delete_all"`
compare_option 字符串	当 `action=compare` 时要使用的快照选项。选项 `"summary"` `"ipv4routes"` `"ipv6routes"`
comparison_results_file 字符串	当 `action=compare` 时，将存储快照比较的文件名。
description 字符串	当 `action=create` 时要使用的快照描述。
element_key1 字符串	指定用于区分行条目的标记，当 `action=add` 时使用。
element_key2 字符串	指定用于区分行条目的标记，当 `action=add` 时使用。
path 字符串	指定存储新创建的快照或快照比较的文件路径，当 `action=create` 且 `save_snapshot_locally=true` 或 `action=compare` 时使用。默认值： `"./"`
row_id 字符串	指定 show 命令 XML 输出中每行条目的标签，当 `action=add` 时使用。
save_snapshot_locally 布尔值	指定是否本地存储新创建的快照，当 `action=create` 时使用。选项 `false` ← (默认) `true`
section 字符串	用于命名 show 命令输出，当 `action=add` 时使用。
show_command 字符串	指定新的 show 命令，当 `action=add` 时使用。
snapshot1 字符串	当 `action=compare` 时要使用的第一个快照。
snapshot2 字符串	当 `action=compare` 时要使用的第二个快照。
snapshot_name 字符串	快照名称，当 `action=create` 或 `action=delete` 时使用。

说明 

注意

在 VIRL 上针对 NXOSv 7.3.(0)D1(1) 进行了测试
不支持 Cisco MDS
transport=cli 可能会导致超时错误。
element_key1 和 element_key2 参数指定用于区分行条目的标记。在大多数情况下，只需要指定 element_key1 参数即可区分行条目。
action=compare 将始终在本地文件中存储比较报告。
有关使用 CLI 和 NX-API 的信息，请参阅 :ref:`NXOS 平台选项指南 `
有关使用 Ansible 管理网络设备的更多信息，请参阅 :ref:`Ansible 网络指南 `
有关使用 Ansible 管理 Cisco 设备的更多信息，请参阅 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例 

# 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/

返回值 

常见返回值记录在此处，以下是此模块特有的字段

键	描述
commands 列表 / 元素=字符串	发送到设备的命令返回：详细模式示例： `["snapshot create post_snapshot Post-snapshot"]`

作者

Gabriele Gerbino (@GGabriele)