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, содержащий данные подключения.
	auth_pass строка добавлен в 2.5.3		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение добавлен в 2.5.3	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число	Значение по умолчанию: "0 (использовать стандартный порт)"	Указывает порт, который будет использоваться при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число добавлен в 2.3	Значение по умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy логическое значение добавлен в 2.5	Варианты: нет да ←	Если `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 в формате XML, который будет использован при `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
- 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 список	режим подробной информации	команды, отправленные на устройство Пример: ['snapshot create post_snapshot Post-snapshot']

Статус

Гарантия обратной совместимости этого модуля не предоставляется. [превью]
Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний 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.8/modules/nxos_snapshot_module.html