fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy 模块 – 配置 IPv4 接口策略。

注意

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

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

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

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

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_interfacepolicy

字典

设置的顶级参数。

address_type

别名：address-type

字符串

地址类型。

选项

  • "ipv4"

  • "ipv6"

application_list

别名：application-list

字符串

应用程序列表名称。

application_list_status

别名：application-list-status

字符串

启用/禁用应用程序控制。

选项

  • "disable"

  • "enable"

av_profile

别名：av-profile

字符串

反病毒配置文件。

av_profile_status

别名：av-profile-status

字符串

启用/禁用反病毒。

选项

  • "disable"

  • "enable"

casb_profile

别名：casb-profile

任意

(列表) CASB 配置文件。

casb_profile_status

别名：casb-profile-status

字符串

启用/禁用 CASB。

选项

  • "disable"

  • "enable"

casi_profile

别名：casi-profile

字符串

CASI 配置文件名称。

casi_profile_status

别名：casi-profile-status

字符串

启用/禁用 CASI。

选项

  • "disable"

  • "enable"

comments

字符串

注释。

dlp_profile

别名：dlp-profile

字符串

DLP 配置文件名称。

dlp_profile_status

别名：dlp-profile-status

字符串

启用/禁用 DLP。

选项

  • "disable"

  • "enable"

dlp_sensor

别名：dlp-sensor

字符串

DLP 传感器名称。

dlp_sensor_status

别名：dlp-sensor-status

字符串

启用/禁用 DLP。

选项

  • "disable"

  • "enable"

dsri

字符串

启用/禁用 DSRI。

选项

  • "disable"

  • "enable"

dstaddr

任意

(列表或字符串) 地址对象，用于将流量监控限制为发送到指定地址或范围的网络流量。

emailfilter_profile

别名：emailfilter-profile

字符串

电子邮件过滤器配置文件。

emailfilter_profile_status

别名：emailfilter-profile-status

字符串

启用/禁用电子邮件过滤器。

选项

  • "disable"

  • "enable"

interface

字符串

来自可用接口的被监控接口名称。

ips_sensor

别名：ips-sensor

字符串

IPS 传感器名称。

ips_sensor_status

别名：ips-sensor-status

字符串

启用/禁用 IPS。

选项

  • "disable"

  • "enable"

label

字符串

标签。

logtraffic

字符串

此策略中使用的日志记录类型

选项

  • "disable"

  • "all"

  • "utm"

policyid

整数 / 必填

策略 ID。

scan_botnet_connections

别名: scan-botnet-connections

字符串

启用/禁用扫描与僵尸网络服务器的连接。

选项

  • "disable"

  • "block"

  • "monitor"

service

任意

(列表或字符串) 可用选项中的服务对象。

spamfilter_profile

别名: spamfilter-profile

字符串

反垃圾邮件配置文件。

spamfilter_profile_status

别名: spamfilter-profile-status

字符串

启用/禁用反垃圾邮件。

选项

  • "disable"

  • "enable"

srcaddr

任意

(列表或字符串) 地址对象，用于将流量监控限制为从指定地址或范围发送的网络流量。

status

字符串

启用/禁用此策略。

选项

  • "disable"

  • "enable"

uuid

字符串

通用唯一标识符

webfilter_profile

别名: webfilter-profile

字符串

Web 过滤配置文件。

webfilter_profile_status

别名: webfilter-profile-status

字符串

启用/禁用 Web 过滤。

选项

  • "disable"

  • "enable"

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 IPv4 interface policies.
      fortinet.fortimanager.fmgr_pkg_firewall_interfacepolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_interfacepolicy:
          address-type: ipv4 # <value in [ipv4, ipv6]>
          comments: "ansible-comment"
          interface: sslvpn_tun_intf
          policyid: 1
          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 interface policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_interfacepolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            interface-policy: "your_value"

返回值

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

键

描述

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

列表 / 元素=字符串

如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回: 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈方 (@fshen01)

  • 陆宏斌 (@fgtdev-hblu)