Spec-Zone.ru › Ansible 2.9

iosxr_config – Управление разделами конфигурации Cisco IOS XR

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Краткое описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
admin
boolean
добавлено в 2.4
    Варианты:
  • нет ←
  • да
Переходит в режим администрирования для внесения изменений в конфигурацию устройства.
after
-
Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Как и с параметром before, это позволяет автору сценария добавить набор команд, которые будут выполнены после набора команд.
backup
boolean
    Варианты:
  • нет ←
  • да
Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, файл резервной копии записывается в папку backup в корневом каталоге сценария или корневом каталоге роли, если сценарий является частью роли Ansible. Если каталог не существует, он создается.
backup_options
dictionary
добавлено в 2.8
Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только когда backup установлено в значение да, если backup установлено в нет, этот параметр будет проигнорирован.
dir_path
path
Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться файл конфигурации резервной копии. Если каталог не существует, он будет сначала создан, а имя файла будет либо значением filename, либо именем файла по умолчанию, как описано в описании параметров filename. Если значение пути не указано, в текущем рабочем каталоге будет создан каталог backup, и конфигурация резервной копии будет скопирована в filename внутри каталога backup.
filename
-
Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before
-
Упорядоченный набор команд, которые будут добавлены в стек команд, если требуется внести изменения. Это позволяет автору сценария выполнить команды конфигурации перед внесением каких-либо изменений, не затрагивая порядок сопоставления набора команд с системой.
comment
-
По умолчанию:
"configured by iosxr_config"
Позволяет указать описание коммита, которое будет включено при сохранении конфигурации. Если конфигурация не изменялась или не сохранялась, этот аргумент игнорируется.
config
-
Модуль по умолчанию подключается к удаленному устройству и извлекает текущую конфигурацию running-config, чтобы использовать ее в качестве основы для сравнения с содержимым источника. Иногда не нужно получать текущую конфигурацию running-config для каждой задачи в сценарии. Аргумент config позволяет разработчику передать конфигурацию, используемую в качестве базовой конфигурации для сравнения.
exclusive
boolean
добавлено в 2.9
    Варианты:
  • нет ←
  • да
Переходит в режим эксклюзивной конфигурации, который блокирует всех пользователей от внесения изменений в конфигурацию до завершения эксклюзивной сессии.
force
boolean
    Варианты:
  • нет ←
  • да
Аргумент force указывает модулю не учитывать текущую конфигурацию running-config устройства. При установке в значение true это приведет к передаче содержимого src на устройство без предварительной проверки, уже ли оно настроено.
Обратите внимание, что этот аргумент следует считать устаревшим. Для достижения эквивалента установите match=none, которое является идемпотентным. Этот аргумент будет удален в будущей версии.
label
-
добавлено в 2.7
Позволяет указать метку коммита, которая будет включена при сохранении конфигурации. Метка должна начинаться с буквы и не превышать 30 символов, допускаются только буквы, цифры, дефисы и подчеркивания. Если конфигурация не изменялась или не сохранялась, этот аргумент игнорируется.
lines
-
Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в конфигурации running-config устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.

псевдонимы: команды
match
-
    Варианты:
  • строка ←
  • строго
  • точно
  • ничего
Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сравниваются построчно. Если match установлено в строго, строки команд сравниваются с учетом позиции. Если match установлено в точно, строки команд должны быть идентичными. Наконец, если match установлено в ничего, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удаленном устройстве.
parents
-
Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider
dictionary
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Для получения дополнительной информации см. Руководство по сети.
Объект типа dict, содержащий сведения о подключении.
host
строка / обязательно
Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола.
password
строка
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port
целое число
По умолчанию:
22
Указывает порт, используемый при построении подключения к удаленному устройству.
ssh_keyfile
путь
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истек до завершения операции, модуль вернет ошибку.
username
строка
Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
replace
-
    Варианты:
  • строка ←
  • блок
  • конфигурация
Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в строка, измененные строки передаются на устройство в режиме конфигурации. Если аргумент replace установлен в блок, весь блок команд передается на устройство в режиме конфигурации, если какая-либо строка неверна.
src
-
Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте управления Ansible или относительным путем от корневого каталога playbook или роли. Этот аргумент взаимоисключает с lines, parents.

Примечания

Примечание

  • Этот модуль работает с подключением network_cli. См. параметры платформы IOS-XR.
  • Проверено на IOS XRv 6.1.3.
  • Этот модуль не поддерживает подключение netconf
  • Сокращенные команды НЕ идемпотентны, см. Вопросы и ответы по сети.
  • Избегайте изменений, нарушающих работу сервиса (например, IP-адрес управления) при замене конфигурации.
  • Не используйте end в файле заменяемой конфигурации.
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible.
  • Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- 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
    replace: config
    backup: yes

- name: for idempotency, use full-form commands
  iosxr_config:
    lines:
      # - shut
      - shutdown
    # parents: int g0/0/0/1
    parents: interface GigabitEthernet0/0/0/1

- name: configurable backup path
  iosxr_config:
    src: config.cfg
    backup: yes
    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


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается командой Ansible Network. [сеть]

Поддержка Red Hat

Дополнительная информация о поддержке этого модуля Red Hat доступна в этой статье базы знаний Red Hat.

Авторы

  • Ricardo Carrillo Cruz (@rcarrillocruz)

Подсказка

Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/iosxr_config_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API