fortinet.fortimanager.fmgr_system_npu_hpe 模块 – 主机保护引擎配置。

注意

此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_system_npu_hpe。

fortinet.fortimanager 2.2.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有需要在使用前调整到数据源的参数和值。

参数

参数

注释

access_token

字符串

无需使用用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构不同时，才设置为 True，模块将继续执行而不验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

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

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

system_npu_hpe

字典

设置的顶级参数。

all_protocol

别名：all-protocol

整数

除高优先级流量外，每个主机队列的最大数据包速率

arp_max

别名：arp-max

整数

最大 ARP 数据包速率

enable_queue_shaper

别名：enable-queue-shaper

字符串

启用/禁用 NPU 主机保护引擎

选项

  • "disable"

  • "enable"

enable_shaper

别名：enable-shaper

字符串

启用/禁用 NPU 主机保护引擎

选项

  • "disable"

  • "enable"

esp_max

别名：esp-max

整数

最大 ESP 数据包速率

exception_code

别名：exception-code

整数

最大异常代码流量速率

fragment_with_sess

别名：fragment-with-sess

整数

最大具有会话的片段流量速率

fragment_without_session

别名：fragment-without-session

整数

最大无会话的片段流量速率

high_priority

别名：high-priority

整数

高优先级流量数据包的最大数据包速率

icmp_max

别名：icmp-max

整数

最大 ICMP 数据包速率

ip_frag_max

别名：ip-frag-max

整数

最大分片 IP 数据包速率

ip_others_max

别名：ip-others-max

整数

其他数据包的最大 IP 数据包速率

l2_others_max

别名：l2-others-max

整数

非 ARP 数据包的最大 L2 数据包速率

pri_type_max

别名：pri-type-max

整数

优先级类型流量的最大溢出速率

queue_shaper_max

别名：queue-shaper-max

整数

每队列的最大流量字节速率

sctp_max

别名：sctp-max

整数

最大 SCTP 数据包速率

tcp_max

别名：tcp-max

整数

最大 TCP 数据包速率

tcpfin_rst_max

别名：tcpfin-rst-max

整数

最大 TCP 携带 FIN 或 RST 标志数据包速率

tcpsyn_ack_max

别名：tcpsyn-ack-max

整数

最大 TCP 携带 SYN 和 ACK 标志数据包速率

tcpsyn_max

别名：tcpsyn-max

整数

最大 TCP SYN 数据包速率

udp_max

别名：udp-max

整数

最大 UDP 数据包速率

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: Host protection engine configuration.
      fortinet.fortimanager.fmgr_system_npu_hpe:
        # 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>
        system_npu_hpe:
          all_protocol: <integer>
          arp_max: <integer>
          enable_shaper: <value in [disable, enable]>
          esp_max: <integer>
          high_priority: <integer>
          icmp_max: <integer>
          ip_frag_max: <integer>
          ip_others_max: <integer>
          l2_others_max: <integer>
          pri_type_max: <integer>
          sctp_max: <integer>
          tcp_max: <integer>
          tcpfin_rst_max: <integer>
          tcpsyn_ack_max: <integer>
          tcpsyn_max: <integer>
          udp_max: <integer>
          enable_queue_shaper: <value in [disable, enable]>
          exception_code: <integer>
          fragment_with_sess: <integer>
          fragment_without_session: <integer>
          queue_shaper_max: <integer>

返回值

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

键

描述

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)