aruba_config – Управление разделами конфигурации Aruba
Новая в версии 2.4.
Описание
- Конфигурации Aruba используют простой синтаксис блочного отступа для сегментации конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации Aruba детерминированным способом.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| after - | Упорядоченный набор команд, которые добавляются в конец стека команд, если требуется внести изменения. Так же как и с параметром before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд. | ||
| backup boolean |
| Этот аргумент заставит модуль создать полную резервную копию текущей running-config удалённого устройства перед внесением любых изменений. Если значение backup_options не задано, файл резервной копии будет сохранён в папке backup в корневом каталоге плейбука. Если папка не существует, она будет создана. | |
| backup_options словарь добавлено в 2.8 | Это объект типа dict, содержащий настраиваемые параметры, связанные с путём к файлу резервной копии. Значение этого параметра читается только при условии, что backup установлено в значение да. Если backup установлено в нет, этот параметр будет проигнорирован. | ||
| dir_path путь | Этот параметр предоставляет путь, заканчивающийся именем каталога, в котором будет храниться конфигурационный файл резервной копии. Если каталог не существует, он будет сначала создан, а имя файла — это значение filename или имя файла по умолчанию, как описано в описании параметров filename. Если значение пути не задано, в текущей рабочей директории будет создан каталог backup, и конфигурация резервной копии будет скопирована в filename внутри каталога backup. | ||
| filename - | Имя файла, используемое для хранения конфигурации резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время> | ||
| before - | Упорядоченный набор команд, которые помещаются в стек команд, если необходимо внести изменение. Это даёт разработчику плейбука возможность выполнить команды конфигурации перед внесением изменений, не влияя на то, как набор команд сопоставляется с системой. | ||
| diff_against - |
| При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать разницы по различным источникам.Когда этот параметр настроен как startup, модуль вернёт разницу между running-config и startup-config. Когда этот параметр настроен как intended, модуль вернёт разницу между running-config и конфигурацией, предоставленной в аргументе intended_config.Когда этот параметр настроен как running, модуль вернёт разницу «до» и «после» running-config по отношению к любым внесённым изменениям в конфигурацию устройства. | |
| diff_ignore_lines - | Используйте этот аргумент, чтобы указать одну или несколько строк, которые должны быть пропущены при сравнении. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк. | ||
| encrypt boolean добавлено в 2.5 |
| Это позволяет отображать пароли и ключи контроллера Aruba в открытом виде (если установлено false) или в зашифрованном виде (если установлено true). Если установлено false, настройка будет перешифрована в конце выполнения модуля. Резервные копии по-прежнему зашифрованы, даже если установлено false. | |
| intended_config - | intended_config предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной running-config. Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в intended. | ||
| lines - | Упорядоченный набор команд, которые должны быть сконфигурированы в данном разделе. Команды должны быть точно такими же, как и в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: команды | ||
| 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 позволяет разработчику передать конфигурацию, используемую в качестве базовой конфигурации для сравнения. псевдонимы: конфигурация | ||
| save_when - добавлено в 2.5 |
| При внесении изменений в конфигурацию устройства, по умолчанию изменения не копируются в энергонезависимую память. Использование этого аргумента изменит это поведение. Если аргумент установлен в always, то текущая конфигурация (running-config) всегда будет копироваться в стартовую конфигурацию (startup-config), и флаг modified всегда будет установлен в True. Если аргумент установлен в modified, то текущая конфигурация будет скопирована в стартовую только в том случае, если она изменилась с момента последнего сохранения в стартовую конфигурацию. Если аргумент установлен в never, то текущая конфигурация никогда не будет скопирована в стартовую конфигурацию. Если аргумент установлен в changed, то текущая конфигурация будет скопирована в стартовую только в том случае, если задача внесла изменения. | |
| src - | Указывает путь к файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible control или относительным путем от корневого каталога playbook или роли. Этот аргумент взаимоисключающий с 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_config: "{{ 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
- name: configurable backup path
aruba_config:
backup: yes
lines: hostname {{ inventory_hostname }}
backup_options:
filename: backup.cfg
dir_path: /home/user
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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. [сообщество]
Авторы
- 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.9/modules/aruba_config_module.html
