aruba_config — Управление разделами конфигурации Aruba
Новая версия 2.4.
Краткое описание
- Конфигурации Aruba используют простой синтаксис с отступами для разделения конфигурации на секции. Этот модуль предоставляет реализацию для работы с секциями конфигурации Aruba детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after | Упорядоченный набор команд для добавления в конец стека команд, если требуется изменение. Так же как и с before, это позволяет разработчику плана заданий добавить набор команд, которые будут выполнены после набора команд. | ||
| backup bool |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config с удалённого устройства перед внесением каких-либо изменений. Файл резервной копии записывается в папку backup в корневом каталоге плана заданий. Если папка не существует, она создаётся. | |
| before | Упорядоченный набор команд для добавления в стек команд, если требуется изменение. Это позволяет разработчику плана заданий выполнить команды конфигурации до внесения любых изменений, не влияя на способ сопоставления набора команд с системой. | ||
| diff_against |
| При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать разницы с различными источниками.Когда этот параметр настроен как startup, модуль вернёт разницу между running-config и startup-config. Когда этот параметр настроен как intended, модуль вернёт разницу между running-config и конфигурацией, предоставленной в аргументе intended_config. Когда этот параметр настроен как running, модуль вернёт разницу между running-config до и после внесения изменений в конфигурацию устройства. | |
| diff_ignore_lines | Используйте этот аргумент для указания одной или нескольких строк, которые должны быть пропущены при сравнении. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| encrypt bool (добавлено в 2.5) |
| Это позволяет отображать пароли и ключи контроллера Aruba в открытом виде, если значение установлено в false, или шифровать, если значение установлено в true. Если значение установлено в false, настройка будет повторно зашифрована в конце выполнения модуля. Резервные копии по-прежнему зашифрованы даже при установке значения в false. | |
| intended_config | intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной конфигурации running-config. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется только для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в intended. | ||
| lines | Упорядоченный набор команд, которые должны быть сконфигурированы в секции. Команды должны быть точно такими же, как и в текущей конфигурации running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | ||
| match |
| Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сравниваются построчно. Если match установлено в strict, строки команд сравниваются с учётом позиции. Если match установлено в exact, строки команд должны точно совпадать. Если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией running на удалённом устройстве. | |
| parents | Упорядоченный набор родителей, которые однозначно идентифицируют секцию или иерархию, с которыми должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальных команд. | ||
| provider | Объект dict, содержащий данные подключения. | ||
| 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. | ||
| replace |
| Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в block, весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка неверна. | |
| running_config | По умолчанию модуль подключается к удалённому устройству и получает текущую конфигурацию running-config для использования в качестве базы для сравнения с содержимым источника. Иногда нежелательно получать текущую конфигурацию running-config для каждой задачи в плане заданий. Аргумент running_config позволяет реализатору передать конфигурацию, используемую в качестве базовой конфигурации для сравнения. псевдонимы: config | ||
| save_when (добавлено в 2.5) |
| По умолчанию при внесении изменений в текущую конфигурацию running устройства, эти изменения не копируются в постоянную память. Этот аргумент изменяет это поведение. Если аргумент установлен в always, running-config всегда копируется в startup-config, а флаг modified всегда устанавливается в True. Если аргумент установлен в modified, running-config копируется в startup-config только если он изменился с момента последней сохранения в startup-config. Если аргумент установлен в never, running-config никогда не копируется в startup-config. Если аргумент установлен в changed, running-config копируется в startup-config только если задача внесла изменения. | |
| src | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на хосте 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'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом 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/aruba_config_module.html
