Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_profile_udp — управление профилями UDP на 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_profile_udp.

Добавлено в f5networks.f5_modules 1.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управление профилями UDP в системе BIG-IP. Существует множество профилей UDP, каждый из которых содержит собственные настройки стандартного профиля udp. Пользователям этого модуля следует учитывать, что для многих доступных параметров значение по умолчанию в модуле не задано. Вместо этого значение по умолчанию назначает сама система BIG-IP, и в большинстве случаев оно подходит.

Параметры

Параметр

Комментарии

datagram_load_balancing

логическое значение

Если задано true, указывает, что система балансирует нагрузку UDP, обрабатывая каждый пакет отдельно.

Варианты:

  • false
  • true

idle_timeout

строка

Задает время, в течение которого соединение остается неактивным (по нему не передается трафик), прежде чем его можно будет удалить.

При создании нового профиля, если этот параметр не задан, удаленное устройство выберет значение по умолчанию, подходящее для профиля на основе его профиля parent.

Если указано число, оно задает количество секунд, в течение которых UDP-соединение может оставаться неактивным до удаления системой.

Если задано indefinite, UDP-соединения могут оставаться неактивными неограниченно долго.

Если задано 0 или immediate, UDP-соединение не должно оставаться неактивным и поэтому сразу становится доступным для удаления.

name

строка / обязательный

Задает имя профиля.

parent

строка

Задает профиль, от которого этот профиль наследует настройки.

При создании нового профиля, если этот параметр не задан, по умолчанию используется системный профиль udp.

partition

строка

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

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 ← (по умолчанию)

state

строка

Если задано present, гарантирует, что профиль существует.

Если задано absent, гарантирует, что профиль удален.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

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

Примеры

- name: Create a TCP profile
  bigip_profile_tcp:
    name: foo
    parent: udp
    idle_timeout: 300
    datagram_load_balancing: false
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

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

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

Ключ

Описание

datagram_load_balancing

логическое значение

Новое значение параметра балансировки нагрузки датаграмм ресурса.

Возвращается: при изменении

Пример: true

idle_timeout

целое число

Новое время ожидания бездействия ресурса.

Возвращается: при изменении

Пример: 100

parent

строка

Новый родительский профиль ресурса.

Возвращается: при изменении

Пример: "udp"

Авторы

  • 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_profile_udp_module.html

Spec-Zone.ru

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