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

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

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

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

Управление профилями SIP в системе BIG-IP.

Параметры

Параметр	Комментарии
community string	Когда `dialog_aware` имеет значение `true` и конфигурация требует нескольких пар виртуальный сервер — профиль SIP, это строковое значение указывает, относится ли пара к одной и той же функциональной группе прокси-серверов SIP.
description string	Описание профиля. Чтобы полностью удалить запись, задайте значение `''`.
dialog_aware boolean	Если задано значение `true`, система собирает сведения о диалогах SIP и автоматически перенаправляет сообщения SIP, относящиеся к известному диалогу SIP. Варианты: `false` `true`
enable_sip_firewall boolean	Указывает, включена ли политика Advanced Firewall Manager (AFM). Если задано значение `true`, параметры безопасности SIP, настроенные в профиле DoS в AFM, применяются к виртуальным серверам, использующим этот профиль. Варианты: `false` `true`
insert_record_route_header boolean	Если задано значение `true`, вставляет заголовок SIP Record-Route, указывающий следующий узел для последующих сообщений запроса SIP. Варианты: `false` `true`
insert_via_header boolean	Если задано значение `true`, вставляет заголовок Via в перенаправляемый запрос SIP. Заголовки Via указывают путь через прокси-устройства и используемые транспортные протоколы. В ответном сообщении используется эта информация о маршрутизации. Варианты: `false` `true`
log_profile string	Указывает параметры ведения журнала, которые издатель использует для отправки сообщений журнала. Имя может быть указано с префиксом раздела (`/Common/foo`) или только как имя объекта (`foo`). Чтобы удалить запись, задайте значение `''`, однако для профиля `log_publisher` также необходимо задать значение `''`.
log_publisher string	Указывает издателя, настроенного для регистрации сообщений. Имя может быть указано с префиксом раздела (`/Common/foo`) или только как имя объекта (`foo`). Чтобы удалить запись, задайте значение `''`, однако для профиля `log_profile` также необходимо задать значение `''`.
max_size integer	Указывает максимальный размер сообщения SIP, принимаемого системой BIG-IP. Допустимый диапазон значений: `0 - 4294967295` байт.
name string / обязательный	Указывает имя профиля SIP, которым необходимо управлять.
parent string	Указывает профиль, от которого этот профиль наследует параметры. При создании профиля, если этот параметр не указан, используется системный профиль `sip`.
partition string	Раздел устройства, в котором необходимо управлять ресурсами. По умолчанию: `"Common"`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict со сведениями о подключении.
auth_provider string	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется в основном при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку её имя было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задает тайм-аут в секундах для подключения к сетевому устройству или отправки ему команд. Если операция не будет завершена до истечения тайм-аута, модуль сообщит об ошибке.
transport string	Настраивает транспортное подключение для соединения с удаленным устройством. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах под вашим контролем, где применяются самоподписанные сертификаты. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
secure_via_header boolean	Если параметр установлен (включен), вставляет защищенный заголовок Via в перенаправляемый запрос SIP. Защищенный заголовок Via указывает источник сообщения. Этот параметр заставляет вставляемый заголовок Via указывать Transport Layer Security. Чтобы этот параметр действовал, для `insert_via_header` необходимо задать значение (true). Варианты: `false` `true`
security boolean	Если задано значение `true`, включает расширенную проверку безопасности Horizontal Security Layer (HSL). Варианты: `false` `true`
state string	Если задано значение `present`, обеспечивает наличие профиля. Если задано значение `absent`, обеспечивает удаление профиля. Варианты: `"present"` ← (по умолчанию) `"absent"`
terminate_on_bye boolean	Если задано значение `true`, закрывает соединение по завершении транзакции BYE. Транзакция BYE — это сообщение, которое приложение отправляет другому приложению, когда готово закрыть соединение между ними. Варианты: `false` `true`
user_via_header string	Если `insert_via_header` имеет значение `true`, указывает значение Via, которое система вставляет в качестве верхнего заголовка Via в сообщение SIP REQUEST. Допустимое значение должно включать параметры протокола SIP и sent_by, например: `SIP/2.0/UDP 10.10.10.10:5060`. Чтобы полностью удалить запись, задайте значение `''`.

Примечания

Примечание

Дополнительные сведения об использовании 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 SIP profile
  bigip_profile_sip:
    name: foo
    parent: sip
    log_profile: alg_log
    log_publisher: foo-publisher
    description: this is a new profile
    security: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update SIP profile
  bigip_profile_sip:
    name: foo
    insert_record_route_header: true
    enable_sip_firewall: true
    insert_via_header: true
    user_via_header: "SIP/2.0/UDP 10.10.10.10:5060"
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Delete a SIP profile
  bigip_profile_sip:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
community string	Указывает, относится ли пара к одной и той же функциональной группе прокси-серверов SIP. Возвращается: при изменении Пример: `"foo_community"`
description string	Описание профиля. Возвращается: при изменении Пример: `"custom description"`
dialog_aware boolean	Указывает, собирает ли система сведения о диалогах SIP. Возвращается: при изменении Пример: `false`
enable_sip_firewall boolean	Указывает, включена ли политика Advanced Firewall Manager. Возвращается: при изменении Пример: `true`
insert_record_route_header boolean	Указывает, будет ли система вставлять заголовок SIP Record-Route. Возвращается: при изменении Пример: `true`
insert_via_header boolean	Указывает, будет ли система вставлять заголовок Via в перенаправляемый запрос SIP. Возвращается: при изменении Пример: `true`
log_profile string	Параметры ведения журнала, которые издатель использует для отправки сообщений журнала. Возвращается: при изменении Пример: `"/Common/alg_profile"`
log_publisher string	Издатель, настроенный для регистрации сообщений. Возвращается: при изменении Пример: `"/Common/foo_publisher"`
max_size boolean	Указывает, закроет ли система соединение по завершении транзакции BYE. Возвращается: при изменении Пример: `false`
parent string	Указывает профиль, от которого этот профиль наследует параметры. Возвращается: при изменении Пример: `"/Common/sip"`
secure_via_header boolean	Указывает, будет ли система вставлять защищенный заголовок Via в перенаправляемый запрос SIP. Возвращается: при изменении Пример: `false`
security boolean	Включает расширенную проверку безопасности Horizontal Security Layer. Возвращается: при изменении Пример: `true`
terminate_on_bye boolean	Указывает, закроет ли система соединение по завершении транзакции BYE. Возвращается: при изменении Пример: `false`
user_via_header string	Значение, которое система вставляет в качестве верхнего заголовка Via в сообщение SIP REQUEST. Возвращается: при изменении Пример: `"SIP/2.0/UDP 10.10.10.10:5060"`

Авторы

Wojciech Wypior (@wojtek0806)

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

© 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_sip_module.html