fortinet.fortios.fortios_system_csf 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中，将此 FortiGate 添加到安全架构或在此 FortiGate 上设置新的安全架构。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详情。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_csf。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 csf 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括在使用前需要调整到数据源的所有参数和值。在 FOS v6.0.0 上进行了测试

要求

执行此模块的主机需要满足以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性，则用斜杠字符分隔。

标记有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选择

  • "present"

  • "absent"

system_csf

字典

将此 FortiGate 添加到安全架构或在此 FortiGate 上设置新的安全架构。

accept_auth_by_cert

字符串

接受具有未知证书的连接并要求管理员批准。

选择

  • "disable"

  • "enable"

authorization_request_type

字符串

授权请求类型。

选择

  • "serial"

  • "certificate"

certificate

字符串

证书。源 certificate.local.name。

configuration_sync

字符串

配置同步模式。

选择

  • "default"

  • "local"

downstream_access

字符串

启用/禁用下游设备访问此设备的配置和数据。

选择

  • "enable"

  • "disable"

downstream_accprofile

字符串

来自下游设备的请求的默认访问配置文件。源 system.accprofile.name。

fabric_connector

列表 / 元素=字典

架构连接器配置。

accprofile

字符串

覆盖访问配置文件。源 system.accprofile.name。

configuration_write_access

字符串

启用/禁用下游设备对配置的写入访问。

选择

  • "enable"

  • "disable"

serial

字符串 / 必需

序列号。

vdom

列表 / 元素=字典

连接器有权访问的虚拟域。如果未设置，则连接器将仅有权访问它通过安全架构加入的 VDOM。

name

字符串 / 必需

虚拟域名。源 system.vdom.name。

fabric_device

列表 / 元素=字典

架构设备配置。

access_token

字符串

设备访问令牌。

device_ip

字符串

设备 IP。

device_type

字符串

设备类型。

选择

  • "fortimail"

https_port

整数

架构设备的 HTTPS 端口。

login

字符串

设备登录名。

name

字符串 / 必需

设备名称。

password

字符串

设备登录密码。

fabric_object_unification

字符串

架构 CMDB 对象统一。

选择

  • "default"

  • "local"

fabric_workers

整数

安全架构守护程序的工作进程数。

file_mgmt

字符串

启用/禁用安全架构守护程序文件管理。

选择

  • "enable"

  • "disable"

file_quota

整数

守护程序文件可以使用的最大内存量（以字节为单位）。

file_quota_warning

整数

当已使用配额的设定百分比时发出警告。

fixed_key

字符串

当此设备是根设备时使用的自动生成的固定密钥。（如果未设置，将自动生成。）

forticloud_account_enforcement

字符串

架构 FortiCloud 帐户统一。

选择

  • "enable"

  • "disable"

group_name

字符串

安全架构组名称。安全架构中的所有 FortiGate 都必须具有相同的组名称。

group_password

字符串

安全架构组密码。安全架构中的所有 FortiGate 都必须具有相同的组密码。

log_unification

字符串

启用/禁用日志统一的发现消息广播。

选择

  • "disable"

  • "enable"

management_ip

字符串

此 FortiGate 的管理 IP 地址。用于从安全架构中的另一个 FortiGate 登录到此 FortiGate。

management_port

整数

管理连接的覆盖端口（覆盖管理端口）。

saml_configuration_sync

字符串

SAML 设置配置同步。

选择

  • "default"

  • "local"

source_ip

字符串

与上游 FortiGate 通信的源 IP 地址。

status

字符串

启用/禁用安全架构。

选择

  • "enable"

  • "disable"

trusted_list

列表 / 元素=字典

预先授权和阻止的安全架构节点。

action

字符串

安全架构授权操作。

选择

  • "accept"

  • "deny"

authorization_type

字符串

授权类型。

选择

  • "serial"

  • "certificate"

certificate

字符串

证书。

downstream_authorization

字符串

信任此节点管理员的授权。

选择

  • "enable"

  • "disable"

ha_members

列表 / 元素=字符串

HA 成员。

index

整数

树中下游的索引。

name

字符串 / 必需

名称。

serial

字符串

序列号。

uid

字符串

当前 CSF 节点的唯一 ID

upstream

字符串

此 FortiGate 在安全架构中的上游 FortiGate 的 IP/FQDN。

upstream_interface

字符串

指定到达服务器的出接口。源系统.接口.名称。

upstream_interface_select_method

字符串

指定如何选择到达服务器的出接口。

选择

  • "auto" （自动）

  • "sdwan" （SD-WAN）

  • "specify" （指定）

upstream_ip

字符串

安全编排中，此 FortiGate 上游的 FortiGate 的 IP 地址。

upstream_port

整数

用于与安全编排中此 FortiGate 上游的 FortiGate 通信的端口号。

vdom

字符串

虚拟域，在之前定义的那些中选择。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例

- name: Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate.
  fortinet.fortios.fortios_system_csf:
      vdom: "{{ vdom }}"
      system_csf:
          accept_auth_by_cert: "disable"
          authorization_request_type: "serial"
          certificate: "<your_own_value> (source certificate.local.name)"
          configuration_sync: "default"
          downstream_access: "enable"
          downstream_accprofile: "<your_own_value> (source system.accprofile.name)"
          fabric_connector:
              -
                  accprofile: "<your_own_value> (source system.accprofile.name)"
                  configuration_write_access: "enable"
                  serial: "<your_own_value>"
                  vdom:
                      -
                          name: "default_name_14 (source system.vdom.name)"
          fabric_device:
              -
                  access_token: "<your_own_value>"
                  device_ip: "<your_own_value>"
                  device_type: "fortimail"
                  https_port: "443"
                  login: "<your_own_value>"
                  name: "default_name_21"
                  password: "<your_own_value>"
          fabric_object_unification: "default"
          fabric_workers: "2"
          file_mgmt: "enable"
          file_quota: "0"
          file_quota_warning: "90"
          fixed_key: "<your_own_value>"
          forticloud_account_enforcement: "enable"
          group_name: "<your_own_value>"
          group_password: "<your_own_value>"
          log_unification: "disable"
          management_ip: "<your_own_value>"
          management_port: "32767"
          saml_configuration_sync: "default"
          source_ip: "84.230.14.43"
          status: "enable"
          trusted_list:
              -
                  action: "accept"
                  authorization_type: "serial"
                  certificate: "<your_own_value>"
                  downstream_authorization: "enable"
                  ha_members: "<your_own_value>"
                  index: "0"
                  name: "default_name_45"
                  serial: "<your_own_value>"
          uid: "<your_own_value>"
          upstream: "<your_own_value>"
          upstream_interface: "<your_own_value> (source system.interface.name)"
          upstream_interface_select_method: "auto"
          upstream_ip: "<your_own_value>"
          upstream_port: "8013"

返回值

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

键

描述

build

字符串

FortiGate 镜像的构建号

返回： 始终

示例： "1547"

http_method

字符串

用于将内容配置到 FortiGate 中的最后使用的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在最后一次应用的操作中给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回： 始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

指示操作结果

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

version

字符串

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)