fortinet.fortios.fortios_firewall_ssh_setting 模块 – Fortinet FortiOS 和 FortiGate 中的 SSH 代理设置。

注意

此模块是 fortinet.fortios 集合 (版本 2.3.8) 的一部分。

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定： fortinet.fortios.fortios_firewall_ssh_setting。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 firewall_ssh 功能和设置类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整为数据源。已在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 Fortigate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

firewall_ssh_setting

字典

SSH 代理设置。

caname

字符串

SSH 检查使用的 CA 证书。来源 firewall.ssh.local-ca.name。

host_trusted_checking

字符串

启用/禁用主机信任检查。

选项

  • "enable"

  • "disable"

hostkey_dsa1024

字符串

SSH 代理使用的 DSA 证书。来源 firewall.ssh.local-key.name。

hostkey_ecdsa256

字符串

SSH 代理使用的 ECDSA nid256 证书。来源 firewall.ssh.local-key.name。

hostkey_ecdsa384

字符串

SSH 代理使用的 ECDSA nid384 证书。来源 firewall.ssh.local-key.name。

hostkey_ecdsa521

字符串

SSH 代理使用的 ECDSA nid384 证书。来源 firewall.ssh.local-key.name。

hostkey_ed25519

字符串

SSH 代理使用的 ED25519 主机密钥。来源 firewall.ssh.local-key.name。

hostkey_rsa2048

字符串

SSH 代理使用的 RSA 证书。来源 firewall.ssh.local-key.name。

untrusted_caname

字符串

SSH 检查使用的不受信任的 CA 证书。来源 firewall.ssh.local-ca.name。

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则以斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

注释

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方式。

示例

- name: SSH proxy settings.
  fortinet.fortios.fortios_firewall_ssh_setting:
      vdom: "{{ vdom }}"
      firewall_ssh_setting:
          caname: "<your_own_value> (source firewall.ssh.local-ca.name)"
          host_trusted_checking: "enable"
          hostkey_dsa1024: "myhostname (source firewall.ssh.local-key.name)"
          hostkey_ecdsa256: "myhostname (source firewall.ssh.local-key.name)"
          hostkey_ecdsa384: "myhostname (source firewall.ssh.local-key.name)"
          hostkey_ecdsa521: "myhostname (source firewall.ssh.local-key.name)"
          hostkey_ed25519: "myhostname (source firewall.ssh.local-key.name)"
          hostkey_rsa2048: "myhostname (source firewall.ssh.local-key.name)"
          untrusted_caname: "<your_own_value> (source firewall.ssh.local-ca.name)"

返回值

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

键

描述

build

字符串

Fortigate 镜像的版本号

返回： 始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (id)

返回： 成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回： 始终

示例： "urlfilter"

path

字符串

用于完成请求的表的路径

返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

version

字符串

FortiGate 版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑 link (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)