Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: 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
При включении вставляет заголовок secure Via в пересылаемый SIP-запрос.
Заголовок secure Via указывает, откуда исходит сообщение.
Этот параметр заставляет вставленный заголовок Via указывать Transport Layer Security. Для действия этого параметра insert_via_header должно быть установлено в (yes).
security
логическое значение
    Варианты:
  • no
  • yes
Когда yes, включает использование расширенной проверки безопасности Horizontal Security Layer (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-протокол и настройки 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: 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
строка
изменён
Указывает, принадлежит ли пара к одному функциональному группе SIP-прокси.

Пример:
foo_community
description
строка
изменён
Описание профиля.

Пример:
custom description
dialog_aware
булево
изменён
Указывает, собирает ли система информацию о SIP-диалоге.
enable_sip_firewall
булево
изменён
Указывает, включён ли политику Advanced Firewall Manager.

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

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

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

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

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

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

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

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


Авторы

  • Wojciech Wypior (@wojtek0806)

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

Spec-Zone.ru

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