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

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

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

Описание

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

Параметры

Параметр	Комментарии
community строка	Когда `dialog_aware` является `true`, и конфигурация требует нескольких пар SIP виртуальный сервер-профиль, эта строковая переменная указывает, принадлежит ли пара к одной и той же функциональной группе SIP прокси.
description строка	Описание профиля. Чтобы полностью удалить запись, задайте значение `''`.
dialog_aware логическое	Когда `true`, система собирает информацию о SIP диалогах и автоматически пересылает SIP сообщения, принадлежащие известному SIP диалогу. Варианты: `false` `true`
enable_sip_firewall логическое	Указывает, включен ли политику Advanced Firewall Manager (AFM). Когда `true`, настройки SIP безопасности, настроенные в профиле DoS в AFM, применяются к виртуальным серверам, использующим этот профиль. Варианты: `false` `true`
insert_record_route_header логическое	Когда `true`, вставляет SIP заголовок Record-Route, который указывает следующий хост для последующих SIP запросов. Варианты: `false` `true`
insert_via_header логическое	Когда `true`, вставляет заголовок Via в пересылаемый SIP запрос. Заголовки Via указывают путь, пройденный через прокси-устройства и используемые транспортные средства. Сообщение ответа использует эту информацию маршрутизации. Варианты: `false` `true`
log_profile строка	Указывает параметры ведения журнала, используемые издателем для отправки сообщений журнала. Формат имени может быть префиксным с разделом (`/Common/foo`) или указанным просто как имя объекта (`foo`). Для удаления записи задайте значение `''`, но также профиль `log_publisher` должен быть установлен как `''`.
log_publisher строка	Указывает издателя, определенного для ведения журнала сообщений. Формат имени может быть префиксным с разделом (`/Common/foo`) или указанным просто как имя объекта (`foo`). Для удаления записи задайте значение `''`, но также профиль `log_profile` должен быть установлен как `''`.
max_size целое число	Указывает максимальный размер SIP сообщения, принимаемый системой BIG-IP. Диапазон принимаемых значений `0 - 4294967295` байт.
name строка / обязательно	Указывает имя SIP профиля для управления.
parent строка	Указывает профиль, от которого этот профиль наследует настройки. При создании нового профиля, если этот параметр не указан, по умолчанию используется системный профиль `sip`.
partition строка	Раздел устройства для управления ресурсами. По умолчанию: `"Common"`
provider словарь добавлен в f5networks.f5_modules 1.0.0	Объект словаря, содержащий данные подключения.
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` ← (по умолчанию)
secure_via_header логическое	При включении вставляется заголовок secure Via в пересылаемый SIP-запрос. Заголовок secure Via указывает, откуда исходит сообщение. Этот параметр заставляет вставленный заголовок Via указывать Transport Layer Security. Для действия этого параметра, `insert_via_header` должно быть установлено в (true). Варианты: `false` `true`
security логическое	При включении, включает использование расширенной проверки безопасности HSL (Horizontal Security Layer). Варианты: `false` `true`
state строка	При значении `present`, гарантирует существование профиля. При значении `absent`, гарантирует удаление профиля. Варианты: `"present"` ← (по умолчанию) `"absent"`
terminate_on_bye логическое	При включении, закрывает соединение по завершении транзакции BYE. Транзакция BYE - это сообщение, которое приложение отправляет другому приложению, когда готово закрыть соединение между ними. Варианты: `false` `true`
user_via_header строка	При `insert_via_header` `true`, указывает значение Via, которое система вставляет в качестве верхнего заголовка Via в SIP REQUEST сообщении. Допустимое значение должно включать SIP протокол и отправленные настройки, например: `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 на диске, убедитесь, что включен хотя бы один task, использующий модуль 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. Возвращается: changed Пример: `"foo_community"`
description string	Описание профиля. Возвращается: changed Пример: `"custom description"`
dialog_aware boolean	Указывает, собирает ли система информацию о SIP-диалоге. Возвращается: changed Пример: `false`
enable_sip_firewall boolean	Указывает, включена ли политика Advanced Firewall Manager. Возвращается: changed Пример: `true`
insert_record_route_header boolean	Указывает, будет ли система вставлять заголовок SIP Record-Route. Возвращается: changed Пример: `true`
insert_via_header boolean	Указывает, будет ли система вставлять заголовок Via в переадресованный запрос SIP. Возвращается: changed Пример: `true`
log_profile string	Параметры ведения журнала, которые издатель использует для отправки сообщений журнала. Возвращается: changed Пример: `"/Common/alg_profile"`
log_publisher string	Издатель, определённый для регистрации сообщений. Возвращается: changed Пример: `"/Common/foo_publisher"`
max_size boolean	Указывает, будет ли система закрывать соединение по завершении транзакции BYE. Возвращается: changed Пример: `false`
parent string	Указывает профиль, от которого этот профиль наследует параметры. Возвращается: changed Пример: `"/Common/sip"`
secure_via_header boolean	Указывает, будет ли система вставлять защищённый заголовок Via в переадресованный запрос SIP. Возвращается: changed Пример: `false`
security boolean	Включает использование расширенной проверки безопасности горизонтального уровня безопасности. Возвращается: changed Пример: `true`
terminate_on_bye boolean	Указывает, будет ли система закрывать соединение по завершении транзакции BYE. Возвращается: changed Пример: `false`
user_via_header string	Значение, которое система вставляет в качестве верхнего заголовка Via в сообщении SIP REQUEST. Возвращается: changed Пример: `"SIP/2.0/UDP 10.10.10.10:5060"`

Авторы

Wojciech Wypior (@wojtek0806)

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

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