fortinet.fortimanager.fmgr_pkg_footer_policy 模块 – 配置 IPv4/IPv6 策略。
注意
此模块是 fortinet.fortimanager 集合(版本 2.8.2)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定:fortinet.fortimanager.fmgr_pkg_footer_policy
。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值,这些参数和值需要在使用前调整为数据源。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True,模块将继续执行而不验证参数。 选择
|
|
启用/禁用任务的日志记录。 选择
|
|
使用 forticloud API 访问令牌验证 Ansible 客户端。 |
|
请求的 URL 中的参数 (pkg)。 |
|
顶层参数集。 |
|
分配的策略块。 |
|
(列表)访问代理。 |
|
操作。 选择
|
|
活动身份验证方法。 选择
|
|
反重放。 选择
|
|
(列表或字符串)应用类别。 |
|
(列表或字符串)应用组。 |
|
(列表)应用程序。 |
|
应用程序图表。 选择
|
|
应用程序列表。 |
|
身份验证证书。 |
|
身份验证方法。 选择
|
|
身份验证路径。 选择
|
|
身份验证门户。 选择
|
|
身份验证重定向地址。 |
|
自动 ASIC 卸载。 选择
|
|
AV 配置文件。 |
|
带宽。 选择
|
|
最佳路由。 选择
|
|
阻止通知。 选择
|
|
强制门户豁免。 选择
|
|
捕获数据包。 选择
|
|
现有 CASB 配置文件的名称。 |
|
(列表或字符串)Casi 配置文件。 |
|
中心 NAT。 选择
|
|
启用/禁用 CGN 端点独立过滤。 选择
|
|
启用/禁用 CGN 端点独立映射 选择
|
|
(列表或字符串)NP 日志服务器组名称 |
|
资源配额 |
|
会话配额 |
|
启用/禁用软件端点独立过滤控制。 选择
|
|
Cifs 配置文件。 |
|
客户端信誉。 选择
|
|
客户端信誉模式。 选择
|
|
(字典或字符串) 注释。 |
|
(列表或字符串) 自定义日志字段。 |
|
解密流量镜像。 |
|
(列表或字符串) 深度检测选项。 |
|
延迟 TCP NPU 会话。 选择
|
|
延迟 TCP NPU 会话。 选择
|
|
检测 HTTP 请求中的 HTTPS。 选择
|
|
设备检测门户。 选择
|
|
设备所有权。 选择
|
|
(列表或字符串) 设备。 |
|
现有 Diameter 过滤器配置文件的名称。 |
|
启用后,将数据包 DiffServ 值从会话的原始方向复制到其回复方向。 选择
|
|
Diffserv 前向。 选择
|
|
Diffserv 反向。 选择
|
|
Diffservcode 前向。 |
|
Diffservcode 反向。 |
|
免责声明。 选择
|
|
现有 DLP 配置文件的名称。 |
|
(列表或字符串) DLP 传感器。 |
|
DNS 过滤器配置文件。 |
|
仅限 DP。 选择
|
|
Dscp 匹配。 选择
|
|
Dscp 取反。 选择
|
|
Dscp 值。 |
|
DSRI。 选择
|
|
(列表或字符串) 目标地址。 |
|
(列表或字符串) 目标地址6。 |
|
启用后,dstaddr6 指定目标地址不能是什么。 选择
|
|
目标地址取反。 选择
|
|
(列表或字符串) 目标接口。 |
|
动态旁路。 选择
|
|
动态配置文件。 选择
|
|
动态配置文件访问。 选择
|
|
动态配置文件回退。 选择
|
|
(列表或字符串) 动态配置文件组。 |
|
启用/禁用动态 RADIUS 定义的流量整形。 选择
|
|
启用/禁用检查端点独立过滤针孔。 选择
|
|
启用/禁用学习端点独立过滤针孔。 选择
|
|
电子邮件收集。 选择
|
|
电子邮件收集门户。 选择
|
|
电子邮件过滤器配置文件。 |
|
端点检查。 选择
|
|
端点合规性。 选择
|
|
(列表或字符串) 端点保持活动接口。 |
|
(列表或字符串) 端点配置文件。 |
|
扩展日志。 选择
|
|
失败的连接。 选择
|
|
未经身份验证的回退。 选择
|
|
在 FEC 设备上,对此策略匹配的流量启用/禁用前向纠错。 选择
|
|
文件过滤器配置文件。 |
|
防火墙会话脏标记。 选择
|
|
固定端口。 选择
|
|
强制代理。 选择
|
|
FortiClient 合规性设备。 选择
|
|
FortiClient 合规性强制门户。 选择
|
|
FSAE。 选择
|
|
(列表或字符串) 用于 NTLM 的 FSAE 服务器。 |
|
FSSO。 选择
|
|
用于 NTLM 的 FSSO 代理。 |
|
(列表或字符串) FSSO 组。 |
|
地理位置。 选择
|
|
GeoIP 任播。 选择
|
|
GeoIP 匹配。 选择
|
|
全局标签。 |
|
(列表或字符串) 组。 |
|
GTP 配置文件。 |
|
HTTP 策略重定向。 选择
|
|
HTTP 隧道身份验证。 选择
|
|
(列表) IA 配置文件。 |
|
ICAP 配置文件。 |
|
基于身份。 选择
|
|
基于身份的策略。 |
|
操作。 选择
|
|
应用程序图表。 选择
|
|
应用程序列表。 |
|
AV 配置文件。 |
|
捕获数据包。 选择
|
|
深度检测选项。 |
|
设备。 |
|
Dlp 传感器。 |
|
目标地址。 |
|
目标地址取反。 选择
|
|
端点合规性。 选择
|
|
用户组。 |
|
ICAP 配置文件。 |
|
ID。 |
|
IPS 传感器。 |
|
日志流量。 选择
|
|
日志流量应用。 选择
|
|
日志流量开始。 选择
|
|
Mms 配置文件。 |
|
每 IP 限速器。 |
|
配置文件组。 |
|
配置文件协议选项。 |
|
配置文件类型。 选择
|
|
替换消息组。 |
|
计划。 |
|
发送拒绝数据包。 选择
|
|
服务。 |
|
服务取反。 选择
|
|
垃圾邮件过滤器配置文件。 |
|
Sslvpn 门户。 |
|
Sslvpn 域。 |
|
流量整形器。 |
|
反向流量整形器。 |
|
用户。 |
|
Utm 状态。 选择
|
|
Voip 配置文件。 |
|
Web 过滤器配置文件。 |
|
基于身份的路由。 |
|
身份来源。 选择
|
|
隐式代理检测。 选择
|
|
入站。 选择
|
|
检测模式。 选择
|
|
互联网服务。 选择
|
|
启用/禁用此策略使用 IPv6 互联网服务。 选择
|
|
(列表)自定义 IPv6 互联网服务名称。 |
|
(列表)自定义互联网服务 IPv6 组名称。 |
|
(列表)互联网服务组名称。 |
|
(列表)IPv6 互联网服务名称。 |
|
启用后,internet-service6 指定服务不能是什么。 选择
|
|
启用/禁用此策略的源中使用 IPv6 互联网服务。 选择
|
|
(列表)自定义 IPv6 互联网服务源名称。 |
|
(列表)自定义互联网服务 IPv6 源组名称。 |
|
(列表)互联网服务 IPv6 源组名称。 |
|
(列表)IPv6 互联网服务源名称。 |
|
启用后,internet-service6-src 指定服务不能是什么。 选择
|
|
(列表或字符串)自定义互联网服务。 |
|
(列表或字符串)自定义互联网服务组。 |
|
(列表或字符串)互联网服务组。 |
|
(列表或字符串)互联网服务 ID。 |
|
(列表或字符串)互联网服务名称。 |
|
互联网服务取反。 选择
|
|
互联网服务源。 选择
|
|
(列表或字符串) 互联网服务源自定义。 |
|
(列表或字符串) 互联网服务源自定义组。 |
|
(列表或字符串) 互联网服务源组。 |
|
(列表或字符串) 互联网服务源 ID。 |
|
(列表或字符串) 互联网服务源名称。 |
|
互联网服务源取反。 选择
|
|
基于 IP。 选择
|
|
策略的 IP 版本。 |
|
Ippool。 选择
|
|
IPS 传感器。 |
|
现有 VoIP 的名称 |
|
(列表) 隔离器配置文件。 |
|
(列表) 隔离器服务器。 |
|
标签。 |
|
学习模式。 选择
|
|
记录 HTTP 事务。 选择
|
|
记录不匹配的流量。 选择
|
|
日志流量。 选择
|
|
日志流量应用。 选择
|
|
日志流量开始。 选择
|
|
匹配 VIP。 选择
|
|
仅匹配 VIP。 选择
|
|
每个用户的最大会话数。 |
|
(列表或字符串) Mms 配置文件。 |
|
名称。 |
|
Nat。 选择
|
|
启用/禁用 NAT46。 选择
|
|
启用/禁用 NAT64。 选择
|
|
Natinbound。 选择
|
|
Natip。 |
|
Natoutbound。 选择
|
|
(列表) 动态网络服务名称。 |
|
(列表) 动态网络服务源名称。 |
|
Np 加速。 选择
|
|
Np 加速。 选择
|
|
Ntlm。 选择
|
|
(列表) 启用 NTLM 的浏览器。 |
|
Ntlm 访客。 选择
|
|
出站。 选择
|
|
透传。 选择
|
|
启用/禁用被动 WAN 健康度测量。 选择
|
|
启用/禁用 PCP 入站 DNAT。 选择
|
|
启用/禁用 PCP 出站 SNAT。 选择
|
|
(列表) PCP 池名称。 |
|
每 IP 限速器。 |
|
允许任何主机。 选择
|
|
允许 STUN 主机。 选择
|
|
PFCP 配置文件。 |
|
策略的行为。 |
|
启用/禁用策略过期。 选择
|
|
策略过期日期 |
|
策略过期日期和时间,以纪元格式表示。 |
|
启用/禁用 CGNAT 的硬件会话设置。 选择
|
|
策略 ID。 |
|
(列表或字符串) 池名称。 |
|
(列表或字符串) 池名称6。 |
|
启用/禁用如果原始源端口未使用,则保留来自源 NAT 的原始源端口。 选择
|
|
配置文件组。 |
|
配置文件协议选项。 |
|
配置文件类型。 选择
|
|
启用 IP 身份验证绕过。 选择
|
|
Radius MAC 身份验证绕过。 选择
|
|
(列表) 重定向配置文件。 |
|
重定向 URL。 |
|
(列表或字符串) Replacemsg 组。 |
|
Replacemsg 覆盖组。 |
|
信誉方向。 选择
|
|
IPv6 信誉生效的初始流量方向。 选择
|
|
信誉最小值。 |
|
采取行动的 IPv6 最低信誉值。 |
|
需要 TFA。 选择
|
|
反向缓存。 选择
|
|
Rsso。 选择
|
|
(列表或字符串) Rtp 地址。 |
|
Rtp nat。 选择
|
|
扫描僵尸网络连接。 选择
|
|
计划。 |
|
计划超时。 选择
|
|
现有 SCTP 过滤器配置文件的名称。 |
|
发送拒绝数据包。 选择
|
|
(列表或字符串) 服务。 |
|
服务取反。 选择
|
|
(整数或字符串) 会话生存时间。 |
|
会话。 选择
|
|
(列表) 安全组标签。 |
|
启用/禁用安全组标签 选择
|
|
(列表或字符串) 垃圾邮件过滤器配置文件。 |
|
(列表或字符串) 源供应商 MAC 地址。 |
|
(列表或字符串) 源地址。 |
|
(列表或字符串) 源地址 IPv6。 |
|
启用后,srcaddr6 指定源地址不得为何值。 选择
|
|
源地址取反。 选择
|
|
(列表或字符串) 源接口。 |
|
SSH 过滤器配置文件。 |
|
SSH 策略检查。 选择
|
|
SSH 策略重定向。 选择
|
|
SSL 镜像。 选择
|
|
(列表或字符串) SSL 镜像接口。 |
|
SSL SSH 配置文件。 |
|
SSL VPN 身份验证。 选择
|
|
SSL VPN 客户端证书。 选择
|
|
SSL VPN 密码。 选择
|
|
SSO 身份验证方法。 选择
|
|
状态。 选择
|
|
(列表或字符串) 标签。 |
|
TCP MSS 接收器。 |
|
TCP MSS 发送器。 |
|
TCP 重置。 选择
|
|
无 SYN 的 TCP 会话。 选择
|
|
(列表) TCP 超时配置文件 ID |
|
超时发送 RST。 选择
|
|
TOS。 |
|
TOS 掩码。 |
|
TOS 取反。 选择
|
|
流量整形器。 |
|
反向流量整形器。 |
|
基于事务。 选择
|
|
透明。 选择
|
|
类型。 选择
|
|
(列表) UDP 超时配置文件 ID |
|
(列表或字符串) URL 类别。 |
|
(列表) URL 风险。 |
|
(列表或字符串) 用户。 |
|
UTM 检测模式。 选择
|
|
Utm 状态。 选择
|
|
UUID。 |
|
UUID 索引。 |
|
(列表或字符串) 供应商 MAC 地址。 |
|
现有视频过滤器配置文件的名称。 |
|
现有虚拟补丁配置文件的名称。 |
|
VLAN CoS 转发。 |
|
VLAN CoS 反向。 |
|
VLAN 过滤器。 |
|
Voip 配置文件。 |
|
VPN 隧道。 |
|
WAF 配置文件。 |
|
广域网优化。 选择
|
|
广域网优化检测。 选择
|
|
广域网优化被动优化。 选择
|
|
广域网优化对等端。 |
|
广域网优化配置文件。 |
|
WCCP。 选择
|
|
Web 身份验证 Cookie。 选择
|
|
Web 缓存。 选择
|
|
Web 缓存 HTTPS。 选择
|
|
Web 过滤器配置文件。 |
|
Web 代理转发服务器。 |
|
Web 代理配置文件。 |
|
WSSO。 选择
|
|
启用/禁用零信任设备所有权。 选择
|
|
(列表或字符串) 源 ztna-ems-tag 名称。 |
|
(列表) 源 ztna-ems-tag-secondary 名称。 |
|
(列表或字符串) 源 ztna-geo-tag 名称。 |
|
将 ZTNA 流量重定向到匹配的访问代理 proxy-policy。 选择
|
|
启用/禁用零信任访问。 选择
|
|
ZTNA 标签匹配逻辑。 选择
|
|
底层 Json RPC 请求的覆盖方法。 选择
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选择
|
|
用于在工作区模式下锁定 FortiManager 的 ADOM,值可以是 global 和其他包括 root 在内的 ADOM。 |
|
等待其他用户释放工作区锁定的最大时间(以秒为单位)。 默认值: |
说明
注意
从 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 IPv4 footer policies.
fortinet.fortimanager.fmgr_pkg_footer_policy:
bypass_validation: false
pkg: ansible
state: present
pkg_footer_policy:
action: accept # <value in [deny, accept, ipsec, ...]>
dstaddr: gall
dstintf: any
name: ansible-test-footer
policyid: 1074741836 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
status: enable
- 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 IPv4 footer policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_footer_policy"
params:
pkg: "ansible"
policy: "your_value"
返回值
常见的返回值记录在此处此处,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持,则发出警告。 返回: 复杂 |
作者
Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)