fortinet.fortimanager.fmgr_authentication_scheme 模块 – 配置身份验证方案。

注意

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

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

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

要在 Playbook 中使用它，请指定：fortinet.fortimanager.fmgr_authentication_scheme。

在 fortinet.fortimanager 2.1.0 中新增

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

authentication_scheme

字典

顶级参数集。

domain_controller

别名：domain-controller

字符串

域控制器设置。

ems_device_owner

别名：ems-device-owner

字符串

启用/禁用使用设备所有者的 SSH 公钥身份验证

选项

  • "disable"

  • "enable"

fsso_agent_for_ntlm

别名：fsso-agent-for-ntlm

字符串

用于 NTLM 身份验证的 FSSO 代理。

fsso_guest

别名：fsso-guest

字符串

启用/禁用用户 fsso-guest 身份验证

选项

  • "disable"

  • "enable"

kerberos_keytab

别名：kerberos-keytab

字符串

Kerberos keytab 设置。

method

列表 / elements=string

身份验证方法

选项

  • "ntlm"

  • "basic"

  • "digest"

  • "form"

  • "negotiate"

  • "fsso"

  • "rsso"

  • "ssh-publickey"

  • "saml"

  • "cert"

  • "x-auth-user"

  • "saml-sp"

name

字符串 / 必需

身份验证方案名称。

negotiate_ntlm

别名：negotiate-ntlm

字符串

启用/禁用 NTLM 的协商身份验证

选项

  • "disable"

  • "enable"

require_tfa

别名：require-tfa

字符串

启用/禁用双因素身份验证

选项

  • "disable"

  • "enable"

saml_server

别名：saml-server

字符串

SAML 配置。

saml_timeout

别名：saml-timeout

整数

SAML 身份验证超时（以秒为单位）。

ssh_ca

别名：ssh-ca

字符串

SSH CA 名称。

user_cert

别名：user-cert

字符串

启用/禁用使用用户证书的身份验证

选项

  • "disable"

  • "enable"

user_database

别名：user-database

任意

（列表或字符串）包含用户信息；本地身份验证服务器

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

列表 / elements=integer

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / elements=integer

将覆盖成功条件的 rc 代码列表。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

为在工作区模式下运行的 FortiManager 锁定的 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 有助于完成此工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 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: Configure Authentication Schemes.
      fortinet.fortimanager.fmgr_authentication_scheme:
        # 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, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        authentication_scheme:
          domain_controller: <string>
          fsso_agent_for_ntlm: <string>
          fsso_guest: <value in [disable, enable]>
          kerberos_keytab: <string>
          method:
            - "ntlm"
            - "basic"
            - "digest"
            - "form"
            - "negotiate"
            - "fsso"
            - "rsso"
            - "ssh-publickey"
            - "saml"
            - "cert"
            - "x-auth-user"
            - "saml-sp"
          name: <string>
          negotiate_ntlm: <value in [disable, enable]>
          require_tfa: <value in [disable, enable]>
          ssh_ca: <string>
          user_database: <list or string>
          ems_device_owner: <value in [disable, enable]>
          saml_server: <string>
          saml_timeout: <integer>
          user_cert: <value in [disable, enable]>

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回： 总是

request_url

字符串

请求的完整URL。

返回： 总是

示例： "/sys/login/user"

response_code

整数

API请求的状态码。

返回： 总是

示例： 0

response_data

列表 / elements=string

API响应数据。

返回： 总是

response_message

字符串

API响应的描述性消息。

返回： 总是

示例： "OK."

system_information

字典

目标系统的信息。

返回： 总是

rc

整数

请求的状态。

返回： 总是

示例： 0

version_check_warning

列表 / elements=string

如果剧本中使用的参数不受当前FortiManager版本支持，则发出警告。

返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)