Модуль fortinet.fortios.fortios_voip_profile — настройка профилей VoIP в FortiOS и FortiGate компании Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_voip_profile.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций и профилей VoIP. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, необходимы следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если указан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
voip_profile dictionary | Настройка профилей VoIP. |
|
comment string |
Комментарий. |
|
feature_set string |
Набор функций проверки IPS или voipd (SIP-ALG). Варианты:
|
|
msrp dictionary |
MSRP. |
|
log_violations string |
Включить/отключить ведение журнала нарушений MSRP. Варианты:
|
|
max_msg_size integer |
Максимально допустимый размер сообщения MSRP (1–65535). |
|
max_msg_size_action string |
Действие при нарушении ограничения max-msg-size. Варианты:
|
|
status string |
Включить/отключить MSRP. Варианты:
|
|
name string / обязательный |
Имя профиля. |
|
sccp dictionary |
SCCP. |
|
block_mcast string |
Включить/отключить блокировку многоадресных RTP-подключений. Варианты:
|
|
log_call_summary string |
Включить/отключить ведение журнала со сводной информацией о вызовах SCCP. Варианты:
|
|
log_violations string |
Включить/отключить ведение журнала нарушений SCCP. Варианты:
|
|
max_calls integer |
Максимальное количество вызовов в минуту на клиента SCCP (не более 65535). |
|
status string |
Включить/отключить SCCP. Варианты:
|
|
verify_header string |
Включить/отключить проверку содержимого заголовка SCCP. Варианты:
|
|
sip dictionary |
SIP. |
|
ack_rate integer |
Ограничение частоты запросов ACK (в секунду, на политику). |
|
ack_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
block_ack string |
Включить/отключить блокировку запросов ACK. Варианты:
|
|
block_bye string |
Включить/отключить блокировку запросов BYE. Варианты:
|
|
block_cancel string |
Включить/отключить блокировку запросов CANCEL. Варианты:
|
|
block_geo_red_options string |
Включить/отключить блокировку запросов OPTIONS, при этом запросы OPTIONS по-прежнему отправляют уведомления для обеспечения резервирования. Варианты:
|
|
block_info string |
Включить/отключить блокировку запросов INFO. Варианты:
|
|
block_invite string |
Включить/отключить блокировку запросов INVITE. Варианты:
|
|
block_long_lines string |
Включить/отключить блокировку запросов с заголовками, длина которых превышает max-line-length. Варианты:
|
|
block_message string |
Включить/отключить блокировку запросов MESSAGE. Варианты:
|
|
block_notify string |
Включить/отключить блокировку запросов NOTIFY. Варианты:
|
|
block_options string |
Включить/отключить блокировку запросов OPTIONS, а также сообщений-уведомлений OPTIONS для обеспечения резервирования. Варианты:
|
|
block_prack string |
Включить/отключить блокировку запросов PRACK. Варианты:
|
|
block_publish string |
Включить/отключить блокировку запросов PUBLISH. Варианты:
|
|
block_refer string |
Включить/отключить блокировку запросов REFER. Варианты:
|
|
block_register string |
Включить/отключить блокировку запросов REGISTER. Варианты:
|
|
block_subscribe string |
Включить/отключить блокировку запросов SUBSCRIBE. Варианты:
|
|
block_unknown string |
Блокировать нераспознанные запросы SIP (включено по умолчанию). Варианты:
|
|
block_update string |
Включить/отключить блокировку запросов UPDATE. Варианты:
|
|
bye_rate integer |
Ограничение частоты запросов BYE (в секунду, на политику). |
|
bye_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
call_id_regex string |
Проверить значение заголовка Call-Id с помощью регулярного выражения PCRE. |
|
call_keepalive integer |
Продолжать отслеживать вызовы без RTP в течение указанного количества минут. |
|
cancel_rate integer |
Ограничение частоты запросов CANCEL (в секунду, на политику). |
|
cancel_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
contact_fixup string |
Выполнять корректировку Contact, даже если IP:порт в Contact не совпадает с IP:портом сеанса. Варианты:
|
|
content_type_regex string |
Проверить значение заголовка Content-Type с помощью регулярного выражения PCRE. |
|
hnt_restrict_source_ip string |
Включить/отключить ограничение, согласно которому при включенном HNT IP-адрес источника RTP должен совпадать с IP-адресом источника SIP. Варианты:
|
|
hosted_nat_traversal string |
Транзит через размещенный NAT (HNT). Варианты:
|
|
info_rate integer |
Ограничение частоты запросов INFO (в секунду, на политику). |
|
info_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
invite_rate integer |
Ограничение частоты запросов INVITE (в секунду, на политику). |
|
invite_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
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_no_proxy_require string |
Действие при некорректных сообщениях SIP без заголовка Proxy-Require. Варианты:
|
|
malformed_header_no_require string |
Действие при некорректных сообщениях SIP без заголовка Require. Варианты:
|
|
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 string |
Действие при некорректной строке SDP k. Варианты:
|
|
malformed_header_sdp_m string |
Действие при некорректной строке SDP m. Варианты:
|
|
malformed_header_sdp_o string |
Действие при некорректной строке SDP o. Варианты:
|
|
malformed_header_sdp_r string |
Действие при некорректной строке SDP r. Варианты:
|
|
malformed_header_sdp_s string |
Действие при некорректной строке SDP s. Варианты:
|
|
malformed_header_sdp_t string |
Действие при некорректной строке SDP t. Варианты:
|
|
malformed_header_sdp_v string |
Действие при некорректной строке SDP v. Варианты:
|
|
malformed_header_sdp_z string |
Действие при некорректной строке SDP z. Варианты:
|
|
malformed_header_to string |
Действие при некорректном заголовке To. Варианты:
|
|
malformed_header_via string |
Действие при некорректном заголовке VIA. Варианты:
|
|
malformed_request_line string |
Действие при некорректной строке запроса. Варианты:
|
|
max_body_length integer |
Максимальная длина тела сообщения SIP (0 означает отсутствие ограничения). |
|
max_dialogs integer |
Максимальное количество одновременных вызовов/диалогов (на политику). |
|
max_idle_dialogs integer |
Максимальное количество установленных, но неактивных диалогов, которые нужно сохранять (на политику). |
|
max_line_length integer |
Максимальная длина строки заголовка SIP (78–4096). |
|
message_rate integer |
Ограничение частоты запросов MESSAGE (в секунду, на политику). |
|
message_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
nat_port_range string |
Диапазон портов NAT для RTP. |
|
nat_trace string |
Включить/отключить сохранение исходного IP-адреса в строке SDP i. Варианты:
|
|
no_sdp_fixup string |
Включить/отключить исправление SDP. Варианты:
|
|
notify_rate integer |
Ограничение частоты запросов NOTIFY (в секунду, на политику). |
|
notify_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
open_contact_pinhole string |
Включить/отключить открытие pinhole для порта Contact, отличного от REGISTER. Варианты:
|
|
open_record_route_pinhole string |
Включить/отключить открытие pinhole для порта Record-Route. Варианты:
|
|
open_register_pinhole string |
Включить/отключить открытие pinhole для порта Contact запроса REGISTER. Варианты:
|
|
open_via_pinhole string |
Включить/отключить открытие pinhole для порта Via. Варианты:
|
|
options_rate integer |
Ограничение частоты запросов OPTIONS (в секунду, для каждой политики). |
|
options_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
prack_rate integer |
Ограничение частоты запросов PRACK (в секунду, для каждой политики). |
|
prack_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
preserve_override string |
Переопределить строку i для сохранения исходных IP-адресов. Варианты:
|
|
provisional_invite_expiry_time integer |
Время истечения срока действия предварительного INVITE (10–3600 секунд). |
|
publish_rate integer |
Ограничение частоты запросов PUBLISH (в секунду, для каждой политики). |
|
publish_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
refer_rate integer |
Ограничение частоты запросов REFER (в секунду, для каждой политики). |
|
refer_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
register_contact_trace string |
Включить/отключить запись исходного IP-адреса и порта в заголовке Contact запросов REGISTER. Варианты:
|
|
register_rate integer |
Ограничение частоты запросов REGISTER (в секунду, для каждой политики). |
|
register_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
rfc2543_branch string |
Включить/отключить поддержку ветви, соответствующей RFC 2543. Варианты:
|
|
rtp string |
Включить/отключить создание отверстий для прохождения трафика RTP через межсетевой экран. Варианты:
|
|
ssl_algorithm string |
Относительная стойкость алгоритмов шифрования, принимаемых при согласовании. Варианты:
|
|
ssl_auth_client string |
Запрашивать сертификат клиента и проверять его с помощью peer/peergrp. Источник: user.peer.name user.peergrp.name. |
|
ssl_auth_server string |
Проверять сертификат сервера с помощью peer/peergrp. Источник: user.peer.name user.peergrp.name. |
|
ssl_client_certificate string |
Имя сертификата, который будет предъявлен серверу по запросу. Источник: vpn.certificate.local.name. |
|
ssl_client_renegotiation string |
Разрешить/запретить серверу повторное согласование параметров с клиентом. Варианты:
|
|
ssl_max_version string |
Максимальная версия SSL/TLS для согласования. Варианты:
|
|
ssl_min_version string |
Минимальная версия SSL/TLS для согласования. Варианты:
|
|
ssl_mode string |
Режим SSL/TLS для шифрования и расшифрования трафика. Варианты:
|
|
ssl_pfs string |
Совершенная прямая секретность SSL (PFS). Варианты:
|
|
ssl_send_empty_frags string |
Отправлять пустые фрагменты для защиты от атак на вектор инициализации CBC (только SSL 3.0 и TLS 1.0). Варианты:
|
|
ssl_server_certificate string |
Имя сертификата, предъявляемого клиенту при каждом SSL-соединении. Источник: vpn.certificate.local.name. |
|
status string |
Включить/отключить SIP. Варианты:
|
|
strict_register string |
Включить/отключить режим, разрешающий подключение только регистратору. Варианты:
|
|
subscribe_rate integer |
Ограничение частоты запросов SUBSCRIBE (в секунду, для каждой политики). |
|
subscribe_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
|
unknown_header string |
Действие для неизвестного заголовка SIP. Варианты:
|
|
update_rate integer |
Ограничение частоты запросов UPDATE (в секунду, для каждой политики). |
|
update_rate_track string |
Отслеживать поле протокола пакета. Варианты:
|
Примечания
Примечание
- Устаревший fortiosapi больше не рекомендуется; предпочтительный способ запуска плейбуков — httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure VoIP profiles.
fortinet.fortios.fortios_voip_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
voip_profile:
comment: "Comment."
feature_set: "ips"
msrp:
log_violations: "disable"
max_msg_size: "0"
max_msg_size_action: "pass"
status: "disable"
name: "default_name_10"
sccp:
block_mcast: "disable"
log_call_summary: "disable"
log_violations: "disable"
max_calls: "0"
status: "disable"
verify_header: "disable"
sip:
ack_rate: "0"
ack_rate_track: "none"
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: "0"
bye_rate_track: "none"
call_id_regex: "<your_own_value>"
call_keepalive: "0"
cancel_rate: "0"
cancel_rate_track: "none"
contact_fixup: "disable"
content_type_regex: "<your_own_value>"
hnt_restrict_source_ip: "disable"
hosted_nat_traversal: "disable"
info_rate: "0"
info_rate_track: "none"
invite_rate: "0"
invite_rate_track: "none"
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_no_proxy_require: "discard"
malformed_header_no_require: "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: "0"
max_dialogs: "0"
max_idle_dialogs: "0"
max_line_length: "998"
message_rate: "0"
message_rate_track: "none"
nat_port_range: "<your_own_value>"
nat_trace: "disable"
no_sdp_fixup: "disable"
notify_rate: "0"
notify_rate_track: "none"
open_contact_pinhole: "disable"
open_record_route_pinhole: "disable"
open_register_pinhole: "disable"
open_via_pinhole: "disable"
options_rate: "0"
options_rate_track: "none"
prack_rate: "0"
prack_rate_track: "none"
preserve_override: "disable"
provisional_invite_expiry_time: "210"
publish_rate: "0"
publish_rate_track: "none"
refer_rate: "0"
refer_rate_track: "none"
register_contact_trace: "disable"
register_rate: "0"
register_rate_track: "none"
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: "0"
subscribe_rate_track: "none"
unknown_header: "discard"
update_rate: "0"
update_rate_track: "none"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для настройки содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_voip_profile_module.html