Модуль fortinet.fortios.fortios_voip_profile – Настройка профилей VoIP в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в playbook укажите: fortinet.fortios.fortios_voip_profile.
Добавлена в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять категорию функций и профилей VoIP. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log логическое значение | Включить/выключить логирование для задачи. Варианты:
|
member_path строка | Путь к атрибуту элемента для работы. Разделяется с помощью символа слеша, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операции над элементом. |
member_state строка | Добавить или удалить элемент по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Варианты:
|
vdom строка | Виртуальная область (из ранее определённых). VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
voip_profile словарь | Настройка профилей VoIP. |
|
comment строка |
Комментарий. |
|
feature_set строка |
Набор функций проверки IPS или voipd (SIP-ALG). Варианты:
|
|
msrp словарь |
MSRP. |
|
log_violations строка |
Включить/выключить логирование нарушений MSRP. Варианты:
|
|
max_msg_size целое число |
Максимальный размер сообщения MSRP (1-65535). |
|
max_msg_size_action строка |
Действие при нарушении max-msg-size. Варианты:
|
|
status строка |
Включить/выключить MSRP. Варианты:
|
|
name строка / обязательно |
Имя профиля. |
|
sccp словарь |
SCCP. |
|
block_mcast строка |
Включить/выключить блокировку RTP-соединений multicast. Варианты:
|
|
log_call_summary строка |
Включить/выключить логирование сводки вызовов SCCP. Варианты:
|
|
log_violations строка |
Включить/выключить логирование нарушений SCCP. Варианты:
|
|
max_calls целое число |
Максимальное количество вызовов в минуту на SCCP-клиента (максимум 65535). |
|
status строка |
Включить/выключить SCCP. Варианты:
|
|
verify_header string |
Включить/выключить проверку содержимого заголовка SCCP. Choices:
|
|
sip dictionary |
SIP. |
|
ack_rate integer |
Лимит скорости запросов ACK (в секунду, на политику). |
|
ack_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
block_ack string |
Включить/выключить блокировку запросов ACK. Choices:
|
|
block_bye string |
Включить/выключить блокировку запросов BYE. Choices:
|
|
block_cancel string |
Включить/выключить блокировку запросов CANCEL. Choices:
|
|
block_geo_red_options string |
Включить/выключить блокировку запросов OPTIONS, но запросы OPTIONS все еще уведомляют о избыточности. Choices:
|
|
block_info string |
Включить/выключить блокировку запросов INFO. Choices:
|
|
block_invite string |
Включить/выключить блокировку запросов INVITE. Choices:
|
|
block_long_lines string |
Включить/выключить блокировку запросов с заголовками, превышающими max-line-length. Choices:
|
|
block_message string |
Включить/выключить блокировку запросов MESSAGE. Choices:
|
|
block_notify string |
Включить/выключить блокировку запросов NOTIFY. Choices:
|
|
block_options string |
Включить/выключить блокировку запросов OPTIONS и без OPTIONS в качестве уведомляющего сообщения для избыточности. Choices:
|
|
block_prack string |
Включить/выключить блокировку запросов prack. Choices:
|
|
block_publish string |
Включить/выключить блокировку запросов PUBLISH. Choices:
|
|
block_refer string |
Включить/выключить блокировку запросов REFER. Choices:
|
|
block_register string |
Включить/выключить блокировку запросов REGISTER. Choices:
|
|
block_subscribe string |
Включить/выключить блокировку запросов SUBSCRIBE. Choices:
|
|
block_unknown string |
Блокировать нераспознанные SIP-запросы (включено по умолчанию). Choices:
|
|
block_update string |
Включить/отключить блокировку UPDATE-запросов. Choices:
|
|
bye_rate integer |
Лимит скорости запросов BYE (в секунду, на политику). |
|
bye_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
call_id_regex string |
Проверить регулярное выражение PCRE для значения заголовка Call-Id. |
|
call_keepalive integer |
Продолжать отслеживать вызовы без RTP в течение указанного количества минут. |
|
cancel_rate integer |
Лимит скорости запросов CANCEL (в секунду, на политику). |
|
cancel_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
contact_fixup string |
Исправить контакт в любом случае, даже если IP:порт контакта не совпадает с IP:портом сессии. Choices:
|
|
content_type_regex string |
Проверить регулярное выражение PCRE для значения заголовка Content-Type. |
|
hnt_restrict_source_ip string |
Включить/отключить ограничение исходного IP RTP тем же, что и исходный IP SIP, когда включен HNT. Choices:
|
|
hosted_nat_traversal string |
Hosted NAT Traversal (HNT). Choices:
|
|
info_rate integer |
Лимит скорости запросов INFO (в секунду, на политику). |
|
info_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
invite_rate integer |
Лимит скорости запросов INVITE (в секунду, на политику). |
|
invite_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
ips_rtp string |
Включить/отключить IPS на RTP. Choices:
|
|
log_call_summary string |
Включить/отключить логирование сводки SIP-вызовов. Choices:
|
|
log_violations string |
Включить/отключить логирование нарушений SIP. Choices:
|
|
malformed_header_allow string |
Действие для некорректного заголовка Allow. Choices:
|
|
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. Choices:
|
|
malformed_header_sdp_i string |
Действие для некорректной строки SDP i. Choices:
|
|
malformed_header_sdp_k string |
Действие для некорректной строки SDP k. Choices:
|
|
malformed_header_sdp_m string |
Действие для некорректной строки SDP m. Choices:
|
|
malformed_header_sdp_o string |
Действие для некорректной строки SDP o. Choices:
|
|
malformed_header_sdp_r string |
Действие для некорректной строки SDP r. Choices:
|
|
malformed_header_sdp_s string |
Действие для некорректной строки SDP s. Choices:
|
|
malformed_header_sdp_t string |
Действие для некорректной строки SDP t. Choices:
|
|
malformed_header_sdp_v string |
Действие для некорректной строки SDP v. Choices:
|
|
malformed_header_sdp_z string |
Действие для некорректной строки SDP z. Choices:
|
|
malformed_header_to string |
Действие для некорректного заголовка To. Choices:
|
|
malformed_header_via string |
Действие для некорректного заголовка VIA. Choices:
|
|
malformed_request_line string |
Действие для некорректной строки запроса. Choices:
|
|
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 |
Отслеживать поле протокола пакета. Choices:
|
|
nat_port_range string |
Диапазон портов RTP NAT. |
|
nat_trace string |
Включить/отключить сохранение исходного IP в строке SDP. Choices:
|
|
no_sdp_fixup string |
Включить/отключить отказ от исправления SDP. Choices:
|
|
notify_rate integer |
Лимит скорости запросов NOTIFY (в секунду, на политику). |
|
notify_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
open_contact_pinhole string |
Включить/отключить открытие pinhole для порта Contact, отличного от REGISTER. Choices:
|
|
open_record_route_pinhole string |
Включить/отключить открытие pinhole для порта Record-Route. Choices:
|
|
open_register_pinhole string |
Включить/отключить открытие pinhole для порта Contact REGISTER. Choices:
|
|
open_via_pinhole string |
Включить/отключить открытие pinhole для порта Via. Choices:
|
|
options_rate integer |
Лимит скорости запросов OPTIONS (в секунду, на политику). |
|
options_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
prack_rate integer |
Лимит скорости запросов PRACK (в секунду, на политику). |
|
prack_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
preserve_override string |
Переопределить строку i для сохранения исходных IP-адресов. Choices:
|
|
provisional_invite_expiry_time integer |
Время истечения (10-3600, в секундах) для предварительного INVITE. |
|
publish_rate integer |
Лимит скорости запросов PUBLISH (в секунду, на политику). |
|
publish_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
refer_rate integer |
Лимит скорости запросов REFER (в секунду, на политику). |
|
refer_rate_track string |
Отслеживать поле протокола пакета. Choices:
|
|
register_contact_trace string |
Включить/отключить трассировку исходного IP/порта в заголовке contact запросов REGISTER. Choices:
|
|
register_rate integer |
Лимит скорости запросов REGISTER (в секунду, на политику). |
|
register_rate_track string |
Отслеживание поля протокола пакета. Choices:
|
|
rfc2543_branch string |
Включить/отключить поддержку через ветку, совместимую с RFC 2543. Choices:
|
|
rtp string |
Включить/отключить создание отверстий для трафика RTP для прохождения через брандмауэр. Choices:
|
|
ssl_algorithm string |
Относительная сила алгоритмов шифрования, принимаемых при согласовании. Choices:
|
|
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 |
Разрешить/заблокировать переговорный процесс клиента сервером. Choices:
|
|
ssl_max_version string |
Наивысшая версия SSL/TLS для согласования. Choices:
|
|
ssl_min_version string |
Наименьшая версия SSL/TLS для согласования. Choices:
|
|
ssl_mode string |
Режим SSL/TLS для шифрования и дешифрования трафика. Choices:
|
|
ssl_pfs string |
SSL Perfect Forward Secrecy. Choices:
|
|
ssl_send_empty_frags string |
Отправлять пустые фрагменты, чтобы избежать атаки на CBC IV (только SSL 3.0 и TLS 1.0). Choices:
|
|
ssl_server_certificate string |
Имя сертификата, возвращаемого клиенту в каждом SSL-подключении. Источник vpn.certificate.local.name. |
|
status string |
Включить/отключить SIP. Choices:
|
|
strict_register string |
Включить/отключить разрешение подключения только регистратору. Choices:
|
|
subscribe_rate integer |
Лимит скорости запросов SUBSCRIBE (в секунду, на политику). |
|
subscribe_rate_track string |
Отслеживание поля протокола пакета. Choices:
|
|
unknown_header string |
Действие для неизвестного заголовка SIP. Варианты:
|
|
update_rate integer |
Лимит скорости запросов UPDATE (в секунду, на политику). |
|
update_rate_track string |
Отслеживание поля протокола пакета. Варианты:
|
Примечания
Примечание
- Устаревший fortiosapi был снят с поддержки, httpapi является предпочтительным способом запуска playbooks
- Модуль поддерживает 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_voip_profile_module.html