fortinet.fortimanager.fmgr_pkg_firewall_policy6 模块 – 配置 IPv6 策略。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_pkg_firewall_policy6。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包括所有需要在使用前根据数据源调整的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
pkg 字符串 / 必需	请求 URL 中的参数 (pkg)。
pkg_firewall_policy6 字典	设置的顶级参数。
_policy_block 整数	分配的策略块。
action 字符串	策略操作 选项 "deny" "accept" "ipsec" "ssl-vpn"
anti_replay 别名：anti-replay 字符串	启用/禁用抗重放检查。 选项 "disable" "enable"
app_category 别名：app-category 任意	(列表或字符串) 应用类别 ID 列表。
app_group 别名：app-group 任意	(列表或字符串) 应用组名称。
application 任意	(列表) 应用 ID 列表。
application_list 别名：application-list 字符串	现有应用列表的名称。
auto_asic_offload 别名：auto-asic-offload 字符串	启用/禁用策略流量 ASIC 卸载。 选项 "disable" "enable"
av_profile 别名：av-profile 字符串	现有防病毒配置文件的名称。
casi_profile 别名：casi-profile 字符串	CASI 配置文件。
cgn_log_server_grp 别名：cgn-log-server-grp 字符串	NP 日志服务器组名称
cifs_profile 别名：cifs-profile 字符串	现有 CIFS 配置文件的名称。
comments 字符串	注释。
custom_log_fields 别名：custom-log-fields 任意	(列表或字符串) 要将自定义日志字段附加到此策略的日志消息的日志字段索引号。
decrypted_traffic_mirror 别名：decrypted-traffic-mirror 字符串	已解密的流量镜像。
devices 任意	(列表或字符串) 可以由策略匹配的设备或设备组的名称。
diffserv_forward 别名：diffserv-forward 字符串	启用以将数据包 DiffServ 值更改为指定的 diffservcode-forward 值。 选项 "disable" "enable"
diffserv_reverse 别名：diffserv-reverse 字符串	启用更改数据包反向 选项 "disable" "enable"
diffservcode_forward 别名：diffservcode-forward 字符串	将数据包 DiffServ 更改为此值。
diffservcode_rev 别名：diffservcode-rev 字符串	更改数据包反向
dlp_sensor 别名：dlp-sensor 字符串	现有 DLP 传感器的名称。
dnsfilter_profile 别名：dnsfilter-profile 字符串	现有 DNS 过滤配置文件的名称。
dscp_match 别名：dscp-match 字符串	启用 DSCP 检查。 选项 "disable" "enable"
dscp_negate 别名：dscp-negate 字符串	启用否定的 DSCP 匹配。 选项 "disable" "enable"
dscp_value 别名：dscp-value 字符串	DSCP 值。
dsri 字符串	启用 DSRI 以忽略 HTTP 服务器响应。 选项 "disable" "enable"
dstaddr 任意	(列表或字符串) 目标地址和地址组名称。
dstaddr_negate 别名：dstaddr-negate 字符串	启用时，dstaddr 指定目标地址不能是什么。 选项 "disable" "enable"
dstintf 任意	(列表或字符串) 出站
emailfilter_profile 别名：emailfilter-profile 字符串	现有电子邮件过滤配置文件的名称。
firewall_session_dirty 别名：firewall-session-dirty 字符串	如果此防火墙策略的配置发生更改，如何处理会话。 选项 "check-all" "check-new"
fixedport 字符串	启用此选项可防止源 NAT 更改会话的源端口。 选项 "disable" "enable"
fsso_groups 别名：fsso-groups 任意	(列表或字符串) FSSO 组的名称。
global_label 别名：global-label 字符串	在 GUI 处于全局视图模式下显示的策略标签。
groups 任意	(列表或字符串) 可以使用此策略进行身份验证的用户组的名称。
http_policy_redirect 别名：http-policy-redirect 字符串	重定向 HTTP 选项 "disable" "enable"
icap_profile 别名：icap-profile 字符串	现有 ICAP 配置文件的名称。
inbound 字符串	基于策略的 IPsec VPN 选项 "disable" "enable"
inspection_mode 别名：inspection-mode 字符串	策略检查模式 选项 "proxy" "flow"
ippool 字符串	启用此选项可为源 NAT 使用 IP 池。 选项 "disable" "enable"
ips_sensor 别名：ips-sensor 字符串	现有 IPS 传感器的名称。
label 字符串	在 GUI 处于区域视图模式下显示的策略标签。
logtraffic 字符串	启用或禁用日志记录。 选项 "disable" "enable" "all" "utm"
logtraffic_start 别名：logtraffic-start 字符串	记录会话开始和结束时的日志。 选项 "disable" "enable"
mms_profile 别名：mms-profile 字符串	现有 MMS 配置文件的名称。
name 字符串	策略名称。
nat 字符串	启用/禁用源 NAT。 选项 "disable" "enable"
natinbound 字符串	基于策略的 IPsec VPN 选项 "disable" "enable"
natoutbound 字符串	基于策略的 IPsec VPN 选项 "disable" "enable"
np_accelation 别名：np-accelation 字符串	启用/禁用 UTM 网络处理器加速。 选项 "disable" "enable"
np_acceleration 别名：np-acceleration 字符串	启用/禁用 UTM 网络处理器加速。 选项 "disable" "enable"
outbound 字符串	基于策略的 IPsec VPN 选项 "disable" "enable"
per_ip_shaper 别名：per-ip-shaper 字符串	每个 IP 流量整形器。
policy_offload 别名：policy-offload 字符串	启用/禁用将策略配置卸载到 CP 处理器。 选项 "disable" "enable"
policyid 整数 / 必需	策略 ID。
poolname 任意	(列表或字符串) IP 池名称。
profile_group 别名：profile-group 字符串	配置文件组的名称。
profile_protocol_options 别名：profile-protocol-options 字符串	现有协议选项配置文件的名称。
profile_type 别名：profile-type 字符串	确定防火墙策略是只允许安全配置文件组还是只允许单个配置文件。 选项 "single" "group"
replacemsg_override_group 别名：replacemsg-override-group 字符串	覆盖此策略的默认替换消息组。
rsso 字符串	启用/禁用 RADIUS 单点登录 选项 "disable" "enable"
schedule 字符串	计划名称。
send_deny_packet 别名：send-deny-packet 字符串	启用/禁用返回拒绝数据包。 选项 "disable" "enable"
service 任意	(列表或字符串) 服务和服务组名称。
service_negate 别名：service-negate 字符串	启用后，service 指定服务不能是什么。 选项 "disable" "enable"
session_ttl 别名：session-ttl 任意	(整数或字符串) 此策略接受的会话的会话 TTL（以秒为单位）。
spamfilter_profile 别名：spamfilter-profile 字符串	现有垃圾邮件过滤器配置文件的名称。
srcaddr 任意	(列表或字符串) 源地址和地址组名称。
srcaddr_negate 别名：srcaddr-negate 字符串	启用后，srcaddr 指定源地址不能是什么。 选项 "disable" "enable"
srcintf 任意	(列表或字符串) 输入
ssh_filter_profile 别名：ssh-filter-profile 字符串	现有 SSH 过滤器配置文件的名称。
ssh_policy_redirect 别名：ssh-policy-redirect 字符串	将 SSH 流量重定向到匹配的透明代理策略。 选项 "disable" "enable"
ssl_mirror 别名：ssl-mirror 字符串	启用此选项可将解密的 SSL 流量复制到 FortiGate 接口。 选项 "disable" "enable"
ssl_mirror_intf 别名：ssl-mirror-intf 任意	(列表或字符串) SSL 镜像接口名称。
ssl_ssh_profile 别名：ssl-ssh-profile 字符串	现有 SSL SSH 配置文件的名称。
status 字符串	启用或禁用此策略。 选项 "disable" "enable"
tags 字符串	应用于此策略的对象标签的名称。
tcp_mss_receiver 别名：tcp-mss-receiver 整数	接收器 TCP 最大分段大小
tcp_mss_sender 别名：tcp-mss-sender 整数	发送器 TCP 最大分段大小
tcp_session_without_syn 别名：tcp-session-without-syn 字符串	启用/禁用创建没有 SYN 标志的 TCP 会话。 选项 "all" "data-only" "disable"
timeout_send_rst 别名：timeout-send-rst 字符串	启用/禁用在 TCP 会话过期时发送 RST 数据包。 选项 "disable" "enable"
tos 字符串	ToS
tos_mask 别名：tos-mask 字符串	非零位位置用于比较，而零位位置被忽略。
tos_negate 别名：tos-negate 字符串	启用否定的 TOS 匹配。 选项 "disable" "enable"
traffic_shaper 别名：traffic-shaper 字符串	反向流量整形器。
traffic_shaper_reverse 别名：traffic-shaper-reverse 字符串	反向流量整形器。
url_category 别名：url-category 任意	(列表或字符串) URL 类别 ID 列表。
users 任意	(列表或字符串) 可以使用此策略进行身份验证的单个用户的名称。
utm_status 别名：utm-status 字符串	启用 AV/Web/IPS 保护配置文件。 选项 "disable" "enable"
uuid 字符串	通用唯一标识符
vlan_cos_fwd 别名：vlan-cos-fwd 整数	VLAN 正向用户优先级
vlan_cos_rev 别名：vlan-cos-rev 整数	VLAN 反向用户优先级
vlan_filter 别名：vlan-filter 字符串	设置 VLAN 过滤器。
voip_profile 别名：voip-profile 字符串	现有 VoIP 配置文件的名称。
vpntunnel 字符串	基于策略的 IPsec VPN
waf_profile 别名：waf-profile 字符串	现有 Web 应用防火墙配置文件的名称。
webcache 字符串	启用/禁用 Web 缓存。 选项 "disable" "enable"
webcache_https 别名：webcache-https 字符串	启用/禁用 HTTPS 的 Web 缓存。 选项 "disable" "enable"
webfilter_profile 别名：webfilter-profile 字符串	现有 Web 过滤器配置文件的名称。
webproxy_forward_server 别名：webproxy-forward-server 字符串	Web 代理转发服务器名称。
webproxy_profile 别名：webproxy-profile 字符串	Web 代理配置文件名称。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
rc_failed 列表 / 元素=整数	将被覆盖的失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将被覆盖的成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选项 "present" "absent"
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 的 adom 锁定，值可以是 global 和 root 等其他值。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最大时间（以秒为单位）。 默认值： 300

备注

注意

• 从 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 IPv6 policies.
      fortinet.fortimanager.fmgr_pkg_firewall_policy6:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_policy6:
          action: accept # <value in [deny, accept, ipsec, ...]>
          comments: ansible-comment
          dstaddr: all
          dstintf: any
          name: ansible-test-policy6
          nat: disable
          policyid: 1
          schedule: always
          service: ALL
          srcaddr: all
          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 IPv6 policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_policy6"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            policy6: "your_value"

返回值

常见的返回值已在此处记录，以下是此模块独有的字段

键	描述
元数据 (meta) 字典	请求的结果。 返回值：始终返回
请求URL (request_url) 字符串	请求的完整URL。 返回值：始终返回 示例： "/sys/login/user"
响应代码 (response_code) 整数	API请求的状态。 返回值：始终返回 示例： 0
响应数据 (response_data) 列表 / 元素=字符串	API响应。 返回值：始终返回
响应消息 (response_message) 字符串	API响应的描述性消息。 返回值：始终返回 示例： "OK."
系统信息 (system_information) 字典	目标系统的信息。 返回值：始终返回
返回码 (rc) 整数	请求的状态。 返回值：始终返回 示例： 0
版本检查警告 (version_check_warning) 列表 / 元素=字符串	如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回值：复杂类型

作者

• 杜欣伟 (@dux-fortinet)

• 李星 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑链 (@chillancezen)

• 沈峰 (@fshen01)

• 陆宏斌 (@fgtdev-hblu)

集合链接

• 问题追踪器
• 主页
• 代码仓库