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 设备。
示例包括所有需要在使用前调整为数据源的参数和值。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True,模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务的日志记录。 选项
|
|
设置的顶级参数。 |
|
启用后,允许服务器证书验证失败的 SSL 会话。 选项
|
|
基于证书探测失败的操作。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于收到的客户端证书的操作。 选项
|
|
基于加密的客户端 hello 的存在来阻止/允许会话。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
SSL 检查级别。 选项
|
|
允许或阻止无效的 SSL 会话服务器证书。 选项
|
|
允许的最小 SSL 版本。 选项
|
|
基于服务器证书已吊销时的操作。 选项
|
|
将客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
基于使用的 SSL 加密不被支持时的操作。 选项
|
|
基于使用的 SSL 密码不被支持时的操作。 选项
|
|
基于使用的 SSL 协商不被支持时的操作。 选项
|
|
基于使用的 SSL 版本不被支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的 SSL 会话服务器证书。 选项
|
|
允许、忽略或阻止不受信任的 SSL 会话服务器证书。 选项
|
|
使用FortiCloud API访问令牌认证Ansible客户端。 |
|
底层Json RPC请求的重写方法。 选项
|
|
将覆盖失败条件的RC代码列表。 |
|
将覆盖成功条件的RC代码列表。 |
|
已弃用,请使用“ssl_ssh_profile” |
|
请求URL中的参数(ssl-ssh-profile)。 |
|
在工作区模式下运行FortiManager时要锁定的ADOM,值可以是全局的和其他包括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: 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]>
返回值
公共返回值已记录此处,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回:始终 |
|
请求的完整URL。 返回:始终 示例: |
|
API请求的状态。 返回:始终 示例: |
|
API响应。 返回:始终 |
|
API响应的描述性消息。 返回:始终 示例: |
|
目标系统的信息。 返回:始终 |
|
请求的状态。 返回:始终 示例: |
|
如果剧本中使用的参数不受当前FortiManager版本支持,则会发出警告。 返回:复杂类型 |