Модуль cisco.nxos.nxos_snapshot — управление снимками текущих состояний выбранных функций.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_snapshot.

Добавлено в cisco.nxos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание снимков текущих состояний выбранных функций, добавление новых команд show для создания снимков, удаление и сравнение существующих снимков.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: snapshot

Параметры

Параметр	Комментарии
action string / обязательный	Определяет действие со снимком, которое должен выполнить модуль. Варианты: `"add"` `"compare"` `"create"` `"delete"` `"delete_all"`
compare_option string	Параметры снимка, используемые при `action=compare`. Варианты: `"summary"` `"ipv4routes"` `"ipv6routes"`
comparison_results_file string	Имя файла, в котором будут сохранены результаты сравнения снимков при `action=compare`.
description string	Описание снимка, используемое при `action=create`.
element_key1 string	Укажите теги, используемые для различения строк, при `action=add`.
element_key2 string	Укажите теги, используемые для различения строк, при `action=add`.
path string	Укажите путь к файлу, в котором будет сохранён созданный снимок или результаты сравнения снимков, при `action=create` и `save_snapshot_locally=true` или `action=compare`. По умолчанию: `"./"`
row_id string	Указывает тег каждой строки в выводе команды show в формате XML, используемый при `action=add`.
save_snapshot_locally boolean	Укажите, нужно ли сохранять созданный снимок локально; используется при `action=create`. Варианты: `false` ← (по умолчанию) `true`
section string	Используется для именования вывода команды show при `action=add`.
show_command string	Укажите новую команду show, используемую при `action=add`.
snapshot1 string	Первый снимок, используемый при `action=compare`.
snapshot2 string	Второй снимок, используемый при `action=compare`.
snapshot_name string	Имя снимка, используемое при `action=create` или `action=delete`.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) в VIRL
Не поддерживается на Cisco MDS
transport=cli может привести к ошибкам тайм-аута.
Параметры element_key1 и element_key2 задают теги, используемые для различения строк. В большинстве случаев для различения строк достаточно указать только параметр element_key1.
action=compare всегда сохраняет отчёт о сравнении в локальный файл.
Сведения об использовании CLI и NX-API см. в :ref:`руководстве по параметрам платформы NXOS <nxos_platform_options>`
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/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 list / элементы=string	команды, отправленные устройству Возвращается: в подробном режиме Пример: `["snapshot create post_snapshot Post-snapshot"]`

Авторы

Gabriele Gerbino (@GGabriele)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_snapshot_module.html