cisco.nxos.nxos_rollback – Создание контрольной точки или откат к контрольной точке.
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_rollback.
Новое в версии 1.0.0: плагина cisco.nxos
Обзор
- Этот модуль позволяет создать файл контрольной точки конфигурации или выполнить откат к файлу контрольной точки конфигурации на коммутаторах Cisco NXOS.
Примечание
Этот модуль имеет соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| checkpoint_file строка | Имя файла контрольной точки для создания. Взаимоисключающее с rollback_to. | ||
| provider словарь | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6 рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения 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, это значение игнорируется. | |
| rollback_to строка | Имя файла контрольной точки для отката. Взаимоисключающее с checkpoint_file. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Иногда
transport=nxapiможет вызвать ошибку таймаута. - Для получения информации об использовании CLI и NX-API см. Руководство NXOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- cisco.nxos.nxos_rollback:
checkpoint_file: backup.cfg
username: '{{ un }}'
password: '{{ pwd }}'
host: '{{ inventory_hostname }}'
- cisco.nxos.nxos_rollback:
rollback_to: backup.cfg
username: '{{ un }}'
password: '{{ pwd }}'
host: '{{ inventory_hostname }}'
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| filename строка | успех | Имя файла контрольной точки/отката. Пример: backup.cfg |
| status строка | успех | Выполненная операция и успех её выполнения. Пример: rollback executed |
Авторы
- Jason Edelman (@jedelman8)
- Gabriele Gerbino (@GGabriele)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_rollback_module.html