fortinet.fortios.fortios_user_external_identity_provider 模块 – 在 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_user_external_identity_provider。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改用户功能和 external_identity_provider 类别来配置 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_external_identity_provider

字典

配置外部身份提供程序。

group_attr_name

字符串

身份验证查询中的组属性名称。

interface

字符串

指定到达服务器的出站接口。源系统.接口.名称。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

name

字符串 / 必需

外部身份提供程序名称。

port

整数

外部身份提供程序服务端口号（使用默认值则为 0）。

server_identity_check

字符串

启用/禁用服务器对其证书和主题替代名称进行身份验证。

选项

  • "disable"

  • "enable"

source_ip

字符串

使用此 IPv4/v6 地址连接到外部身份提供程序。

timeout

整数

以秒为单位的连接超时值。

type

字符串

外部身份提供程序类型。

选项

  • "ms-graph"

user_attr_name

字符串

身份验证查询中的用户属性名称。

version

字符串

外部身份 API 版本。

选项

  • "v1.0"

  • "beta"

vdom

字符串

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

默认值： "root"

备注

注意

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

示例

- name: Configure external identity provider.
  fortinet.fortios.fortios_user_external_identity_provider:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_external_identity_provider:
          group_attr_name: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          name: "default_name_6"
          port: "0"
          server_identity_check: "disable"
          source_ip: "84.230.14.43"
          timeout: "5"
          type: "ms-graph"
          user_attr_name: "<your_own_value>"
          version: "v1.0"

返回值

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

键

描述

build

字符串

FortiGate 镜像的版本号

返回值：始终

示例： "1547"

http_method

字符串

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

返回值：始终

示例： "PUT"

http_status

字符串

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

返回值：始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (ID)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表名称

返回值：始终

示例： "urlfilter"

path

字符串

用于完成请求的表路径

返回值：始终

示例： "webfilter"

revision

字符串

内部修订号

返回值：始终

示例： "17.0.2.10658"

serial

字符串

设备序列号

返回值：始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回值：始终

示例： "success"

vdom

字符串

使用的虚拟域

返回值：始终

示例： "root"

version

字符串

FortiGate 版本

返回值：始终

示例： "v5.6.3"

作者

  • 郑琳 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)