fortinet.fortimanager.fmgr_pkg_authentication_rule 模块 – 配置身份验证规则。

注意

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

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

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

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

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_rule

字典

设置的顶层参数。

active_auth_method

别名: active-auth-method

字符串

选择一个活动的身份验证方法。

cert_auth_cookie

别名: cert-auth-cookie

字符串

启用/禁用使用设备证书作为身份验证 cookie

选项

  • "disable"

  • "enable"

comments

字符串

注释。

cors_depth

别名: cors-depth

整数

允许 CORS 访问的深度

cors_stateful

别名: cors-stateful

字符串

启用/禁用 CORS 访问的允许

选项

  • "disable"

  • "enable"

dstaddr

任何

(列表或字符串) 从可用选项中选择一个 IPv4 目标地址。

dstaddr6

任何

(列表或字符串) 从可用选项中选择一个 IPv6 目标地址。

ip_based

别名: ip-based

字符串

启用/禁用基于 IP 的身份验证。

选项

  • "disable"

  • "enable"

name

字符串 / 必需

身份验证规则名称。

protocol

字符串

选择用于身份验证的协议

选项

  • "http"

  • "ftp"

  • "socks"

  • "ssh"

srcaddr

任何

(列表或字符串) 从可用选项中选择一个 IPv4 源地址。

srcaddr6

任何

(列表或字符串) 选择一个 IPv6 源地址。

srcintf

任何

(列表或字符串) 传入

sso_auth_method

别名: sso-auth-method

字符串

选择一个单点登录

status

字符串

启用/禁用此身份验证规则。

选项

  • "disable"

  • "enable"

transaction_based

别名: transaction-based

字符串

启用/禁用基于事务的身份验证

选项

  • "disable"

  • "enable"

web_auth_cookie

别名: web-auth-cookie

字符串

启用/禁用 Web 身份验证 cookie

选项

  • "disable"

  • "enable"

web_portal

别名: web-portal

字符串

启用/禁用代理透明策略的 Web 门户

选项

  • "disable"

  • "enable"

proposed_method

字符串

底层 Json RPC 请求的重写方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 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 Rules.
      fortinet.fortimanager.fmgr_pkg_authentication_rule:
        # 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>
        state: present # <value in [present, absent]>
        pkg_authentication_rule:
          active_auth_method: <string>
          comments: <string>
          ip_based: <value in [disable, enable]>
          name: <string>
          protocol: <value in [http, ftp, socks, ...]>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          sso_auth_method: <string>
          status: <value in [disable, enable]>
          transaction_based: <value in [disable, enable]>
          web_auth_cookie: <value in [disable, enable]>
          web_portal: <value in [disable, enable]>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          srcintf: <list or string>
          cors_depth: <integer>
          cors_stateful: <value in [disable, enable]>
          cert_auth_cookie: <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)