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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд, которые нужно добавить в конец стека команд, если требуется внести изменение. Подобно параметру before, это позволяет разработчику плейбука добавить набор команд, которые должны выполняться после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущей `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку `backup` в корневом каталоге плейбука. Если папка не существует, она создается.
before -			Упорядоченный набор команд для добавления в стек команд, если требуется внести изменение. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением любых изменений без влияния на сопоставление набора команд с системой.
diff_against -		Варианты: intended running	При использовании аргумента `ansible-playbook --diff` командной строки модуль может генерировать разницы по отношению к различным источникам. Когда этот параметр настроен как intended, модуль вернет разницу между текущей конфигурацией и конфигурацией, предоставленной в аргументе `intended_config`. Когда этот параметр настроен как running, модуль вернет разницу до и после текущей конфигурации в сравнении с любыми изменениями, внесенными в конфигурацию устройства.
diff_ignore_lines -			Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время разницы. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config -			`intended_config` предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки конечной текущей конфигурации. Этот аргумент не будет изменять какие-либо настройки на удаленном устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение `diff_against` и установить его в значение intended.
lines -			Упорядоченный набор команд, которые должны быть сконфигурированы. Команды должны быть точно такими же, как и в конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, поскольку некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: команды
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 позволяет разработчику передать конфигурацию, используемую в качестве базовой конфигурации для сравнения. псевдонимы: config
save boolean		Варианты: no ← yes	Аргумент `save` указывает модулю сохранить текущую конфигурацию в конфигурацию по умолчанию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений нет, конфигурация все равно сохраняется в конфигурацию по умолчанию. Этот параметр всегда приводит к возвращению модулем значения изменилось. Этот аргумент несовместим с save_when. Этот параметр устарел, начиная с Ansible 2.7. Используйте `save_when`.
save_when - добавлен в 2.7		Варианты: always never ← changed	При внесении изменений в текущую конфигурацию устройства по умолчанию изменения не копируются в постоянное хранилище. Этот аргумент изменяет это. Если аргумент установлен в always, текущая конфигурация всегда копируется в конфигурацию по умолчанию, и модуль всегда возвращает значение изменилось. Если аргумент установлен в never, текущая конфигурация никогда не копируется в конфигурацию по умолчанию. Если аргумент установлен в changed, текущая конфигурация копируется в конфигурацию по умолчанию только если задача внесла изменение.
src -			Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневого каталога плейбука или роли. Этот аргумент несовместим с 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

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

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

Ключ	Возвращаемое значение	Описание
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']

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом 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.7/modules/aireos_config_module.html