fortinet.fortimanager.fmgr_firewall_gtp 模块 – 配置 GTP。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在剧本中使用它,请指定:fortinet.fortimanager.fmgr_firewall_gtp
。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True,模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
超额计费通知地址 |
|
APN。 |
|
动作。 选项
|
|
(列表或字符串) APN 成员。 |
|
ID。 |
|
APN 选择模式。 选项
|
|
APN 过滤器 选项
|
|
授权的 GGSN 组 |
|
授权的 GGSN/PGW IPv6 组。 |
|
授权的 SGSN 组 |
|
授权的 SGSN/SGW IPv6 组。 |
|
注释。 |
|
超额计费上下文。 |
|
控制平面消息速率限制 |
|
默认 apn 动作 选项
|
|
默认 imsi 动作 选项
|
|
封装的 IP 流量的默认动作 选项
|
|
封装的非 IP 流量的默认动作 选项
|
|
默认高级策略动作 选项
|
|
记录拒绝 选项
|
|
回显请求间隔 |
|
以扩展格式记录 选项
|
|
记录转发 选项
|
|
全局隧道限制。 |
|
GTP 中的 GTP 选项
|
|
启用/禁用被拒绝的 GTP-U 数据包的日志记录。 选项
|
|
启用/禁用转发GTP-U数据包的日志记录。 选项
|
|
GTP-U数据包频率的日志记录。 |
|
GTPv0流量。 选项
|
|
半关闭隧道超时 |
|
半打开隧道超时 |
|
切换SGSN组 |
|
切换SGSN/SGW IPv6组。 |
|
IE允许列表。 |
|
IE允许列表。 |
|
IE移除策略。 |
|
ID。 |
|
要移除的GTP IE。 选项
|
|
SGSN地址名称。 |
|
SGSN IPv6地址名称。 |
|
IE移除策略。 选项
|
|
IE验证。 |
|
验证APN限制。 选项
|
|
验证计费网关地址。 选项
|
|
验证计费ID。 选项
|
|
验证最终用户地址。 选项
|
|
验证GSN地址。 选项
|
|
验证IMEI 选项
|
|
验证IMSI。 选项
|
|
验证MM上下文。 选项
|
|
验证MS时区。 选项
|
|
验证MS已验证。 选项
|
|
验证MSISDN。 选项
|
|
验证NSAPI。 选项
|
|
验证PDP上下文。 选项
|
|
验证服务质量 选项
|
|
验证RAI。 选项
|
|
验证RAT类型。 选项
|
|
验证是否需要重新排序。 选项
|
|
验证选择模式。 选项
|
|
验证用户位置信息。 选项
|
|
IE白名单。 |
|
IE白名单。 |
|
IMSI。 |
|
动作。 选项
|
|
(列表或字符串) APN 成员。 |
|
ID。 |
|
MCC MNC。 |
|
MSISDN前缀。 |
|
APN 选择模式。 选项
|
|
IMSI过滤器 选项
|
|
计费接口 |
|
GTP报头中的无效保留字段 选项
|
|
要记录的无效SGSN IPv6组。 |
|
要记录的无效SGSN组 |
|
封装流量的IP过滤器 选项
|
|
IP策略。 |
|
动作。 选项
|
|
目标地址名称。 |
|
目标IPv6地址名称。 |
|
ID。 |
|
源地址名称。 |
|
源IPv6地址名称。 |
|
GTP-C数据包频率的日志记录。 |
|
用户数据日志限制 |
|
用于选择性日志记录的IMSI前缀。 |
|
用于选择性日志记录的MSISDN前缀 |
|
最大消息长度 |
|
消息过滤器。 |
|
创建AA PDP。 选项
|
|
创建MBMS。 选项
|
|
创建PDP。 选项
|
|
数据记录。 选项
|
|
删除AA PDP。 选项
|
|
删除MBMS。 选项
|
|
删除PDP。 选项
|
|
回显。 选项
|
|
错误指示。 选项
|
|
故障报告。 选项
|
|
转发重定位。 选项
|
|
转发SRNS上下文。 选项
|
|
GTP PDU。 选项
|
|
标识。 选项
|
|
MBMS通知。 选项
|
|
节点存活。 选项
|
|
Note MS存在。 选项
|
|
PDU通知。 选项
|
|
RAN信息。 选项
|
|
重定向。 选项
|
|
重定位取消。 选项
|
|
发送路由。 选项
|
|
SGSN上下文。 选项
|
|
支持扩展。 选项
|
|
未知消息操作。 选项
|
|
更新MBMS。 选项
|
|
更新PDP。 选项
|
|
不支持的版本。 选项
|
|
消息过滤器。 |
|
消息过滤器。 |
|
消息速率限制。 |
|
创建AA PDP上下文请求的速率限制 |
|
创建AA PDP上下文响应的速率限制 |
|
创建MBMS上下文请求的速率限制 |
|
创建MBMS上下文响应的速率限制 |
|
创建PDP上下文请求的速率限制 |
|
创建PDP上下文响应的速率限制 |
|
删除AA PDP上下文请求的速率限制 |
|
删除AA PDP上下文响应的速率限制 |
|
删除MBMS上下文请求的速率限制 |
|
删除MBMS上下文响应的速率限制 |
|
删除PDP上下文请求的速率限制 |
|
删除PDP上下文响应的速率限制 |
|
回显响应的速率限制 |
|
回显请求的速率限制 |
|
回显响应的速率限制 |
|
错误指示的速率限制 |
|
故障报告请求的速率限制 |
|
故障报告响应的速率限制 |
|
转发重定位完成确认的速率限制 |
|
转发重定位完成的速率限制 |
|
转发重定位请求的速率限制 |
|
转发重定位响应的速率限制 |
|
转发SRNS上下文的速率限制 |
|
转发SRNS上下文确认的速率限制 |
|
G-PDU的速率限制 |
|
标识请求的速率限制 |
|
标识响应的速率限制 |
|
MBMS注销请求的速率限制 |
|
MBMS注销响应的速率限制 |
|
MBMS通知拒绝请求的速率限制 |
|
MBMS 通知拒绝响应的速率限制 |
|
MBMS 通知请求的速率限制 |
|
MBMS 通知响应的速率限制 |
|
MBMS 注册请求的速率限制 |
|
MBMS 注册响应的速率限制 |
|
MBMS 会话启动请求的速率限制 |
|
MBMS 会话启动响应的速率限制 |
|
MBMS 会话停止请求的速率限制 |
|
MBMS 会话停止响应的速率限制 |
|
Note MS GPRS 存在请求的速率限制 |
|
Note MS GPRS 存在响应的速率限制 |
|
PDU 通知拒绝请求的速率限制 |
|
PDU 通知拒绝响应的速率限制 |
|
PDU 通知请求的速率限制 |
|
PDU 通知响应的速率限制 |
|
RAN 信息中继的速率限制 |
|
位置取消请求的速率限制 |
|
位置取消响应的速率限制 |
|
发送 GPRS 路由信息的请求的速率限制 |
|
发送 GPRS 路由信息的响应的速率限制 |
|
SGSN 上下文确认的速率限制 |
|
SGSN 上下文请求的速率限制 |
|
SGSN 上下文响应的速率限制 |
|
支持扩展报头通知的速率限制 |
|
更新 MBMS 上下文请求的速率限制 |
|
更新 MBMS 上下文响应的速率限制 |
|
更新 PDP 上下文请求的速率限制 |
|
更新 PDP 上下文响应的速率限制 |
|
不支持版本时的速率限制 |
|
消息速率限制 v0。 |
|
速率限制 |
|
速率限制 |
|
速率限制 |
|
消息速率限制 v1。 |
|
速率限制 |
|
速率限制 |
|
速率限制 |
|
消息速率限制 v2。 |
|
速率限制 |
|
速率限制 |
|
速率限制 |
|
最小消息长度 |
|
缺少必需的信息元素 选项
|
|
GTP 监控模式 选项
|
|
配置文件名称。 |
|
用于封装流量的非 IP 过滤器 选项
|
|
Noip策略。 |
|
动作。 选项
|
|
协议范围结束 |
|
ID。 |
|
协议范围开始 |
|
协议字段类型。 选项
|
|
非状态信息元素。 选项
|
|
非状态 GTP 消息 选项
|
|
每个 APN 的整形器。 |
|
APN 名称。 |
|
ID。 |
|
速率限制 |
|
GTP 版本号 |
|
策略。 |
|
动作。 选项
|
|
APN 后缀。 |
|
APN 选择模式。 选项
|
|
(列表或字符串) APN 成员。 |
|
ID。 |
|
IMEI |
|
IMSI 前缀。 |
|
IMSI 前缀。 |
|
最大 APN 限制值。 选项
|
|
GTP 消息。 选项
|
|
MSISDN前缀。 |
|
MSISDN前缀。 |
|
RAI 模式。 |
|
RAT 类型。 选项
|
|
ULI模式。 |
|
高级策略过滤器 选项
|
|
策略v2。 |
|
动作。 选项
|
|
APN 选择模式。 选项
|
|
(列表或字符串) APN 成员。 |
|
ID。 |
|
IMSI 前缀。 |
|
最大 APN 限制值。 选项
|
|
MEI模式。 |
|
GTP 消息。 选项
|
|
MSISDN前缀。 |
|
RAT 类型。 选项
|
|
(列表) GTPv2 ULI模式 |
|
超额计费通知端口 |
|
RAT超时配置文件。 |
|
GTP速率限制模式。 选项
|
|
记录速率限制 选项
|
|
速率采样间隔 |
|
如果回显响应过期则删除 选项
|
|
恢复IE不同时删除 选项
|
|
保留信息元素 选项
|
|
当GTPv0/v1隧道超时时,向路径端点发送DELETE请求。 选项
|
|
当GTPv2隧道超时时,向路径端点发送DELETE请求。 选项
|
|
移动台的欺骗源地址。 选项
|
|
记录状态无效 选项
|
|
亚秒级间隔 选项
|
|
启用/禁用亚秒级采样。 选项
|
|
记录隧道流量计数器 选项
|
|
隧道限制 |
|
隧道限制 选项
|
|
已建立的隧道超时 |
|
未知gtp版本的动作 选项
|
|
用户平面消息速率限制 |
|
速率限制的警告阈值 |
|
使用FortiCloud API访问令牌验证Ansible客户端。 |
|
底层Json RPC请求的覆盖方法。 选项
|
|
将被覆盖的失败条件的rc代码列表。 |
|
将被覆盖的成功条件的rc代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
在工作区模式下运行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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure GTP.
fortinet.fortimanager.fmgr_firewall_gtp:
bypass_validation: false
adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
state: present
firewall_gtp:
monitor-mode: disable # <value in [disable, enable, vdom]>
name: "ansible-test"
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the GTPs
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_gtp"
params:
adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
gtp: "your_value"
返回值
公共返回值已记录此处,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回:始终 |
|
请求的完整URL。 返回:始终 示例: |
|
api请求的状态。 返回:始终 示例: |
|
api响应。 返回:始终 |
|
api响应的描述性消息。 返回:始终 示例: |
|
目标系统的信息。 返回:始终 |
|
请求的状态。 返回:始终 示例: |
|
如果剧本中使用的参数不受当前FortiManager版本支持,则发出警告。 返回:复杂 |