Spec-Zone.ru › Ansible 2.5

dellos6_config — Управление секциями конфигурации Dell EMC Networking OS6

Новая версия с 2.2.

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус
    • Автор

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
after Значение по умолчанию:
None
Упорядоченный набор команд, добавляемых в конец стека команд, если необходимо внести изменения. Как и с before, это позволяет разработчику плейбука добавить набор команд, которые должны быть выполнены после набора команд.
backup
    Варианты:
  • no ←
  • yes
Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневом каталоге плейбука. Если каталога не существует, он создаётся.
before Значение по умолчанию:
None
Упорядоченный набор команд, помещаемых в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации до добавления любых изменений без влияния на способ сопоставления набора команд с системой.
config Значение по умолчанию:
None
Модуль по умолчанию подключается к удалённому устройству и извлекает текущую running-config, чтобы использовать её в качестве базы для сравнения с содержимым source. Иногда нежелательно получать текущую running-config для каждой задачи в плейбуке. Аргумент config позволяет реализатору передать конфигурацию, используемую в качестве базовой конфигурации для сравнения.
lines Значение по умолчанию:
None
Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть идентичными командам, найденным в running-config устройства. Убедитесь, что вы учитываете синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. Этот аргумент взаимоисключает src.

псевдонимы: команды
match
    Варианты:
  • line ←
  • strict
  • exact
  • none
Указывает модулю, как выполнять сопоставление набора команд с текущей конфигурацией устройства. Если match установлен на line, команды сопоставляются построчно. Если match установлен на strict, строки команд сопоставляются с учётом позиции. Если match установлен на exact, строки команд должны точно совпадать. Наконец, если match установлен на none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удалённом устройстве.
parents Значение по умолчанию:
None
Упорядоченный набор родительских элементов, которые уникально идентифицируют секцию или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд.
provider Значение по умолчанию:
None
Объект словаря, содержащий данные подключения.
username
Пользователь для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME.
host
требуется
Указывает имя DNS хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
ssh_keyfile
Путь к файлу ssh-ключа, используемому для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout Значение по умолчанию:
10
Указывает время ожидания бездействия (в секундах) для подключения. Полезно, если консоль зависает перед продолжением. Например, при сохранении конфигурации.
password Значение по умолчанию:
None
Пароль для аутентификации сеанса SSH с удалённым устройством. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD.
port Значение по умолчанию:
22
Указывает порт для использования при создании подключения к удалённому устройству.
replace
    Варианты:
  • line ←
  • block
Указывает модулю, как выполнять конфигурацию на устройстве. Если replace установлен на line, изменённые строки добавляются на устройство в режиме конфигурации. Если replace установлен на block, весь блок команд добавляется на устройство в режиме конфигурации, если какая-либо строка неверна.
save
    Варианты:
  • yes
  • no ←
Аргумент save инструктирует модуль сохранить running-config в startup-config по завершении работы модуля. Если указан режим проверки, этот аргумент игнорируется.
src Значение по умолчанию:
None
Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневого каталога плейбука или роли. Этот аргумент взаимоисключает lines.
update
    Варианты:
  • merge ←
  • check
Аргумент update управляет тем, как обрабатываются операторы конфигурации на удалённом устройстве. Допустимые варианты для аргумента update — merge и check. При установке аргумента на merge изменения конфигурации сливаются с текущей конфигурацией устройства. При установке аргумента на check изменения конфигурации определяются, но фактически не применяются на удалённом устройстве.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами Dell EMC Network см. на странице https://www.ansible.com/ansible-dell-networking.

Примеры

- dellos6_config:
    lines: ['hostname {{ inventory_hostname }}']

- dellos6_config:
    lines:
      - 10 permit ip 1.1.1.1 any log
      - 20 permit ip 2.2.2.2 any log
      - 30 permit ip 3.3.3.3 any log
      - 40 permit ip 4.4.4.4 any log
      - 50 permit ip  5.5.5.5 any log
    parents: ['ip access-list test']
    before: ['no ip access-list test']
    match: exact

- dellos6_config:
    lines:
      - 10 permit ip 1.1.1.1 any log
      - 20 permit ip 2.2.2.2 any log
      - 30 permit ip 3.3.3.3 any log
      - 40 permit ip 4.4.4.4 any log
    parents: ['ip access-list test']
    before: ['no ip access-list test']
    replace: block

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

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

Ключ Возвращаемое значение Описание
backup_path
строка
при backup = yes
Полный путь к резервному файлу

Пример:
/playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34
commands
список
всегда
Набор команд, которые будут отправлены на удалённое устройство

Пример:
['interface Te1/0/1', 'no shutdown', 'exit']
saved
булево
когда не check_mode.
Возвращает, сохраняется ли конфигурация в startup-конфигурацию или нет.

Пример:
True
updates
список
всегда
Набор команд, которые будут отправлены на удалённое устройство.

Пример:
['interface Te1/0/1', 'no shutdown', 'exit']


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.

Автор

  • Abirami N(@abirami-n)

Подсказка

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

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

Spec-Zone.ru

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