Модуль community.network.voss_config — Управление секциями конфигурации Extreme VOSS

Примечание

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

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

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

Для использования в книге задач укажите: community.network.voss_config.

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

Обзор

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

Псевдонимы: network.voss.voss_config

Параметры

Параметр	Комментарии
after строка	Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется изменение. Так же, как и с параметром before, это позволяет автору плейбука добавить набор команд, которые будут выполнены после заданного набора команд.
backup логическое	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневой директории плейбука или корневой директории роли, если плейбук является частью роли Ansible. Если директория не существует, она создается. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только тогда, когда `backup` установлено в yes; если `backup` установлено в no, этот параметр будет проигнорирован.
dir_path путь	Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться файл конфигурации резервной копии. Если каталог не существует, он будет создан в первую очередь, а имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в `filename` описании параметров. Если значение пути не указано, в этом случае будет создана папка backup в текущей рабочей директории, и конфигурация резервной копии будет скопирована в `filename` в папке backup.
filename строка	Имя файла, используемое для хранения конфигурации резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before строка	Упорядоченный набор команд, которые добавляются в стек команд, если необходимо изменение. Это позволяет автору плейбука выполнить команды конфигурации до внесения каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой.
defaults логическое	Этот аргумент указывает, следует ли собирать все значения по умолчанию при получении конфигурации удаленного устройства. При включенном значении модуль получит текущую конфигурацию, выполнив команду `show running-config verbose`. Варианты: `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 установлено в line, команды сопоставляются по строкам. Если match установлено в strict, строки команд сопоставляются по позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
parents строка	Родительская строка, которая однозначно идентифицирует раздел, с которым должны сравниваться команды. Если этот аргумент опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. Обратите внимание, что конфигурации VOSS поддерживают только один уровень вложенных команд.
replace строка	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, измененные строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка некорректна. Варианты: `"line"` ← (по умолчанию) `"block"`

END_OF_DOCUMENT_MARKER

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

Примечания

Примечание

Тестировалось на VOSS 7.0.0
Сокращенные команды НЕ идемпотентны, см. FAQ по сети.

Примеры

- name: Configure system name
  community.network.voss_config:
    lines: prompt "{{ inventory_hostname }}"

- name: Configure interface settings
  community.network.voss_config:
    lines:
      - name "ServerA"
    backup: true
    parents: interface GigabitEthernet 1/1

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

- name: Check the startup-config against the running-config
  community.network.voss_config:
    diff_against: startup
    diff_ignore_lines:
      - qos queue-profile .*

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

- name: Configurable backup path
  community.network.voss_config:
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Описание
backup_path string	Полный путь к резервной копии файла Возвращается: при backup = yes Пример: `"/playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21"`
commands list / elements=string	Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: `["interface GigabitEthernet 1/1", "name \"ServerA\"", "exit"]`
updates list / elements=string	Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: `["prompt \"VSP200\""]`

Авторы

Lindsay Hill (@LindsayHill)

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

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