cisco.nxos.nxos_snapshot – Управление моментальными снимками текущего состояния выбранных функций.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в книге задач укажите: cisco.nxos.nxos_snapshot.
Введено в версии 1.0.0: для cisco.nxos
Обзор
- Создание моментальных снимков текущего состояния выбранных функций, добавление новых команд show для создания, удаления и сравнения существующих снимков.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| action строка / обязательно |
| Определяет действие над снимком, которое выполнит модуль. | |
| compare_option строка |
| Параметры сравнения снимков, которые будут использоваться при 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.Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в версии после 2022-06-01. Для получения дополнительной информации обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для создания соединения с удалённым устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для соответствующего протокола, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может быть медленным при возврате ответа на длительные команды (sh mac, sh bgp и т. д.). | ||
| transport строка |
| Настраивает протокол подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если 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
- cisco.nxos.nxos_snapshot:
action: create
snapshot_name: test_snapshot
description: Done with Ansible
save_snapshot_locally: true
path: /home/user/snapshots/
# Delete a snapshot
- cisco.nxos.nxos_snapshot:
action: delete
snapshot_name: test_snapshot
# Delete all existing snapshots
- cisco.nxos.nxos_snapshot:
action: delete_all
# Add a show command for snapshots creation
- cisco.nxos.nxos_snapshot:
section: myshow
show_command: show ip interface brief
row_id: ROW_intf
element_key1: intf-name
# Compare two snapshots
- cisco.nxos.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'] |
Авторы
- 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.10/collections/cisco/nxos/nxos_snapshot_module.html
