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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в плейбуке укажите: community.network.edgeos_config.

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		Варианты: нет ← да	Аргумент `backup` создаст резервную копию текущей активной конфигурации устройства на хост Ansible перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии будет находиться в папке backup в корне плейбука или в корне роли, если плейбук является частью роли Ansible. Если папка не существует, она будет создана.
backup_options словарь			Это объект dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только когда `backup` установлено в да, если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр указывает путь, заканчивающийся именем папки, в которой будет храниться резервный файл конфигурации. Если папка не существует, она будет создана, а имя файла будет либо значением `filename`, либо именем по умолчанию, как описано в описании параметров `filename`. Если значение пути не указано, в текущей рабочей директории будет создана папка backup, и резервная копия конфигурации будет скопирована в `filename` внутри папки backup.
	filename строка		Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<дата>@<время>
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
  community.network.edgeos_config:
    lines:
      - set system host-name {{ inventory_hostname }}
      - set service lldp
      - delete service dhcp-server

- name: Backup and load from file
  community.network.edgeos_config:
    src: edgeos.cfg
    backup: yes

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

Значения возврата

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = да	Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34
commands список / элементы=строка	всегда	Список команд конфигурации, отправленных устройству Пример: ['...', '...']

Авторы

Nathaniel Case (@Qalthos)
Sam Doran (@samdoran)

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