iosxr_config - Управление разделами конфигурации Cisco IOS XR
Новое в версии 2.1.
Описание
- Конфигурации Cisco IOS XR используют простой синтаксис блочного отступа для разбиения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации IOS XR детерминированным способом.
Параметры
| параметр | обязателен | значение по умолчанию | возможные значения | комментарии | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| admin (добавлено в 2.4)
| нет |
| Переход в административный режим конфигурации для внесения изменений в конфигурацию устройства. | ||||||||||||||||||||||||||||||||||||
| after | нет | Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Так же, как и с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. | |||||||||||||||||||||||||||||||||||||
| backup (добавлено в 2.2)
| нет |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневой директории плейбука. Если папка не существует, она создается. | ||||||||||||||||||||||||||||||||||||
| before | нет | Упорядоченный набор команд для помещения в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до внесения любых изменений, не влияя на то, как набор команд сопоставляется с системой. | |||||||||||||||||||||||||||||||||||||
| comment (добавлено в 2.2)
| нет | настроен модулем iosxr_config | Разрешает указать описание коммита для включения при сохранении конфигурации. Если конфигурация не изменялась или не сохранялась, этот аргумент игнорируется. | ||||||||||||||||||||||||||||||||||||
| config | нет | Модуль по умолчанию подключается к удаленному устройству и извлекает текущую конфигурацию running-config, чтобы использовать ее в качестве основы для сравнения с содержимым source. Иногда нежелательно получать текущую конфигурацию running-config для каждой задачи в плейбуке. Аргумент config позволяет реализатору передать конфигурацию для использования в качестве базовой конфигурации для сравнения. | |||||||||||||||||||||||||||||||||||||
| force (добавлено в 2.2)
| нет |
| Аргумент force инструктирует модуль не учитывать текущую конфигурацию running-config устройств. Если он установлен в true, это заставит модуль переместить содержимое src на устройство без предварительной проверки, настроено ли оно уже. Обратите внимание, что этот аргумент следует считать устаревшим. Для достижения эквивалентного результата установите match=none, который является идемпотентным. Этот аргумент будет удален в будущей версии. | ||||||||||||||||||||||||||||||||||||
| lines | нет | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды | |||||||||||||||||||||||||||||||||||||
| match | нет | строка |
| Инструктирует модуль о способе выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сопоставляются построчно. Если match установлен в строго, строки команд сопоставляются с учетом позиции. Если match установлен в точно, строки команд должны быть точным соответствием. Наконец, если match установлен в ничего, модуль не будет пытаться сравнить исходную конфигурацию с конфигурацией running на удаленном устройстве. | |||||||||||||||||||||||||||||||||||
| parents | нет | Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел, с которым должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. | |||||||||||||||||||||||||||||||||||||
| provider | нет | Объект словаря, содержащий данные подключения. |
|||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| replace | нет | строка |
| Инструктирует модуль о способе выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, измененные строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команды отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. | |||||||||||||||||||||||||||||||||||
| src (добавлено в 2.2)
| нет | Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня плейбука или роли. Этот аргумент несовместим с lines. | |||||||||||||||||||||||||||||||||||||
Примеры
- name: configure top level configuration
iosxr_config:
lines: hostname {{ inventory_hostname }}
- name: configure interface settings
iosxr_config:
lines:
- description test interface
- ip address 172.31.1.1 255.255.255.0
parents: interface GigabitEthernet0/0/0/0
- name: load a config from disk and replace the current config
iosxr_config:
src: config.cfg
backup: yes
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| backup_path | Полный путь к файлу резервной копии | при backup=да | строка | /playbooks/ansible/backup/iosxr01.2016-07-16@22:28:34 |
| updates | Набор команд, которые будут отправлены на удаленное устройство | Только когда указано lines. | список | ['...', '...'] |
Примечания
Примечание
- Тестировалось на IOS XR 6.1.2
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля Red Hat вы найдете в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если у вас есть желание, пожалуйста, прочитайте Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/iosxr_config_module.html
