edgeos_config - Управление конфигурацией EdgeOS на удалённом устройстве
Новое в версии 2.5.
Обзор
- Этот модуль предоставляет управление файлами конфигурации устройств EdgeOS. Он предоставляет аргументы для управления как файлом конфигурации, так и состоянием активной конфигурации. Все операторы конфигурации основаны на командах
setиdeleteв конфигурации устройства. - Это сетевой модуль и требует
connection: network_cliдля правильной работы. - Для получения дополнительной информации обратитесь к Руководству по сети.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| backup |
| Аргумент backup создаст резервную копию текущей активной конфигурации устройства на хост Ansible перед внесением любых изменений. Файл резервной копии будет расположен в папке backup в корневом каталоге playbook или в корневом каталоге роли, если playbook является частью роли ansible. Если каталог не существует, он будет создан. |
| comment | Значение по умолчанию: configured by edgeos_config | Разрешает указать описание коммита для включения при фиксации конфигурации. Если конфигурация не изменена или не зафиксирована, этот аргумент игнорируется. |
| config | Значение по умолчанию: None | Аргумент config задаёт базу конфигурации для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически извлечёт текущую активную конфигурацию с удалённого устройства. |
| lines | Значение по умолчанию: None | Упорядоченный набор строк конфигурации для управления и сравнения с существующей конфигурацией на удалённом устройстве. |
| match |
| Аргумент match управляет методом сопоставления с текущей активной конфигурацией. По умолчанию, желаемая конфигурация сравнивается с активной конфигурацией, и изменения загружаются. Если аргумент match установлен в none, активная конфигурация игнорируется, и конфигурация всегда загружается. |
| save |
| Аргумент save управляет тем, сохраняются ли внесённые изменения в активную конфигурацию на диске. Это независимо от фиксации конфигурации. При установке в True, активная конфигурация сохраняется. |
| src | Значение по умолчанию: None | Аргумент src указывает путь к исходному файлу конфигурации для загрузки. Исходный файл конфигурации может быть в формате скобок или в формате набора. Исходный файл может содержать переменные шаблонов Jinja2. |
Примечания
Примечание
- Тестировано на EdgeOS 1.9.7
- Рекомендуется установить
ANSIBLE_PERSISTENT_COMMAND_TIMEOUTв 30, так как команда save может занимать больше времени, чем стандартные 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 = yes | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34 |
| commands список | всегда | Список команд конфигурации, отправленных на устройство Пример: ['...', '...'] |
| filtered список | всегда | Список команд конфигурации, удалённых для предотвращения сбоя загрузки Пример: ['...', '...'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/edgeos_config_module.html