fortinet.fortimanager.fmgr_voip_profile_sip – SIP.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_voip_profile_sip.

Введено в версии 2.10: of fortinet.fortimanager

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

Обзор

Этот модуль может настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательный			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливать в True только при несоответствии схемы модуля структуре API FortiManager, модуль продолжает выполнение без проверки параметров
profile строка / обязательный			параметр (profile) в запрошенном URL
rc_failed список / элементы=строка			список кодов rc, при которых условия для отказа будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, при которых условия для успеха будут переопределены
state строка / обязательный		Варианты: present absent	направление для создания, обновления или удаления объекта
voip_profile_sip словарь			установленные параметры верхнего уровня
	ack-rate целое число		Лимит скорости запросов ACK (в секунду, на политику).
	block-ack строка	Варианты: отключить включить	Включить/отключить блокировку запросов ACK.
	block-bye строка	Варианты: отключить включить	Включить/отключить блокировку запросов BYE.
	block-cancel строка	Варианты: отключить включить	Включить/отключить блокировку запросов CANCEL.
	block-geo-red-options строка	Варианты: отключить включить	Включить/отключить блокировку запросов OPTIONS, но запросы OPTIONS всё ещё уведомляют о дублировании.
	block-info строка	Варианты: отключить включить	Включить/отключить блокировку запросов INFO.
	block-invite строка	Варианты: отключить включить	Включить/отключить блокировку запросов INVITE.
	block-long-lines строка	Варианты: отключить включить	Включить/отключить блокировку запросов с заголовками, превышающими максимальную длину строки.
	block-message строка	Варианты: отключить включить	Включить/отключить блокировку запросов MESSAGE.
	block-notify строка	Варианты: отключить включить	Включить/отключить блокировку запросов NOTIFY.
	block-options строка	Варианты: отключить включить	Включить/отключить блокировку запросов OPTIONS, и никаких OPTIONS в качестве уведомлений о дублировании.
	block-prack строка	Варианты: отключить включить	Включить/отключить блокировку запросов prack.
	block-publish строка	Варианты: отключить включить	Включить/отключить блокировку запросов PUBLISH.
	block-refer строка	Варианты: отключить включить	Включить/отключить блокировку запросов REFER.
	block-register строка	Варианты: отключить включить	Включить/отключить блокировку запросов REGISTER.
	block-subscribe строка	Варианты: отключить включить	Включить/отключить блокировку запросов SUBSCRIBE.
	block-unknown строка	Варианты: отключить включить	Блокировать нераспознанные запросы SIP (по умолчанию включено).
	block-update строка	Варианты: отключить включить	Включить/отключить блокировку запросов UPDATE.
	bye-rate целое число		Лимит скорости запросов BYE (в секунду, на политику).
	call-keepalive целое число		Продолжать отслеживание звонков без RTP в течение заданного количества минут.
	cancel-rate целое число		Лимит скорости запросов CANCEL (в секунду, на политику).
	contact-fixup строка	Варианты: отключить включить	Исправить контакт любым способом, даже если IP:порт контакта не совпадает с IP:портом сессии.
	hnt-restrict-source-ip строка	Варианты: отключить включить	Включить/отключить ограничение источника RTP на совпадение с SIP-источником при включенном HNT.
	hosted-nat-traversal строка	Варианты: отключить включить	Прохождение NAT с помощью хостинга (HNT).
	info-rate целое число		Лимит скорости запросов INFO (в секунду, на политику).
	invite-rate целое число		Лимит скорости запросов INVITE (в секунду, на политику).
	ips-rtp строка	Варианты: отключить включить	Включить/отключить разрешение IPS в RTP.
	log-call-summary строка	Варианты: отключить включить	Включить/отключить логирование сводки звонков SIP.
	log-violations строка	Варианты: отключить включить	Включить/отключить логирование нарушений SIP.
	malformed-header-allow строка	Варианты: пропустить отбросить ответить	Действие для заголовка Allow с неверным форматом.
	malformed-header-call-id строка	Варианты: пропустить отбросить ответить	Действие для заголовка Call-ID с неверным форматом.
	malformed-header-contact строка	Варианты: пропустить отбросить ответить	Действие для заголовка Contact с неверным форматом.
	malformed-header-content-length строка	Варианты: пропустить отбросить ответить	Действие для заголовка Content-Length с неверным форматом.
	malformed-header-content-type строка	Варианты: пропустить отбросить ответить	Действие для заголовка Content-Type с неверным форматом.
	malformed-header-cseq строка	Варианты: пропустить отбросить ответить	Действие для заголовка CSeq с неверным форматом.
	malformed-header-expires строка	Варианты: пропустить отбросить ответить	Действие для заголовка Expires с неверным форматом.
	malformed-header-from строка	Варианты: пропустить отбросить ответить	Действие для заголовка From с неверным форматом.
	malformed-header-max-forwards строка	Варианты: пропустить отбросить ответить	Действие для заголовка Max-Forwards с неверным форматом.
	malformed-header-p-asserted-identity строка	Варианты: пропустить отбросить ответить	Действие для заголовка P-Asserted-Identity с неверным форматом.

неправильный-заголовок-rack строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка RAck.
неправильный-заголовок-record-route строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка Record-Route.
неправильный-заголовок-route строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка Route.
неправильный-заголовок-rseq строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка RSeq.
неправильный-заголовок-sdp-a строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP a.
неправильный-заголовок-sdp-b строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP b.
неправильный-заголовок-sdp-c строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP c.
неправильный-заголовок-sdp-i строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP i.
неправильный-заголовок-sdp-k строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP k.
неправильный-заголовок-sdp-m строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP m.
неправильный-заголовок-sdp-o строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP o.
неправильный-заголовок-sdp-r строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP r.
неправильный-заголовок-sdp-s строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP s.
неправильный-заголовок-sdp-t строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP t.
неправильный-заголовок-sdp-v строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP v.
неправильный-заголовок-sdp-z строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки SDP z.
неправильный-заголовок-to строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка To.
неправильный-заголовок-via строка	Варианты: пропустить отклонить ответить	Действие для неправильного заголовка VIA.
неправильная-строка-запроса строка	Варианты: пропустить отклонить ответить	Действие для неправильной строки запроса.
максимальная-длина-тела целое число		Максимальная длина тела сообщения SIP (0 означает без ограничений).
максимальное-количество-диалогов целое число		Максимальное количество одновременных вызовов/диалогов (на политику).
максимальное-количество-неактивных-диалогов целое число		Максимальное количество установленных, но неактивных диалогов для сохранения (на политику).
максимальная-длина-строки целое число		Максимальная длина строки SIP-заголовка (78-4096).
скорость-сообщений целое число		Предел скорости запросов MESSAGE (в секунду, на политику).
nat-трассировка строка	Варианты: отключить включить	Включить/отключить сохранение исходного IP-адреса в строке SDP i.
без-коррекции-sdp строка	Варианты: отключить включить	Включить/отключить корректировку SDP.
скорость-уведомлений целое число		Предел скорости запросов NOTIFY (в секунду, на политику).
открытый-контактный-пинхол строка	Варианты: отключить включить	Включить/отключить открытый пинхол для порта контакта не-REGISTER.
открытый-пинхол-record-route строка	Варианты: отключить включить	Включить/отключить открытый пинхол для порта Record-Route.
открытый-пинхол-register строка	Варианты: отключить включить	Включить/отключить открытый пинхол для порта контакта REGISTER.
открытый-пинхол-via строка	Варианты: отключить включить	Включить/отключить открытый пинхол для порта Via.
скорость-options целое число		Предел скорости запросов OPTIONS (в секунду, на политику).
скорость-prack целое число		Предел скорости запросов PRACK (в секунду, на политику).
сохранить-переопределение строка	Варианты: отключить включить	Переопределить строку i для сохранения исходного IP-адреса (по умолчанию: добавить).
время-истечения-промежуточного-invite целое число		Время истечения для промежуточного INVITE (10 - 3600 сек).
скорость-publish целое число		Предел скорости запросов PUBLISH (в секунду, на политику).
скорость-refer целое число		Предел скорости запросов REFER (в секунду, на политику).
трассировка-register-контакта строка	Варианты: отключить включить	Включить/отключить трассировку исходного IP/порта в заголовке контакта запросов REGISTER.
скорость-register целое число		Предел скорости запросов REGISTER (в секунду, на политику).
rfc2543-ветвь строка	Варианты: отключить включить	Включить/отключить поддержку, соответствующую RFC 2543, через ветвь.
rtp строка	Варианты: отключить включить	Включить/отключить создание пинхолов для RTP-трафика для прохождения через брандмауэр.
алгоритм-ssl строка	Варианты: высокий средний низкий	Относительная сила алгоритмов шифрования, принятых в ходе переговоров.
аутентификация-ssl-клиента строка		Требовать сертификат клиента и аутентифицировать его с участником/группой участников.
аутентификация-ssl-сервера строка		Проверить сертификат сервера с участником/группой участников.
сертификат-ssl-клиента строка		Имя сертификата, которое предлагается серверу, если он затребован.
переподключение-ssl-клиента строка	Варианты: разрешить запретить безопасно	Разрешить/запретить переподключение клиента сервером.

	ssl-max-version string	Варианты: ssl-3.0 tls-1.0 tls-1.1 tls-1.2	Наивысшая версия SSL/TLS для переговоров.
	ssl-min-version string	Варианты: ssl-3.0 tls-1.0 tls-1.1 tls-1.2	Наименьшая версия SSL/TLS для переговоров.
	ssl-mode string	Варианты: выкл полный	Режим SSL/TLS для шифрования и дешифрования трафика.
	ssl-pfs string	Варианты: требуется запрещено разрешено	SSL Perfect Forward Secrecy.
	ssl-send-empty-frags string	Варианты: отключено включено	Отправка пустых фрагментов для предотвращения атаки на CBC IV (только SSL 3.0 и TLS 1.0).
	ssl-server-certificate string		Имя сертификата, возвращаемого клиенту в каждом SSL-соединении.
	status string	Варианты: отключено включено	Включить/отключить SIP.
	strict-register string	Варианты: отключено включено	Включить/отключить разрешение только регистрации ретранслятора.
	subscribe-rate integer		Предел скорости запросов SUBSCRIBE (в секунду, на политику).
	unknown-header string	Варианты: пропустить отбросить ответить	Действие для неизвестного SIP-заголовка.
	update-rate integer		Предел скорости запросов UPDATE (в секунду, на политику).
workspace_locking_adom string			администрируемая область для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень
workspace_locking_timeout integer		По умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, запуск одного модуля может завершиться ошибкой, когда возвращается ненулевой rc. Вы также можете переопределить условия для завершения ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SIP.
     fmgr_voip_profile_sip:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        profile: <your own value>
        voip_profile_sip:
           ack-rate: <value of integer>
           block-ack: <value in [disable, enable]>
           block-bye: <value in [disable, enable]>
           block-cancel: <value in [disable, enable]>
           block-geo-red-options: <value in [disable, enable]>
           block-info: <value in [disable, enable]>
           block-invite: <value in [disable, enable]>
           block-long-lines: <value in [disable, enable]>
           block-message: <value in [disable, enable]>
           block-notify: <value in [disable, enable]>
           block-options: <value in [disable, enable]>
           block-prack: <value in [disable, enable]>
           block-publish: <value in [disable, enable]>
           block-refer: <value in [disable, enable]>
           block-register: <value in [disable, enable]>
           block-subscribe: <value in [disable, enable]>
           block-unknown: <value in [disable, enable]>
           block-update: <value in [disable, enable]>
           bye-rate: <value of integer>
           call-keepalive: <value of integer>
           cancel-rate: <value of integer>
           contact-fixup: <value in [disable, enable]>
           hnt-restrict-source-ip: <value in [disable, enable]>
           hosted-nat-traversal: <value in [disable, enable]>
           info-rate: <value of integer>
           invite-rate: <value of integer>
           ips-rtp: <value in [disable, enable]>
           log-call-summary: <value in [disable, enable]>
           log-violations: <value in [disable, enable]>
           malformed-header-allow: <value in [pass, discard, respond]>
           malformed-header-call-id: <value in [pass, discard, respond]>
           malformed-header-contact: <value in [pass, discard, respond]>
           malformed-header-content-length: <value in [pass, discard, respond]>
           malformed-header-content-type: <value in [pass, discard, respond]>
           malformed-header-cseq: <value in [pass, discard, respond]>
           malformed-header-expires: <value in [pass, discard, respond]>
           malformed-header-from: <value in [pass, discard, respond]>
           malformed-header-max-forwards: <value in [pass, discard, respond]>
           malformed-header-p-asserted-identity: <value in [pass, discard, respond]>
           malformed-header-rack: <value in [pass, discard, respond]>
           malformed-header-record-route: <value in [pass, discard, respond]>
           malformed-header-route: <value in [pass, discard, respond]>
           malformed-header-rseq: <value in [pass, discard, respond]>
           malformed-header-sdp-a: <value in [pass, discard, respond]>
           malformed-header-sdp-b: <value in [pass, discard, respond]>
           malformed-header-sdp-c: <value in [pass, discard, respond]>
           malformed-header-sdp-i: <value in [pass, discard, respond]>
           malformed-header-sdp-k: <value in [pass, discard, respond]>
           malformed-header-sdp-m: <value in [pass, discard, respond]>
           malformed-header-sdp-o: <value in [pass, discard, respond]>
           malformed-header-sdp-r: <value in [pass, discard, respond]>
           malformed-header-sdp-s: <value in [pass, discard, respond]>
           malformed-header-sdp-t: <value in [pass, discard, respond]>
           malformed-header-sdp-v: <value in [pass, discard, respond]>
           malformed-header-sdp-z: <value in [pass, discard, respond]>
           malformed-header-to: <value in [pass, discard, respond]>
           malformed-header-via: <value in [pass, discard, respond]>
           malformed-request-line: <value in [pass, discard, respond]>
           max-body-length: <value of integer>
           max-dialogs: <value of integer>
           max-idle-dialogs: <value of integer>
           max-line-length: <value of integer>
           message-rate: <value of integer>
           nat-trace: <value in [disable, enable]>
           no-sdp-fixup: <value in [disable, enable]>
           notify-rate: <value of integer>
           open-contact-pinhole: <value in [disable, enable]>
           open-record-route-pinhole: <value in [disable, enable]>
           open-register-pinhole: <value in [disable, enable]>
           open-via-pinhole: <value in [disable, enable]>
           options-rate: <value of integer>
           prack-rate: <value of integer>
           preserve-override: <value in [disable, enable]>
           provisional-invite-expiry-time: <value of integer>
           publish-rate: <value of integer>
           refer-rate: <value of integer>
           register-contact-trace: <value in [disable, enable]>
           register-rate: <value of integer>
           rfc2543-branch: <value in [disable, enable]>
           rtp: <value in [disable, enable]>
           ssl-algorithm: <value in [high, medium, low]>
           ssl-auth-client: <value of string>
           ssl-auth-server: <value of string>
           ssl-client-certificate: <value of string>
           ssl-client-renegotiation: <value in [allow, deny, secure]>
           ssl-max-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-min-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
           ssl-mode: <value in [off, full]>
           ssl-pfs: <value in [require, deny, allow]>
           ssl-send-empty-frags: <value in [disable, enable]>
           ssl-server-certificate: <value of string>
           status: <value in [disable, enable]>
           strict-register: <value in [disable, enable]>
           subscribe-rate: <value of integer>
           unknown-header: <value in [pass, discard, respond]>
           update-rate: <value of integer>

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

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

Ключ	Возвращаемое	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 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/fortinet/fortimanager/fmgr_voip_profile_sip_module.html