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

Новинка в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр	Комментарии
datagram_load_balancing boolean	Когда `true`, указывает, что система балансирует UDP-трафик по пакетам. Варианты: `false` `true`
idle_timeout string	Указывает длительность простоя соединения (отсутствия трафика), после которой соединение может быть удалено. При создании нового профиля, если этот параметр не указан, удалённое устройство выберет значение по умолчанию, соответствующее профилю, исходя из его `parent` профиля. При указании числа, обозначает количество секунд, в течение которых UDP-соединение может оставаться неактивным, прежде чем система удалит его. Когда `indefinite`, указывает, что UDP-соединения могут оставаться неактивными неопределённо долго. Когда `0` или `immediate`, указывает, что вы не хотите, чтобы UDP-соединение оставалось неактивным, и поэтому оно сразу же подлежит удалению.
name string / обязательный	Указывает имя профиля.
parent string	Указывает профиль, от которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, значение по умолчанию — `udp` профиль, предоставляемый системой.
partition string	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения маркеров аутентификации от удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `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 boolean	Если `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 boolean	Новое значение параметра балансировки данных UDP. Возвращается: changed Пример: `true`
idle_timeout integer	Новое значение тайм-аута бездействия ресурса. Возвращается: changed Пример: `100`
parent string	Новое родительское значение ресурса. Возвращается: changed Пример: `"udp"`

Авторы

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