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

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

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

Обзор

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

Примечание

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

Псевдонимы: network.edgeos.edgeos_config

Параметры

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

- name: Configurable backup path
  community.network.edgeos_config:
    src: edgeos.cfg
    backup: true
    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 список / элементы=строка	Список команд конфигурации, отправленных на устройство Возвращается: всегда Пример: `["...", "..."]`

Авторы

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

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/edgeos_config_module.html