fortios_voip_profile – Настройка профилей VoIP в Fortinet’s FortiOS и FortiGate

Новая версия с 2.8.

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

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять категорию функций и профилей VoIP. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
host строка				IP-адрес FortiOS или FortiGate.
https логическое			Варианты: нет да ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка			По умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логическое добавлено в 2.9			Варианты: нет да ←	Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
state строка добавлено в 2.9			Варианты: есть отсутствует	Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перенесён на этот внешний уровень.
username строка				Имя пользователя FortiOS или FortiGate.
vdom строка			По умолчанию: "root"	Виртуальный домен, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок.
voip_profile словарь			По умолчанию: null	Настройка профилей VoIP.
	comment строка			Комментарий.
	name строка / обязательно			Имя профиля.
	sccp словарь			SCCP.
		block_mcast строка	Варианты: отключить включить	Включить/отключить блокировку RTP-соединений с мультикаст-адресацией.
		log_call_summary строка	Варианты: отключить включить	Включить/отключить протоколирование краткого описания вызовов SCCP.
		log_violations строка	Варианты: отключить включить	Включить/отключить протоколирование нарушений SCCP.
		max_calls целое число		Максимальное количество вызовов в минуту на одного клиента SCCP (максимум 65535).
		status строка	Варианты: отключить включить	Включить/отключить SCCP.
		verify_header строка	Варианты: отключить включить	Включить/отключить проверку содержимого заголовков SCCP.
	sip словарь			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 string	Варианты: отключить включить	Блокировать нераспознанные запросы SIP (по умолчанию включено).
block_update string	Варианты: отключить включить	Включить/отключить блокирование запросов UPDATE.
bye_rate integer		Лимит скорости запросов BYE (в секунду, на политику).
call_keepalive integer		Продолжать отслеживание вызовов без RTP в течение заданного количества минут.
cancel_rate integer		Лимит скорости запросов CANCEL (в секунду, на политику).
contact_fixup string	Варианты: отключить включить	Выполнить исправление контакта, даже если IP:порт контакта не совпадает с IP:портом сессии.
hnt_restrict_source_ip string	Варианты: отключить включить	Включить/отключить ограничение источника RTP на совпадение с источником SIP, когда HNT включён.
hosted_nat_traversal string	Варианты: отключить включить	Проход NAT для хостинга (HNT).
info_rate integer		Лимит скорости запросов INFO (в секунду, на политику).
invite_rate integer		Лимит скорости запросов INVITE (в секунду, на политику).
ips_rtp string	Варианты: отключить включить	Включить/отключить разрешение IPS в RTP.
log_call_summary string	Варианты: отключить включить	Включить/отключить протоколирование сводки SIP-вызова.
log_violations string	Варианты: отключить включить	Включить/отключить протоколирование нарушений SIP.
malformed_header_allow string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Allow.
malformed_header_call_id string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Call-ID.
malformed_header_contact string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Contact.
malformed_header_content_length string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Content-Length.
malformed_header_content_type string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Content-Type.
malformed_header_cseq string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка CSeq.
malformed_header_expires string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Expires.
malformed_header_from string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка From.
malformed_header_max_forwards string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Max-Forwards.
malformed_header_p_asserted_identity string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка P-Asserted-Identity.
malformed_header_rack string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка RAck.
malformed_header_record_route string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Record-Route.
malformed_header_route string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка Route.
malformed_header_rseq string	Варианты: отбрасывать пропускать отвечать	Действие для некорректного заголовка RSeq.
malformed_header_sdp_a string	Варианты: отбрасывать пропускать отвечать	Действие для некорректной строки SDP a.
malformed_header_sdp_b string	Варианты: отбрасывать пропускать отвечать	Действие для некорректной строки SDP b.
malformed_header_sdp_c string	Варианты: отбрасывать пропускать отвечать	Действие для некорректной строки SDP c.
malformed_header_sdp_i string	Варианты: отбрасывать пропускать отвечать	Действие для некорректной строки SDP i.

malformed_header_sdp_k строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP k.
malformed_header_sdp_m строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP m.
malformed_header_sdp_o строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP o.
malformed_header_sdp_r строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP r.
malformed_header_sdp_s строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP s.
malformed_header_sdp_t строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP t.
malformed_header_sdp_v строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP v.
malformed_header_sdp_z строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки SDP z.
malformed_header_to строка	Варианты: отбросить пропустить ответить	Действие для некорректного заголовка To.
malformed_header_via строка	Варианты: отбросить пропустить ответить	Действие для некорректного заголовка VIA.
malformed_request_line строка	Варианты: отбросить пропустить ответить	Действие для некорректной строки запроса.
max_body_length целое число		Максимальная длина тела сообщения SIP (0 означает без ограничений).
max_dialogs целое число		Максимальное количество одновременных вызовов/диалогов (на политику).
max_idle_dialogs целое число		Максимальное количество установленных, но неактивных диалогов для сохранения (на политику).
max_line_length целое число		Максимальная длина строки SIP-заголовка (78-4096).
message_rate целое число		Лимит скорости запросов MESSAGE (в секунду, на политику).
nat_trace строка	Варианты: отключить включить	Включить/отключить сохранение исходного IP в строке SDP i.
no_sdp_fixup строка	Варианты: отключить включить	Включить/отключить отсутствие исправления SDP.
notify_rate целое число		Лимит скорости запросов NOTIFY (в секунду, на политику).
open_contact_pinhole строка	Варианты: отключить включить	Включить/отключить открытие pinhole для порта Contact, не использующего REGISTER.
open_record_route_pinhole строка	Варианты: отключить включить	Включить/отключить открытие pinhole для порта Record-Route.
open_register_pinhole строка	Варианты: отключить включить	Включить/отключить открытие pinhole для порта Contact, использующего REGISTER.
open_via_pinhole строка	Варианты: отключить включить	Включить/отключить открытие pinhole для порта Via.
options_rate целое число		Лимит скорости запросов OPTIONS (в секунду, на политику).
prack_rate целое число		Лимит скорости запросов PRACK (в секунду, на политику).
preserve_override строка	Варианты: отключить включить	Переопределение строки i для сохранения исходного IP.
provisional_invite_expiry_time целое число		Время истечения срока действия предварительного INVITE (10-3600 сек).
publish_rate целое число		Лимит скорости запросов PUBLISH (в секунду, на политику).
refer_rate целое число		Лимит скорости запросов REFER (в секунду, на политику).
register_contact_trace строка	Варианты: отключить включить	Включить/отключить отслеживание исходного IP/порта в заголовке Contact запросов REGISTER.
register_rate целое число		Лимит скорости запросов REGISTER (в секунду, на политику).
rfc2543_branch строка	Варианты: отключить включить	Включить/отключить поддержку ветвления, соответствующего RFC 2543.
rtp строка	Варианты: отключить включить	Включить/отключить создание pinholes для RTP-трафика для прохождения через брандмауэр.

	ssl_algorithm строка	Варианты: высокий средний низкий	Относительная сила алгоритмов шифрования, принимаемых при согласовании.
	ssl_auth_client строка		Требовать сертификат клиента и аутентифицировать его у партнёра/группы партнёров. Источник: user.peer.name user.peergrp.name.
	ssl_auth_server строка		Аутентифицировать сертификат сервера у партнёра/группы партнёров. Источник: user.peer.name user.peergrp.name.
	ssl_client_certificate строка		Имя сертификата, которое предложить серверу, если запрошено. Источник: vpn.certificate.local.name.
	ssl_client_renegotiation строка	Варианты: разрешить запретить защищённо	Разрешить/заблокировать повторное согласование клиента сервером.
	ssl_max_version строка	Варианты: ssl-3.0 tls-1.0 tls-1.1 tls-1.2	Наивысшая версия SSL/TLS для согласования.
	ssl_min_version строка	Варианты: ssl-3.0 tls-1.0 tls-1.1 tls-1.2	Наименьшая версия SSL/TLS для согласования.
	ssl_mode строка	Варианты: нет полный	Режим SSL/TLS для шифрования и дешифрования трафика.
	ssl_pfs строка	Варианты: требуется запрещено разрешено	SSL Perfect Forward Secrecy.
	ssl_send_empty_frags строка	Варианты: включить отключить	Отправлять пустые фрагменты для предотвращения атаки на CBC IV (только SSL 3.0 и TLS 1.0).
	ssl_server_certificate строка		Имя сертификата, возвращаемого клиенту в каждом соединении SSL. Источник: vpn.certificate.local.name.
	status строка	Варианты: отключить включить	Включить/отключить SIP.
	strict_register строка	Варианты: отключить включить	Включить/отключить разрешение только регистрации.
	subscribe_rate целое число		Лимит скорости запросов SUBSCRIBE (в секунду, на политику).
	unknown_header строка	Варианты: отбросить пропустить ответить	Действие для неизвестного SIP-заголовка.
	update_rate целое число		Лимит скорости запросов UPDATE (в секунду, на политику).
state строка		Варианты: существует отсутствует	Устаревшее Начиная с Ansible 2.9, рекомендуется использовать параметр "state" на верхнем уровне. Указывает, нужно ли создать или удалить объект.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполняется как local_action в вашем плейбуке

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure VoIP profiles.
    fortios_voip_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      voip_profile:
        comment: "Comment."
        name: "default_name_4"
        sccp:
            block_mcast: "disable"
            log_call_summary: "disable"
            log_violations: "disable"
            max_calls: "9"
            status: "disable"
            verify_header: "disable"
        sip:
            ack_rate: "13"
            block_ack: "disable"
            block_bye: "disable"
            block_cancel: "disable"
            block_geo_red_options: "disable"
            block_info: "disable"
            block_invite: "disable"
            block_long_lines: "disable"
            block_message: "disable"
            block_notify: "disable"
            block_options: "disable"
            block_prack: "disable"
            block_publish: "disable"
            block_refer: "disable"
            block_register: "disable"
            block_subscribe: "disable"
            block_unknown: "disable"
            block_update: "disable"
            bye_rate: "31"
            call_keepalive: "32"
            cancel_rate: "33"
            contact_fixup: "disable"
            hnt_restrict_source_ip: "disable"
            hosted_nat_traversal: "disable"
            info_rate: "37"
            invite_rate: "38"
            ips_rtp: "disable"
            log_call_summary: "disable"
            log_violations: "disable"
            malformed_header_allow: "discard"
            malformed_header_call_id: "discard"
            malformed_header_contact: "discard"
            malformed_header_content_length: "discard"
            malformed_header_content_type: "discard"
            malformed_header_cseq: "discard"
            malformed_header_expires: "discard"
            malformed_header_from: "discard"
            malformed_header_max_forwards: "discard"
            malformed_header_p_asserted_identity: "discard"
            malformed_header_rack: "discard"
            malformed_header_record_route: "discard"
            malformed_header_route: "discard"
            malformed_header_rseq: "discard"
            malformed_header_sdp_a: "discard"
            malformed_header_sdp_b: "discard"
            malformed_header_sdp_c: "discard"
            malformed_header_sdp_i: "discard"
            malformed_header_sdp_k: "discard"
            malformed_header_sdp_m: "discard"
            malformed_header_sdp_o: "discard"
            malformed_header_sdp_r: "discard"
            malformed_header_sdp_s: "discard"
            malformed_header_sdp_t: "discard"
            malformed_header_sdp_v: "discard"
            malformed_header_sdp_z: "discard"
            malformed_header_to: "discard"
            malformed_header_via: "discard"
            malformed_request_line: "discard"
            max_body_length: "71"
            max_dialogs: "72"
            max_idle_dialogs: "73"
            max_line_length: "74"
            message_rate: "75"
            nat_trace: "disable"
            no_sdp_fixup: "disable"
            notify_rate: "78"
            open_contact_pinhole: "disable"
            open_record_route_pinhole: "disable"
            open_register_pinhole: "disable"
            open_via_pinhole: "disable"
            options_rate: "83"
            prack_rate: "84"
            preserve_override: "disable"
            provisional_invite_expiry_time: "86"
            publish_rate: "87"
            refer_rate: "88"
            register_contact_trace: "disable"
            register_rate: "90"
            rfc2543_branch: "disable"
            rtp: "disable"
            ssl_algorithm: "high"
            ssl_auth_client: "<your_own_value> (source user.peer.name user.peergrp.name)"
            ssl_auth_server: "<your_own_value> (source user.peer.name user.peergrp.name)"
            ssl_client_certificate: "<your_own_value> (source vpn.certificate.local.name)"
            ssl_client_renegotiation: "allow"
            ssl_max_version: "ssl-3.0"
            ssl_min_version: "ssl-3.0"
            ssl_mode: "off"
            ssl_pfs: "require"
            ssl_send_empty_frags: "enable"
            ssl_server_certificate: "<your_own_value> (source vpn.certificate.local.name)"
            status: "disable"
            strict_register: "disable"
            subscribe_rate: "106"
            unknown_header: "discard"
            update_rate: "108"

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

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

Ключ	Возвращаемое	Описание
build строка	всегда	Номер сборки образа fortigate Пример: 1547
http_method строка	всегда	Последний метод, используемый для предоставления контента в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, предоставленный FortiGate по последней применённой операции Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь таблицы, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Виртуальная область, используемая Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы заметите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_voip_profile_module.html