aruba_config — Управление разделами конфигурации Aruba
Новое в версии 2.4.
Обзор
- Конфигурации Aruba используют простой синтаксис с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации Aruba детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after | Значение по умолчанию: None | Упорядоченный набор команд для добавления в конец стека команд, если требуется внести изменения. Так же, как и с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. | |
| backup |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она создается. | |
| before | Значение по умолчанию: None | Упорядоченный набор команд для добавления в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на то, как набор команд сопоставляется с системой. | |
| diff_against |
| При использовании аргумента командной строки ansible-playbook --diff, модуль может генерировать различия по отношению к различным источникам.Если этот параметр настроен как startup, модуль вернёт разницу между текущей конфигурацией и конфигурацией по умолчанию. Если этот параметр настроен как intended, модуль вернёт разницу между текущей конфигурацией и конфигурацией, предоставленной в аргументе intended_config.Если этот параметр настроен как running, модуль вернет разницу до и после текущей конфигурации относительно любых изменений, внесенных в конфигурацию устройства. | |
| diff_ignore_lines | Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время вычисления разницы. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| encrypt (добавлено в 2.5) | Значение по умолчанию: yes | Это позволяет отображать пароли и ключи контроллера Aruba в открытом виде, если установлено значение false, или в зашифрованном виде, если установлено значение true. Если значение установлено как false, настройка будет перешифрована в конце выполнения модуля. Резервные копии все равно будут зашифрованы, даже если значение установлено как false. | |
| intended_config | intended_config предоставляет основную конфигурацию, к которой должен соответствовать узел, и используется для проверки окончательной текущей конфигурации. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в intended. | ||
| lines | Значение по умолчанию: None | Упорядоченный набор команд, которые должны быть настроены в секции. Команды должны быть идентичными командам, найденным в текущей конфигурации устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | |
| match |
| Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено как line, команды сопоставляются по строкам. Если match установлено как strict, строки команд сопоставляются с учётом позиции. Если match установлено как exact, строки команд должны точно совпадать. Наконец, если match установлено как none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удалённого устройства. | |
| parents | Значение по умолчанию: None | Упорядоченный набор родителей, которые однозначно идентифицируют секцию или иерархию, по которым следует проверять команды. Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальным командам. | |
| provider | Значение по умолчанию: None | Объект типа dict, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве целевого адреса для протокола. | ||
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль вернёт ошибку. | |
| password | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | Значение по умолчанию: 22 | Указывает порт, используемый при подключении к удалённому устройству. | |
| replace |
| Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в значение line, изменённые строки передаются устройству в режиме конфигурации. Если параметр replace установлен в значение block, весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка неверна. | |
| running_config | Значение по умолчанию: None | Модуль по умолчанию подключается к удалённому устройству и извлекает текущую конфигурацию running-config, чтобы использовать её в качестве основы для сравнения с содержимым source. Иногда нежелательно, чтобы задача получала текущую конфигурацию running-config для каждой задачи в плейбуке. Аргумент running_config позволяет реализатору передать конфигурацию для использования в качестве основной конфигурации сравнения. псевдонимы: config | |
| save_when (добавлено в 2.5) |
| При внесении изменений в текущую конфигурацию устройства, изменения по умолчанию не записываются в энергонезависимую память. С помощью этого аргумента это можно изменить. Если аргумент установлен в always, текущая конфигурация всегда копируется в конфигурацию по умолчанию, и флаг modified всегда устанавливается в True. Если аргумент установлен в modified, текущая конфигурация копируется в конфигурацию по умолчанию только если она изменилась с момента последней записи в конфигурацию по умолчанию. Если аргумент установлен в never, текущая конфигурация никогда не копируется в конфигурацию по умолчанию. Если аргумент установлен в changed, текущая конфигурация копируется в конфигурацию по умолчанию только в том случае, если задача внесла изменения. | |
| src | Значение по умолчанию: None | Указывает исходный путь к файлу, который содержит конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневой директории плейбука или роли. Этот аргумент исключает lines, parents. | |
Примеры
- name: configure top level configuration
aruba_config:
lines: hostname {{ inventory_hostname }}
- name: diff the running-config against a provided config
aruba_config:
diff_against: intended
intended: "{{ lookup('file', 'master.cfg') }}"
- name: configure interface settings
aruba_config:
lines:
- description test interface
- ip access-group 1 in
parents: interface gigabitethernet 0/0/0
- name: load new acl into device
aruba_config:
lines:
- permit host 10.10.10.10
- ipv6 permit host fda9:97d6:32a3:3e59::3333
parents: ip access-list standard 1
before: no ip access-list standard 1
match: exact
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | при backup = да | Полный путь к резервной копии файла Пример: /playbooks/ansible/backup/aruba_config.2016-07-16@22:28:34 |
| commands список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['hostname foo', 'vlan 1', 'name default'] |
| updates список | всегда | Набор команд, которые будут отправлены на удалённое устройство Пример: ['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.5/modules/aruba_config_module.html
