fortinet.fortimanager.fmgr_pkg_header_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_header_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互联网服务名称。 |
|
(列表) 自定义互联网服务6组名称。 |
|
(列表) 互联网服务组名称。 |
|
(列表) IPv6互联网服务名称。 |
|
启用时，internet-service6指定服务必须不是什么。 选项
|
|
启用/禁用此策略中源的IPv6互联网服务。 选项
|
|
(列表) 自定义IPv6互联网服务源名称。 |
|
(列表) 自定义互联网服务6源组名称。 |
|
(列表) 互联网服务6源组名称。 |
|
(列表) IPv6互联网服务源名称。 |
|
启用时，internet-service6-src指定服务必须不是什么。 选项
|
|
(列表或字符串) 互联网服务自定义。 |
|
(列表或字符串) 互联网服务自定义组。 |
|
(列表或字符串) 互联网服务组。 |
|
(列表或字符串) 互联网服务ID。 |
|
(列表或字符串) 互联网服务名称。 |
|
互联网服务否定。 选项
|
|
互联网服务源。 选项
|
|
(列表或字符串) 互联网服务源自定义。 |
|
(列表或字符串) 互联网服务源自定义组。 |
|
(列表或字符串) 互联网服务源组。 |
|
(列表或字符串) 互联网服务源ID。 |
|
(列表或字符串)互联网服务源名称。 |
|
互联网服务源否定。 选项
|
|
基于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。 |
|
(列表或字符串)池名称。 |
|
(列表或字符串)IPv6池名称。 |
|
如果源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 最大报文段大小接收端。 |
|
TCP 最大报文段大小发送端。 |
|
TCP 重置。 选项
|
|
无SYN的TCP会话。 选项
|
|
(列表) TCP 超时配置文件ID。 |
|
超时发送RST。 选项
|
|
TOS (Type of Service)。 |
|
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-Tag 名称。 |
|
(列表) 源 ZTNA-EMS-Tag-Secondary 名称。 |
|
(列表或字符串) 源 ZTNA-Geo-Tag 名称。 |
|
将 ZTNA 流量重定向到匹配的 Access-Proxy 代理策略。 选项
|
|
启用/禁用零信任访问。 选项
|
|
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 header policies.
fortinet.fortimanager.fmgr_pkg_header_policy:
bypass_validation: false
pkg: ansible
state: present
pkg_header_policy:
action: accept # <value in [deny, accept, ipsec, ...]>
comments: "ansible-comment"
dstaddr: gall
dstintf: any
name: ansible-test-header
policyid: 1073741826 # must larger than 2^30(1074741824), since header/footer policy is a special policy
schedule: galways
service: gALL
srcaddr: gall
srcintf: any
status: disable
- 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 header policies
fortinet.fortimanager.fmgr_fact:
facts:
selector: "pkg_header_policy"
params:
pkg: "ansible"
policy: "your_value"
返回值
常见的返回值已在此处记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整 URL。 返回：始终 示例： |
|
API 请求的状态。 返回：始终 示例： |
|
API 响应。 返回：始终 |
|
API 响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回：复杂类型 |