Spec-Zone.ru › Ansible 2.10

f5networks.f5_modules.bigip_profile_sip – Управление профилями SIP на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в книге задач, укажите: f5networks.f5_modules.bigip_profile_sip.

Добавлена в версии 1.0.0: из f5networks.f5_modules

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

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
community
строка
Когда dialog_aware является yes, и конфигурация требует нескольких пар виртуальных серверов SIP-профиль, эта строковая величина указывает, относится ли пара к одной и той же функциональной группе SIP-прокси.
description
строка
Описание профиля.
Чтобы полностью удалить запись, установите значение ''.
dialog_aware
логическое
    Варианты:
  • no
  • yes
Когда yes, система собирает информацию о диалогах SIP и автоматически пересылает сообщения SIP, относящиеся к известному диалогу SIP.
enable_sip_firewall
логическое
    Варианты:
  • no
  • yes
Указывает, включена ли политика Advanced Firewall Manager (AFM).
Когда yes, настройки безопасности SIP, настроенные в профиле DoS в AFM, применяются к виртуальным серверам, использующим этот профиль.
insert_record_route_header
логическое
    Варианты:
  • no
  • yes
Когда yes, вставляет заголовок Record-Route SIP, который указывает следующий узел для последующих сообщений запроса SIP.
insert_via_header
логическое
    Варианты:
  • no
  • yes
Когда yes, вставляет заголовок Via в пересылаемый запрос SIP.
Заголовки Via указывают путь, пройденный через устройства-прокси и используемые транспортные средства. Сообщение ответа использует эту информацию о маршрутизации.
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
словарь
добавлен в 1.0.0 f5networks.f5_modules
Объект словаря, содержащий данные подключения.
auth_provider
строка
Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства.
Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem
логическое
    Варианты:
  • no
  • yes
Если yes, данные телеметрии TEEM не отправляются в F5.
Вы можете опустить этот параметр, установив переменную среды F5_TEEM.
password
строка / обязательно
Пароль учетной записи пользователя, используемой для подключения к BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.

псевдонимы: pass, pwd
server
строка / обязательно
Хост BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER.
server_port
целое число
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
целое число
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку.
transport
строка
    Варианты:
  • rest ←
Настраивает транспортное соединение для использования при подключении к удалённому устройству.
user
строка / обязательно
Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные права на устройстве.
Вы можете опустить этот параметр, установив переменную среды F5_USER.
validate_certs
логическое
    Варианты:
  • no
  • yes ←
Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов.
Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
secure_via_header
логическое
    Варианты:
  • no
  • yes
При включении вставляет безопасный заголовок Via в пересылаемый запрос SIP.
Заголовок secure Via указывает место происхождения сообщения.
Этот параметр заставляет вставленный заголовок Via указывать Transport Layer Security. Для того, чтобы этот параметр вступил в силу, insert_via_header должен быть установлен в (yes).
security
логическое
    Варианты:
  • no
  • yes
Когда yes. включает использование расширенной проверки безопасности горизонтального уровня безопасности (HSL).
state
строка
    Варианты:
  • present ←
  • absent
Когда present, гарантирует существование профиля.
Когда absent, гарантирует удаление профиля.
terminate_on_bye
логическое
    Варианты:
  • no
  • yes
Когда yes, закрывает соединение при завершении транзакции BYE.
Транзакция BYE — это сообщение, которое приложение отправляет другому приложению, когда оно готово закрыть соединение между ними.
user_via_header
строка
Когда insert_via_header равно yes, указывает значение 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 конфигурация сохранится на диске, обязательно включите по крайней мере одну задачу, использующую модуль 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: yes
    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: yes
    enable_sip_firewall: yes
    insert_via_header: yes
    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-диалоге.
enable_sip_firewall
boolean
изменён
Указывает, включён ли Advanced Firewall Manager policy.

Пример:
True
insert_record_route_header
boolean
изменён
Указывает, вставит ли система заголовок Record-Route SIP.

Пример:
True
insert_via_header
boolean
изменён
Указывает, вставит ли система заголовок Via в переадресованный SIP-запрос.

Пример:
True
log_profile
string
изменён
Настройки логирования, используемые издателем для отправки сообщений журнала.

Пример:
/Common/alg_profile
log_publisher
string
изменён
Определённый издатель для записи сообщений журнала.

Пример:
/Common/foo_publisher
max_size
boolean
изменён
Указывает, закроет ли система соединение при завершении транзакции BYE.
parent
string
изменён
Указывает профиль, настройки которого наследуются этим профилем.

Пример:
/Common/sip
secure_via_header
boolean
изменён
Указывает, вставит ли система защищённый заголовок Via в переадресованный SIP-запрос.
security
boolean
изменён
Включает использование расширенной проверки безопасности Horizontal Security Layer.

Пример:
True
terminate_on_bye
boolean
изменён
Указывает, закроет ли система соединение при завершении транзакции BYE.
user_via_header
string
изменён
Значение, которое система вставляет в качестве верхнего заголовка Via в сообщении SIP REQUEST.

Пример:
SIP/2.0/UDP 10.10.10.10:5060


Авторы

  • Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_profile_sip_module.html

Spec-Zone.ru

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