fortinet.fortimanager.fmgr_system_saml 模块 – SAML 身份验证的全局设置。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

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 代码列表。

system_saml

字典

设置的顶级参数。

acs_url

别名：acs-url

字符串

SP ACS

auth_request_signed

别名：auth-request-signed

字符串

启用/禁用已签名的身份验证请求。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

cert

字符串

证书名称。

default_profile

别名：default-profile

字符串

默认配置文件名称。

entity_id

别名：entity-id

字符串

SP 实体 ID。

fabric_idp

别名：fabric-idp

列表 / 元素=字典

Fabric idp。

dev_id

别名：dev-id

字符串

IDP 设备 ID。

idp_cert

别名：idp-cert

字符串

IDP 证书名称。

idp_entity_id

别名：idp-entity-id

字符串

IDP 实体 ID。

idp_single_logout_url

别名：idp-single-logout-url

字符串

IDP 单点注销 URL。

idp_single_sign_on_url

别名：idp-single-sign-on-url

字符串

IDP 单点登录 URL。

idp_status

别名：idp-status

字符串

启用/禁用 SAML 身份验证

disable - 禁用 SAML 身份验证。

enable - 启用 SAML 身份验证。

选项

  • "disable"

  • "enable"

forticloud_sso

别名：forticloud-sso

字符串

启用/禁用 FortiCloud SSO

disable - 禁用 Forticloud SSO。

enable - 启用 Forticloud SSO。

选项

  • "disable"

  • "enable"

idp_cert

别名：idp-cert

字符串

IDP 证书名称。

idp_entity_id

别名：idp-entity-id

字符串

IDP 实体 ID。

idp_single_logout_url

别名：idp-single-logout-url

字符串

IDP 单点注销 URL。

idp_single_sign_on_url

别名：idp-single-sign-on-url

字符串

IDP 单点登录 URL。

login_auto_redirect

别名：login-auto-redirect

字符串

启用/禁用自动重定向到 IDP 登录页面。

disable - 禁用自动重定向到 IDP 登录页面。

enable - 启用自动重定向到 IDP 登录页面。

选项

  • "disable"

  • "enable"

role

字符串

SAML 角色。

IDP - 身份提供程序。

SP - 服务提供程序。

选项

  • "IDP"

  • "SP"

  • "FAB-SP"

server_address

别名：server-address

字符串

服务器地址。

service_providers

别名：service-providers

列表 / 元素=字典

服务提供程序。

idp_entity_id

别名：idp-entity-id

字符串

IDP 实体 ID。

idp_single_logout_url

别名：idp-single-logout-url

字符串

IDP 单点注销 URL。

idp_single_sign_on_url

别名：idp-single-sign-on-url

字符串

IDP 单点登录 URL。

name

字符串

名称。

prefix

字符串

前缀。

sp_adom

别名: sp-adom

字符串

SP ADOM 名称。

sp_cert

别名: sp-cert

字符串

SP 证书名称。

sp_entity_id

别名: sp-entity-id

字符串

SP 实体 ID。

sp_profile

别名: sp-profile

字符串

SP 配置文件名称。

sp_single_logout_url

别名: sp-single-logout-url

字符串

SP 单点注销 URL。

sp_single_sign_on_url

别名: sp-single-sign-on-url

字符串

SP 单点登录 URL。

sls_url

别名: sls-url

字符串

SP SLS

状态

字符串

启用/禁用 SAML 身份验证

disable - 禁用 SAML 身份验证。

enable - 启用 SAML 身份验证。

选项

  • "disable"

  • "enable"

user_auto_create

别名: user-auto-create

字符串

启用/禁用用户自动创建

disable - 禁用自动创建用户。

enable - 启用自动创建用户。

选项

  • "disable"

  • "enable"

want_assertions_signed

别名: want-assertions-signed

字符串

启用/禁用是否需要签名断言。

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

workspace_locking_adom

字符串

在工作区模式下运行时，要锁定的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 帮助完成这项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Global settings for SAML authentication.
      fortinet.fortimanager.fmgr_system_saml:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        system_saml:
          acs_url: <string>
          cert: <string>
          entity_id: <string>
          idp_cert: <string>
          idp_entity_id: <string>
          idp_single_logout_url: <string>
          idp_single_sign_on_url: <string>
          login_auto_redirect: <value in [disable, enable]>
          role: <value in [IDP, SP, FAB-SP]>
          server_address: <string>
          service_providers:
            -
              idp_entity_id: <string>
              idp_single_logout_url: <string>
              idp_single_sign_on_url: <string>
              name: <string>
              prefix: <string>
              sp_cert: <string>
              sp_entity_id: <string>
              sp_single_logout_url: <string>
              sp_single_sign_on_url: <string>
              sp_adom: <string>
              sp_profile: <string>
          sls_url: <string>
          status: <value in [disable, enable]>
          default_profile: <string>
          fabric_idp:
            -
              dev_id: <string>
              idp_cert: <string>
              idp_entity_id: <string>
              idp_single_logout_url: <string>
              idp_single_sign_on_url: <string>
              idp_status: <value in [disable, enable]>
          forticloud_sso: <value in [disable, enable]>
          user_auto_create: <value in [disable, enable]>
          auth_request_signed: <value in [disable, enable]>
          want_assertions_signed: <value in [disable, enable]>

返回值

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

键

描述

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)