fortinet.fortimanager.fmgr_firewall_gtp 模块 – 配置 GTP。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,您可能已经安装了这个集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定: 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 in GTP 选项
|
|
启用/禁用记录被拒绝的 GTP-U 数据包。 选项
|
|
启用/禁用记录转发的 GTP-U 数据包。 选项
|
|
记录 GTP-U 数据包的频率。 |
|
GTPv0 流量。 选项
|
|
半关闭隧道超时 |
|
半打开隧道超时 |
|
切换 SGSN 组 |
|
切换 SGSN/SGW IPv6 组。 |
|
IE 允许列表。 |
|
IE 允许列表。 |
|
IE 删除策略。 |
|
ID。 |
|
要删除的 GTP IEs。 选项
|
|
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 通知。 选项
|
|
节点存活。 选项
|
|
注意 MS 存在。 选项
|
|
PDU 通知。 选项
|
|
Ran 信息。 选项
|
|
重定向。 选项
|
|
重定位取消。 选项
|
|
发送路由。 选项
|
|
SGSN 上下文。 选项
|
|
支持扩展。 选项
|
|
未知消息操作。 选项
|
|
更新 MBMS。 选项
|
|
更新 PDP。 选项
|
|
版本不支持。 选项
|
|
消息过滤器。 |
|
消息过滤器。 |
|
消息速率限制。 |
|
创建 AA PDP 上下文请求的速率限制 |
|
创建 AA PDP 上下文响应的速率限制 |
|
创建 MBMS 上下文请求的速率限制 |
|
创建 MBMS 上下文响应的速率限制 |
|
创建 PDP 上下文请求的速率限制 |
|
创建 PDP 上下文响应的速率限制 |
|
删除 AA PDP 上下文请求的速率限制 |
|
删除 AA PDP 上下文响应的速率限制 |
|
删除 MBMS 上下文请求的速率限制 |
|
删除 MBMS 上下文响应的速率限制 |
|
删除 PDP 上下文请求的速率限制 |
|
删除 PDP 上下文响应的速率限制 |
|
Echo 响应的速率限制 |
|
Echo 请求的速率限制 |
|
Echo 响应的速率限制 |
|
错误指示的速率限制 |
|
失败报告请求的速率限制 |
|
失败报告响应的速率限制 |
|
转发重定位完成确认的速率限制 |
|
转发重定位完成的速率限制 |
|
转发重定位请求的速率限制 |
|
转发重定位响应的速率限制 |
|
转发 SRNS 上下文的速率限制 |
|
转发 SRNS 上下文确认的速率限制 |
|
G-PDU 的速率限制 |
|
身份识别请求的速率限制 |
|
身份识别响应的速率限制 |
|
MBMS 注销请求的速率限制 |
|
MBMS 注销响应的速率限制 |
|
MBMS 通知拒绝请求的速率限制 |
|
MBMS 通知拒绝响应的速率限制 |
|
MBMS 通知请求的速率限制 |
|
MBMS 通知响应的速率限制 |
|
MBMS 注册请求的速率限制 |
|
MBMS 注册响应的速率限制 |
|
MBMS 会话开始请求的速率限制 |
|
MBMS 会话开始响应的速率限制 |
|
MBMS 会话停止请求的速率限制 |
|
MBMS 会话停止响应的速率限制 |
|
通知 MS GPRS 存在请求的速率限制 |
|
通知 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,该值可以是全局的和其他的,包括 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 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持,则发出警告。 返回: 复杂 |