fortinet.fortimanager.fmgr_firewall_sslsshprofile 模块 – 配置 SSL/SSH 协议选项。
注意
此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。
如果您使用的是 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用: ansible-galaxy collection install fortinet.fortimanager
。
要在 playbook 中使用它,请指定: fortinet.fortimanager.fmgr_firewall_sslsshprofile
。
fortinet.fortimanager 1.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括需要在使用前调整为数据源的所有参数和值。
参数
参数 |
注释 |
---|---|
无需使用用户名和密码即可访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时设置为 True,模块将继续执行而无需验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
设置的顶级参数。 |
|
启用/禁用通过 FortiGuard 允许列表豁免服务器。 选项
|
|
启用/禁用通过 FortiGuard 证书黑名单阻止基于 SSL 的僵尸网络通信。 选项
|
|
启用/禁用通过 FortiGuard 证书封锁列表阻止基于 SSL 的僵尸网络通信。 选项
|
|
SSL 检查使用的 CA 证书。 |
|
包含密钥的证书,用于在重新签名服务器证书以进行 SSL 检查时使用。 |
|
可选注释。 |
|
点。 |
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许的最小 ssl 版本。 选项
|
|
在建立 TCP 3 次握手后代理流量 选项
|
|
启用/禁用 QUIC 检查 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
Ech 外部 sni。 |
|
ClientHelloOuter SNI 名称。 |
|
要阻止的 ClientHelloOuter SNI。 |
|
Ftps。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小SSL版本。 选项
|
|
(列表) 用于扫描的端口 |
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
Https。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书探测失败的操作。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于加密客户端问候的存在来阻止/允许会话。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小SSL版本。 选项
|
|
(列表) 用于扫描的端口 |
|
在建立 TCP 3 次握手后代理流量 选项
|
|
启用/禁用 QUIC 检查 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
Imaps。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小 ssl 版本。 选项
|
|
(列表) 用于扫描的端口 |
|
在建立 TCP 3 次握手后代理流量 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
启用/禁用对MAPI over HTTPS的检查。 选项
|
|
名称。 |
|
Pop3s。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小 ssl 版本。 选项
|
|
(列表) 用于扫描的端口 |
|
在建立 TCP 3 次握手后代理流量 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
启用/禁用对RPC over HTTPS的检查。 选项
|
|
(列表或字符串) SSL检查使用的证书,用于替换服务器证书。 |
|
重新签名或替换服务器证书。 选项
|
|
Smtps。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小 ssl 版本。 选项
|
|
(列表) 用于扫描的端口 |
|
在建立 TCP 3 次握手后代理流量 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
Ssh。 |
|
SSH阻止选项。 选项
|
|
SSL检查级别。 选项
|
|
SSH日志记录选项。 选项
|
|
(列表) 用于扫描的端口 |
|
在建立 TCP 3 次握手后代理流量 选项
|
|
协商过程中接受的加密算法的相对强度。 选项
|
|
启用/禁用 SSH 策略检查。 选项
|
|
启用/禁用 SSH 隧道策略检查。 选项
|
|
配置协议检查状态。 选项
|
|
基于 SSH 版本不支持采取的操作。 选项
|
|
SSL。 |
|
启用后,允许服务器证书验证失败的SSL会话。 选项
|
|
基于证书探测失败的操作。 选项
|
|
基于证书验证失败的操作。 选项
|
|
基于证书验证超时的操作。 选项
|
|
基于客户端证书请求的操作。 选项
|
|
基于接收到的客户端证书的操作。 选项
|
|
基于加密客户端问候的存在来阻止/允许会话。 选项
|
|
基于服务器证书已过期时的操作。 选项
|
|
SSL检查级别。 选项
|
|
允许或阻止无效的SSL会话服务器证书。 选项
|
|
允许的最小SSL版本。 选项
|
|
基于服务器证书被吊销时的操作。 选项
|
|
使用客户端 hello 消息中的 SNI 与返回的服务器证书中的 CN 或 SAN 字段进行检查。 选项
|
|
基于使用的SSL加密是否不受支持的操作。 选项
|
|
基于使用的 SSL 密码不受支持时的操作。 选项
|
|
基于使用的 SSL 协商不受支持时的操作。 选项
|
|
基于使用的 SSL 版本不受支持时的操作。 选项
|
|
允许、忽略或阻止不受信任的SSL会话服务器证书。 选项
|
|
基于服务器证书未由受信任的 CA 发行时的操作。 选项
|
|
启用/禁用 SSL 异常日志记录。 选项
|
|
启用/禁用 SSL 异常日志记录。 选项
|
|
SSL 免除。 |
|
IPv4 地址对象。 |
|
IPv6 地址对象。 |
|
FortiGuard 类别 ID。 |
|
ID 号。 |
|
使用正则表达式免除服务器。 |
|
地址对象的类型 选项
|
|
使用通配符 FQDN 免除服务器。 |
|
启用/禁用基于 IP 的 URL 评级。 选项
|
|
启用/禁用 SSL 免除日志记录。 选项
|
|
启用/禁用 SSL 免除日志记录。 选项
|
|
启用/禁用 TLS 握手日志记录。 选项
|
|
启用/禁用 SSL 服务器证书验证日志记录。 选项
|
|
启用/禁用 SSL 协商日志记录。 选项
|
|
SSL 服务器。 |
|
在 FTPS 握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 FTPS 握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
在 HTTPS 握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 HTTPS 握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
SSL 服务器 ID。 |
|
在 IMAPS 握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 IMAPS 握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
SSL 服务器的 IPv4 地址。 |
|
在 POP3S 握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 POP3S 握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
在 SMTPS 握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 SMTPS 握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
在 SSL 协议握手期间,基于客户端证书请求采取的操作。 选项
|
|
在 SSL 协议握手期间,基于接收到的客户端证书采取的操作。 选项
|
|
启用/禁用服务器证书信息日志记录。 选项
|
|
配置 ALPN 选项。 选项
|
|
SSL 检查使用的不受信任的 CA 证书。 |
|
启用/禁用使用 SSL 服务器表进行 SSL 卸载。 选项
|
|
启用/禁用通过 FortiGuard 白名单免除服务器。 选项
|
|
使用FortiCloud API访问令牌认证Ansible客户端。 |
|
底层Json RPC请求的覆盖方法。 选项
|
|
将覆盖失败条件的rc代码列表。 |
|
将覆盖成功条件的rc代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
对于在工作区模式下运行的FortiManager,需要锁定的ADOM,值可以是global和其他包括root。 |
|
等待其他用户释放工作区锁的最大时间(秒)。 默认值: |
注释
注意
从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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure SSL/SSH protocol options.
fortinet.fortimanager.fmgr_firewall_sslsshprofile:
bypass_validation: false
adom: ansible
state: present
firewall_sslsshprofile:
comment: "ansible-comment1"
mapi-over-https: disable # <value in [disable, enable]>
name: "ansible-test"
use-ssl-server: disable # <value in [disable, enable]>
whitelist: enable # <value in [disable, enable]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the SSL/SSH protocol options
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_sslsshprofile"
params:
adom: "ansible"
ssl-ssh-profile: "your_value"
返回值
常见的返回值已在此处记录,以下是此模块特有的字段
键 |
描述 |
---|---|
请求的结果。 返回值: 始终 |
|
请求的完整URL。 返回值: 始终 示例: |
|
API请求的状态。 返回值: 始终 示例: |
|
API响应。 返回值: 始终 |
|
API响应的描述性消息。 返回值: 始终 示例: |
|
目标系统的信息。 返回值: 始终 |
|
请求的状态。 返回值: 始终 示例: |
|
如果剧本中使用的参数不受当前FortiManager版本支持,则会发出警告。 返回值: 复杂 |