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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется внести изменения. Так же как и с параметром before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не указано, файл резервной копии записывается в папку `backup` в корневом каталоге playbook. Если директория не существует, она создается.
backup_options словарь добавлен в версии 2.8			Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только тогда, когда `backup` установлено в yes. Если `backup` установлено в no, этот параметр будет проигнорирован.
	dir_path путь		Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться конфигурационный файл резервной копии. Если директория не существует, она будет создана в первую очередь, а имя файла будет либо значением `filename`, либо именем по умолчанию, как описано в описании параметров `filename`. Если значение пути не указано, в текущем рабочем каталоге будет создана директория backup, и конфигурация резервной копии будет скопирована в `filename` внутри директории backup.
	filename -		Имя файла, которое будет использоваться для хранения конфигурации резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before -			Упорядоченный набор команд, которые добавляются в стек команд, если требуется внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения любых изменений, не влияя на то, как набор команд сопоставляется с системой.
diff_against -		Варианты: intended running	При использовании аргумента командной строки `ansible-playbook --diff` модуль может генерировать diff против разных источников. Если этот параметр настроен как intended, модуль вернёт diff между running-config и конфигурацией, указанной в аргументе `intended_config`. Если этот параметр настроен как running, модуль вернёт diff между running-config до и после внесения изменений в конфигурацию устройства.
diff_ignore_lines -			Используйте этот аргумент, чтобы указать одну или несколько строк, которые следует игнорировать во время diff. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config -			`intended_config` предоставляет базовая конфигурация, которой должен соответствовать узел, и используется для проверки конечной running-config. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение `diff_against` и установить его в intended.
lines -			Упорядоченный набор команд, которые должны быть настроены. Команды должны быть абсолютно идентичными командам, найденным в run-config устройства. Обратите внимание на синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: commands
match -		Варианты: line ← none	Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сопоставляются построчно. Если match установлен в none, модуль не будет пытаться сравнивать исходную конфигурацию с текущей конфигурацией удаленного устройства.
provider -			Объект типа 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`.
running_config -			По умолчанию модуль подключается к удалённому устройству и получает текущую running-config, чтобы использовать её в качестве основы для сравнения с содержимым исходного файла. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в playbook. Аргумент running_config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения. псевдонимы: config
save boolean		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить running-config в startup-config. Эта операция выполняется после внесения любых изменений в текущую running-config. Если изменений не было, конфигурация всё равно сохраняется в startup-config. Этот параметр всегда заставит модуль вернуть результат "изменилось". Этот аргумент несовместим с save_when. Этот параметр устарел начиная с Ansible 2.7, используйте `save_when`.
save_when - добавлен в 2.7		Варианты: always never ← changed	По умолчанию при внесении изменений в running-конфигурацию устройства, изменения не копируются в non-volatile хранилище. Этот аргумент изменит это. Если аргумент установлен в always, running-конфигурация всегда копируется в startup-конфигурацию, и модуль всегда возвращает результат "изменилось". Если аргумент установлен в never, running-конфигурация никогда не копируется в startup-конфигурацию. Если аргумент установлен в changed, running-конфигурация копируется в startup-конфигурацию только в том случае, если задача внесла изменения.
src -			Указывает исходный путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте Ansible или относительным путём от корневого каталога playbook или роли. Этот аргумент несовместим с lines.

Примеры

- name: configure configuration
  aireos_config:
    lines: sysname testDevice

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

- name: load new acl into device
  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
  aireos_config:
    backup: yes
    lines: sysname testDevice
    backup_options:
      filename: backup.cfg
      dir_path: /home/user

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

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

Ключ	Возвращаемое значение	Описание
backup_path строка	при backup равно yes	Полный путь к файлу резервной копии Пример: /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']

Статус

Для данного модуля не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

James Mighion (@jmighion)

Подсказка

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

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