Модуль community.network.aruba_config — Управление разделами конфигурации Aruba
Примечание
Этот модуль входит в коллекцию community.network (версия 5.0.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в плейбуке, укажите: community.network.aruba_config.
Обзор
- Конфигурации Aruba используют простой синтаксис блочного отступа для разделения конфигурации на секции. Этот модуль обеспечивает реализацию работы с разделами конфигурации Aruba детерминированным способом.
Псевдонимы: network.aruba.aruba_config
Параметры
Параметр | Комментарии |
|---|---|
after строка | Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется внести изменения. Так же, как и с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. |
backup логическое | Этот параметр заставит модуль создать полную резервную копию текущей Варианты:
|
backup_options словарь | Это объект типа dict, содержащий настраиваемые параметры, относящиеся к пути к файлу резервной копии. Значение этого параметра считывается только когда |
|
dir_path путь |
Этот параметр указывает путь к папке, в которой будет храниться файл резервной копии конфигурации. Если папка не существует, она будет создана, а имя файла будет либо значением |
|
filename строка |
Имя файла, используемого для хранения резервной копии конфигурации. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> |
before строка | Упорядоченный набор команд, которые добавляются в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением любых изменений без влияния на то, как набор команд сопоставляется с системой. |
diff_against строка | При использовании параметра командной строки Когда этот параметр настроен как startup, модуль вернёт разницу между текущей конфигурацией и конфигурацией по умолчанию. Когда этот параметр настроен как intended, модуль вернёт разницу между текущей конфигурацией и конфигурацией, предоставленной в параметре Когда этот параметр настроен как running, модуль вернёт разницу до и после текущей конфигурации относительно любых изменений, внесённых в конфигурацию устройства. Варианты:
|
diff_ignore_lines строка | Используйте этот параметр для указания одной или нескольких строк, которые следует игнорировать во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот параметр принимает список регулярных выражений или точных совпадений строк. |
encrypt логическое | Это позволяет отображать пароли и ключи контроллера Aruba в виде обычного текста, когда установлено в false, или зашифрованным, когда установлено в true. Если установлено в false, настройка будет повторно зашифрована по завершении работы модуля. Резервные копии по-прежнему зашифрованы, даже если установлено в false. Варианты:
|
intended_config строка |
|
lines псевдонимы: commands строка | Упорядоченный набор команд, которые должны быть сконфигурированы в разделе. Команды должны быть точно такими же, как и в рабочей конфигурации устройства. Убедитесь, что вы учли синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства. |
match строка | Указывает модулю способ выполнения сопоставления набора команд с текущей конфигурацией устройства. Если match установлено в line, команды сопоставляются по строкам. Если match установлено в strict, строки команд сопоставляются относительно позиции. Если match установлено в exact, строки команд должны быть точным совпадением. Наконец, если match установлено в none, модуль не будет пытаться сравнить исходную конфигурацию с рабочей конфигурацией на удалённом устройстве. Варианты:
|
parents строка | Упорядоченный набор родительских элементов, которые уникально идентифицируют раздел или иерархию, по которым должны проверяться команды. Если параметр parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальных команд. |
replace строка | Указывает модулю способ выполнения конфигурации на устройстве. Если параметр replace установлен в line, изменённые строки отправляются на устройство в режиме конфигурации. Если параметр replace установлен в block, весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна. Варианты:
|
running_config aliases: config строка | Модуль по умолчанию подключается к удалённому устройству и извлекает текущую конфигурацию running-config, чтобы использовать её в качестве основы для сравнения с содержимым источника. Иногда нежелательно, чтобы задача получала текущую running-config для каждой задачи в плейбуке. Аргумент running_config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения. |
save_when строка | При внесении изменений в конфигурацию устройства running-configuration, эти изменения по умолчанию не копируются в энергонезависимую память. Использование этого аргумента изменит это. Если аргумент установлен на always, то running-config всегда будет скопирована в стартовую конфигурацию, а флаг modified всегда будет установлен в True. Если аргумент установлен на modified, то running-config будет скопирована в стартовую конфигурацию только в случае её изменения с момента последнего сохранения в стартовую конфигурацию. Если аргумент установлен на never, running-config никогда не будет скопирована в стартовую конфигурацию. Если аргумент установлен на changed, то running-config будет скопирована в стартовую конфигурацию только в том случае, если задача внесла изменения. Варианты:
|
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: true
lines: hostname {{ inventory_hostname }}
backup_options:
filename: backup.cfg
dir_path: /home/user
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
backup_path строка | Полный путь к файлу резервной копии Возвращается: при backup = yes Пример: |
commands список / элементы=строка | Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: |
updates список / элементы=строка | Набор команд, которые будут отправлены на удалённое устройство Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/aruba_config_module.html
