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