edgeos_config — Управление конфигурацией EdgeOS на удалённом устройстве

Новое в версии 2.5.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Этот модуль предоставляет управление файлами конфигурации устройств EdgeOS. Он предоставляет аргументы для управления как файлом конфигурации, так и состоянием активной конфигурации. Все команды конфигурации основаны на командах set и delete в конфигурации устройства.
Это сетевой модуль и для его корректной работы требуется connection: network_cli.
Дополнительную информацию можно найти в Руководстве по сети.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
backup bool	Варианты: no ← yes	Аргумент `backup` создаст резервную копию активной конфигурации текущего устройства на хост Ansible перед внесением каких-либо изменений. Файл резервной копии будет расположен в папке backup в корневом каталоге playbook или корневом каталоге роли, если playbook является частью роли Ansible. Если директория не существует, она создаётся.
comment	Значение по умолчанию: "configured by edgeos_config"	Позволяет указать описание коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменялась или не сохранялась, этот аргумент игнорируется.
config		Аргумент `config` определяет базу конфигурации для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически извлечёт текущую активную конфигурацию с удалённого устройства.
lines		Упорядоченный набор строк конфигурации, которые будут обрабатываться и сравниваться с существующей конфигурацией на удалённом устройстве.
match	Варианты: line ← none	Аргумент `match` управляет методом сопоставления с текущей активной конфигурацией. По умолчанию желаемая конфигурация сопоставляется с активной конфигурацией, и отличия загружаются. Если аргумент `match` установлен в `none`, активная конфигурация игнорируется, и конфигурация всегда загружается.
save bool	Варианты: no ← yes	Аргумент `save` управляет тем, сохраняются ли внесённые изменения в активную конфигурацию на диске. Это независимо от сохранения конфигурации. При значении `True`, активная конфигурация сохраняется.
src		Аргумент `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 список	всегда	Список команд конфигурации, удалённых для предотвращения сбоя загрузки Пример: ['...', '...']

Статус

Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.

Техническое обслуживание

Этот модуль помечен как community, что означает, что его поддерживает сообщество Ansible. Для получения дополнительной информации см. Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

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.6/modules/edgeos_config_module.html