Spec-Zone.ru › Ansible 2.4

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

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

  • Обзор
  • Параметры
  • Примеры
  • Возвращаемые значения
    • Статус

Обзор

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

Параметры

параметр обязательно по умолчанию варианты комментарии
after
нет
Упорядоченный набор команд, которые будут добавлены в конец стека команд, если требуется внести изменения. Так же как и с before, это позволяет разработчику плейбука добавить набор команд, которые будут выполнены после набора команд.
backup
нет
  • да
  • нет
Этот аргумент заставит модуль создать полную резервную копию текущего running-config с удаленного устройства перед внесением любых изменений. Файл резервной копии записывается в папку backup в корневой директории плейбука. Если директория не существует, она создается.
before
нет
Упорядоченный набор команд, которые будут помещены в стек команд, если требуется внести изменения. Это позволяет разработчику плейбука выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на способ сопоставления набора команд с системой.
diff_against
нет
  • startup
  • intended
  • running
При использовании аргумента командной строки ansible-playbook --diff модуль может генерировать разницы по различным источникам.
Когда этот параметр настроен как startup, модуль вернет разницу между running-config и startup-config.
Когда этот параметр настроен как intended, модуль вернет разницу между running-config и конфигурацией, предоставленной в аргументе intended_config.
Когда этот параметр настроен как running, модуль вернет разницу между running-config до и после любых изменений, внесенных в конфигурацию устройства.
diff_ignore_lines
нет
Используйте этот аргумент для указания одной или нескольких строк, которые должны быть проигнорированы во время сравнения. Это используется для строк в конфигурации, которые автоматически обновляются системой. Этот аргумент принимает список регулярных выражений или точных совпадений строк.
intended_config
нет
intended_config предоставляет главную конфигурацию, которой должен соответствовать узел, и используется для проверки окончательной running-config. Этот аргумент не будет изменять какие-либо настройки на удаленном устройстве и используется только для проверки соответствия текущей конфигурации устройства. При указании этого аргумента задача также должна изменить значение diff_against и установить его в значение intended.
lines
нет
Упорядоченный набор команд, которые должны быть настроены в разделе. Команды должны быть идентичны командам, найденным в running-config устройства. Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются парсером конфигурации устройства.
псевдонимы: команды
match
нет строка
  • строка
  • строго
  • точно
  • ничего
Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства. Если match установлен в значение строка, команды сопоставляются по строкам. Если match установлен в значение строго, строки команд сопоставляются с учетом позиции. Если match установлен в значение точно, строки команд должны быть точным совпадением. Наконец, если match установлен в значение ничего, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией на удаленном устройстве.
parents
нет
Упорядоченный набор родительских элементов, которые уникально идентифицируют раздел, с которым должны сравниваться команды. Если аргумент parents опущен, команды сравниваются с набором команд верхнего уровня или глобальными командами.
provider
нет
Объект словаря, содержащий данные подключения.
Объект словаря provider
параметр обязательно по умолчанию варианты комментарии
username
нет
Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME.
host
да
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
ssh_keyfile
нет
Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE.
timeout
нет 10
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
password
нет
Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD.
port
нет 22
Указывает порт, используемый при подключении к удаленному устройству.
replace
нет строка
  • строка
  • блок
Указывает модулю способ выполнения конфигурации на устройстве. Если аргумент replace установлен в значение строка, измененные строки передаются устройству в режиме конфигурации. Если аргумент replace установлен в значение блок, весь блок команд передается устройству в режиме конфигурации, если какая-либо строка неверна.
running_config
нет
По умолчанию модуль подключается к удаленному устройству и получает текущую running-config для использования в качестве основы для сравнения с содержимым источника. Иногда нежелательно получать текущую running-config для каждой задачи в плейбуке. Аргумент running_config позволяет разработчику передать конфигурацию, используемую в качестве базовой конфигурации для сравнения.
псевдонимы: конфигурация
save_when
нет никогда
  • всегда
  • никогда
  • изменено
При внесении изменений в рабочую конфигурацию устройства, изменения по умолчанию не копируются в энергонезависимую память. Использование этого аргумента изменит это поведение. Если аргумент установлен в значение всегда, running-config всегда будет копироваться в startup-config, а флаг изменено всегда будет установлен в True. Если аргумент установлен в значение изменено, running-config будет скопирована в startup-config только в том случае, если она изменилась с момента последней записи в startup-config. Если аргумент установлен в значение никогда, running-config никогда не будет скопирована в startup-config
src
нет
Указывает путь к исходному файлу, содержащему конфигурацию или шаблон конфигурации для загрузки. Путь к исходному файлу может быть полным путем на хосте Ansible или относительным путем от корневой директории плейбука или роли. Этот аргумент несовместим с аргументом lines.

Примеры

- 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 и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/aruba_config_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API