Spec-Zone.ru › Ansible

Модуль community.network.aireos_config — Управление конфигурациями Cisco WLC

Примечание

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

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

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

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

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

Обзор

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

Псевдонимы: network.aireos.aireos_config

Параметры

Параметр

Комментарии

after

строка

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

backup

булево

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

Варианты:

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

backup_options

словарь

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

dir_path

путь

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

filename

строка

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

before

строка

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

diff_against

строка

При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать разницы по отношению к различным источникам.

Если этот параметр настроен как intended, модуль вернёт разницу между текущей конфигурацией и конфигурацией, предоставленной в аргументе intended_config.

Если этот параметр настроен как running, модуль вернёт разницу «до» и «после» текущей конфигурации в отношении любых изменений, внесённых в конфигурацию устройства.

Варианты:

  • "intended"
  • "running"

diff_ignore_lines

строка

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

intended_config

строка

intended_config предоставляет основную конфигурацию, к которой должен соответствовать узел, и используется для проверки окончательной текущей конфигурации. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется только для проверки соответствия текущей конфигурации устройства. При указании этого аргумента необходимо также изменить значение diff_against и установить его в intended.

lines

алиасы: commands

строка

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

match

строка

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

Варианты:

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

running_config

алиасы: config

строка

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

save

булево

Аргумент save инструктирует модуль сохранить текущую конфигурацию в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений не было, конфигурация всё равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда заставит модуль вернуть значение «изменилось». Этот параметр несовместим с параметром save_when.

Этот параметр устарел начиная с Ansible 2.7, используйте save_when

Варианты:

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

save_when

string

При внесении изменений в конфигурацию устройства, изменения по умолчанию не копируются в энергонезависимую память. Использование этого аргумента изменит это. Если аргумент установлен на always, то текущая конфигурация всегда будет скопирована в стартовую конфигурацию, и модуль всегда будет возвращать изменение. Если аргумент установлен на never, текущая конфигурация никогда не будет скопирована в стартовую конфигурацию. Если аргумент установлен на changed, то текущая конфигурация будет скопирована в стартовую конфигурацию только в том случае, если задание внесло изменение.

Выбои:

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

src

string

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

Примеры

- name: Configure configuration
  community.network.aireos_config:
    lines: sysname testDevice

- name: Diff the running-config against a provided config
  community.network.aireos_config:
    diff_against: intended
    intended: "{{ lookup('file', 'master.cfg') }}"

- name: Load new acl into device
  community.network.aireos_config:
    lines:
      - acl create testACL
      - acl rule protocol testACL 1 any
      - acl rule direction testACL 3 in
    before: acl delete testACL

- name: Configurable backup path
  community.network.aireos_config:
    backup: true
    lines: sysname testDevice
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ

Описание

backup_path

string

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

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

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

commands

list / elements=string

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

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

Пример: ["hostname foo", "vlan 1", "name default"]

updates

list / elements=string

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

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

Пример: ["hostname foo", "vlan 1", "name default"]

Авторы

  • James Mighion (@jmighion)

Ссылки на коллекцию

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

© 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/aireos_config_module.html

Spec-Zone.ru

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