cisco.nxos.nxos_rollback – Создание контрольной точки или откат к контрольной точке.
Примечание
Этот плагин входит в состав коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: 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 ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS | ||
| authorize булево |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| 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 строка |
| Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент транспорта поддерживает подключение к устройству по 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 не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если аргумент транспорта не является nxapi, это значение игнорируется. | |
| rollback_to строка | Имя файла контрольной точки для возврата. Взаимоисключающее с checkpoint_file. | ||
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Иногда
transport=nxapiможет привести к ошибке тайм-аута. - Для получения информации о работе с CLI и NX-API см. Руководство по параметрам платформы NXOS
- Дополнительную информацию о работе с 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 строка | успех | Выполненная операция и её успешность. Пример: откат выполнен |
Авторы
- 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.10/collections/cisco/nxos/nxos_rollback_module.html