fortinet.fortimanager.fmgr_user_fsso 模块 – 配置 Fortinet 单点登录

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必需	请求的 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。 选择 false ← (默认) true
enable_log 布尔值	启用/禁用任务的日志记录。 选择 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选择 "update" "set" "add"
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。 选择 "present" "absent"
user_fsso 字典	顶层参数集。
_gui_meta 字符串	Gui 元数据。
dynamic_mapping 列表 / 元素=字典	动态映射。
_gui_meta 字符串	Gui 元数据。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
group_poll_interval 别名：group-poll-interval 整数	组轮询间隔。
interface 字符串	接口。
interface_select_method 别名：interface-select-method 字符串	接口选择方法。 选择 "auto" "sdwan" "specify"
ldap_poll 别名：ldap-poll 字符串	Ldap 轮询。 选择 "disable" "enable"
ldap_poll_filter 别名：ldap-poll-filter 字符串	Ldap 轮询过滤器。
ldap_poll_interval 别名：ldap-poll-interval 整数	Ldap 轮询间隔。
ldap_server 别名：ldap-server 字符串	Ldap 服务器。
logon_timeout 别名：logon-timeout 整数	在 FSSO 服务器关闭后保持登录状态的分钟数间隔。
password 任意	(列表) 密码。
password2 任意	(列表) 密码 2。
password3 任意	(列表) 密码 3。
password4 任意	(列表) 密码 4。
password5 任意	(列表) 密码 5。
port 整数	端口。
port2 整数	端口 2。
port3 整数	端口 3。
port4 整数	端口 4。
port5 整数	端口 5。
server 字符串	服务器。
server2 字符串	服务器 2。
server3 字符串	服务器 3。
server4 字符串	服务器 4。
server5 字符串	服务器 5。
sni 字符串	服务器名称指示。
source_ip 别名：source-ip 字符串	源 IP。
source_ip6 别名：source-ip6 字符串	源 IPv6。
ssl 字符串	Ssl。 选择 "disable" "enable"
ssl_server_host_ip_check 别名：ssl-server-host-ip-check 字符串	启用/禁用服务器主机/IP 验证。 选择 "disable" "enable"
ssl_trusted_cert 别名：ssl-trusted-cert 字符串	Ssl 受信任的证书。
type 字符串	类型。 选择 "default" "fortiems" "fortinac" "fortiems-cloud"
user_info_server 别名：user-info-server 任意	（列表或字符串）用户信息服务器。
group_poll_interval 别名：group-poll-interval 整数	从 FSSO 服务器获取组的分钟间隔，或设置为禁用。
interface 字符串	指定用于连接服务器的传出接口。
interface_select_method 别名：interface-select-method 字符串	指定如何选择用于连接服务器的传出接口。 选择 "auto" "sdwan" "specify"
ldap_poll 别名：ldap-poll 字符串	启用/禁用从 LDAP 服务器自动获取组。 选择 "disable" "enable"
ldap_poll_filter 别名：ldap-poll-filter 字符串	用于获取组的过滤器。
ldap_poll_interval 别名：ldap-poll-interval 整数	从 LDAP 服务器获取组信息的间隔（分钟）。
ldap_server 别名：ldap-server 字符串	用于获取组信息的 LDAP 服务器。
logon_timeout 别名：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 别名：source-ip 字符串	用于与 FSSO 代理通信的源 IP 地址。
source_ip6 别名：source-ip6 字符串	用于与 FSSO 代理通信的 IPv6 源地址。
ssl 字符串	启用/禁用 SSL 的使用。 选择 "disable" "enable"
ssl_server_host_ip_check 别名：ssl-server-host-ip-check 字符串	启用/禁用服务器主机/IP 验证。 选择 "disable" "enable"
ssl_trusted_cert 别名：ssl-trusted-cert 字符串	受信任的服务器证书或 CA 证书。
type 字符串	服务器类型。 选择 "default" "fortiems" "fortinac" "fortiems-cloud"
user_info_server 别名：user-info-server 字符串	用于获取用户信息 LDAP 服务器。
workspace_locking_adom 字符串	在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 root。
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 Fortinet Single Sign On (FSSO) agents.
      fortinet.fortimanager.fmgr_user_fsso:
        bypass_validation: false
        adom: ansible
        state: present
        user_fsso:
          name: ansible-test-fsso
          password: fortinet
          port: 9000
          server: ansible

- 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 Fortinet Single Sign On (FSSO) agents
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_fsso"
          params:
            adom: "ansible"
            fsso: "your_value"

返回值

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

键	描述
meta 字典	请求的结果。 返回值： 始终
request_url 字符串	请求的完整 URL。 返回值： 始终 示例： "/sys/login/user"
response_code 整数	API 请求的状态。 返回值： 始终 示例： 0
response_data 列表 / 元素=字符串	API 响应。 返回值： 始终
response_message 字符串	API 响应的描述性消息。 返回值： 始终 示例： "OK."
system_information 字典	目标系统的信息。 返回值： 始终
rc 整数	请求的状态。 返回值： 始终 示例： 0
version_check_warning 列表 / 元素=字符串	如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回值： 复杂

作者

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）