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. Объект словаря, содержащий данные подключения.
	auth_pass - добавлено в 2.5.3	По умолчанию: "none"	Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному каналу передачи данных. Значение хоста используется в качестве адреса назначения для канала передачи.
	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"	Настраивает канал передачи данных для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: нет ← да	Настраивает transport на использование SSL, если значение true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого канала передачи. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: нет да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самоподписанными сертификатами. Если параметр transport не равен nxapi, это значение игнорируется.
row_id -			Указывает тег каждой строки в XML-выводе команды show, используемой при `action=add`.
save_snapshot_locally boolean		Варианты: нет ← да	Указывает на локальное сохранение нового созданного снимка, используемое при `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.7/modules/nxos_snapshot_module.html