nxos_rollback - Установка контрольной точки или откат к контрольной точке.
Новая версия с 2.2.
Обзор
- Этот модуль предоставляет возможность устанавливать файл контрольной точки конфигурации или откатываться к файлу контрольной точки конфигурации на коммутаторах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| checkpoint_file | Имя файла контрольной точки для создания. Взаимоисключающее с rollback_to. | ||
| provider | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Дополнительная информация содержится в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию устанавливается на соответствующий общий порт транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспорта cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: "нет" | Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если установлено в true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| rollback_to | Имя файла контрольной точки для отката. Взаимоисключающее с 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 выполнен |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. Дополнительная информация содержится в Руководстве по поддержке и техническому обслуживанию модулей.
Список других модулей, также поддерживаемых командой Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний Knowledge Base article
Автор
- 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.6/modules/nxos_rollback_module.html