cisco.nxos.nxos_snapshot – Управление снимками текущего состояния выбранных функций.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в плейбуке укажите: cisco.nxos.nxos_snapshot.

Новое в версии 1.0.0: модуля cisco.nxos

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
action строка / обязательно		Варианты: add compare create delete delete_all	Определяет действие над снимком, которое должен выполнить модуль.
compare_option строка		Варианты: summary ipv4routes ipv6routes	Параметры снимка для использования при `action=compare`.
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`.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для создания подключения к удалённому устройству. Это значение применимо к cli или nxapi. Значение порта по умолчанию устанавливается для соответствующего общего порта транспорта, если не предоставлено в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl логическое	Варианты: нет ← да	Настраивает transport на использование SSL, если установлено `yes` только в случае `transport=nxapi`, иначе это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs логическое	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самоподписанные сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
row_id строка			Указывает тег каждой записи строки вывода команды show, который будет использоваться при `action=add`.
save_snapshot_locally логическое		Варианты: нет ← да	Укажите, чтобы сохранить новый созданный снимок локально, для использования при `action=create`.
section строка			Используется для именования вывода команды show, для использования при `action=add`.
show_command строка			Укажите новую команду show, для использования при `action=add`.
snapshot1 строка			Первый снимок, используемый при `action=compare`.
snapshot2 строка			Второй снимок, используемый при `action=compare`.
snapshot_name строка			Имя снимка, используемое при `action=create` или `action=delete`.

Примечания

Примечание

Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
transport=cli может привести к ошибкам таймаута.
Параметры element_key1 и element_key2 задают теги для различения записей строк. В большинстве случаев достаточно указать только параметр element_key1, чтобы различить записи строк.
action=compare всегда будет сохранять отчёт о сравнении в локальном файле.
Для получения информации о работе с CLI и NX-API обратитесь к руководству NXOS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами обратитесь к руководству Ansible Network Guide
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco посетите страницу интеграции 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)

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