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

Примечание

Этот плагин входит в сборку community.network (версия 2.0.1).

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

Чтобы использовать его в книге задач, укажите: community.network.aireos_config

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after строка			Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Аналогично параметру before, это позволяет разработчику книги задач добавить набор команд, которые будут выполнены после набора команд.
backup логическое значение		Варианты: нет ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением любых изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневой директории книги задач. Если директория не существует, она создается.
backup_options словарь			Это объект-словарь, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только в том случае, если `backup` установлено в да. Если `backup` установлено в нет, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр предоставляет путь, заканчивающийся именем директории, в которой будет храниться файл резервной копии конфигурации. Если директория не существует, она будет создана. Имя файла — это либо значение `filename`, либо имя файла по умолчанию, как описано в описании параметров `filename`. Если значение пути не указано, в текущей рабочей директории будет создана директория backup, и резервная копия конфигурации будет скопирована в `filename` внутри директории backup.
	filename строка		Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно генерируется на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before строка			Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику книги задач выполнить команды конфигурации перед внесением любых изменений, не влияя на способ сопоставления набора команд с системой.
diff_against строка		Варианты: запланированная рабочая	Используя аргумент командной строки `ansible-playbook --diff`, модуль может генерировать разницы по разным источникам. Если этот параметр настроен как запланированная, модуль вернет разницу между текущей конфигурацией и конфигурацией, предоставленной в аргументе `intended_config`. Если этот параметр настроен как рабочая, модуль вернет разницу между текущей конфигурацией до и после изменений, внесенных в конфигурацию устройства.
diff_ignore_lines строка			Используйте этот аргумент для указания одной или нескольких строк, которые следует игнорировать при вычислении разницы. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config строка			Это `intended_config` предоставляет основную конфигурацию, к которой должен соответствовать узел, и используется для проверки окончательной рабочей конфигурации. Этот аргумент не будет изменять какие-либо параметры на удаленном устройстве и используется только для проверки соответствия текущей конфигурации устройства. При использовании этого аргумента задача также должна изменить значение `diff_against` и установить его в запланированную.
lines строка			Упорядоченный набор команд, которые должны быть настроены. Команды должны быть точно такими же, как и в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды
match строка		Варианты: строка ← нет	Указывает модулю, как выполнить сопоставление набора команд с текущей конфигурацией устройства. Если match установлено в строка, команды сопоставляются построчно. Если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удаленном устройстве.
provider строка			Объект-словарь, содержащий данные соединения.
	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`.
running_config строка			По умолчанию модуль подключается к удаленному устройству и получает текущую рабочую конфигурацию, чтобы использовать ее в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую рабочую конфигурацию для каждой задачи в книге задач. Аргумент running_config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения. псевдонимы: конфигурация
save логическое значение		Варианты: нет ← да	Аргумент `save` инструктирует модуль сохранить рабочую конфигурацию в стартовую конфигурацию. Эта операция выполняется после внесения любых изменений в текущую рабочую конфигурацию. Если изменений нет, конфигурация все равно сохраняется в стартовую. Этот параметр всегда заставит модуль вернуть измененный статус. Этот аргумент несовместим с save_when. Этот параметр устарел, начиная с Ansible 2.7. Используйте `save_when`
save_when строка		Варианты: всегда никогда ← изменён	При внесении изменений в рабочую конфигурацию устройства изменения по умолчанию не копируются в энергонезависимую память. Использование этого аргумента изменит это. Если аргумент установлен в всегда, рабочая конфигурация всегда копируется в стартовую, и модуль всегда возвращает измененный статус. Если аргумент установлен в никогда, рабочая конфигурация никогда не копируется в стартовую. Если аргумент установлен в изменён, рабочая конфигурация копируется в стартовую только в том случае, если задача внесла изменения.
src строка			Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога книги задач или роли. Этот аргумент несовместим с 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: yes
    lines: sysname testDevice
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup = да	Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/aireos_config.2016-07-16@22:28:34
commands список / элементы=строка	всегда	Набор команд, которые будут отправлены на удаленное устройство Пример: ['hostname foo', 'vlan 1', 'name default']
updates список / элементы=строка	всегда	Набор команд, которые будут отправлены на удаленное устройство Пример: ['hostname foo', 'vlan 1', 'name default']

Авторы

James Mighion (@jmighion)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/aireos_config_module.html