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 设备。
示例包含所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
|---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 FortiCloud API 访问令牌验证 Ansible 客户端。 |
|
底层 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
设置的顶级参数。 |
|
SP ACS |
|
启用/禁用签名身份验证请求。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
证书名称。 |
|
默认配置文件名称。 |
|
SP 实体 ID。 |
|
Fabric IDP。 |
|
IDP 设备 ID。 |
|
IDP 证书名称。 |
|
IDP 实体 ID。 |
|
IDP 单点注销 URL。 |
|
IDP 单点登录 URL。 |
|
启用/禁用 SAML 身份验证 disable - 禁用 SAML 身份验证。 enable - 启用 SAML 身份验证。 选项
|
|
启用/禁用 FortiCloud SSO disable - 禁用 FortiCloud SSO。 enable - 启用 FortiCloud SSO。 选项
|
|
IDP 证书名称。 |
|
IDP 实体 ID。 |
|
IDP 单点注销 URL。 |
|
IDP 单点登录 URL。 |
|
启用/禁用自动重定向到 IDP 登录页面。 disable - 禁用自动重定向到 IDP 登录页面。 enable - 启用自动重定向到 IDP 登录页面。 选项
|
|
SAML 角色。 IDP - 身份提供者。 SP - 服务提供者。 选项
|
|
服务器地址。 |
|
服务提供商。 |
|
IDP实体ID。 |
|
IDP 单点注销 URL。 |
|
IDP 单点登录 URL。 |
|
名称。 |
|
前缀。 |
|
SP adom名称。 |
|
SP证书名称。 |
|
SP实体ID。 |
|
SP配置文件名称。 |
|
SP单点注销URL。 |
|
SP单点登录URL。 |
|
SP SLS |
|
启用/禁用 SAML 身份验证 disable - 禁用 SAML 身份验证。 enable - 启用 SAML 身份验证。 选项
|
|
启用/禁用用户自动创建 disable - 禁用自动创建用户。 enable - 启用自动创建用户。 选项
|
|
启用/禁用需要签名断言。 disable - 禁用设置。 enable - 启用设置。 选项
|
|
在工作区模式下运行FortiManager时要锁定的ADOM，值可以是global和其他值，包括root。 |
|
等待其他用户释放工作区锁的最大时间（秒）。 默认值: |
注释
注意
从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]>
返回值
常用的返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回：始终 |
|
请求的完整URL。 返回：始终 示例： |
|
API请求的状态。 返回：始终 示例： |
|
API响应。 返回：始终 |
|
API响应的描述性消息。 返回：始终 示例： |
|
目标系统的信息。 返回：始终 |
|
请求的状态。 返回：始终 示例： |
|
如果剧本中使用的参数不受当前FortiManager版本支持，则会发出警告。 返回：复杂 |