community.network.nos_config – Управление разделами конфигурации Extreme Networks NOS
Примечание
Этот плагин входит в коллекцию community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.nos_config.
Обзор
- Конфигурации Extreme NOS используют простой синтаксис отступов блоков для разделения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации NOS детерминированным способом.
Примечание
Этот модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Как и с before, это позволяет автору книги задач добавить набор команд, которые будут выполнены после набора команд. | ||
| backup булево |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не задано, файл резервной копии записывается в папку backup в корневой директории книги задач. Если директория не существует, она создается. | |
| backup_options словарь | Это объект словаря, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только при backup установлено в да, если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться резервный файл конфигурации. Если каталог не существует, он будет создан в первую очередь, и имя файла будет либо значением filename, либо именем по умолчанию, как описано в filename описании параметров. Если значение пути не указано, в этом случае будет создан каталог backup в текущем рабочем каталоге, и резервная копия конфигурации будет скопирована в filename в каталоге backup. | ||
| filename строка | Имя файла, используемое для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before строка | Упорядоченный набор команд для помещения в стек команд, если требуется изменение. Это позволяет автору книги задач выполнить команды конфигурации перед внесением каких-либо изменений без влияния на способ сопоставления набора команд с системой. | ||
| diff_against строка |
| При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать разницы с различными источниками.При настройке этого параметра как запланированная, модуль вернет разницу между текущей конфигурацией и конфигурацией, предоставленной в аргументе intended_config. При настройке этого параметра как работающая, модуль вернет разницу до и после текущей конфигурации по отношению к любым изменениям, внесенным в конфигурацию устройства. | |
| diff_ignore_lines строка | Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| intended_config строка | intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной текущей конфигурации. Этот аргумент не будет изменять какие-либо параметры на удаленном устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства предоставленной. При указании этого аргумента задача также должна изменить значение diff_against и установить его в запланированная. | ||
| lines строка | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как в конфигурации текущей работы устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды | ||
| match строка |
| Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются по строкам. Если match установлен в жесткий, строки команд сопоставляются с учетом позиции. Если match установлен в точный, строки команд должны совпадать. Наконец, если match установлен в нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. | |
| multiline_delimiter строка | По умолчанию: "@" | Этот аргумент используется при передаче многострочного элемента конфигурации устройству NOS. Он определяет символ, который будет использоваться в качестве разделителя. Это относится только к действию конфигурации. | |
| parents строка | Упорядоченный набор родителей, однозначно определяющих раздел или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. | ||
| replace строка |
| Указывает модулю, как выполнить конфигурацию на устройстве. Если аргумент replace установлен в строка, измененные строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд передается на устройство в режиме конфигурации, если какая-либо строка неверна. | |
| running_config строка | Модуль по умолчанию подключается к удаленному устройству и извлекает текущую конфигурацию для использования в качестве основы для сравнения с содержимым источника. Бывают случаи, когда задача не должна получать текущую конфигурацию для каждой задачи в книге задач. Аргумент running_config позволяет реализатору передать конфигурацию для использования в качестве базовой конфигурации для сравнения. псевдонимы: конфигурация | ||
| src строка | Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня книги задач или роли. Этот аргумент несовместим с lines, parents. | ||
Примечания
Примечание
- Проверено на NOS 7.2.0
Примеры
- name: Configure top level configuration
community.network.nos_config:
lines: logging raslog console INFO
- name: Configure interface settings
community.network.nos_config:
lines:
- description test interface
- ip address 172.31.1.1/24
parents:
- interface TenGigabitEthernet 104/0/1
- name: Configure multiple interfaces
community.network.nos_config:
lines:
- lacp timeout long
parents: "{{ item }}"
with_items:
- interface TenGigabitEthernet 104/0/1
- interface TenGigabitEthernet 104/0/2
- name: Load new acl into device
community.network.nos_config:
lines:
- seq 10 permit ip host 1.1.1.1 any log
- seq 20 permit ip host 2.2.2.2 any log
- seq 30 permit ip host 3.3.3.3 any log
- seq 40 permit ip host 4.4.4.4 any log
- seq 50 permit ip host 5.5.5.5 any log
parents: ip access-list extended test
before: no ip access-list extended test
match: exact
- name: Check the running-config against master config
community.network.nos_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: Configurable backup path
community.network.nos_config:
lines: logging raslog console INFO
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup = да | Полный путь к файлу резервной копии Пример: /playbooks/ansible/backup/nos_config.2018-02-12@18:26:34 |
| commands список / элементы=строка | всегда | Набор команд, которые будут переданы на удаленное устройство Пример: ['switch-attributes hostname foo', 'router ospf', 'area 0'] |
| updates список / элементы=строка | всегда | Набор команд, которые будут переданы на удаленное устройство Пример: ['switch-attributes hostname foo', 'router ospf', 'area 0'] |
Авторы
- 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/nos_config_module.html