модуль fortinet.fortimanager.fmgr_voip_profile_sip – SIP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_voip_profile_sip.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
profile string / обязательный | Параметр (profile) в запрашиваемом URL. |
proposed_method string | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия сбоя. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
voip_profile_sip dictionary | Набор параметров верхнего уровня. |
|
ack_rate псевдонимы: ack-rate integer |
Ограничение частоты запросов ACK |
|
ack_rate_track псевдонимы: ack-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
block_ack псевдонимы: block-ack string |
Включить/отключить блокировку запросов ACK. Варианты:
|
|
block_bye псевдонимы: block-bye string |
Включить/отключить блокировку запросов BYE. Варианты:
|
|
block_cancel псевдонимы: block-cancel string |
Включить/отключить блокировку запросов CANCEL. Варианты:
|
|
block_geo_red_options псевдонимы: block-geo-red-options string |
Включить/отключить блокировку запросов OPTIONS, при этом запросы OPTIONS по-прежнему отправляют уведомления для обеспечения избыточности. Варианты:
|
|
block_info псевдонимы: block-info string |
Включить/отключить блокировку запросов INFO. Варианты:
|
|
block_invite псевдонимы: block-invite string |
Включить/отключить блокировку запросов INVITE. Варианты:
|
|
block_long_lines псевдонимы: block-long-lines string |
Включить/отключить блокировку запросов с заголовками, длина которых превышает max-line-length. Варианты:
|
|
block_message псевдонимы: block-message string |
Включить/отключить блокировку запросов MESSAGE. Варианты:
|
|
block_notify псевдонимы: block-notify string |
Включить/отключить блокировку запросов NOTIFY. Варианты:
|
|
block_options псевдонимы: block-options string |
Включить/отключить блокировку запросов OPTIONS, а также не отправлять OPTIONS в качестве уведомительного сообщения для обеспечения избыточности. Варианты:
|
|
block_prack псевдонимы: block-prack string |
Включить/отключить блокировку запросов prack. Варианты:
|
|
block_publish псевдонимы: block-publish string |
Включить/отключить блокировку запросов PUBLISH. Варианты:
|
|
block_refer псевдонимы: block-refer string |
Включить/отключить блокировку запросов REFER. Варианты:
|
|
block_register псевдонимы: block-register string |
Включить/отключить блокировку запросов REGISTER. Варианты:
|
|
block_subscribe псевдонимы: block-subscribe string |
Включить/отключить блокировку запросов SUBSCRIBE. Варианты:
|
|
block_unknown псевдонимы: block-unknown string |
Блокировать нераспознанные запросы SIP Варианты:
|
|
block_update псевдонимы: block-update string |
Включить/отключить блокировку запросов UPDATE. Варианты:
|
|
bye_rate псевдонимы: bye-rate integer |
Ограничение частоты запросов BYE |
|
bye_rate_track псевдонимы: bye-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
call_id_regex псевдонимы: call-id-regex string |
Проверять значение заголовка Call-Id с помощью регулярного выражения PCRE. |
|
call_keepalive псевдонимы: call-keepalive integer |
Продолжать отслеживать вызовы без RTP в течение указанного количества минут. |
|
cancel_rate псевдонимы: cancel-rate integer |
Ограничение частоты запросов CANCEL |
|
cancel_rate_track псевдонимы: cancel-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
contact_fixup псевдонимы: contact-fixup string |
Корректировать контакт в любом случае, даже если IP-адрес контакта Варианты:
|
|
content_type_regex псевдонимы: content-type-regex string |
Проверять значение заголовка Content-Type с помощью регулярного выражения PCRE. |
|
hnt_restrict_source_ip псевдонимы: hnt-restrict-source-ip string |
Включить/отключить ограничение, согласно которому IP-адрес источника RTP должен совпадать с IP-адресом источника SIP, если включен HNT. Варианты:
|
|
hosted_nat_traversal псевдонимы: hosted-nat-traversal string |
Обход NAT для размещенных систем Варианты:
|
|
info_rate псевдонимы: info-rate integer |
Ограничение частоты запросов INFO |
|
info_rate_track псевдонимы: info-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
invite_rate псевдонимы: invite-rate integer |
Ограничение частоты запросов INVITE |
|
invite_rate_track псевдонимы: invite-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
ips_rtp псевдонимы: ips-rtp string |
Включить/отключить IPS для RTP. Варианты:
|
|
log_call_summary псевдонимы: log-call-summary string |
Включить/отключить ведение журнала сводок SIP-вызовов. Варианты:
|
|
log_violations псевдонимы: log-violations string |
Включить/отключить ведение журнала нарушений SIP. Варианты:
|
|
malformed_header_allow aliases: malformed-header-allow string |
Действие при некорректном заголовке Allow. Варианты:
|
|
malformed_header_call_id aliases: malformed-header-call-id string |
Действие при некорректном заголовке Call-ID. Варианты:
|
|
malformed_header_contact aliases: malformed-header-contact string |
Действие при некорректном заголовке Contact. Варианты:
|
|
malformed_header_content_length aliases: malformed-header-content-length string |
Действие при некорректном заголовке Content-Length. Варианты:
|
|
malformed_header_content_type aliases: malformed-header-content-type string |
Действие при некорректном заголовке Content-Type. Варианты:
|
|
malformed_header_cseq aliases: malformed-header-cseq string |
Действие при некорректном заголовке CSeq. Варианты:
|
|
malformed_header_expires aliases: malformed-header-expires string |
Действие при некорректном заголовке Expires. Варианты:
|
|
malformed_header_from aliases: malformed-header-from string |
Действие при некорректном заголовке From. Варианты:
|
|
malformed_header_max_forwards aliases: malformed-header-max-forwards string |
Действие при некорректном заголовке Max-Forwards. Варианты:
|
|
malformed_header_no_proxy_require aliases: malformed-header-no-proxy-require string |
Действие для некорректных SIP-сообщений без заголовка Proxy-Require. Варианты:
|
|
malformed_header_no_require aliases: malformed-header-no-require string |
Действие для некорректных SIP-сообщений без заголовка Require. Варианты:
|
|
malformed_header_p_asserted_identity aliases: malformed-header-p-asserted-identity string |
Действие при некорректном заголовке P-Asserted-Identity. Варианты:
|
|
malformed_header_rack aliases: malformed-header-rack string |
Действие при некорректном заголовке RAck. Варианты:
|
|
malformed_header_record_route aliases: malformed-header-record-route string |
Действие при некорректном заголовке Record-Route. Варианты:
|
|
malformed_header_route aliases: malformed-header-route string |
Действие при некорректном заголовке Route. Варианты:
|
|
malformed_header_rseq aliases: malformed-header-rseq string |
Действие при некорректном заголовке RSeq. Варианты:
|
|
malformed_header_sdp_a aliases: malformed-header-sdp-a string |
Действие при некорректной строке SDP a. Варианты:
|
|
malformed_header_sdp_b aliases: malformed-header-sdp-b string |
Действие при некорректной строке SDP b. Варианты:
|
|
malformed_header_sdp_c aliases: malformed-header-sdp-c string |
Действие при некорректной строке SDP c. Варианты:
|
|
malformed_header_sdp_i aliases: malformed-header-sdp-i string |
Действие при некорректной строке SDP i. Варианты:
|
|
malformed_header_sdp_k aliases: malformed-header-sdp-k string |
Действие при некорректной строке SDP k. Варианты:
|
|
malformed_header_sdp_m aliases: malformed-header-sdp-m string |
Действие при некорректной строке SDP m. Варианты:
|
|
malformed_header_sdp_o aliases: malformed-header-sdp-o string |
Действие при некорректной строке SDP o. Варианты:
|
|
malformed_header_sdp_r aliases: malformed-header-sdp-r string |
Действие при некорректной строке SDP r. Варианты:
|
|
malformed_header_sdp_s aliases: malformed-header-sdp-s string |
Действие при некорректной строке SDP s. Варианты:
|
|
malformed_header_sdp_t aliases: malformed-header-sdp-t string |
Действие при некорректной строке SDP t. Варианты:
|
|
malformed_header_sdp_v aliases: malformed-header-sdp-v string |
Действие при некорректной строке SDP v. Варианты:
|
|
malformed_header_sdp_z aliases: malformed-header-sdp-z string |
Действие при некорректной строке SDP z. Варианты:
|
|
malformed_header_to aliases: malformed-header-to string |
Действие при некорректном заголовке To. Варианты:
|
|
malformed_header_via aliases: malformed-header-via string |
Действие при некорректном заголовке VIA. Варианты:
|
|
malformed_request_line aliases: malformed-request-line string |
Действие при некорректной строке запроса. Варианты:
|
|
max_body_length aliases: max-body-length integer |
Максимальная длина тела SIP-сообщения |
|
max_dialogs aliases: max-dialogs integer |
Максимальное количество одновременных вызовов/диалогов |
|
max_idle_dialogs aliases: max-idle-dialogs integer |
Максимальное количество установленных, но неактивных диалогов для сохранения |
|
max_line_length aliases: max-line-length integer |
Максимальная длина строки заголовка SIP |
|
message_rate aliases: message-rate integer |
Ограничение частоты запросов MESSAGE |
|
message_rate_track aliases: message-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
nat_port_range aliases: nat-port-range string |
Диапазон портов NAT для RTP. |
|
nat_trace aliases: nat-trace string |
Включить/отключить сохранение исходного IP-адреса в строке SDP i. Варианты:
|
|
no_sdp_fixup aliases: no-sdp-fixup string |
Включить/отключить запрет исправления SDP. Варианты:
|
|
notify_rate aliases: notify-rate integer |
Ограничение частоты запросов NOTIFY |
|
notify_rate_track aliases: notify-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
open_contact_pinhole aliases: open-contact-pinhole string |
Включить или отключить открытие отверстия для порта Contact, отличного от REGISTER. Варианты:
|
|
open_record_route_pinhole aliases: open-record-route-pinhole string |
Включить или отключить открытие отверстия для порта Record-Route. Варианты:
|
|
open_register_pinhole aliases: open-register-pinhole string |
Включить или отключить открытие отверстия для порта Contact запроса REGISTER. Варианты:
|
|
open_via_pinhole aliases: open-via-pinhole string |
Включить или отключить открытие отверстия для порта Via. Варианты:
|
|
options_rate aliases: options-rate integer |
Ограничение частоты запросов OPTIONS |
|
options_rate_track aliases: options-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
prack_rate aliases: prack-rate integer |
Ограничение частоты запросов PRACK |
|
prack_rate_track aliases: prack-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
preserve_override aliases: preserve-override string |
Переопределить строку i, чтобы сохранить исходный IPS Варианты:
|
|
provisional_invite_expiry_time aliases: provisional-invite-expiry-time integer |
Время истечения срока действия предварительного INVITE |
|
publish_rate aliases: publish-rate integer |
Ограничение частоты запросов PUBLISH |
|
publish_rate_track aliases: publish-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
refer_rate aliases: refer-rate integer |
Ограничение частоты запросов REFER |
|
refer_rate_track aliases: refer-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
register_contact_trace aliases: register-contact-trace string |
Включить или отключить запись исходного IP-адреса и порта в заголовке Contact запросов REGISTER. Варианты:
|
|
register_rate aliases: register-rate integer |
Ограничение частоты запросов REGISTER |
|
register_rate_track aliases: register-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
rfc2543_branch aliases: rfc2543-branch string |
Включить или отключить поддержку параметра Via с ветвью, соответствующей RFC 2543. Варианты:
|
|
rtp string |
Включить или отключить создание отверстий для прохождения трафика RTP через межсетевой экран. Варианты:
|
|
ssl_algorithm aliases: ssl-algorithm string |
Относительная стойкость алгоритмов шифрования, принимаемых при согласовании. Варианты:
|
|
ssl_auth_client aliases: ssl-auth-client string |
Требовать сертификат клиента и проверять его подлинность с помощью peer/peergrp. |
|
ssl_auth_server aliases: ssl-auth-server string |
Проверять подлинность сертификата сервера с помощью peer/peergrp. |
|
ssl_client_certificate aliases: ssl-client-certificate string |
Имя сертификата, предоставляемого серверу по его запросу. |
|
ssl_client_renegotiation aliases: ssl-client-renegotiation string |
Разрешить или запретить серверу повторное согласование параметров с клиентом. Варианты:
|
|
ssl_max_version aliases: ssl-max-version string |
Максимальная версия SSL/TLS для согласования. Варианты:
|
|
ssl_min_version aliases: ssl-min-version string |
Минимальная версия SSL/TLS для согласования. Варианты:
|
|
ssl_mode aliases: ssl-mode string |
Режим SSL/TLS для шифрования и расшифрования трафика. Варианты:
|
|
ssl_pfs aliases: ssl-pfs string |
Совершенная прямая секретность SSL (PFS). Варианты:
|
|
ssl_send_empty_frags aliases: ssl-send-empty-frags string |
Отправлять пустые фрагменты для защиты от атаки на вектор инициализации CBC Варианты:
|
|
ssl_server_certificate aliases: ssl-server-certificate string |
Имя сертификата, предоставляемого клиенту при каждом SSL-соединении. |
|
status string |
Включить или отключить SIP. Варианты:
|
|
strict_register aliases: strict-register string |
Включить или отключить ограничение, разрешающее подключение только регистратора. Варианты:
|
|
subscribe_rate aliases: subscribe-rate integer |
Ограничение частоты запросов SUBSCRIBE |
|
subscribe_rate_track aliases: subscribe-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
unknown_header aliases: unknown-header string |
Действие для неизвестного заголовка SIP. Варианты:
|
|
update_rate aliases: update-rate integer |
Ограничение частоты запросов UPDATE |
|
update_rate_track aliases: update-rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значением может быть global, а также другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов должны соответствовать соглашению об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако при их использовании будут выдаваться предупреждения об устаревании. Чтобы игнорировать эти предупреждения, задайте deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: SIP.
fortinet.fortimanager.fmgr_voip_profile_sip:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
profile: <your own value>
voip_profile_sip:
# ack_rate: <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: <integer>
# call_keepalive: <integer>
# cancel_rate: <integer>
# contact_fixup: <value in [disable, enable]>
# hnt_restrict_source_ip: <value in [disable, enable]>
# hosted_nat_traversal: <value in [disable, enable]>
# info_rate: <integer>
# invite_rate: <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: <integer>
# max_dialogs: <integer>
# max_idle_dialogs: <integer>
# max_line_length: <integer>
# message_rate: <integer>
# nat_trace: <value in [disable, enable]>
# no_sdp_fixup: <value in [disable, enable]>
# notify_rate: <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: <integer>
# prack_rate: <integer>
# preserve_override: <value in [disable, enable]>
# provisional_invite_expiry_time: <integer>
# publish_rate: <integer>
# refer_rate: <integer>
# register_contact_trace: <value in [disable, enable]>
# register_rate: <integer>
# rfc2543_branch: <value in [disable, enable]>
# rtp: <value in [disable, enable]>
# ssl_algorithm: <value in [high, medium, low]>
# ssl_auth_client: <string>
# ssl_auth_server: <string>
# ssl_client_certificate: <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: <string>
# status: <value in [disable, enable]>
# strict_register: <value in [disable, enable]>
# subscribe_rate: <integer>
# unknown_header: <value in [pass, discard, respond]>
# update_rate: <integer>
# nat_port_range: <string>
# ack_rate_track: <value in [none, src-ip, dest-ip]>
# bye_rate_track: <value in [none, src-ip, dest-ip]>
# cancel_rate_track: <value in [none, src-ip, dest-ip]>
# info_rate_track: <value in [none, src-ip, dest-ip]>
# invite_rate_track: <value in [none, src-ip, dest-ip]>
# malformed_header_no_proxy_require: <value in [pass, discard, respond]>
# malformed_header_no_require: <value in [pass, discard, respond]>
# message_rate_track: <value in [none, src-ip, dest-ip]>
# notify_rate_track: <value in [none, src-ip, dest-ip]>
# options_rate_track: <value in [none, src-ip, dest-ip]>
# prack_rate_track: <value in [none, src-ip, dest-ip]>
# publish_rate_track: <value in [none, src-ip, dest-ip]>
# refer_rate_track: <value in [none, src-ip, dest-ip]>
# register_rate_track: <value in [none, src-ip, dest-ip]>
# subscribe_rate_track: <value in [none, src-ip, dest-ip]>
# update_rate_track: <value in [none, src-ip, dest-ip]>
# call_id_regex: <string>
# content_type_regex: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном запросе |
Ссылки на коллекцию
© 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/fortimanager/fmgr_voip_profile_sip_module.html