nxos_rollback — Установка контрольной точки или откат к контрольной точке.
Новая версия 2.2.
Описание
- Этот модуль позволяет устанавливать файл контрольной точки конфигурации или откатываться к файлу контрольной точки конфигурации на коммутаторах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| checkpoint_file | По умолчанию: None | Имя файла контрольной точки для создания. Взаимоисключающее с rollback_to. | |
| provider | По умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Дополнительная информация в руководстве NXOS Platform Options. Объект типа dict, содержащий данные подключения. | |
| username | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize (добавлен в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если 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 |
| Устанавливает transport для использования SSL, если значение true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это распространённый параметр, используемый как для cli, так и для nxapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах с персональным контролем, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт для создания подключения к удалённому устройству. Это значение относится как к cli, так и к nxapi. Значение порта по умолчанию — стандартный порт соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Устанавливает транспорт для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| rollback_to | По умолчанию: None | Имя файла контрольной точки для отката. Взаимоисключающее с checkpoint_file. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Иногда
transport=nxapiможет привести к ошибке таймаута. - Дополнительная информация по использованию CLI и NX-API в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco на странице интеграции Cisco.
Примеры
- 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 executed |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратно совместимым.
Поддержка
Дополнительная информация о поддержке данного модуля компанией Red Hat находится в этой статье базы знаний.
Автор
- Jason Edelman (@jedelman8)
- 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_rollback_module.html