Spec-Zone.ru › Ansible

Модуль community.network.ironware_config — Управление разделами конфигурации на устройствах Extreme Ironware

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

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

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

Для использования в книге задач укажите: community.network.ironware_config.

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

Обзор

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

Псевдонимы: network.ironware.ironware_config

Параметры

Параметр

Комментарии

after

строка

Упорядоченный набор команд, добавляемых в конец стека команд, если требуется изменение. Подобно параметру before, это позволяет автору плейбука добавить набор команд для выполнения после набора команд.

authorize

логическое

Устарело

Начиная с Ansible 2.7, рекомендуется использовать connection: network_cli и become: true.

Для получения дополнительной информации см. руководство IronWare Platform Options.

<hr>

Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE.

Варианты:

  • false ← (по умолчанию)
  • true

backup

логическое

Этот параметр заставит модуль создать полную резервную копию текущего running-config с удаленного устройства перед внесением каких-либо изменений. Если значение backup_options не указано, файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она создается.

Варианты:

  • false ← (по умолчанию)
  • true

backup_options

словарь

Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра читается только тогда, когда backup установлено в да; если backup установлено в нет, этот параметр будет проигнорирован.

dir_path

путь

Этот параметр задает путь, заканчивающийся именем каталога, в котором будет храниться файл резервной копии конфигурации. Если каталог не существует, он создается в первую очередь, а имя файла — это значение filename или имя файла по умолчанию, как описано в описании параметров filename. Если значение пути не задано, в текущем рабочем каталоге создается каталог backup, и резервная копия конфигурации копируется в filename внутри каталога backup.

filename

строка

Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно генерируется на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>

before

строка

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

commit

строка

Этот параметр определяет метод обновления, используемый при применении изменений конфигурации к удаленному узлу. Если значение установлено в merge, обновления конфигурации объединяются с текущей конфигурацией. Если значение установлено в check, изменения на удаленном хосте не вносятся.

Варианты:

  • "merge" ← (по умолчанию)
  • "check"

config

строка

Параметр config позволяет автору плейбука указать базу конфигурации, используемую для проверки необходимых изменений конфигурации. Если этот параметр задан, модуль не будет загружать текущую конфигурацию с удаленного узла.

строки

псевдонимы: команды

строка

Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть идентичны командам, найденным в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.

match

строка

Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются построчно. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны точно совпадать. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве.

Варианты:

  • "line" ← (по умолчанию)
  • "strict"
  • "exact"
  • "none"

parents

строка

Упорядоченный набор родителей, уникально определяющих раздел, с которым должны сравниваться команды. Если параметр parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами.

replace

строка

Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в line, измененные строки отправляются устройству в режиме конфигурации. Если параметр replace установлен в block, весь блок команд отправляется устройству в режиме конфигурации, если какая-либо строка неверна.

Варианты:

  • "line" ← (по умолчанию)
  • "block"

save_when

string

При внесении изменений в текущую конфигурацию устройства, эти изменения по умолчанию не копируются в постоянное хранилище. Использование этого аргумента изменит это поведение. Если аргумент установлен в always, то текущая конфигурация (running-config) всегда будет скопирована в стартовую конфигурацию (startup-config), и флаг modified всегда будет установлен в True. Если аргумент установлен в modified, то текущая конфигурация будет скопирована в стартовую только в случае, если она изменилась с момента последнего сохранения в стартовую конфигурацию. Если аргумент установлен в never, текущая конфигурация никогда не будет скопирована в стартовую.

Выбираемые значения:

  • "always"
  • "never" ← (по умолчанию)
  • "modified"

src

string

Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корня playbook или роли. Этот аргумент несовместим с аргументами lines и parents.

update

string

Аргумент update управляет тем, как обрабатываются команды конфигурации на удаленном устройстве. Допустимые значения для аргумента update — merge и check. При значении merge изменения конфигурации объединяются с текущей рабочей конфигурацией устройства. При значении check изменения конфигурации определяются, но фактически не настраиваются на удалённом устройстве.

Выбираемые значения:

  • "merge" ← (по умолчанию)
  • "check"

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`Руководстве по Ansible для сетей

Примеры

- name: Run commands that should be configured in the section
  community.network.ironware_config:
    lines:
      - port-name test
      - enable
      - load-interval 30
      - rate-limit input broadcast unknown-unicast multicast 521216 64000
    parents: ['interface ethernet 1/2']

Возвращаемые значения

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

Ключ

Описание

backup_path

string

Полный путь к резервной копии файла.

Возвращается: при backup = yes

Пример: "/playbooks/ansible/backup/ironware_config.2016-07-16@22:28:34"

updates

list / elements=string

Набор команд, которые будут отправлены на удаленное устройство.

Возвращается: всегда

Пример: ["...", "..."]

Авторы

  • Paul Baker (@paulquack)

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

  • Система отслеживания задач
  • Репозиторий (исходники)

© 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/community/network/ironware_config_module.html

Spec-Zone.ru

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