aruba_config – Управление разделами конфигурации Aruba

Новая в версии 2.4.

Описание
Параметры
Примеры
Значения возврата
Статус

Описание

Конфигурации Aruba используют простой синтаксис блочного отступа для сегментации конфигурации на разделы. Этот модуль предоставляет реализацию для работы с разделами конфигурации Aruba детерминированным способом.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
after -			Упорядоченный набор команд, которые будут добавлены в конец стека команд, если необходимо внести изменения. Как и в случае с before, это позволяет разработчику playbook добавить набор команд, которые будут выполнены после набора команд.
backup boolean		Варианты: no ← yes	Этот аргумент заставит модуль создать полную резервную копию текущего `running-config` с удаленного устройства перед внесением каких-либо изменений. Файл резервной копии будет записан в папку `backup` в корневой директории playbook. Если директория не существует, она будет создана.
before -			Упорядоченный набор команд, которые будут добавлены в стек команд, если необходимо внести изменения. Это позволяет разработчику playbook выполнить команды конфигурации до внесения любых изменений без влияния на соответствие набора команд системе.
diff_against -		Варианты: startup intended running	При использовании аргумента командной строки `ansible-playbook --diff` модуль может генерировать разницы (diff) с разными источниками. Когда этот параметр настроен как startup, модуль вернёт разницу между текущей конфигурацией (running-config) и конфигурацией по умолчанию (startup-config). Когда этот параметр настроен как intended, модуль вернёт разницу между текущей конфигурацией (running-config) и конфигурацией, предоставленной в аргументе `intended_config`. Когда этот параметр настроен как running, модуль вернёт разницу между конфигурацией до и после изменения конфигурации устройства.
diff_ignore_lines -			Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы при сравнении (diff). Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
encrypt boolean добавлен в 2.5		Варианты: no yes ←	Это позволяет отображать пароли и ключи контроллера Aruba в открытом виде (при установке false) или в зашифрованном виде (при установке true). Если установлено false, параметр будет заново зашифрован в конце выполнения модуля. Резервные копии по-прежнему зашифрованы даже при установке false.
intended_config -			`intended_config` предоставляет основную конфигурацию, которой должен соответствовать узел, и используется для проверки конечной конфигурации (running-config). Этот аргумент не будет изменять какие-либо настройки на удалённом устройстве и используется исключительно для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение `diff_against` и установить его в intended.
lines -			Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть абсолютно такими же, как и в конфигурации устройства (running-config). Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства. псевдонимы: commands
match -		Варианты: line ← strict exact none	Указывает модулю способ сравнения набора команд с текущей конфигурацией устройства. Если match установлен в line, команды сравниваются построчно. Если match установлен в strict, строки команд сравниваются с учётом позиции. Если match установлен в exact, строки команд должны быть точным совпадением. И, наконец, если match установлен в none, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удалённого устройства.
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 -		Варианты: line ← block	Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в line, то изменённые строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в block, то весь блок команд передаётся устройству в режиме конфигурации, если какая-либо строка не верна.
running_config -			Модуль по умолчанию подключается к удалённому устройству и получает текущую конфигурацию (running-config) для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую конфигурацию (running-config) для каждой задачи в playbook. Аргумент running_config позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения. псевдонимы: config
save_when - добавлен в 2.5		Варианты: always never ← modified changed	По умолчанию изменения в конфигурации устройства (running-configuration) не копируются в постоянную память. Используя этот аргумент, можно изменить это поведение. Если аргумент установлен в 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 или относительным путем от корневой директории 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: "{{ 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. [community]

Авторы

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.7/modules/aruba_config_module.html