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

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

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

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

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

Параметры

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

Статус

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

Поддержка

Дополнительную информацию о поддержке данного модуля 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.5/modules/nxos_snapshot_module.html