fortinet.fortimanager.fmgr_firewall_sslsshprofile_ssl 模块 – 配置 SSL 选项。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值在使用前需要调整为数据源。

参数 

参数	注释
access_token 字符串	用于访问 FortiManager 而无需使用用户名和密码的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而不验证参数。选择 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务的日志记录。选择 `false` ← (默认) `true`
firewall_sslsshprofile_ssl 字典	设置的顶层参数。
allow_invalid_server_cert 别名: allow-invalid-server-cert 字符串	启用后，允许其服务器证书验证失败的 SSL 会话。选择 `“禁用”` `“启用”`
cert_probe_failure 别名: cert-probe-failure 字符串	基于证书探测失败的操作。选择 `“阻止”` `“允许”`
cert_validation_failure 别名: cert-validation-failure 字符串	基于证书验证失败的操作。选择 `“允许”` `“阻止”` `“忽略”`
cert_validation_timeout 别名: cert-validation-timeout 字符串	基于证书验证超时的操作。选择 `“允许”` `“阻止”` `“忽略”`
client_cert_request 别名: client-cert-request 字符串	基于客户端证书请求的操作。选择 `“绕过”` `“检查”` `“阻止”`
client_certificate 别名: client-certificate 字符串	基于接收到的客户端证书的操作。选择 `“绕过”` `“检查”` `“阻止”`
encrypted_client_hello 别名: encrypted-client-hello 字符串	根据是否存在加密客户端问候来阻止/允许会话。选择 `“阻止”` `“允许”`
expired_server_cert 别名: expired-server-cert 字符串	基于服务器证书已过期的操作。选择 `“允许”` `“阻止”` `“忽略”`
inspect_all 别名: inspect-all 字符串	SSL 检查的级别。选择 `“禁用”` `“证书检查”` `“深度检查”`
invalid_server_cert 别名: invalid-server-cert 字符串	允许或阻止无效的 SSL 会话服务器证书。选择 `“允许”` `“阻止”`
min_allowed_ssl_version 别名: min-allowed-ssl-version 字符串	允许的最小 SSL 版本。选择 `“ssl-3.0”` `“tls-1.0”` `“tls-1.1”` `“tls-1.2”` `“tls-1.3”`
revoked_server_cert 别名: revoked-server-cert 字符串	基于服务器证书被吊销的操作。选择 `“允许”` `“阻止”` `“忽略”`
sni_server_cert_check 别名: sni-server-cert-check 字符串	使用返回的服务器证书中的 CN 或 SAN 字段检查客户端 hello 消息中的 SNI。选择 `“禁用”` `“启用”` `“严格”`
unsupported_ssl 别名: unsupported-ssl 字符串	基于使用的 SSL 加密不受支持的操作。选择 `“绕过”` `“检查”` `“阻止”`
unsupported_ssl_cipher 别名: unsupported-ssl-cipher 字符串	基于使用的 SSL 密码套件不受支持的操作。选择 `“允许”` `“阻止”`
unsupported_ssl_negotiation 别名: unsupported-ssl-negotiation 字符串	基于使用的 SSL 协商不受支持的操作。选择 `“允许”` `“阻止”`
unsupported_ssl_version 别名: unsupported-ssl-version 字符串	基于使用的 SSL 版本不受支持的操作。选择 `“阻止”` `“允许”` `“检查”`
untrusted_cert 别名: untrusted-cert 字符串	允许、忽略或阻止不受信任的 SSL 会话服务器证书。选择 `“允许”` `“阻止”` `“忽略”`
untrusted_server_cert 别名: untrusted-server-cert 字符串	允许、忽略或阻止不受信任的 SSL 会话服务器证书。选择 `“允许”` `“阻止”` `“忽略”`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选择 `“更新”` `“设置”` `“添加”`
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
ssl-ssh-profile 字符串	已弃用，请使用“ssl_ssh_profile”
ssl_ssh_profile 字符串	请求 URL 中的参数 (ssl-ssh-profile)。
workspace_locking_adom 字符串	用于锁定在工作区模式下运行的 FortiManager 的 ADOM，该值可以是全局值和其他值，包括 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 SSL options.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile_ssl:
        # 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>
        ssl_ssh_profile: <your own value>
        firewall_sslsshprofile_ssl:
          allow_invalid_server_cert: <value in [disable, enable]>
          client_cert_request: <value in [bypass, inspect, block]>
          inspect_all: <value in [disable, certificate-inspection, deep-inspection]>
          unsupported_ssl: <value in [bypass, inspect, block]>
          untrusted_cert: <value in [allow, block, ignore]>
          invalid_server_cert: <value in [allow, block]>
          sni_server_cert_check: <value in [disable, enable, strict]>
          untrusted_server_cert: <value in [allow, block, ignore]>
          cert_validation_failure: <value in [allow, block, ignore]>
          cert_validation_timeout: <value in [allow, block, ignore]>
          client_certificate: <value in [bypass, inspect, block]>
          expired_server_cert: <value in [allow, block, ignore]>
          revoked_server_cert: <value in [allow, block, ignore]>
          unsupported_ssl_cipher: <value in [allow, block]>
          unsupported_ssl_negotiation: <value in [allow, block]>
          cert_probe_failure: <value in [block, allow]>
          min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          unsupported_ssl_version: <value in [block, allow, inspect]>
          encrypted_client_hello: <value in [block, allow]>

返回值 

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

键	描述
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)