fortinet.fortimanager.fmgr_voip_profile 模块 – 配置 VoIP 配置文件。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_voip_profile。
fortinet.fortimanager 1.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
设置的顶级参数。 |
|
注释。 |
|
流或代理检查功能集。 选项
|
|
Msrp。 |
|
启用/禁用 MSRP 违规日志记录。 选项
|
|
允许的最大 MSRP 消息大小 |
|
违反 max-msg-size 的操作。 选项
|
|
启用/禁用 MSRP。 选项
|
|
配置文件名称。 |
|
Sccp。 |
|
启用/禁用阻止多播 RTP 连接。 选项
|
|
启用/禁用 SCCP 电话摘要日志记录。 选项
|
|
启用/禁用 SCCP 违规日志记录。 选项
|
|
每个 SCCP 客户端每分钟的最大呼叫次数 |
|
启用/禁用 SCCP。 选项
|
|
启用/禁用验证 SCCP 标头内容。 选项
|
|
Sip。 |
|
ACK 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
启用/禁用阻止 ACK 请求。 选项
|
|
启用/禁用阻止 BYE 请求。 选项
|
|
启用/禁用阻止 CANCEL 请求。 选项
|
|
启用/禁用阻止 OPTIONS 请求，但 OPTIONS 请求仍会为冗余发出通知。 选项
|
|
启用/禁用阻止 INFO 请求。 选项
|
|
启用/禁用阻止 INVITE 请求。 选项
|
|
启用/禁用阻止标头超过 max-line-length 的请求。 选项
|
|
启用/禁用阻止 MESSAGE 请求。 选项
|
|
启用/禁用阻止 NOTIFY 请求。 选项
|
|
启用/禁用阻止 OPTIONS 请求，并且也不允许 OPTIONS 作为冗余的通知消息。 选项
|
|
启用/禁用阻止 prack 请求。 选项
|
|
启用/禁用阻止 PUBLISH 请求。 选项
|
|
启用/禁用阻止 REFER 请求。 选项
|
|
启用/禁用 REGISTER 请求。 选项
|
|
启用/禁用 SUBSCRIBE 请求。 选项
|
|
阻止无法识别的 SIP 请求。 选项
|
|
启用/禁用 UPDATE 请求。 选项
|
|
BYE 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
验证 Call-Id 头部值的 PCRE 正则表达式。 |
|
持续跟踪无 RTP 的呼叫，持续时间为这么多分钟。 |
|
CANCEL 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
即使联系人的 IP 地址有效，也修复联系人信息。 选项
|
|
验证 Content-Type 头部值的 PCRE 正则表达式。 |
|
启用/禁用在启用 HNT 时将 RTP 源 IP 限制为与 SIP 源 IP 相同。 选项
|
|
托管 NAT 穿越。 选项
|
|
INFO 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
INVITE 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
启用/禁用允许在 RTP 上使用 IPS。 选项
|
|
启用/禁用 SIP 呼叫摘要的日志记录。 选项
|
|
启用/禁用 SIP 违规的日志记录。 选项
|
|
格式错误的 Allow 头部的操作。 选项
|
|
格式错误的 Call-ID 头部的操作。 选项
|
|
格式错误的 Contact 头部的操作。 选项
|
|
格式错误的 Content-Length 头部的操作。 选项
|
|
格式错误的 Content-Type 头部的操作。 选项
|
|
格式错误的 CSeq 头部的操作。 选项
|
|
格式错误的 Expires 头部的操作。 选项
|
|
格式错误的 From 头部的操作。 选项
|
|
格式错误的 Max-Forwards 头部的操作。 选项
|
|
对于缺少 Proxy-Require 头部的格式错误的 SIP 消息的操作。 选项
|
|
对于缺少 Require 头部的格式错误的 SIP 消息的操作。 选项
|
|
格式错误的 P-Asserted-Identity 头部的操作。 选项
|
|
格式错误的 RAck 头部的操作。 选项
|
|
格式错误的 Record-Route 头部的操作。 选项
|
|
格式错误的 Route 头部的操作。 选项
|
|
格式错误的 RSeq 头部的操作。 选项
|
|
格式错误的 SDP a 行的操作。 选项
|
|
格式错误的 SDP b 行的操作。 选项
|
|
格式错误的 SDP c 行的操作。 选项
|
|
格式错误的 SDP i 行的操作。 选项
|
|
格式错误的 SDP k 行的操作。 选项
|
|
格式错误的 SDP m 行的操作。 选项
|
|
格式错误的 SDP o 行的操作。 选项
|
|
格式错误的 SDP r 行的操作。 选项
|
|
格式错误的 SDP s 行的操作。 选项
|
|
格式错误的 SDP t 行的操作。 选项
|
|
格式错误的 SDP v 行的操作。 选项
|
|
格式错误的 SDP z 行的操作。 选项
|
|
格式错误的 To 头部的操作。 选项
|
|
格式错误的 VIA 头部的操作。 选项
|
|
格式错误的请求行的操作。 选项
|
|
最大 SIP 消息正文长度。 |
|
最大并发呼叫/对话数。 |
|
要保留的最大已建立但空闲的对话数。 |
|
最大 SIP 头行长度。 |
|
MESSAGE 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
RTP NAT 端口范围。 |
|
启用/禁用在 SDP i 行中保留原始 IP。 选项
|
|
启用/禁用 SDP 修复。 选项
|
|
NOTIFY 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
启用/禁用为非 REGISTER Contact 端口打开针孔。 选项
|
|
启用/禁用为 Record-Route 端口打开针孔。 选项
|
|
启用/禁用为 REGISTER Contact 端口打开针孔。 选项
|
|
启用/禁用为 Via 端口打开针孔。 选项
|
|
OPTIONS 请求速率限制。 |
|
跟踪数据包协议字段。 选项
|
|
PRACK 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
覆盖 i 行以保留原始 IPS 选项
|
|
临时 INVITE 的过期时间 |
|
PUBLISH 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
REFER 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
启用/禁用在 REGISTER 请求的 contact 头中跟踪原始 IP/端口。 选项
|
|
REGISTER 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
启用/禁用对符合 RFC 2543 的分支的支持。 选项
|
|
启用/禁用为 RTP 流量创建防火墙穿透。 选项
|
|
协商中接受的加密算法的相对强度。 选项
|
|
要求客户端证书并使用对等方/对等组对其进行身份验证。 |
|
使用对等方/对等组对服务器证书进行身份验证。 |
|
如果服务器请求，则提供给服务器的证书名称。 |
|
允许/阻止服务器进行客户端重新协商。 选项
|
|
要协商的最高 SSL/TLS 版本。 选项
|
|
要协商的最低 SSL/TLS 版本。 选项
|
|
用于流量加密和解密的 SSL/TLS 模式。 选项
|
|
SSL 完全前向保密。 选项
|
|
发送空片段以避免对 CBC IV 的攻击 选项
|
|
在每个 SSL 连接中返回给客户端的证书名称。 |
|
启用/禁用 SIP。 选项
|
|
启用/禁用仅允许注册者连接。 选项
|
|
SUBSCRIBE 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
未知 SIP 头部的操作。 选项
|
|
UPDATE 请求速率限制 |
|
跟踪数据包协议字段。 选项
|
|
在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是 global 和其他包括 root。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认值: |
注释
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将参数（例如“var-name”）更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常情况下，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。
示例
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure VoIP profiles.
fortinet.fortimanager.fmgr_voip_profile:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
state: present # <value in [present, absent]>
voip_profile:
comment: <string>
name: <string>
sccp:
block_mcast: <value in [disable, enable]>
log_call_summary: <value in [disable, enable]>
log_violations: <value in [disable, enable]>
max_calls: <integer>
status: <value in [disable, enable]>
verify_header: <value in [disable, enable]>
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_port_range: <string>
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>
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>
feature_set: <value in [flow, proxy, ips, ...]>
msrp:
log_violations: <value in [disable, enable]>
max_msg_size: <integer>
max_msg_size_action: <value in [pass, block, reset, ...]>
status: <value in [disable, enable]>
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 始终 |
|
请求的完整 URL。 返回: 始终 示例: |
|
API 请求的状态。 返回: 始终 示例: |
|
API 响应。 返回: 始终 |
|
API 响应的描述性消息。 返回: 始终 示例: |
|
目标系统的信息。 返回: 始终 |
|
请求的状态。 返回: 始终 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回: 复杂 |