fortinet.fortios.fortios_voip_profile – Настройка профилей VoIP в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Чтобы использовать его в playbook, укажите: fortinet.fortios.fortios_voip_profile.
Новое в версии 2.8: модуля fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры и профили функций VoIP. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерирован из GUI Fortigate. | |||
| state строка добавлен в 2.9 fortinet.fortios |
| Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перемещён на внешний уровень. | ||
| vdom строка | По умолчанию: "root" | Виртуальный домен, среди тех, что были определены ранее. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. | ||
| voip_profile словарь | Настройка профилей VoIP. | |||
| comment строка | Комментарий. | |||
| name строка / обязательно | Имя профиля. | |||
| sccp словарь | SCCP. | |||
| block_mcast строка |
| Включить/выключить блокировку RTP-соединений multicast. | ||
| 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 строка |
| Блокировка неизвестных SIP-запросов (по умолчанию включена). | ||
| block_update строка |
| Включить/выключить блокировку запросов UPDATE. | ||
| bye_rate целое число | Предел скорости запросов BYE (в секунду, на политику). | |||
| call_keepalive целое число | Продолжать отслеживание вызовов без RTP в течение этого количества минут. | |||
| cancel_rate целое число | Предел скорости запросов CANCEL (в секунду, на политику). | |||
| contact_fixup строка |
| Исправление контакта, даже если IP:порт контакта не совпадает с IP:портом сессии. | ||
| hnt_restrict_source_ip строка |
| Включить/выключить ограничение источника RTP-IP на совпадение с SIP-источником IP при включенном HNT. | ||
| hosted_nat_traversal строка |
| Hosted NAT Traversal (HNT). | ||
| info_rate целое число | Предел скорости запросов INFO (в секунду, на политику). | |||
| invite_rate целое число | Предел скорости запросов INVITE (в секунду, на политику). | |||
| ips_rtp строка |
| Включить/выключить разрешение IPS на RTP. | ||
| log_call_summary строка |
| Включить/выключить протоколирование сводки SIP-вызовов. | ||
| log_violations строка |
| Включить/выключить протоколирование нарушений 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 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 (в секунду, на политику). | |||
| nat_trace string |
| Включить/выключить сохранение исходного IP в строке SDP i. | ||
| no_sdp_fixup string |
| Включить/выключить отсутствие исправления SDP. | ||
| notify_rate integer | Предел скорости запросов NOTIFY (в секунду, на политику). | |||
| open_contact_pinhole string |
| Включить/выключить открытие туннеля для порта Contact при отсутствии REGISTER. | ||
| open_record_route_pinhole string |
| Включить/выключить открытие туннеля для порта Record-Route. |
| open_register_pinhole string |
| Включить/отключить открытое отверстие для порта контакта REGISTER. | ||
| open_via_pinhole string |
| Включить/отключить открытое отверстие для порта Via. | ||
| options_rate integer | Предел скорости запросов OPTIONS (в секунду, на политику). | |||
| prack_rate integer | Предел скорости запросов PRACK (в секунду, на политику). | |||
| preserve_override string |
| Переопределить i-строку для сохранения исходного IPS. | ||
| provisional_invite_expiry_time integer | Время истечения срока действия предварительного INVITE (10 - 3600 с). | |||
| publish_rate integer | Предел скорости запросов PUBLISH (в секунду, на политику). | |||
| refer_rate integer | Предел скорости запросов REFER (в секунду, на политику). | |||
| register_contact_trace string |
| Включить/отключить отслеживание оригинального IP/порта в заголовке контакта запросов REGISTER. | ||
| register_rate integer | Предел скорости запросов REGISTER (в секунду, на политику). | |||
| rfc2543_branch string |
| Включить/отключить поддержку через ветвь, совместимую с RFC 2543. | ||
| rtp string |
| Включить/отключить создание отверстий для трафика RTP для прохождения через брандмауэр. | ||
| ssl_algorithm string |
| Относительная сила алгоритмов шифрования, принятых при согласовании. | ||
| ssl_auth_client string | Требовать сертификат клиента и аутентифицировать его с партнёром/группой партнёров. Имя пользователя.имя партнера имя.группы партнеров. | |||
| ssl_auth_server string | Аутентифицировать сертификат сервера с партнёром/группой партнёров. Имя пользователя.имя партнера имя.группы партнеров. | |||
| ssl_client_certificate string | Имя сертификата, предлагаемого серверу при запросе. Имя vpn.сертификат.локальное.имя. | |||
| 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 Perfect Forward Secrecy. | ||
| ssl_send_empty_frags string |
| Отправлять пустые фрагменты для предотвращения атаки на CBC IV (только SSL 3.0 и TLS 1.0). | ||
| ssl_server_certificate string | Имя сертификата, возвращаемого клиенту при каждом соединении SSL. Имя vpn.сертификат.локальное.имя. | |||
| status string |
| Включить/отключить SIP. | ||
| strict_register string |
| Включить/отключить разрешение только регистрирующемуся подключиться. | ||
| subscribe_rate integer | Предел скорости запросов SUBSCRIBE (в секунду, на политику). | |||
| unknown_header string |
| Действие для неизвестного SIP-заголовка. | ||
| update_rate integer | Предел скорости запросов UPDATE (в секунду, на политику). | |||
| state string |
| Устаревшее Начиная с Ansible 2.9, мы рекомендуем использовать параметр «state» на верхнем уровне. Указывает, нужно ли создавать или удалять объект. | ||
Примечания
Примечание
- Устаревший модуль fortiosapi, httpapi предпочтительнее для выполнения playbooks
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure VoIP profiles.
fortios_voip_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
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 string | всегда | Номер сборки образа fortigate Пример: 1547 |
| http_method string | всегда | Последний метод, используемый для подготовки содержимого в FortiGate Пример: PUT |
| http_status string | всегда | Последний результат, предоставленный FortiGate при последнем применённом действии Пример: 200 |
| mkey string | успех | Главный ключ (id), используемый в последнем вызове FortiGate Пример: id |
| name string | всегда | Название таблицы, используемой для выполнения запроса Пример: urlfilter |
| path string | всегда | Путь к таблице, используемой для выполнения запроса Пример: webfilter |
| revision string | всегда | Внутренний номер версии Пример: 17.0.2.10658 |
| serial string | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status string | всегда | Указание результата операции Пример: успех |
| vdom string | всегда | Используемый виртуальный домен Пример: root |
| version string | всегда | Версия FortiGate Пример: v5.6.3 |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 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/fortios/fortios_voip_profile_module.html