enos_config - Управление секциями конфигурации Lenovo ENOS
Новое в версии 2.5.
Обзор
- Конфигурации Lenovo ENOS используют простой синтаксис блочного отступа для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации ENOS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin |
| Переходит в административный режим конфигурации для внесения изменений в конфигурацию устройства. | |
| after | Значение по умолчанию: Нет | Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменение. Так же, как и с параметром before, это позволяет разработчику игрового плана добавить набор команд, которые будут выполнены после набора команд. | |
| auth_pass | Значение по умолчанию: нет | Указывает пароль для использования, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| backup |
| Этот аргумент заставит модуль создать полную резервную копию текущего running-config с удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневой директории игрового плана. Если папка не существует, она создается. | |
| before | Значение по умолчанию: Нет | Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменение. Это позволяет разработчику игрового плана выполнить команды конфигурации перед внесением любых изменений, не влияя на способ сопоставления набора команд с системой. | |
| comment | Значение по умолчанию: настроен enos_config | Позволяет указать описание коммита для включения при фиксации конфигурации. Если конфигурация не изменена или не зафиксирована, этот аргумент игнорируется. | |
| config | Значение по умолчанию: Нет | Модуль по умолчанию подключается к удаленному устройству и извлекает текущую активную конфигурацию для использования в качестве базы сравнения с содержимым источника. Иногда нежелательно запрашивать текущую активную конфигурацию для каждой задачи в игровом плане. Аргумент config позволяет разработчику передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения. | |
| lines | Значение по умолчанию: Нет | Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть точно такими же, как и в активной конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | |
| match |
| Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match равен строке, команды сопоставляются построчно. Если match равен строго, строки команд сопоставляются с учетом позиции. Если match равен точно, строки команд должны быть точным совпадением. Наконец, если match равен нет, модуль не будет пытаться сравнить исходную конфигурацию с активной конфигурацией на удалённом устройстве. | |
| parents | Значение по умолчанию: Нет | Упорядоченный набор родительских элементов, которые однозначно идентифицируют секцию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами. | |
| provider | Значение по умолчанию: Нет | Объект dict, содержащий данные подключения. | |
| username | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| auth_pass | Значение по умолчанию: нет | Указывает пароль для использования, если требуется войти в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host требуется | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | |
| password | Значение по умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| replace |
| Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace равен строка, изменённые строки отправляются на устройство в режиме конфигурации. Если аргумент replace равен блок, весь блок команды отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна. | |
| src | Значение по умолчанию: Нет | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте управления Ansible или относительным путем от корневой директории игрового плана или роли. Этот аргумент взаимоисключает lines, parents. | |
Примечания
Примечание
- Тестировано на ENOS 8.4.1.2
Примеры
- name: configure top level configuration
enos_config:
"lines: hostname {{ inventory_hostname }}"
- name: configure interface settings
enos_config:
lines:
- enable
- ip ospf enable
parents: interface ip 13
- name: load a config from disk and replace the current config
enos_config:
src: config.cfg
backup: yes
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup = да | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/enos01.2016-07-16@22:28:34 |
| updates список | только при указании lines | Набор команд, которые будут отправлены на удалённое устройство Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Автор
- Anil Kumar Muraleedharan (@amuraleedhar)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/enos_config_module.html