fortinet.fortimanager.fmgr_pm_config_pblock_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_pm_config_pblock_firewall_policy6

fortinet.fortimanager 2.2.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 客户端进行身份验证。

pblock

字符串 / 必填

请求 URL 中的参数 (pblock)。

pm_config_pblock_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

字符串

现有反病毒配置文件的名称。

cgn_log_server_grp

别名:cgn-log-server-grp

字符串

CGN 日志服务器组。

cifs_profile

别名:cifs-profile

字符串

现有 CIFS 配置文件的名称。

comments

字符串

注释。

custom_log_fields

别名:custom-log-fields

任意

(列表) 要将自定义日志字段附加到此策略的日志消息的日志字段索引号。

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_acceleration

别名: np-acceleration

字符串

启用/禁用 UTM 网络处理器加速。

选项

  • "disable"

  • "enable"

outbound

字符串

基于策略的 IPsec VPN

选项

  • "disable"

  • "enable"

per_ip_shaper

别名: per-ip-shaper

字符串

每个 IP 流量整形器。

policy_offload

别名: policy-offload

字符串

策略卸载。

选项

  • "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

字符串

启用时,服务指定服务不能是什么。

选项

  • "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"

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,值可以是全局和其他值,包括 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 (generated based on argument schema)
  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_pm_config_pblock_firewall_policy6:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        pblock: <your own value>
        state: present # <value in [present, absent]>
        pm_config_pblock_firewall_policy6:
          _policy_block: <integer>
          action: <value in [deny, accept, ipsec, ...]>
          anti_replay: <value in [disable, enable]>
          app_category: <list or string>
          app_group: <list or string>
          application: <list or integer>
          application_list: <string>
          auto_asic_offload: <value in [disable, enable]>
          av_profile: <string>
          cgn_log_server_grp: <string>
          cifs_profile: <string>
          comments: <string>
          custom_log_fields: <list or string>
          diffserv_forward: <value in [disable, enable]>
          diffserv_reverse: <value in [disable, enable]>
          diffservcode_forward: <string>
          diffservcode_rev: <string>
          dlp_sensor: <string>
          dnsfilter_profile: <string>
          dsri: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr_negate: <value in [disable, enable]>
          dstintf: <list or string>
          emailfilter_profile: <string>
          firewall_session_dirty: <value in [check-all, check-new]>
          fixedport: <value in [disable, enable]>
          fsso_groups: <list or string>
          global_label: <string>
          groups: <list or string>
          http_policy_redirect: <value in [disable, enable]>
          icap_profile: <string>
          inbound: <value in [disable, enable]>
          inspection_mode: <value in [proxy, flow]>
          ippool: <value in [disable, enable]>
          ips_sensor: <string>
          label: <string>
          logtraffic: <value in [disable, enable, all, ...]>
          logtraffic_start: <value in [disable, enable]>
          mms_profile: <string>
          name: <string>
          nat: <value in [disable, enable]>
          natinbound: <value in [disable, enable]>
          natoutbound: <value in [disable, enable]>
          np_acceleration: <value in [disable, enable]>
          outbound: <value in [disable, enable]>
          per_ip_shaper: <string>
          policy_offload: <value in [disable, enable]>
          policyid: <integer>
          poolname: <list or string>
          profile_group: <string>
          profile_protocol_options: <string>
          profile_type: <value in [single, group]>
          replacemsg_override_group: <string>
          rsso: <value in [disable, enable]>
          schedule: <string>
          send_deny_packet: <value in [disable, enable]>
          service: <list or string>
          service_negate: <value in [disable, enable]>
          session_ttl: <string>
          srcaddr: <list or string>
          srcaddr_negate: <value in [disable, enable]>
          srcintf: <list or string>
          ssh_filter_profile: <string>
          ssh_policy_redirect: <value in [disable, enable]>
          ssl_mirror: <value in [disable, enable]>
          ssl_mirror_intf: <list or string>
          ssl_ssh_profile: <string>
          status: <value in [disable, enable]>
          tcp_mss_receiver: <integer>
          tcp_mss_sender: <integer>
          tcp_session_without_syn: <value in [all, data-only, disable]>
          timeout_send_rst: <value in [disable, enable]>
          tos: <string>
          tos_mask: <string>
          tos_negate: <value in [disable, enable]>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          url_category: <list or string>
          users: <list or string>
          utm_status: <value in [disable, enable]>
          uuid: <string>
          vlan_cos_fwd: <integer>
          vlan_cos_rev: <integer>
          vlan_filter: <string>
          voip_profile: <string>
          vpntunnel: <string>
          waf_profile: <string>
          webcache: <value in [disable, enable]>
          webcache_https: <value in [disable, enable]>
          webfilter_profile: <string>
          webproxy_forward_server: <string>
          webproxy_profile: <string>
          dscp_negate: <value in [disable, enable]>
          devices: <list or string>
          dscp_value: <string>
          spamfilter_profile: <string>
          dscp_match: <value in [disable, enable]>

返回值

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

描述

meta

字典

请求的结果。

返回: 始终

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)