edgeos_config – Управление конфигурацией EdgeOS на удалённом устройстве
Новая версия 2.5.
Описание
- Этот модуль предоставляет управление файлами конфигурации устройств EdgeOS. Он предоставляет аргументы для управления как файлом конфигурации, так и состоянием активной конфигурации. Все утверждения конфигурации основаны на командах
setиdeleteв конфигурации устройства. - Это сетевой модуль и для его корректной работы требуется
connection: network_cli. - Дополнительную информацию можно найти в Руководстве по сети.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| backup boolean |
| Аргумент backup сделает резервную копию текущей активной конфигурации устройства на хост Ansible до внесения каких-либо изменений. Файл резервной копии будет расположен в папке резервных копий в корневой директории выполнения плейбука или в корневой директории роли, если плейбук входит в состав ansible роли. Если директория не существует, она создаётся. |
| comment - | По умолчанию: "настроено edgeos_config" | Позволяет указать описание коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменена или не сохранена, этот аргумент игнорируется. |
| config - | Аргумент config задаёт базовую конфигурацию для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически извлечёт текущую активную конфигурацию с удалённого устройства. | |
| lines - | Упорядоченный набор строк конфигурации, которые будут управляться и сравниваться с существующей конфигурацией на удалённом устройстве. | |
| match - |
| Аргумент match управляет методом сравнения с текущей активной конфигурацией. По умолчанию, желаемая конфигурация сравнивается с активной конфигурацией, и разницы загружаются. Если аргумент match установлен в значение none, активная конфигурация игнорируется, и конфигурация всегда загружается. |
| save boolean |
| Аргумент save управляет тем, сохраняются ли изменения, внесённые в активную конфигурацию, на диск. Это независимо от коммита конфигурации. При значении True, активная конфигурация сохраняется. |
| src - | Аргумент src указывает путь к файлу исходной конфигурации для загрузки. Исходный файл конфигурации может быть в формате с фигурными скобками или в другом формате. Исходный файл может включать переменные шаблонов Jinja2. |
Примечания
Примечание
- Тестировалось на EdgeOS 1.9.7
- Рекомендуется установить
ANSIBLE_PERSISTENT_COMMAND_TIMEOUTв значение 30, так как команда сохранения может занимать больше времени, чем стандартные 10 секунд, на некоторых устройствах EdgeOS.
Примеры
- name: configure the remote device
edgeos_config:
lines:
- set system host-name {{ inventory_hostname }}
- set service lldp
- delete service dhcp-server
- name: backup and load from file
edgeos_config:
src: edgeos.cfg
backup: yes
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| backup_path строка | при backup=да | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34 |
| commands список | всегда | Список команд конфигурации, отправленных на устройство Пример: ['...', '...'] |
| filtered список | всегда | Список команд конфигурации, удалённых для предотвращения ошибки загрузки Пример: ['...', '...'] |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Nathaniel Case (@qalthos)
- Sam Doran (@samdoran)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/edgeos_config_module.html