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 过滤配置文件。 |
|
仅 DPO。 选项
|
|
DSCP 匹配。 选项
|
|
DSCP 取反。 选项
|
|
DSCP 值。 |
|
DSRI。 选项
|
|
(列表或字符串) 目的地址。 |
|
(列表或字符串) IPv6 目的地址。 |
|
启用时,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的整形器。 |
|
配置文件组。 |
|
协议配置文件选项。 |
|
配置文件类型。 选项
|
|
替换消息组。 |
|
调度。 |
|
发送拒绝数据包。 选项
|
|
服务。 |
|
服务取反。 选项
|
|
垃圾邮件过滤配置文件。 |
|
SSL VPN门户。 |
|
SSL VPN领域。 |
|
流量整形器。 |
|
反向流量整形器。 |
|
用户。 |
|
UTM状态。 选项
|
|
VoIP配置文件。 |
|
网页过滤配置文件。 |
|
基于身份的路由。 |
|
身份来源。 选项
|
|
隐式代理检测。 选项
|
|
入站。 选项
|
|
检测模式。 选项
|
|
互联网服务。 选项
|
|
启用/禁用为此策略使用IPv6互联网服务。 选项
|
|
(列表) 自定义IPv6互联网服务名称。 |
|
(列表) 自定义IPv6互联网服务组名称。 |
|
(列表) IPv6互联网服务组名称。 |
|
(列表) IPv6互联网服务名称。 |
|
启用时,internet-service6指定服务不应是什么。 选项
|
|
启用/禁用为此策略在源中使用IPv6互联网服务。 选项
|
|
(列表) 自定义源IPv6互联网服务名称。 |
|
(列表) 自定义源IPv6互联网服务组名称。 |
|
(列表) 源IPv6互联网服务组名称。 |
|
(列表) 源IPv6互联网服务名称。 |
|
启用时,internet-service6-src指定服务不应是什么。 选项
|
|
(列表或字符串) 自定义互联网服务。 |
|
(列表或字符串) Internet 服务自定义组。 |
|
(列表或字符串) Internet 服务组。 |
|
(列表或字符串) Internet 服务 ID。 |
|
(列表或字符串) Internet 服务名称。 |
|
Internet 服务否定。 选项
|
|
Internet 服务源。 选项
|
|
(列表或字符串) Internet 服务自定义源。 |
|
(列表或字符串) Internet 服务自定义源组。 |
|
(列表或字符串) Internet 服务源组。 |
|
(列表或字符串) Internet 服务源ID。 |
|
(列表或字符串) Internet 服务源名称。 |
|
Internet 服务源否定。 选项
|
|
基于 IP。 选项
|
|
策略的 IP 版本。 |
|
IP 池。 选项
|
|
IPS传感器。 |
|
现有 VoIP 的名称 |
|
(列表) 隔离器配置文件。 |
|
(列表) 隔离器服务器。 |
|
标签。 |
|
学习模式。 选项
|
|
记录 HTTP 事务。 选项
|
|
记录不匹配的流量。 选项
|
|
日志流量。 选项
|
|
应用日志流量。 选项
|
|
日志流量起始。 选项
|
|
匹配 VIP。 选项
|
|
仅匹配 VIP。 选项
|
|
每个用户的最大会话数。 |
|
(列表或字符串) MMS 配置文件。 |
|
名称。 |
|
NAT。 选项
|
|
启用/禁用 NAT46。 选项
|
|
启用/禁用 NAT64。 选项
|
|
入站 NAT。 选项
|
|
NAT IP。 |
|
出站 NAT。 选项
|
|
(列表) 动态网络服务名称。 |
|
(列表) 动态网络服务源名称。 |
|
NP 加速。 选项
|
|
NP 加速。 选项
|
|
NTLM。 选项
|
|
(列表) 启用 NTLM 的浏览器。 |
|
NTLM 来宾。 选项
|
|
出站。 选项
|
|
直通。 选项
|
|
启用/禁用被动 WAN 健康检测。 选项
|
|
启用/禁用 PCP 入站 DNAT。 选项
|
|
启用/禁用 PCP 出站 SNAT。 选项
|
|
(列表) PCP 池名称。 |
|
每个IP的整形器。 |
|
允许任何主机。 选项
|
|
允许 STUN 主机。 选项
|
|
PFCP 配置文件。 |
|
策略的行为。 |
|
启用/禁用策略过期。 选项
|
|
策略过期日期 |
|
策略过期日期和时间,以纪元时间格式表示。 |
|
启用/禁用 CGNAT 的硬件会话设置。 选项
|
|
策略 ID。 |
|
(列表或字符串) 池名称。 |
|
(列表或字符串) 池名称6。 |
|
如果原始源端口未被使用,则启用/禁用源 NAT 的原始源端口保留。 选项
|
|
配置文件组。 |
|
协议配置文件选项。 |
|
配置文件类型。 选项
|
|
启用 IP 身份验证绕过。 选项
|
|
Radius MAC 身份验证绕过。 选项
|
|
(列表) 重定向配置文件。 |
|
重定向 URL。 |
|
(列表或字符串) 替换消息组。 |
|
替换消息覆盖组。 |
|
信誉方向。 选项
|
|
IPv6 信誉生效的初始流量方向。 选项
|
|
信誉最低值。 |
|
触发操作所需的IPv6最小信誉。 |
|
需要双因素身份验证。 选项
|
|
反向缓存。 选项
|
|
Rsso。 选项
|
|
(列表或字符串) RTP地址。 |
|
RTP NAT。 选项
|
|
扫描僵尸网络连接。 选项
|
|
调度。 |
|
调度超时。 选项
|
|
现有SCTP过滤器的名称。 |
|
发送拒绝数据包。 选项
|
|
(列表或字符串) 服务。 |
|
服务取反。 选项
|
|
(整数或字符串) 会话TTL。 |
|
会话。 选项
|
|
(列表) 安全组标签。 |
|
启用/禁用安全组标签。 选项
|
|
(列表或字符串) 垃圾邮件过滤配置文件。 |
|
(列表或字符串) 源厂商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配置文件。 |
|
WAN优化。 选项
|
|
WAN优化检测。 选项
|
|
WAN优化被动选项。 选项
|
|
WAN优化对等体。 |
|
WAN优化配置文件。 |
|
WCCP。 选项
|
|
Web认证Cookie。 选项
|
|
Web缓存。 选项
|
|
Web缓存HTTPS。 选项
|
|
网页过滤配置文件。 |
|
Web代理转发服务器。 |
|
Web代理配置文件。 |
|
WSSO。 选项
|
|
启用/禁用零信任设备所有权。 选项
|
|
(列表或字符串) 源ZTNA-EMS标签名称。 |
|
(列表) 源ZTNA-EMS次要标签名称。 |
|
(列表或字符串) 源ZTNA地理标签名称。 |
|
将ZTNA流量重定向到匹配的访问代理代理策略。 选项
|
|
启用/禁用零信任访问。 选项
|
|
Ztna标签匹配逻辑。 选项
|
|
底层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 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版本支持,则会发出警告。 返回:复杂类型 |
作者
杜欣伟 (@dux-fortinet)
李星 (@lix-fortinet)
薛杰 (@JieX19)
郑链 (@chillancezen)
沈方 (@fshen01)
卢洪斌 (@fgtdev-hblu)