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

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Создание снимков текущего состояния выбранных функций, добавление новых команд 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. Объект словаря, содержащий данные подключения.
	auth_pass строка добавлен в 2.5.3		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize ложно, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения `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 целое число	По умолчанию: 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
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
Для получения дополнительной информации об использовании 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 по сетям. [сеть]

Поддержка 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.9/modules/nxos_snapshot_module.html