community.network.aruba_config – Управление разделами конфигурации Aruba
Примечание
Этот плагин является частью коллекции community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Для использования в плейбуке укажите: community.network.aruba_config.
Обзор
- Конфигурации Aruba используют простой синтаксис с отступами для разбиения конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации Aruba детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after строка | Упорядоченный набор команд, которые добавляются в конец стека команд, если необходимо внести изменения. Как и в случае с параметром before, это позволяет разработчику плейбука добавить набор команд для выполнения после набора команд. | ||
| backup логическое значение |
| Этот аргумент заставит модуль создать полную резервную копию текущего running-config с удалённого устройства перед внесением каких-либо изменений. Если значение параметра backup_options не указано, резервная копия сохраняется в папку backup в корневой директории плейбука. Если директория не существует, она создаётся. | |
| backup_options словарь | Это объект типа dict, содержащий конфигурируемые параметры, связанные с путём к резервной копии. Значение этого параметра считывается только тогда, когда backup установлено в да. Если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр задаёт путь, заканчивающийся именем директории, в которой будет храниться конфигурационный файл резервной копии. Если директория не существует, она будет создана, а имя файла будет либо значением filename, либо значением по умолчанию, как описано в описании параметров filename. Если значение пути не указано, в текущей рабочей директории будет создана директория backup, а конфигурационный файл резервной копии будет скопирован в filename внутри директории backup. | ||
| filename строка | Имя файла, которое будет использоваться для хранения конфигурационного файла резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущего времени и даты в формате <имя_хоста>_config.<дата>@<время>. | ||
| before строка | Упорядоченный набор команд, которые добавляются в стек команд, если необходимо внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не затрагивая порядок сопоставления набора команд с системой. | ||
| diff_against строка |
| При использовании аргумента командной строки ansible-playbook --diff, модуль может генерировать разницы с различными источниками.Когда этот параметр установлен как startup, модуль вернёт разницу между running-config и startup конфигурацией. Когда этот параметр установлен как intended, модуль вернёт разницу между running-config и конфигурацией, указанной в аргументе intended_config.Когда этот параметр установлен как running, модуль вернёт разницу до и после running-config по отношению к любым изменениям, внесённым в конфигурацию устройства. | |
| diff_ignore_lines строка | Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| encrypt логическое значение |
| Это позволяет отображать пароли и ключи контроллера Aruba в открытом виде, если установлено в false, или в зашифрованном виде, если установлено в true. Если установлено в false, настройка будет перешифрована в конце выполнения модуля. Резервные копии по-прежнему зашифрованы, даже если установлено в false. | |
| intended_config строка | intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной running-config. Этот аргумент не будет изменять никаких настроек на удалённом устройстве и строго используется для проверки соответствия текущей конфигурации устройства. При указании этого аргумента, задача также должна изменить значение diff_against и установить его в intended. | ||
| lines строка | Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть точно такими же, как и в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. псевдонимы: commands | ||
| match строка |
| Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлен в строка, команды сравниваются по строкам. Если match установлен в строгое, строки команд сравниваются с учётом позиции. Если match установлен в точно, строки команд должны быть точным совпадением. Наконец, если match установлен в ничего, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удалённого устройства. | |
| parents строка | Упорядоченный набор родительских элементов, уникально определяющих раздел или иерархию, с которой должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами. | ||
| 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. | ||
| replace строка |
| Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в строка, изменённые строки отправляются устройству в режиме конфигурации. Если параметр replace установлен в блок, весь блок команд отправляется устройству в режиме конфигурации, если какая-либо строка неверна. | |
| running_config строка | По умолчанию модуль подключается к удалённому устройству и получает текущую running-config для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в плейбуке. Аргумент running_config позволяет реализатору указать конфигурацию, которую следует использовать в качестве базовой конфигурации для сравнения. псевдонимы: config | ||
| save_when строка |
| При внесении изменений в running-конфигурацию устройства, по умолчанию изменения не копируются в нелетучую память. Этот аргумент изменит это поведение. Если аргумент установлен в всегда, то running-config всегда копируется в startup конфигурацию, и флаг изменено всегда устанавливается в True. Если аргумент установлен в изменено, то running-config копируется в startup конфигурацию только в том случае, если она изменилась с момента последнего сохранения в startup конфигурацию. Если аргумент установлен в никогда, running-config никогда не копируется в startup конфигурацию. Если аргумент установлен в изменено, то running-config копируется в startup конфигурацию только в том случае, если задача внесла изменения. | |
| src строка | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путём на контрольном хосте Ansible или относительным путём от корня плейбука или роли. Этот аргумент взаимоисключающий с lines, parents. | ||
Примеры
- name: Configure top level configuration
community.network.aruba_config:
lines: hostname {{ inventory_hostname }}
- name: Diff the running-config against a provided config
community.network.aruba_config:
diff_against: intended
intended_config: "{{ lookup('file', 'master.cfg') }}"
- name: Configure interface settings
community.network.aruba_config:
lines:
- description test interface
- ip access-group 1 in
parents: interface gigabitethernet 0/0/0
- name: Load new acl into device
community.network.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
- name: Configurable backup path
community.network.aruba_config:
backup: yes
lines: hostname {{ inventory_hostname }}
backup_options:
filename: backup.cfg
dir_path: /home/user
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| backup_path строка | если резервное копирование — да | Полный путь к резервной копии файла Пример: /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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/aruba_config_module.html
