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