fortinet.fortimanager.fmgr_firewall_sslsshprofile_sslserver 模块 – 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_sslserver。

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_sslserver

字典

设置的顶层参数。

ftps_client_cert_request

别名: ftps-client-cert-request

字符串

在 FTPS 握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

ftps_client_certificate

别名: ftps-client-certificate

字符串

在 FTPS 握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

https_client_cert_request

别名: https-client-cert-request

字符串

在 HTTPS 握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

https_client_certificate

别名: https-client-certificate

字符串

在 HTTPS 握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

id

整数 / 必需

SSL 服务器 ID。

imaps_client_cert_request

别名: imaps-client-cert-request

字符串

在 IMAPS 握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

imaps_client_certificate

别名: imaps-client-certificate

字符串

在 IMAPS 握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

ip

字符串

SSL 服务器的 IPv4 地址。

pop3s_client_cert_request

别名: pop3s-client-cert-request

字符串

在 POP3S 握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

pop3s_client_certificate

别名: pop3s-client-certificate

字符串

在 POP3S 握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

smtps_client_cert_request

别名: smtps-client-cert-request

字符串

在 SMTPS 握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

smtps_client_certificate

别名: smtps-client-certificate

字符串

在 SMTPS 握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

ssl_other_client_cert_request

别名: ssl-other-client-cert-request

字符串

在 SSL 协议握手期间基于客户端证书请求执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

ssl_other_client_certificate

别名: ssl-other-client-certificate

字符串

在 SSL 协议握手期间基于接收到的客户端证书执行的操作。

选项

  • "bypass"

  • "inspect"

  • "block"

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

ssl-ssh-profile

字符串

已弃用，请使用“ssl_ssh_profile”

ssl_ssh_profile

字符串

请求 URL 中的参数 (ssl-ssh-profile)。

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
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: SSL servers.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile_sslserver:
        bypass_validation: false
        adom: ansible
        ssl-ssh-profile: "ansible-test" # name
        state: present
        firewall_sslsshprofile_sslserver:
          ftps-client-cert-request: block # <value in [bypass, inspect, block]>
          https-client-cert-request: bypass # <value in [bypass, inspect, block]>
          id: 1
          imaps-client-cert-request: bypass # <value in [bypass, inspect, block]>

- 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 servers SSL/SSH protocol option
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_sslsshprofile_sslserver"
          params:
            adom: "ansible"
            ssl-ssh-profile: "ansible-test" # name
            ssl-server: "your_value"

返回值

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

键

描述

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)