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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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: `file` или `template`.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem логический	Если задано значение `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, так как её название вводило в заблуждение. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport строка	Настраивает транспортное подключение, используемое для соединения с удалённым устройством. Варианты: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs логический	Если задано значение `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
reset логический	Загружает конфигурацию устройства по умолчанию. Если задан этот параметр, конфигурация по умолчанию загружается до выполнения команд или применения другой указанной конфигурации. Варианты: `false` ← (по умолчанию) `true`
save логический	Аргумент `save` указывает модулю сохранить running-config в startup-config. Эта операция выполняется после внесения любых изменений в текущую работающую конфигурацию. Если изменений нет, конфигурация всё равно сохраняется в startup-config. Этот параметр всегда приводит к тому, что модуль возвращает значение изменено. Варианты: `false` `true` ← (по умолчанию)
verify логический	Проверяет, допустима ли указанная конфигурация для замены работающей конфигурации. Работающая конфигурация не изменяется. Если для этого параметра задано значение `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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_config_module.html