nxos_rollback — Установка контрольной точки или откатка к контрольной точке.
Новая в версии 2.2.
Описание
- Этот модуль предоставляет возможность установить файл контрольной точки конфигурации или откатиться к файлу контрольной точки конфигурации на коммутаторах Cisco NXOS.
Параметры
| Параметр | Обязательный | По умолчанию | Возможные значения | Комментарии |
|---|---|---|---|---|
| auth_pass
(добавлен в 2.4.4)
|
нет | нет |
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент не имеет значения. Если значение не указано в задаче, то будет использовано значение переменной окружения
ANSIBLE_NET_AUTH_PASS. |
|
| authorize
(добавлен в 2.4.4)
|
нет |
|
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, то будет использовано значение переменной окружения
ANSIBLE_NET_AUTHORIZE. |
|
| checkpoint_file | нет |
Имя файла контрольной точки для создания. Взаимоисключающее с rollback_to.
|
||
| host | да |
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
|
||
| password | нет |
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, то будет использовано значение переменной окружения
ANSIBLE_NET_PASSWORD. |
||
| port | нет | 0 (используется стандартный порт) |
Указывает порт для использования при построении соединения с удалённым устройством. Это значение применяется как для cli, так и для nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
|
|
| provider | нет |
Удобный метод, который позволяет передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, допустимые значения и т. д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре.
|
||
| rollback_to | нет |
Имя файла контрольной точки для отката. Взаимоисключающее с checkpoint_file.
|
||
| 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, это значение игнорируется. |
Примеры
- nxos_rollback:
checkpoint_file: backup.cfg
username: "{{ un }}"
password: "{{ pwd }}"
host: "{{ inventory_hostname }}"
- nxos_rollback:
rollback_to: backup.cfg
username: "{{ un }}"
password: "{{ pwd }}"
host: "{{ inventory_hostname }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| Имя | Описание | Возвращается | Тип | Пример |
|---|---|---|---|---|
| filename |
Имя файла контрольной точки/отката.
|
успех | строка | backup.cfg |
| status |
Выполненная операция и её успешность.
|
успех | строка | выполнен rollback |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Иногда
transport=nxapiможет вызвать ошибку таймаута.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией 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_rollback_module.html