fortinet.fortios.fortios_user_saml 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 SAML 服务器条目。

注意

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

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

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

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_user_saml。

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

SAML 服务器条目配置。

adfs_claim

字符串

启用/禁用断言语句中用户/组属性的 ADFS Claim。

选项

  • "enable"

  • "disable"

auth_url

字符串

用于验证身份验证的 URL。

cert

字符串

用于签署 SAML 消息的证书。来源 vpn.certificate.local.name。

clock_tolerance

整数

时钟偏差容差（秒）（0-300）。

digest_method

字符串

摘要方法算法。

选项

  • "sha1"

  • "sha256"

entity_id

字符串

SP 实体 ID。

group_claim_type

字符串

断言语句中的组声明。

选项

  • "email"

  • "given-name"

  • "name"

  • "upn"

  • "common-name"

  • "email-adfs-1x"

  • "group"

  • "upn-adfs-1x"

  • "role"

  • "sur-name"

  • "ppid"

  • "name-identifier"

  • "authentication-method"

  • "deny-only-group-sid"

  • "deny-only-primary-sid"

  • "deny-only-primary-group-sid"

  • "group-sid"

  • "primary-group-sid"

  • "primary-sid"

  • "windows-account-name"

group_name

字符串

断言语句中的组名。

idp_cert

字符串

IDP 证书名称。来源 vpn.certificate.remote.name。

idp_entity_id

字符串

IDP 实体 ID。

idp_single_logout_url

字符串

IDP 单点注销 URL。

idp_single_sign_on_url

字符串

IDP 单点登录 URL。

limit_relaystate

字符串

启用/禁用限制 relay-state 参数（当它超过 SAML 2.0 规范限制（80 字节）时）。

选项

  • "enable"

  • "disable"

name

字符串 / 必需

SAML 服务器条目名称。

reauth

字符串

启用/禁用向 IDP 发出信号以强制用户重新身份验证。

选项

  • "enable"

  • "disable"

scim_client

字符串

SCIM 客户端名称。来源 user.scim.name。

single_logout_url

字符串

SP 单点注销 URL。

single_sign_on_url

字符串

SP 单点登录 URL。

user_claim_type

字符串

断言语句中的用户名声明。

选项

  • "email"

  • "given-name"

  • "name"

  • "upn"

  • "common-name"

  • "email-adfs-1x"

  • "group"

  • "upn-adfs-1x"

  • "role"

  • "sur-name"

  • "ppid"

  • "name-identifier"

  • "authentication-method"

  • "deny-only-group-sid"

  • "deny-only-primary-sid"

  • "deny-only-primary-group-sid"

  • "group-sid"

  • "primary-group-sid"

  • "primary-sid"

  • "windows-account-name"

user_name

字符串

断言语句中的用户名。

vdom

字符串

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

默认： "root"

注释

注意

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

  • 此模块支持 check_mode。

示例

- name: SAML server entry configuration.
  fortinet.fortios.fortios_user_saml:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_saml:
          adfs_claim: "enable"
          auth_url: "<your_own_value>"
          cert: "<your_own_value> (source vpn.certificate.local.name)"
          clock_tolerance: "15"
          digest_method: "sha1"
          entity_id: "<your_own_value>"
          group_claim_type: "email"
          group_name: "<your_own_value>"
          idp_cert: "<your_own_value> (source vpn.certificate.remote.name)"
          idp_entity_id: "<your_own_value>"
          idp_single_logout_url: "<your_own_value>"
          idp_single_sign_on_url: "<your_own_value>"
          limit_relaystate: "enable"
          name: "default_name_16"
          reauth: "enable"
          scim_client: "<your_own_value> (source user.scim.name)"
          single_logout_url: "<your_own_value>"
          single_sign_on_url: "<your_own_value>"
          user_claim_type: "email"
          user_name: "<your_own_value>"

返回值

公共返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

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)