fortinet.fortimanager.fmgr_firewall_profilegroup 模块 – 配置配置文件组。

注意

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

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

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

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

fortinet.fortimanager 1.0.0 中的新增功能

概要

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

  • 示例包括所有参数和值，这些参数和值在使用前需要调整为数据源。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行，而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

firewall_profilegroup

字典

设置的顶层参数。

application_list

别名: application-list

字符串

现有应用程序列表的名称。

av_profile

别名: av-profile

字符串

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

casb_profile

别名: casb-profile

字符串

现有 CASB 配置文件的名称。

casi_profile

别名: casi-profile

字符串

CASI 配置文件。

cifs_profile

别名: cifs-profile

字符串

现有 CIFS 配置文件的名称。

diameter_filter_profile

别名: diameter-filter-profile

字符串

现有 Diameter 过滤器配置文件的名称。

dlp_profile

别名: dlp-profile

字符串

现有 DLP 配置文件的名称。

dlp_sensor

别名: dlp-sensor

字符串

现有 DLP 传感器的名称。

dnsfilter_profile

别名: dnsfilter-profile

字符串

现有 DNS 过滤器配置文件的名称。

emailfilter_profile

别名: emailfilter-profile

字符串

现有电子邮件过滤器配置文件的名称。

file_filter_profile

别名: file-filter-profile

字符串

现有文件过滤器配置文件的名称。

icap_profile

别名: icap-profile

字符串

现有 ICAP 配置文件的名称。

ips_sensor

别名: ips-sensor

字符串

现有 IPS 传感器的名称。

ips_voip_filter

别名: ips-voip-filter

字符串

现有 VoIP 的名称

mms_profile

别名: mms-profile

字符串

现有 MMS 配置文件的名称。

name

字符串 / 必需

配置文件组名称。

profile_protocol_options

别名: profile-protocol-options

字符串

现有协议选项配置文件的名称。

sctp_filter_profile

别名: sctp-filter-profile

字符串

现有 SCTP 过滤器配置文件的名称。

spamfilter_profile

别名: spamfilter-profile

字符串

现有垃圾邮件过滤器配置文件的名称。

ssh_filter_profile

别名: ssh-filter-profile

字符串

现有 SSH 过滤器配置文件的名称。

ssl_ssh_profile

别名: ssl-ssh-profile

字符串

现有 SSL SSH 配置文件的名称。

videofilter_profile

别名: videofilter-profile

字符串

现有视频过滤器配置文件的名称。

virtual_patch_profile

别名: virtual-patch-profile

字符串

现有虚拟补丁配置文件的名称。

voip_profile

别名: voip-profile

字符串

现有 VoIP 配置文件的名称。

waf_profile

别名: waf-profile

字符串

现有 Web 应用程序防火墙配置文件的名称。

webfilter_profile

别名: webfilter-profile

字符串

现有 Web 过滤器配置文件的名称。

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

list / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行时，要锁定的 FortiManager 的 ADOM，该值可以是全局的，也可以是包括 root 在内的其他 ADOM。

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 profile groups.
      fortinet.fortimanager.fmgr_firewall_profilegroup:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_profilegroup:
          application-list: "default" # need a valid profile name
          name: "ansible-test"

- 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 profile groups
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_profilegroup"
          params:
            adom: "ansible"
            profile-group: "your_value"

返回值

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

键

描述

meta

字典

请求的结果。

返回: 始终

request_url

字符串

请求的完整 URL。

返回: 始终

示例: "/sys/login/user"

response_code

整数

API 请求的状态。

返回: 始终

示例: 0

response_data

list / elements=string

API 响应。

返回: 始终

response_message

字符串

API 响应的描述性消息。

返回: 始终

示例: "OK."

system_information

字典

目标系统的信息。

返回: 始终

rc

整数

请求的状态。

返回: 始终

示例: 0

version_check_warning

list / elements=string

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)