fortinet.fortimanager.fmgr_firewall_sslsshprofile_ssh 模块 – 配置 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_ssh。

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_ssh

字典

设置的顶级参数。

block

列表 / 元素=字符串

SSH 阻止选项。

选择

  • "x11-filter"

  • "ssh-shell"

  • "exec"

  • "port-forward"

inspect_all

别名：inspect-all

字符串

SSL 检查级别。

选择

  • "disable"

  • "deep-inspection"

log

列表 / 元素=字符串

SSH 日志记录选项。

选择

  • "x11-filter"

  • "ssh-shell"

  • "exec"

  • "port-forward"

ports

任何

（列表）用于扫描的端口

proxy_after_tcp_handshake

别名：proxy-after-tcp-handshake

字符串

在建立 TCP 三次握手后代理流量

选择

  • "disable"

  • "enable"

ssh_algorithm

别名：ssh-algorithm

字符串

协商期间接受的加密算法的相对强度。

选择

  • "compatible"

  • "high-encryption"

ssh_policy_check

别名：ssh-policy-check

字符串

启用/禁用 SSH 策略检查。

选择

  • "disable"

  • "enable"

ssh_tun_policy_check

别名：ssh-tun-policy-check

字符串

启用/禁用 SSH 隧道策略检查。

选择

  • "disable"

  • "enable"

status

字符串

配置协议检查状态。

选择

  • "disable"

  • "deep-inspection"

unsupported_version

别名：unsupported-version

字符串

基于不支持的 SSH 版本的操作。

选择

  • "block"

  • "bypass"

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)。

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 可帮助完成此工作。

  • 通常，当返回非零 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 SSH options.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile_ssh:
        # 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_ssh:
          inspect_all: <value in [disable, deep-inspection]>
          ports: <list or integer>
          ssh_algorithm: <value in [compatible, high-encryption]>
          ssh_policy_check: <value in [disable, enable]>
          ssh_tun_policy_check: <value in [disable, enable]>
          status: <value in [disable, deep-inspection]>
          unsupported_version: <value in [block, bypass]>
          block:
            - "x11-filter"
            - "ssh-shell"
            - "exec"
            - "port-forward"
          log:
            - "x11-filter"
            - "ssh-shell"
            - "exec"
            - "port-forward"
          proxy_after_tcp_handshake: <value in [disable, enable]>

返回值

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

键

描述

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

列表 / 元素=字符串

如果剧本中使用的参数不被当前 FortiManager 版本支持，则会发出警告。

返回: 复杂类型

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)