community.network.voss_config – Управление секциями конфигурации Extreme VOSS
Примечание
Этот плагин является частью коллекции community.network (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в книге задач укажите: community.network.voss_config.
Обзор
- Конфигурации Extreme VOSS используют простой текстовый синтаксис. Этот модуль предоставляет реализацию для работы с строками конфигурации EXOS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Аналогично параметру before, это позволяет разработчику книги задач добавить набор команд, которые будут выполнены после набора команд. | ||
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, резервный файл записывается в папку backup в корневой директории книги задач или корневой директории роли, если книга задач является частью роли Ansible. Если директория не существует, она создается. | |
| backup_options словарь | Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к резервному файлу. Значение этого параметра читается только тогда, когда backup установлено в да; если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр задаёт путь, заканчивающийся именем директории, в которой будет храниться резервный файл конфигурации. Если директория не существует, она будет сначала создана, а имя файла будет либо значением filename, либо значением по умолчанию, как описано в описании параметров filename. Если значение пути не указано, в этом случае будет создана директория backup в текущей рабочей директории, и резервная конфигурация будет скопирована в filename внутри директории backup. | ||
| filename строка | Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <hostname>_config.<current-date>@<current-time> | ||
| 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-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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/voss_config_module.html
