fortinet.fortios.fortios_authentication_scheme 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置身份验证方案。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_authentication_scheme

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改身份验证功能和方案类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数和值,需要在使用前调整为数据源。使用 FOS v6.0.0 测试

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

authentication_scheme

字典

配置身份验证方案。

domain_controller

字符串

域控制器设置。源 user.domain-controller.name。

ems_device_owner

字符串

启用/禁用与设备所有者一起使用的 SSH 公钥身份验证。

选择

  • "启用"

  • "禁用"

fsso_agent_for_ntlm

字符串

用于 NTLM 身份验证的 FSSO 代理。源 user.fsso.name。

fsso_guest

字符串

启用/禁用用户 fsso-guest 身份验证。

选择

  • "启用"

  • "禁用"

kerberos_keytab

字符串

Kerberos keytab 设置。源 user.krb-keytab.name。

method

列表 / 元素=字符串

身份验证方法。

选择

  • "ntlm"

  • "basic"

  • "digest"

  • "form"

  • "negotiate"

  • "fsso"

  • "rsso"

  • "ssh-publickey"

  • "cert"

  • "saml"

name

字符串 / 必需

身份验证方案名称。

negotiate_ntlm

字符串

启用/禁用 NTLM 的协商身份验证。

选择

  • "启用"

  • "禁用"

require_tfa

字符串

启用/禁用双因素身份验证。

选择

  • "启用"

  • "禁用"

saml_server

字符串

SAML 配置。源 user.saml.name。

saml_timeout

整数

SAML 身份验证超时(以秒为单位)。

ssh_ca

字符串

SSH CA 名称。源 firewall.ssh.local-ca.name。

user_cert

字符串

启用/禁用使用用户证书的身份验证。

选择

  • "启用"

  • "禁用"

user_database

列表 / 元素=字典

包含用户信息的身份验证服务器;“local”(默认)或“123”(用于 LDAP)。

name

字符串 / 必需

身份验证服务器名称。源 system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name。

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 Authentication Schemes.
  fortinet.fortios.fortios_authentication_scheme:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_scheme:
          domain_controller: "<your_own_value> (source user.domain-controller.name)"
          ems_device_owner: "enable"
          fsso_agent_for_ntlm: "<your_own_value> (source user.fsso.name)"
          fsso_guest: "enable"
          kerberos_keytab: "<your_own_value> (source user.krb-keytab.name)"
          method: "ntlm"
          name: "default_name_9"
          negotiate_ntlm: "enable"
          require_tfa: "enable"
          saml_server: "<your_own_value> (source user.saml.name)"
          saml_timeout: "120"
          ssh_ca: "<your_own_value> (source firewall.ssh.local-ca.name)"
          user_cert: "enable"
          user_database:
              -
                  name: "default_name_17 (source system.datasource.name user.radius.name user.tacacs+.name user.ldap.name user.group.name)"

返回值

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

描述

build

字符串

FortiGate 映像的版本号

返回:总是

示例: "1547"

http_method

字符串

用于将内容配置到 FortiGate 的最后一种方法

返回:总是

示例: "PUT"

http_status

字符串

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

返回:总是

示例: "200"

mkey

字符串

最后一次调用 FortiGate 时使用的主密钥 (id)

返回: 成功

示例: "id"

name

字符串

用于满足请求的表名

返回:总是

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回:总是

示例: "webfilter"

修订版本

字符串

内部修订版本号

返回:总是

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回:总是

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回:总是

示例: "success"

vdom

字符串

使用的虚拟域

返回:总是

示例: "root"

版本

字符串

FortiGate 的版本

返回:总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)