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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
backup boolean		Варианты: нет ← да	Аргумент `backup` создаст резервную копию активной конфигурации текущего устройства на хосте Ansible перед внесением любых изменений. Если значение `backup_options` не задано, файл резервной копии будет расположен в папке backup в корневом каталоге playbook или корневом каталоге роли, если playbook является частью роли ansible. Если папка не существует, она создаётся.
backup_options словарь добавлено в 2.8			Это объект dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только тогда, когда `backup` установлено в да. Если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр задаёт путь, заканчивающийся именем каталога, в котором будет храниться резервная копия файла конфигурации. Если каталог не существует, он сначала создаётся, и имя файла — это значение `filename` или имя файла по умолчанию, как описано в `filename` описании параметров. Если значение пути не задано, в текущем рабочем каталоге создаётся каталог backup, и резервная копия конфигурации будет скопирована в `filename` внутри каталога backup.
	filename -		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно генерируется на основе имени хоста, текущей даты и времени в формате <имя_хоста>_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
  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=да	Полный путь к резервному файлу Пример: /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.8/modules/edgeos_config_module.html