nxos_snapshot — Управление моментальными снимками состояния выбранных функций.
Новое в версии 2.2.
Описание
- Создание моментальных снимков состояния выбранных функций, добавление новых команд show для создания снимков, удаление и сравнение существующих снимков.
Параметры
| параметр | обязательно | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| action | да |
| Определяет действие, которое должен выполнить модуль с моментальным снимком. | |
| auth_pass (добавлено в 2.4.4)
| нет | none | Указывает пароль, который необходимо использовать, если требуется ввод привилегированного режима на удаленном устройстве. Если authorize равно false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| compare_option | нет |
| Параметры моментального снимка, которые необходимо использовать при action=compare. | |
| comparison_results_file | нет | Имя файла, в котором будут храниться результаты сравнения снимков при action=compare. | ||
| description | нет | Описание моментального снимка, которое необходимо использовать при action=create. | ||
| element_key1 | нет | Укажите метки, используемые для различения записей строк, которые необходимо использовать при action=add. | ||
| element_key2 | нет | Укажите метки, используемые для различения записей строк, которые необходимо использовать при action=add. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| path | нет | ./ | Укажите путь к файлу, в котором будет храниться новый созданный снимок или сравнение снимков, необходимо использовать при action=create и save_snapshot_locally=true или action=compare. | |
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для соответствующего транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, варианты и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| 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. | ||
| 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_ssl | нет |
| Настраивает transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых локально сайтах с самозаверяющимися сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
# 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'] |
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
-
transport=cliможет привести к ошибкам таймаута. - Параметры
element_key1иelement_key2задают метки, используемые для различения записей строк. В большинстве случаев для различения записей строк достаточно указать только параметр element_key1. -
action=compareвсегда сохранит отчёт о сравнении в локальном файле.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этом knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Дополнительную помощь в разработке модулей, если вы так решите, см. в Информация сообщества и внесение вклада, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_snapshot_module.html
