aireos_config - Управление конфигурациями Cisco WLC
Новое в версии 2.4.
Обзор
- AireOS не использует синтаксис файла с отступом в блоке, поэтому нет разделов или родителей. Этот модуль предоставляет реализацию работы с конфигурациями AireOS детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after | Значение по умолчанию: None | Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Как и в случае с before, это позволяет разработчику плана действий добавить набор команд, которые должны быть выполнены после набора команд. | |
| backup |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневой директории плана действий. Если директория не существует, она создается. | |
| before | Значение по умолчанию: None | Упорядоченный набор команд, которые следует добавить в стек команд, если требуется внести изменения. Это позволяет разработчику плана действий выполнить команды конфигурации до внесения каких-либо изменений без влияния на то, как набор команд сопоставляется с системой. | |
| diff_against |
| При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать различия по отношению к различным источникам.Когда этот параметр настроен как intended, модуль вернет различия между running-config и конфигурацией, предоставленной в аргументе intended_config. Когда этот параметр настроен как running, модуль вернет различия до и после running-config по отношению к любым изменениям, внесенным в конфигурацию устройства. | |
| diff_ignore_lines | Используйте этот аргумент для указания одной или нескольких строк, которые должны быть пропущены при сравнении. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| intended_config | intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки конечной running-config. Этот аргумент не будет изменять какие-либо параметры на удаленном устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в intended. | ||
| lines | Значение по умолчанию: None | Упорядоченный набор команд, которые должны быть настроены. Команды должны быть идентичны тем, которые находятся в конфигурации run-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. алиасы: команды | |
| match |
| Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сравниваются по строкам. Если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве. | |
| provider | Значение по умолчанию: None | Объект словаря, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль вернет ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт, используемый при построении подключения к удаленному устройству. | |
| running_config | Значение по умолчанию: None | Модуль по умолчанию подключается к удаленному устройству и извлекает текущую running-config для использования в качестве основы для сравнения с содержимым source. В некоторых случаях нежелательно заставлять задачу получать текущую running-config для каждой задачи в плане действий. Аргумент running_config позволяет реализатору передать конфигурацию, которая будет использоваться в качестве базовой конфигурации для сравнения. алиасы: config | |
| save |
| Аргумент save указывает модулю сохранить running-config в startup-config по завершении выполнения модуля. Если указан режим проверки, этот аргумент игнорируется. | |
| src | Значение по умолчанию: None | Указывает путь к источнику файла, содержащего конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте 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 = 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'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Автор
- 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.5/modules/aireos_config_module.html
