exos_config – Управление секциями конфигурации EXOS Extreme Networks

Новая версия 2.7.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
after -	Значение по умолчанию: null	Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Аналогично параметру before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после заданного набора команд.
backup boolean	Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии будет записан в папку `backup` в корневой директории плейбука. Если директория не существует, она будет создана.
before -	Значение по умолчанию: null	Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это даёт возможность разработчику плейбука выполнить команды конфигурации перед внесением любых изменений, не влияя на способ сопоставления набора команд с системой.
defaults boolean	Варианты: no ← yes	Этот аргумент определяет, собирать ли все значения по умолчанию при получении конфигурации работающего режима удалённого устройства. Включив эту опцию, модуль получит текущую конфигурацию, выполнив команду `show running-config all`.
diff_against -	Варианты: running startup intended	При использовании аргумента командной строки `ansible-playbook --diff`, модуль может генерировать разницу с различными источниками. Если этот параметр установлен как startup, модуль вернёт разницу между running-config и startup-config. Если этот параметр установлен как intended, модуль вернёт разницу между running-config и конфигурацией, указанной в аргументе `intended_config`. Если этот параметр установлен как running, модуль вернёт разницу до и после running-config по отношению к любым изменениям, внесённым в конфигурацию устройства.
diff_ignore_lines -		Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config -		`intended_config` предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки конечной конфигурации running-config. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется только для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение `diff_against` и установить его в значение intended.
lines -	Значение по умолчанию: null	Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
match -	Варианты: line ← strict exact none	Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются построчно. Если match установлен на strict, строки команд сопоставляются относительно позиции. Если match установлен на exact, строки команд должны быть точным совпадением. Наконец, если match установлен на none, модуль не будет пытаться сравнивать исходную конфигурацию с конфигурацией running на удалённом устройстве.
replace -	Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен на line, то изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен на block, то весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка некорректна.
running_config -	Значение по умолчанию: null	Модуль по умолчанию подключается к удалённому устройству и получает текущую конфигурацию running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Бывают случаи, когда нежелательно, чтобы задача получала текущую конфигурацию running-config для каждой задачи в плейбуке. Аргумент running_config позволяет разработчику передать конфигурацию, используемую в качестве базовой конфигурации для сравнения. псевдонимы: config
save_when -	Варианты: always never ← modified changed	Когда в конфигурации running-config устройства вносятся изменения, эти изменения по умолчанию не копируются в ПЗУ. Использование этого аргумента изменит это поведение. Если аргумент установлен на always, то running-config всегда будет скопирован в startup-config, а флаг modified всегда будет установлен в True. Если аргумент установлен на modified, то running-config будет скопирован в startup-config только в случае, если он изменился с момента последнего сохранения в startup-config. Если аргумент установлен на never, то running-config никогда не будет скопирован в startup-config. Если аргумент установлен на changed, то running-config будет скопирован в startup-config только в том случае, если задача внесла изменение.
src -	Значение по умолчанию: null	Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте управления Ansible или относительным путём от корня плейбука или роли. Этот аргумент несовместим с аргументом lines.

Примечания

Примечание

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

Примеры

- name: configure SNMP system name
  exos_config:
    lines: configure snmp sysName "{{ inventory_hostname }}"

- name: configure interface settings
  exos_config:
    lines:
      - configure ports 2 description-string "Master Uplink"
    backup: yes

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

- name: check the startup-config against the running-config
  exos_config:
    diff_against: startup
    diff_ignore_lines:
      - ntp clock .*

- name: save running to startup when modified
  exos_config:
    save_when: modified

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Lance Richardson (@hlrichardson)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/exos_config_module.html