fortinet.fortios.fortios_system_ssh_config 模块 – 在 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_system_ssh_config

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

member_path

字符串

要操作的成员属性路径。

如果存在多个属性,则用斜杠字符分隔。

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

member_state

字符串

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

当指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

system_ssh_config

字典

配置 SSH 配置。

ssh_enc_algo

列表 / 元素=字符串

选择一个或多个 SSH 密码。

选项

ssh_hsk

字符串

配置 SSH 主机密钥。

ssh_hsk_algo

列表 / 元素=字符串

选择一个或多个 SSH 主机密钥算法。

选项

  • "ssh-rsa"

  • "ecdsa-sha2-nistp521"

  • "ecdsa-sha2-nistp384"

  • "ecdsa-sha2-nistp256"

  • "rsa-sha2-256"

  • "rsa-sha2-512"

  • "ssh-ed25519"

ssh_hsk_override

字符串

在 SSH 守护程序中启用/禁用 SSH 主机密钥覆盖。

选项

  • "disable"

  • "enable"

ssh_hsk_password

字符串

ssh-hostkey 的密码。

ssh_kex_algo

列表 / 元素=字符串

选择一个或多个 SSH 密钥交换算法。

选项

  • "diffie-hellman-group1-sha1"

  • "diffie-hellman-group14-sha1"

  • "diffie-hellman-group14-sha256"

  • "diffie-hellman-group16-sha512"

  • "diffie-hellman-group18-sha512"

  • "diffie-hellman-group-exchange-sha1"

  • "diffie-hellman-group-exchange-sha256"

  • "[email protected]"

  • "ecdh-sha2-nistp256"

  • "ecdh-sha2-nistp384"

  • "ecdh-sha2-nistp521"

ssh_mac_algo

列表 / 元素=字符串

选择一个或多个 SSH MAC 算法。

选项

vdom

字符串

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

默认值: "root"

备注

注意

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

示例

- name: Configure SSH config.
  fortinet.fortios.fortios_system_ssh_config:
      vdom: "{{ vdom }}"
      system_ssh_config:
          ssh_enc_algo: "[email protected]"
          ssh_hsk: "<your_own_value>"
          ssh_hsk_algo: "ssh-rsa"
          ssh_hsk_override: "disable"
          ssh_hsk_password: "<your_own_value>"
          ssh_kex_algo: "diffie-hellman-group1-sha1"
          ssh_mac_algo: "hmac-md5"

返回值

常见的返回值记录在此处,以下是此模块特有的字段

描述

build

字符串

FortiGate 镜像的版本号

返回: 始终

示例: "1547"

http_method

字符串

最后一次用于将内容配置到 FortiGate 的方法

返回: 始终

示例: "PUT"

http_status

字符串

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

返回: 始终

示例: "200"

mkey

字符串

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

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回: 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回: 始终

示例: "webfilter"

修订版本

字符串

内部修订号

返回: 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

指示操作结果

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

版本

字符串

FortiGate 的版本

返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)