cisco.iosxr.iosxr_config модуль — Модуль для управления разделами конфигурации.

Примечание

Этот модуль входит в коллекцию cisco.iosxr (версия 9.0.0).

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

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

Для использования в плейбуке укажите: cisco.iosxr.iosxr_config.

Добавлена в cisco.iosxr 1.0.0

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

Обзор

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

Псевдонимы: config

Параметры

Параметр	Комментарии
admin boolean	Переход в режим администрирования для внесения изменений в конфигурацию устройства. Варианты: `false` ← (по умолчанию) `true`
after список / элементы=строка	Упорядоченный набор команд для добавления в конец стека команд, если необходимо внести изменения. Так же, как и с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup boolean	Этот параметр заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение параметра `backup_options` не задано, файл резервной копии записывается в папку `backup` в корневом каталоге плейбука или в корневом каталоге роли, если плейбук является частью роли ansible. Если папка не существует, она создается. Варианты: `false` ← (по умолчанию) `true`
backup_options словарь	Это объект типа словарь, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только в том случае, если `backup` установлено в yes, если `backup` установлено в no, этот параметр будет проигнорирован.
dir_path путь	Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться файл конфигурации резервной копии. Если каталог не существует, он будет создан. Имя файла — это либо значение параметра `filename`, либо имя файла по умолчанию, как описано в `filename`. Если значение пути не задано, в текущем рабочем каталоге будет создан каталог backup, и резервная копия конфигурации будет скопирована в `filename` в каталоге backup.
filename строка	Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before список / элементы=строка	Упорядоченный набор команд, которые нужно поместить в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений без влияния на сопоставление набора команд с системой.
comment строка	Разрешает указать описание коммита, которое будет включено при коммите конфигурации. Если конфигурация не изменена или не откоммичена, этот параметр игнорируется. По умолчанию: `"configured by iosxr_config"`
config строка	Модуль по умолчанию подключается к удаленному устройству и извлекает текущую конфигурацию running-config, чтобы использовать ее в качестве основы для сравнения с содержимым источника. Иногда нежелательно запрашивать текущую running-config для каждой задачи в плейбуке. Параметр config позволяет разработчику указать конфигурацию, которую необходимо использовать в качестве базовой конфигурации для сравнения. Строки конфигурации для этого параметра должны быть похожи на строки в текущей running-config устройства, чтобы обеспечить идемпотентность и правильное различие.
disable_default_comment boolean	Отключает комментарий по умолчанию при установке в True. Варианты: `false` ← (по умолчанию) `true`
exclusive boolean	Переход в эксклюзивный режим конфигурации, который блокирует всех пользователей от внесения изменений в конфигурацию до завершения эксклюзивной сессии. Варианты: `false` ← (по умолчанию) `true`
force boolean	Параметр force сообщает модулю не учитывать текущую конфигурацию running-config устройства. При установке в значение true это заставит модуль скопировать содержимое src на устройство без предварительной проверки, не сконфигурировано ли это уже. Обратите внимание, что этот параметр следует считать устаревшим. Для достижения эквивалентного результата установите параметр `match=none`, который является идемпотентным. Этот параметр будет удален в будущих версиях. Варианты: `false` ← (по умолчанию) `true`
label строка	Разрешает указать метку коммита, которая будет включена при коммите конфигурации. Метка должна начинаться с буквы и не должна превышать 30 символов, допускаются только буквы, цифры, дефисы и символы подчеркивания. Если конфигурация не изменена или не откоммичена, этот параметр игнорируется.
строки псевдонимы: команды список / элементы=строка	Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть точными копиями команд, найденных в конфигурации running-config устройства, чтобы гарантировать идемпотентность и правильное различие. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.

match строка	Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве. Варианты: `"line"` ← (по умолчанию) `"strict"` `"exact"` `"none"`
parents список / элементы=строка	Упорядоченный набор родителей, которые однозначно определяют раздел или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются со множеством команд верхнего уровня или глобальных команд.
replace строка	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, то изменённые строки отправляются на устройство в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. Варианты: `"line"` ← (по умолчанию) `"block"` `"config"`
src путь	Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневого каталога книги задач или роли. Этот аргумент взаимоисключающий с lines, parents. Строки конфигурации в исходном файле должны быть похожи на то, как они будут отображаться в текущей конфигурации устройства, чтобы обеспечить идемпотентность и правильное различие.

Примечания

Примечание

Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_iosxr.html
Этот модуль не поддерживает подключение netconf
Сокращённые команды НЕ идемпотентны, см. https://docs.ansible.com/ansible/latest/network/user_guide/faq.html#why-do-the-config-modules-always-return-changed-true-with-abbreviated-commands
Избегайте изменений, которые могут нарушить работу службы (например, IP-адрес управления) из конфигурации replace.
Не используйте end в файле конфигурации replace.
Для обеспечения идемпотентности и корректного сравнения строки конфигурации в соответствующих параметрах модуля должны быть похожи на то, как они отображаются в текущей конфигурации устройства, включая отступы.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в разделе :ref:`Руководство по сети Ansible <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco `<https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

- name: configure top level configuration
  cisco.iosxr.iosxr_config:
    lines: hostname {{ inventory_hostname }}

- name: configure interface settings
  cisco.iosxr.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
  cisco.iosxr.iosxr_config:
    src: config.cfg
    replace: config
    backup: 'yes'

- name: 'for idempotency, use full-form commands'
  cisco.iosxr.iosxr_config:
    lines:
      - shutdown
    parents: interface GigabitEthernet0/0/0/1

- name: configurable backup path
  cisco.iosxr.iosxr_config:
    src: config.cfg
    backup: true
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Описание
backup_path строка	Полный путь к резервной копии файла Возвращается: при backup yes Пример: `"/playbooks/ansible/backup/iosxr01_config.2016-07-16@22:28:34"`
commands список / элементы=строка	Набор команд, которые будут отправлены на удалённое устройство Возвращается: если есть команды для выполнения на хосте Пример: `["hostname foo", "router ospf 1", "router-id 1.1.1.1"]`
date строка	Дата, извлечённая из имени файла резервной копии Возвращается: при backup yes Пример: `"2016-07-16"`
filename строка	Имя файла резервной копии Возвращается: при backup yes и имя файла не указано в параметрах резервной копии Пример: `"iosxr01_config.2016-07-16@22:28:34"`
shortname строка	Полный путь к файлу резервной копии без отметки времени Возвращается: при backup yes и имя файла не указано в параметрах резервной копии Пример: `"/playbooks/ansible/backup/iosxr01_config"`
time строка	Время, извлечённое из имени файла резервной копии Возвращается: при backup yes Пример: `"22:28:34"`
updates список / элементы=строка	Набор команд, которые будут отправлены на удалённое устройство Возвращается: если есть команды для выполнения на хосте Пример: `["hostname foo", "router ospf 1", "router-id 1.1.1.1"]`

Авторы

Ricardo Carrillo Cruz (@rcarrillocruz)

Ссылки на сборку

© 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/cisco/iosxr/iosxr_config_module.html