fortinet.fortios.fortios_cifs_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 CIFS 配置文件。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

在执行此模块的主机上需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

cifs_profile

字典

配置 CIFS 配置文件。

domain_controller

字符串

用于解密 CIFS 流量的域。源凭据存储.域控制器.服务器名称。

file_filter

字典

文件过滤器。

entries

列表 / 元素=字典

文件过滤器条目。

action

字符串

对匹配的文件执行的操作。

选择

  • "log"

  • "block"

comment

字符串

注释。

direction

字符串

匹配会话的起始方向或回复方向中传输的文件。

选择

  • "incoming"

  • "outgoing"

  • "any"

file_type

列表 / 元素=字典

选择文件类型。

name

字符串 / 必需

文件类型名称。源 antivirus.filetype.name。

filter

字符串 / 必需

添加文件过滤器。

protocol

列表 / 元素=字符串

要应用的协议。

选择

  • "cifs"

log

字符串

启用/禁用文件过滤器日志记录。

选择

  • "enable"

  • "disable"

status

字符串

启用/禁用文件过滤器。

选择

  • "enable"

  • "disable"

name

字符串 / 必需

配置文件名称。

server_credential_type

字符串

CIFS 服务器凭据类型。

选择

  • "none"

  • "credential-replication"

  • "credential-keytab"

server_keytab

列表 / 元素=字典

服务器 keytab。

keytab

字符串

包含服务器凭据的 Base64 编码 keytab 文件。

password

字符串

keytab 的密码。

principal

字符串 / 必需

服务主体。例如，“host/cifsserver.example.com@example.com”。

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure CIFS profile.
  fortinet.fortios.fortios_cifs_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      cifs_profile:
          domain_controller: "<your_own_value> (source credential-store.domain-controller.server-name)"
          file_filter:
              entries:
                  -
                      action: "log"
                      comment: "Comment."
                      direction: "incoming"
                      file_type:
                          -
                              name: "default_name_10 (source antivirus.filetype.name)"
                      filter: "<your_own_value>"
                      protocol: "cifs"
              log: "enable"
              status: "enable"
          name: "default_name_15"
          server_credential_type: "none"
          server_keytab:
              -
                  keytab: "<your_own_value>"
                  password: "<your_own_value>"
                  principal: "<your_own_value>"

返回值

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

键

描述

build

字符串

FortiGate 映像的内部版本号

返回： 总是

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 的方法

返回： 总是

示例： "PUT"

http_status

字符串

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

返回： 总是

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥（ID）

返回： success

示例： "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)