Модуль f5networks.f5_modules.bigip_config — Управление разделами конфигурации BIG-IP

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач укажите: f5networks.f5_modules.bigip_config.

Новое в f5networks.f5_modules 1.0.0

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

Описание

Управляет конфигурацией BIG-IP, позволяя использовать команды TMSH для изменения текущей конфигурации или слияния файлов формата SCF в текущую конфигурацию. Дополнительно этот модуль имеет важное значение, так как позволяет сохранять текущую конфигурацию на диск. Поскольку все модули F5 манипулируют текущей конфигурацией, важно использовать этот модуль для сохранения текущей конфигурации.

Параметры

Параметр	Комментарии
merge_content строка	Загружает указанную конфигурацию, которую нужно слить в текущую конфигурацию. Это эквивалентно использованию команды `tmsh` `load sys config from-terminal merge`. Если необходимо читать конфигурацию из файла или шаблона, используйте Ansible’s `file` или `template` плагины поиска соответственно.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
auth_provider строка	Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem логическое	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TELEMETRY_OFF`. Предыдущая используемая переменная `F5_TEEM` устарела, так как её название было запутанным. Варианты: `false` ← (по умолчанию) `true`
пароль псевдонимы: pass, pwd строка / обязательный	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_PASSWORD`.
сервер строка / обязательный	Хост BIG-IP или хост BIG-IQ. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
сервер_порт целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
таймаут целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
транспорт строка	Настраивает транспортное подключение для использования при подключении к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
пользователь строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
проверять_сертификаты логическое	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
сбросить логическое	Загружает стандартную конфигурацию на устройстве. Если этот параметр указан, стандартная конфигурация загружается до выполнения любых команд или другой предоставляемой конфигурации. Варианты: `false` ← (по умолчанию) `true`
сохранить логическое	Аргумент `save` указывает модулю сохранить текущую конфигурацию в стартовую конфигурацию. Эта операция выполняется после внесения любых изменений в текущую конфигурацию. Если изменений нет, конфигурация всё равно сохраняется в стартовую конфигурацию. Этот параметр всегда заставляет модуль вернуть изменён. Варианты: `false` `true` ← (по умолчанию)
проверить логическое	Проверяет указанную конфигурацию на валидность для замены текущей конфигурации. Текущая конфигурация не будет изменена. Когда этот параметр установлен в `true`, модуль не сообщает об изменениях. Варианты: `false` ← (по умолчанию) `true`

Примечания

Примечание

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

Примеры

- name: Save the running configuration of the BIG-IP
  bigip_config:
    save: true
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

- name: Reset the BIG-IP configuration, for example, to RMA the device
  bigip_config:
    reset: true
    save: true
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

- name: Load an SCF configuration
  bigip_config:
    merge_content: "{{ lookup('file', '/path/to/config.scf') }}"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

Значения возврата

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

Ключ	Описание
stdout список / элементы=строка	Набор ответов из опций. Возвращается: всегда Пример: `["...", "..."]`
stdout_lines список / элементы=строка	Значение stdout, разделенное на список. Возвращается: всегда Пример: `[["...", "..."], ["..."], ["..."]]`

Авторы

Tim Rupp (@caphrim007)

Ссылки на коллекцию

© 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/f5networks/f5_modules/bigip_config_module.html