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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		Варианты: no ← yes	Аргумент `backup` создаст резервную копию текущей активной конфигурации устройства на хосте управления Ansible перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии будет расположен в папке backup в корневом каталоге playbook или корневом каталоге роли, если playbook является частью роли ansible. Если каталог не существует, он создаётся.
backup_options словарь добавлен в 2.8			Это объект словаря, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только когда `backup` установлено в yes, если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться резервная копия файла конфигурации. Если каталог не существует, он сначала создаётся, и имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в описании параметров `filename`. Если значение пути не указано, в текущем рабочем каталоге создаётся каталог backup, и резервная копия конфигурации копируется в `filename` в каталоге backup.
	filename -		Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
comment -		По умолчанию: "настроено edgeos_config"	Позволяет указать описание коммита, которое будет включено при коммите конфигурации. Если конфигурация не изменена или не сохранена, этот параметр игнорируется.
config -			Аргумент `config` определяет базу конфигурации для сравнения с желаемой конфигурацией. Если это значение не указано, модуль автоматически извлечёт текущую активную конфигурацию с удалённого устройства.
lines -			Упорядоченный набор строк конфигурации, которые будут управляться и сравниваться с существующей конфигурацией на удалённом устройстве.
match -		Варианты: line ← none	Аргумент `match` контролирует метод сравнения с текущей активной конфигурацией. По умолчанию, желаемая конфигурация сравнивается с активной конфигурацией, и разницы загружаются. Если аргумент `match` установлен в значение `none`, активная конфигурация игнорируется, и конфигурация всегда загружается.
save boolean		Варианты: 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

- name: configurable backup path
  edgeos_config:
    src: edgeos.cfg
    backup: yes
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

Возвращаемые значения

Общие значения возврата описаны здесь, следующие — уникальные для этого модуля поля:

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = yes	Полный путь к файлу резервной копии Пример: /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.9/modules/edgeos_config_module.html