fortinet.fortios.fortios_user_scim 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 SCIM 客户端条目。
注意
此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定： fortinet.fortios.fortios_user_scim。
fortinet.fortios 2.0.0 中的新增功能
概要
此模块能够通过允许用户设置和修改用户功能和 scim 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。
要求
执行此模块的主机需要以下要求。
ansible>=2.15
参数
参数 |
注释 |
|---|---|
基于令牌的身份验证。从 Fortigate 的 GUI 生成。 |
|
启用/禁用任务日志记录。 选项
|
|
要操作的成员属性路径。 如果有多个属性，则用斜杠字符分隔。 标有 member_path 的参数对于执行成员操作是合法的。 |
|
在指定的属性路径下添加或删除成员。 指定 member_state 时，将忽略 state 选项。 选项
|
|
指示是创建还是删除对象。 选项
|
|
配置 SCIM 客户端条目。 |
|
接收 SCIM 创建、读取、更新、删除 (CRUD) 请求的服务器 URL。 |
|
证书名称。来源 vpn.certificate.ca.name vpn.certificate.remote.name certificate.ca.name certificate.remote.name。 |
|
TLS 客户端身份验证方法。 选项
|
|
启用/禁用客户端身份检查。 选项
|
|
用于身份验证的客户端密钥令牌。 |
|
SCIM 客户端 ID。 |
|
SCIM 客户端名称。 |
|
启用/禁用系统跨域身份管理 (SCIM)。 选项
|
|
虚拟域，在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。 默认值： |
备注
注意
旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方式。
示例
- name: Configure SCIM client entries.
fortinet.fortios.fortios_user_scim:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_scim:
base_url: "<your_own_value>"
certificate: "<your_own_value> (source vpn.certificate.ca.name vpn.certificate.remote.name certificate.ca.name certificate.remote.name)"
client_authentication_method: "token"
client_identity_check: "enable"
client_secret_token: "<your_own_value>"
id: "8"
name: "default_name_9"
status: "enable"
返回值
常见的返回值已在 此处 记录，以下是此模块独有的字段。
键 |
描述 |
|---|---|
Fortigate 镜像的版本号 返回： 始终 示例： |
|
上次用于将内容置备到 FortiGate 的方法 返回： 始终 示例： |
|
FortiGate 在应用的最后一次操作中给出的最后结果 返回： 始终 示例： |
|
上次调用 FortiGate 时使用的主密钥 (id) 返回： 成功 示例： |
|
用于完成请求的表的名称 返回： 始终 示例： |
|
用于完成请求的表的路径 返回： 始终 示例： |
|
内部修订号 返回： 始终 示例： |
|
设备的序列号 返回： 始终 示例： |
|
操作结果的指示 返回： 始终 示例： |
|
使用的虚拟域 返回： 始终 示例： |
|
FortiGate 的版本 返回： 始终 示例： |