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

Примечание

Этот плагин является частью коллекции community.network (версия 1.3.0).

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after строка			Последовательность команд, которые будут добавлены в конец стека команд, если необходимо внести изменения. Так же, как и с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup логическое значение		Варианты: no ← да	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Если значение `backup_options` не указано, резервный файл записывается в папку `backup` в корневой директории плейбука. Если папки не существует, она создается.
backup_options словарь			Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра считывается только при указании `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 строка			Объект типа 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 позволяет реализатору передать конфигурацию для использования в качестве базовой конфигурации для сравнения. псевдонимы: конфигурация
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 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/aireos_config_module.html