Модуль community.network.exos_config – Управление разделами конфигурации Extreme Networks EXOS

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.network.

Чтобы использовать её в книге задач, укажите: community.network.exos_config.

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

Обзор

Конфигурации Extreme EXOS используют простой синтаксис текстового файла. Этот модуль предоставляет реализацию для работы с строками конфигурации EXOS детерминированным способом.

Псевдонимы: network.exos.exos_config

Параметры

Параметр	Комментарии
после строка	Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Так же, как и с параметром перед, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
резервная копия логическое значение	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Если значение параметра `backup_options` не указано, файл резервной копии будет сохранён в папке `backup` в корневом каталоге плейбука. Если папка не существует, она будет создана. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра читается только тогда, когда `backup` установлено в да. Если `backup` установлено в нет, этот параметр будет проигнорирован.
dir_path путь	Этот параметр предоставляет путь, заканчивающийся именем папки, в которой будет храниться файл конфигурации резервной копии. Если папка не существует, она будет создана сначала, а имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в `filename` описании параметров. Если значение пути не указано, в текущей рабочей директории будет создана папка backup, и конфигурация резервной копии будет скопирована в `filename` в папке backup.
filename строка	Имя файла, которое будет использоваться для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<current-date>@<current-time>
перед строка	Упорядоченный набор команд, которые будут добавлены в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения любых изменений, не влияя на то, как набор команд сопоставляется с системой.
defaults логическое значение	Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении конфигурации устройства в удалённом режиме. При включении, модуль получит текущую конфигурацию, выполнив команду `show running-config all`. Варианты: `false` ← (по умолчанию) `true`
diff_against строка	При использовании аргумента командной строки `ansible-playbook --diff` модуль может генерировать разницы относительно разных источников. Когда этот параметр настроен как startup, модуль вернёт разницу между running-config и startup-config. Когда этот параметр настроен как intended, модуль вернёт разницу между running-config и конфигурацией, предоставленной в аргументе `intended_config`. Когда этот параметр настроен как running, модуль вернёт разницу до и после running-config относительно любых изменений, внесённых в конфигурацию устройства. Варианты: `"running"` ← (по умолчанию) `"startup"` `"intended"`
diff_ignore_lines строка	Используйте этот аргумент, чтобы указать одну или несколько строк, которые должны быть проигнорированы во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config строка	`intended_config` предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной running-config. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется только для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение `diff_against` и установить его в intended.
команды псевдонимы: команды строка	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.
match строка	Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются построчно. Если match установлено в строго, строки команд сопоставляются с учётом позиции. Если match установлено в точно, строки команд должны быть точным совпадением. Наконец, если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с running-конфигурацией на удалённом устройстве. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
заменить строка	Указывает модулю, как выполнить конфигурирование устройства. Если аргумент replace установлен в строка, изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка некорректна. Варианты: `"line"` ← (по умолчанию) `"block"`

running_config aliases: config string	Модуль по умолчанию подключается к удалённому устройству и извлекает текущую конфигурацию running-config, чтобы использовать её как базу для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую конфигурацию running-config для каждой задачи в плейбуке. Аргумент running_config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения.
save_when string	При внесении изменений в конфигурацию running-устройства, изменения по умолчанию не копируются в энергонезависимую память. Использование этого аргумента изменит это поведение. Если аргумент установлен в always, то конфигурация running-config всегда будет скопирована в startup-config, а флаг modified всегда будет установлен в True. Если аргумент установлен в modified, то конфигурация running-config будет скопирована в startup-config только в том случае, если она изменилась с момента последней записи в startup-config. Если аргумент установлен в never, то конфигурация running-config никогда не будет скопирована в startup-config. Если аргумент установлен в changed, то конфигурация running-config будет скопирована в startup-config только в том случае, если задача внесла изменения. Выбои: `"always"` `"never"` ← (по умолчанию) `"modified"` `"changed"`
src string	Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корня плейбука или роли. Этот аргумент несовместим с аргументом lines.

Примечания

Примечание

Проверено на EXOS версии 22.6.0b19

Примеры

- name: Configure SNMP system name
  community.network.exos_config:
    lines: configure snmp sysName "{{ inventory_hostname }}"

- name: Configure interface settings
  community.network.exos_config:
    lines:
      - configure ports 2 description-string "Master Uplink"
    backup: true

- name: Check the running-config against master config
  community.network.exos_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"

- name: Check the startup-config against the running-config
  community.network.exos_config:
    diff_against: startup
    diff_ignore_lines:
      - ntp clock .*

- name: Save running to startup when modified
  community.network.exos_config:
    save_when: modified

- name: Configurable backup path
  community.network.exos_config:
    lines:
      - configure ports 2 description-string "Master Uplink"
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Описание
backup_path string	Полный путь к резервной копии файла Возвращается: при backup yes Пример: `"/playbooks/ansible/backup/x870_config.2018-08-08@15:00:21"`
commands list / elements=string	Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: `["create vlan \"foo\"", "configure snmp sysName \"x620-red\""]`
updates list / elements=string	Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: `["switch-attributes hostname foo", "router ospf", "area 0"]`

Авторы

Lance Richardson (@hlrichardson)

Ссылки на коллекции

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