Spec-Zone.ru › Ansible 2.7

bigip_profile_udp – Управление профилями UDP на BIG-IP

Новое в версии 2.6.

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

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • f5-sdk >= 3.0.16

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
datagram_load_balancing
boolean
    Варианты:
  • no
  • yes
Указывает, когда yes, что система балансирует нагрузку UDP по пакетам.
idle_timeout
-
Указывает длительность простоя соединения (отсутствие трафика) перед тем, как соединение может быть удалено.
При создании нового профиля, если этот параметр не указан, удаленный узел выберет значение по умолчанию, подходящее для профиля на основе его parent профиля.
Когда указано число, оно обозначает количество секунд, которые соединение UDP может оставаться в состоянии простоя перед его удалением системой.
Когда 0, или indefinite, указывает, что соединения UDP могут оставаться в состоянии простоя неопределенно долго.
Когда immediate, указывает, что вы не хотите, чтобы соединение UDP оставалось в состоянии простоя, и поэтому оно сразу же может быть удалено.
name
- / обязательно
Указывает имя профиля.
parent
-
Указывает профиль, настройки которого наследованы этим профилем.
При создании нового профиля, если этот параметр не указан, значение по умолчанию – предопределенный системой udp профиль.
partition
-
Значение по умолчанию:
"Общие"
Раздел устройства для управления ресурсами.
password
- / обязательно
Пароль учетной записи пользователя для подключения к BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.

псевдонимы: pass, pwd
provider
-
добавлен в 2.5
Значение по умолчанию:
null
Объект словаря, содержащий данные подключения.
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
- / обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удаленному устройству.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен обладать административными правами на устройстве.
Этот параметр можно опустить, установив переменную окружения F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами.
Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS.
server
- / обязательно
Хост BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_SERVER.
server_port
-
добавлен в 2.2
Значение по умолчанию:
443
Порт сервера BIG-IP.
Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT.
state
-
    Варианты:
  • present ←
  • absent
Когда present, гарантирует, что профиль существует.
Когда absent, гарантирует удаление профиля.
user
- / обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен обладать административными правами на устройстве.
Этот параметр можно опустить, установив переменную окружения F5_USER.
validate_certs
boolean
добавлен в 2.0
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверенными сертификатами.
Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS.

Примечания

Примечание

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

Примеры

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

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

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

Ключ Возвращаемое значение Описание
datagram_load_balancing
boolean
изменённое
Новое значение балансировки нагрузки для дейтаграммы.

Пример:
True
idle_timeout
integer
изменённое
Новое значение таймаута простоя для ресурса.

Пример:
100
parent
string
изменённое
Новый родительский ресурс.

Пример:
udp


Состояние

  • Этот модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается партнером 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.7/modules/bigip_profile_udp_module.html

Spec-Zone.ru

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