community.network.voss_config – Управление разделами конфигурации Extreme VOSS
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network
Для использования в книге задач укажите: community.network.voss_config
Обзор
- Конфигурации Extreme VOSS используют простой синтаксис текстового файла. Этот модуль предоставляет реализацию для работы с командами конфигурации EXOS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Подобно параметру before, это позволяет автору книги задач добавить набор команд, которые будут выполнены после набора команд. | ||
| backup логический тип |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением каких-либо изменений. Если значение backup_options не задано, файл резервной копии будет записан в папку backup в корневой директории книги задач или корневой директории роли, если книга задач является частью роли Ansible. Если папка не существует, она будет создана. | |
| backup_options словарь | Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра считывается только тогда, когда backup установлено в да. Если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана, а имя файла будет либо значением filename, либо значением по умолчанию, как описано в описании параметров filename. Если значение пути не задано, в текущей рабочей директории будет создана директория backup, и резервная копия конфигурации будет скопирована в filename внутри директории backup. | ||
| filename строка | Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не задано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before строка | Упорядоченный набор команд, которые нужно поместить в стек команд, если требуется изменение. Это позволяет автору книги задач выполнить команды конфигурации до внесения каких-либо изменений, не влияя на способ сопоставления набора команд с системой. | ||
| defaults логический тип |
| Этот аргумент указывает, нужно ли собирать все значения по умолчанию при получении конфигурации устройства в удалённом режиме. При включённом значении модуль получит текущую конфигурацию, выполнив команду show running-config verbose | |
| diff_against строка |
| При использовании аргумента командной строки 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 строка | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | ||
| match строка |
| Инструктирует модуль о способе сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются по строкам. Если match установлен в строго, строки команд сопоставляются относительно позиции. Если match установлен в точно, строки команд должны быть точным совпадением. И наконец, если match установлен в нет, модуль не будет пытаться сравнить исходную конфигурацию с конфигурацией в удалённом режиме на устройстве. | |
| parents строка | Родительская строка, которая однозначно идентифицирует раздел, с которым должны сравниваться команды. Если этот аргумент опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами. Обратите внимание, что конфигурации VOSS поддерживают только один уровень вложенных команд. | ||
| replace строка |
| Инструктирует модуль о способе выполнения конфигурации на устройстве. Если параметр replace установлен в строка, изменённые строки передаются на устройство в режиме конфигурации. Если параметр replace установлен в блок, весь блок команд передаётся на устройство в режиме конфигурации, если какая-либо строка некорректна. | |
| running_config строка | Модуль по умолчанию подключается к удалённому устройству и извлекает текущую running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в книге задач. Аргумент running_config позволяет реализатору передать конфигурацию, используемую в качестве базовой конфигурации для сравнения. псевдонимы: конфигурация | ||
| save_when строка |
| Когда в конфигурации устройства running-configuration вносятся изменения, эти изменения не копируются в нелетучую память по умолчанию. Использование этого аргумента изменит это поведение. Если аргумент установлен в всегда, то running-config всегда будет сохранена, и флаг изменено всегда будет установлен в True. Если аргумент установлен в изменено, то running-config будет сохранена только в том случае, если она изменилась с момента последнего сохранения в startup-config. Если аргумент установлен в никогда, running-config никогда не будет сохранена. Если аргумент установлен в изменено, то running-config будет сохранена только в том случае, если задача внесла изменение. | |
| src строка | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневой директории книги задач или роли. Этот аргумент несовместим с аргументами lines и parents. | ||
Примечания
Примечание
- Тестировалось с VOSS 7.0.0
- Сокращённые команды НЕ идемпотентны, см. Вопросы и ответы по сети.
Примеры
- name: Configure system name
community.network.voss_config:
lines: prompt "{{ inventory_hostname }}"
- name: Configure interface settings
community.network.voss_config:
lines:
- name "ServerA"
backup: yes
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: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup равно yes | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/vsp200_config.2018-08-21@15:00:21 |
| commands список / элементы=строка | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['interface GigabitEthernet 1/1', 'name "ServerA"', 'exit'] |
| updates список / элементы=строка | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['prompt "VSP200"'] |
Авторы
- Lindsay Hill (@LindsayHill)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/voss_config_module.html
