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

Новое в версии 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Обзор

Создание моментальных снимков текущего состояния выбранных функций, добавление новых команд 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`. Этот параметр требуется только при использовании NX-API. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект dict, содержащий сведения о подключении.
	host обязательный		Указывает имя DNS хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	port	Значение по умолчанию: "0 (использовать стандартный порт)"	Указывает порт для использования при построении соединения с удалённым устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если не указано в задаче. (cli=22, http=80, https=443).
	username		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	authorize bool (добавлено в 2.5.3)	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass (добавлено в 2.5.3)	Значение по умолчанию: "нет"	Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	timeout (добавлено в 2.3)	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.).
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательный	Значение по умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_ssl bool	Варианты: нет ← да	Настраивает transport для использования SSL, если значение равно true, только если `transport=nxapi`, в противном случае это значение игнорируется.
	validate_certs bool	Варианты: нет да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если параметр transport не nxapi, это значение игнорируется.
	use_proxy bool (добавлено в 2.5)	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
row_id			Указывает тег каждой строки в выводе команды show, используемый при `action=add`.
save_snapshot_locally bool		Варианты: нет ← да	Указывает на локальное сохранение нового созданного снимка, используемого при `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
- nxos_snapshot:
    action: create
    snapshot_name: test_snapshot
    description: Done with Ansible
    save_snapshot_locally: true
    path: /home/user/snapshots/

# Delete a snapshot
- nxos_snapshot:
    action: delete
    snapshot_name: test_snapshot

# Delete all existing snapshots
- nxos_snapshot:
    action: delete_all

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

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

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
commands list	режим verbose	команды, отправленные устройству Пример: ['snapshot create post_snapshot Post-snapshot']

Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются командой Ansible Network Team, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний

Автор

Gabriele Gerbino (@GGabriele)

Подсказка

Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/nxos_snapshot_module.html