fortinet.fortimanager.fmgr_pkg_authentication_setting 模块 – 配置身份验证设置。

注意

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

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

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

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

fortinet.fortimanager 2.1.0 中的新功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必填

请求的 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务的日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。

pkg

字符串 / 必填

请求的 URL 中的参数 (pkg)。

pkg_authentication_setting

字典

顶层参数集。

active_auth_scheme

别名: active-auth-scheme

字符串

活动身份验证方法

auth_https

别名: auth-https

字符串

启用/禁用将 HTTP 用户身份验证重定向到 HTTPS。

选项

  • "disable"

  • "enable"

captive_portal

别名: captive-portal

字符串

强制门户主机名。

captive_portal6

别名: captive-portal6

字符串

IPv6 强制门户主机名。

captive_portal_ip

别名: captive-portal-ip

字符串

强制门户 IP 地址。

captive_portal_ip6

别名: captive-portal-ip6

字符串

强制门户 IPv6 地址。

captive_portal_port

别名: captive-portal-port

整数

强制门户端口号

captive_portal_ssl_port

别名: captive-portal-ssl-port

整数

强制门户 SSL 端口号

captive_portal_type

别名: captive-portal-type

字符串

强制门户类型。

选项

  • "fqdn"

  • "ip"

cert_auth

别名: cert-auth

字符串

启用/禁用将证书身份验证重定向到 HTTPS 门户。

选项

  • "disable"

  • "enable"

cert_captive_portal

别名: cert-captive-portal

字符串

证书强制门户主机名。

cert_captive_portal_ip

别名: cert-captive-portal-ip

字符串

证书强制门户 IP 地址。

cert_captive_portal_port

别名: cert-captive-portal-port

整数

证书强制门户端口号

cookie_max_age

别名: cookie-max-age

整数

持久 Web 门户 Cookie 的最大有效期（分钟）

cookie_refresh_div

别名: cookie-refresh-div

整数

持久 Web 门户 Cookie 的刷新率除数

dev_range

别名: dev-range

any

(列表或字符串) 基于 IP 的设备查询的地址范围。

ip_auth_cookie

别名: ip-auth-cookie

字符串

在基于 IP 的 Web 门户身份验证上启用/禁用持久 Cookie

选项

  • "disable"

  • "enable"

persistent_cookie

别名: persistent-cookie

字符串

在 Web 门户身份验证上启用/禁用持久 Cookie

选项

  • "disable"

  • "enable"

rewrite_https_port

别名: rewrite-https-port

整数

重写到 HTTPS 端口

sso_auth_scheme

别名: sso-auth-scheme

字符串

单点登录身份验证方法

update_time

别名: update-time

字符串

上次更新的时间。

user_cert_ca

别名: user-cert-ca

any

(列表或字符串) 用于客户端证书验证的 CA 证书。

proposed_method

字符串

覆盖底层 Json RPC 请求的方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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 可帮助完成此工作。

  • 通常情况下，当返回非零的返回码 (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 setting.
      fortinet.fortimanager.fmgr_pkg_authentication_setting:
        # 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>
        pkg: <your own value>
        pkg_authentication_setting:
          active_auth_scheme: <string>
          auth_https: <value in [disable, enable]>
          captive_portal: <string>
          captive_portal_ip: <string>
          captive_portal_ip6: <string>
          captive_portal_port: <integer>
          captive_portal_ssl_port: <integer>
          captive_portal_type: <value in [fqdn, ip]>
          captive_portal6: <string>
          rewrite_https_port: <integer>
          sso_auth_scheme: <string>
          dev_range: <list or string>
          user_cert_ca: <list or string>
          cert_auth: <value in [disable, enable]>
          cert_captive_portal: <string>
          cert_captive_portal_ip: <string>
          cert_captive_portal_port: <integer>
          cookie_max_age: <integer>
          cookie_refresh_div: <integer>
          ip_auth_cookie: <value in [disable, enable]>
          persistent_cookie: <value in [disable, enable]>
          update_time: <string>

返回值

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

键

描述

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)