fortinet.fortios.fortios_user_fsso 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 Fortinet 单点登录 (FSSO) 代理。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_user_fsso。

fortinet.fortios 2.0.0 中的新增功能

概要 

此模块能够通过允许用户设置和修改用户功能和 fsso 类别来配置 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"`
state 字符串 / 必需	指示是创建还是删除对象。选项 `"present"` `"absent"`
user_fsso 字典	配置 Fortinet 单点登录 (FSSO) 代理。
group_poll_interval 整数	以分钟为单位的间隔，用于从 FSSO 服务器获取组，或者取消设置以禁用。
interface 字符串	指定到达服务器的出站接口。来源 system.interface.name。
interface_select_method 字符串	指定如何选择到达服务器的出站接口。选项 `"auto"` `"sdwan"` `"specify"`
ldap_poll 字符串	启用/禁用从 LDAP 服务器自动获取组。选项 `"enable"` `"disable"`
ldap_poll_filter 字符串	用于获取组的过滤器。
ldap_poll_interval 整数	以分钟为单位的间隔，用于从 LDAP 服务器获取组。
ldap_server 字符串	获取组信息的 LDAP 服务器。来源 user.ldap.name。
logon_timeout 整数	FSSO 服务器关闭后保留登录的间隔（分钟）。
name 字符串 / 必需	名称。
password 字符串	第一个 FSSO 收集器代理的密码。
password2 字符串	第二个 FSSO 收集器代理的密码。
password3 字符串	第三个 FSSO 收集器代理的密码。
password4 字符串	第四个 FSSO 收集器代理的密码。
password5 字符串	第五个 FSSO 收集器代理的密码。
port 整数	第一个 FSSO 收集器代理的端口。
port2 整数	第二个 FSSO 收集器代理的端口。
port3 整数	第三个 FSSO 收集器代理的端口。
port4 整数	第四个 FSSO 收集器代理的端口。
port5 整数	第五个 FSSO 收集器代理的端口。
server 字符串	第一个 FSSO 收集器代理的域名或 IP 地址。
server2 字符串	第二个 FSSO 收集器代理的域名或 IP 地址。
server3 字符串	第三个 FSSO 收集器代理的域名或 IP 地址。
server4 字符串	第四个 FSSO 收集器代理的域名或 IP 地址。
server5 字符串	第五个 FSSO 收集器代理的域名或 IP 地址。
sni 字符串	服务器名称指示。
source_ip 字符串	与 FSSO 代理通信的源 IP。
source_ip6 字符串	与 FSSO 代理通信的 IPv6 源。
ssl 字符串	启用/禁用 SSL 的使用。选项 `"enable"` `"disable"`
ssl_server_host_ip_check 字符串	启用/禁用服务器主机/IP 验证。选项 `"enable"` `"disable"`
ssl_trusted_cert 字符串	受信任的服务器证书或 CA 证书。来源 vpn.certificate.remote.name vpn.certificate.ca.name。
type 字符串	服务器类型。选项 `"default"` `"fortinac"` `"fortiems"` `"fortiems-cloud"`
user_info_server 字符串	获取用户信息的 LDAP 服务器。来源 user.ldap.name。
vdom 字符串	虚拟域，在之前定义的那些虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置和用作不同的单元。默认： `"root"`

备注 

注意

旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。
该模块支持 check_mode。

示例 

- name: Configure Fortinet Single Sign On (FSSO) agents.
  fortinet.fortios.fortios_user_fsso:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_fsso:
          group_poll_interval: "0"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ldap_poll: "enable"
          ldap_poll_filter: "<your_own_value>"
          ldap_poll_interval: "180"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          logon_timeout: "5"
          name: "default_name_11"
          password: "<your_own_value>"
          password2: "<your_own_value>"
          password3: "<your_own_value>"
          password4: "<your_own_value>"
          password5: "<your_own_value>"
          port: "8000"
          port2: "8000"
          port3: "8000"
          port4: "8000"
          port5: "8000"
          server: "192.168.100.40"
          server2: "<your_own_value>"
          server3: "<your_own_value>"
          server4: "<your_own_value>"
          server5: "<your_own_value>"
          sni: "<your_own_value>"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          ssl: "enable"
          ssl_server_host_ip_check: "enable"
          ssl_trusted_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
          type: "default"
          user_info_server: "<your_own_value> (source user.ldap.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"`

作者

郑链 (@chillancezen)
薛杰 (@JieX19)
卢宏斌 (@fgtdev-hblu)
沈方 (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)