Spec-Zone.ru › Ansible 2.8

bigip_imish_config – Управление разделами расширенной конфигурации маршрутизации BIG-IP

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
after
список
Упорядоченный набор команд, которые должны быть добавлены в конец стека команд, если требуется изменение.
Так же, как и с параметром before, это позволяет разработчику playbook добавить набор команд для выполнения после набора команд.
backup
логическое значение
    Варианты:
  • нет ←
  • да
Этот аргумент заставит модуль создать полную резервную копию текущей running-config удаленного устройства перед внесением каких-либо изменений.
Файл резервной копии записывается в папку backup в корневом каталоге playbook или корневом каталоге роли, если playbook является частью роли Ansible. Если каталог не существует, он создается.
backup_options
словарь
добавлено в 2.8
Это объект типа dict, содержащий настраиваемые параметры, связанные с путем к файлу резервной копии. Значение этого параметра читается только тогда, когда backup установлено в да; если backup установлено в нет, этот параметр будет проигнорирован.
dir_path
путь
Этот параметр указывает путь, заканчивающийся именем каталога, в котором будет храниться файл конфигурации резервной копии. Если каталог не существует, он будет сначала создан, а имя файла будет либо значением filename, либо именем файла по умолчанию, как описано в filename описании параметров. Если значение пути не указано, в этом случае будет создан каталог backup в текущем рабочем каталоге, и конфигурация резервной копии будет скопирована в filename в каталоге backup.
filename
строка
Имя файла, которое будет использоваться для хранения конфигурации резервной копии. Если имя файла не указано, оно будет сгенерировано на основе имени хоста, текущей даты и времени в формате <имя_хоста>_config.<дата>@<время>
before
список
Упорядоченный набор команд для добавления в стек команд, если необходимо внести изменения.
Это позволяет разработчику playbook выполнить команды конфигурации перед внесением каких-либо изменений, не влияя на способ сопоставления набора команд с системой.
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 устройства.
Обратите внимание на синтаксис команд конфигурации, так как некоторые команды автоматически изменяются анализатором конфигурации устройства.

алиасы: commands
match
строка
    Варианты:
  • строка ←
  • строгое
  • точное
  • нет
Указывает модулю способ сопоставления набора команд с текущей конфигурацией устройства.
Если match установлено в строка, команды сопоставляются по строкам.
Если match установлено в строгое, строки команд сопоставляются с учетом позиции.
Если match установлено в точное, строки команд должны быть идентичны.
Наконец, если match установлено в нет, модуль не будет пытаться сравнить исходную конфигурацию с текущей конфигурацией удаленного устройства.
parents
список
Упорядоченный набор родительских элементов, которые однозначно идентифицируют раздел или иерархию, с которыми должны быть проверены команды.
Если аргумент parents опущен, команды проверяются по отношению к набору команд верхнего уровня или глобальным командам.
password
строка / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

алиасы: pass, pwd
provider
словарь
добавлено в 2.5
Объект типа dict, содержащий данные подключения.
password
строка / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

алиасы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.
ssh_keyfile
путь
Указывает файл ключа SSH, который будет использоваться для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli.
Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Значение по умолчанию:
10
Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истекает до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli
  • rest ←
Настраивает транспортное соединение для использования при подключении к удаленному устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, находящихся под вашим контролем, которые используют самозаверенные сертификаты.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
замена
строка
    Выбор:
  • строка ←
  • блок
Инструктирует модуль о способе выполнения конфигурации на устройстве.
Если аргумент replace установлен в строка, то измененные строки отправляются на устройство в режиме конфигурации.
Если аргумент replace установлен в блок, то весь блок команд отправляется на устройство в режиме конфигурации, если какая-либо строка неверна.
область_маршрутизации
строка
По умолчанию:
0
Область маршрутизации для управления конфигурацией BGP.
текущая_конфигурация
строка
Модуль по умолчанию подключится к удаленному устройству и получит текущую рабочую конфигурацию для использования в качестве основы для сравнения с содержимым источника.
Бывают случаи, когда нежелательно, чтобы задача получала текущую рабочую конфигурацию для каждой задачи в плане.
Аргумент текущая_конфигурация позволяет разработчику передать конфигурацию для использования в качестве базовой конфигурации для сравнения.

алиасы: конфигурация
сохранять_при
строка
    Выбор:
  • всегда
  • никогда ←
  • изменённая
  • изменилась
При внесении изменений в рабочую конфигурацию устройства, эти изменения по умолчанию не копируются в энергонезависимую память.
Если аргумент установлен в всегда, то текущая конфигурация всегда будет скопирована в начальную конфигурацию, и флаг изменённая всегда будет установлен в True.
Если аргумент установлен в изменённая, то текущая конфигурация будет скопирована в начальную конфигурацию только в том случае, если она изменилась с момента последнего сохранения в начальную конфигурацию.
Если аргумент установлен в никогда, текущая конфигурация никогда не будет скопирована в начальную конфигурацию.
Если аргумент установлен в изменилась, то текущая конфигурация будет скопирована в начальную конфигурацию только в том случае, если задача внесла изменение.
сервер
строка / требуется
Хост BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER.
порт_сервера
целое_число
добавлен в 2.2
По умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную среды F5_SERVER_PORT.
источник
путь
Аргумент источник указывает путь к файлу конфигурации, который необходимо загрузить в удаленную систему.
Путь может быть полным системным путем к файлу конфигурации, если значение начинается с /, или относительным к корню реализованного роли или плана.
Этот аргумент взаимоисключающий с аргументами строки и родители.
пользователь
строка / требуется
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве.
Этот параметр можно опустить, установив переменную среды F5_USER.
проверять_сертификаты
булево
добавлен в 2.0
    Выбор:
  • нет
  • да ←
Если no, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами.
Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS.

Примечания

Примечание

  • Сокращенные команды НЕ идемпотентны, см. FAQ по сети.
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. в https://www.ansible.com/integrations/networks/f5.
  • Требуется версия ПО BIG-IP >= 12.
  • Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы гарантировать сохранение конфигурации BIG-IP на диске, убедитесь, что включена по крайней мере одна задача, использующая модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: configure top level configuration and save it
  bigip_imish_config:
    lines: bfd slow-timer 2000
    save_when: modified
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: diff the running-config against a provided config
  bigip_imish_config:
    diff_against: intended
    intended_config: "{{ lookup('file', 'master.cfg') }}"
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add config to a parent block
  bigip_imish_config:
    lines:
      - bgp graceful-restart restart-time 120
      - redistribute kernel route-map rhi
      - neighbor 10.10.10.11 remote-as 65000
      - neighbor 10.10.10.11 fall-over bfd
      - neighbor 10.10.10.11 remote-as 65000
      - neighbor 10.10.10.11 fall-over bfd
    parents: router bgp 64664
    match: exact
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove an existing acl before writing it
  bigip_imish_config:
    lines:
      - access-list 10 permit 20.20.20.20
      - access-list 10 permit 20.20.20.21
      - access-list 10 deny any
    before: no access-list 10
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: for idempotency, use full-form commands
  bigip_imish_config:
    lines:
      # - desc My interface
      - description My Interface
    # parents: int ANYCAST-P2P-2
    parents: interface ANYCAST-P2P-2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: configurable backup path
  bigip_imish_config:
    lines: bfd slow-timer 2000
    backup: yes
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
    backup_options:
      filename: backup.cfg
      dir_path: /home/user
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны в этом разделе, следующие являются полями, уникальными для данного модуля:

Ключ Возвращаемое значение Описание
путь_резервной_копии
строка
при резервном копировании да
Полный путь к резервной копии

Пример:
/playbooks/ansible/backup/bigip_imish_config.2016-07-16@22:28:34
команды
список
всегда
Набор команд, которые будут отправлены на удаленное устройство

Пример:
['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd']
обновления
список
всегда
Набор команд, которые будут отправлены на удаленное устройство

Пример:
['interface ANYCAST-P2P-2', 'neighbor 20.20.20.21 remote-as 65000', 'neighbor 20.20.20.21 fall-over bfd']


Статус

  • Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
  • Данный модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

  • Tim Rupp (@caphrim007)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете редактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

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