fortinet.fortios.fortios_system_snmp_rmon_stat 模块 – Fortinet 的 FortiOS 和 FortiGate 中 SNMP 远程网络监控 (RMON) 以太网统计信息配置。

注意

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

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

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

要在剧本中使用它,请指定: fortinet.fortios.fortios_system_snmp_rmon_stat

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 system_snmp 功能和 rmon_stat 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整为数据源。已在 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"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_snmp_rmon_stat

字典

SNMP 远程网络监控 (RMON) 以太网统计信息配置。

id

整数 / 必需

RMON 以太网统计信息条目 ID。参见 注释

owner

字符串

以太网统计信息条目的所有者。

source

字符串

以太网统计信息条目的数据源。源系统.接口.名称。

vdom

字符串

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

默认值: "root"

注释

注意

  • 我们强烈建议使用您自己的值作为 id,而不是 0,而 '0' 是一个特殊的占位符,允许后端为对象分配最新的可用编号,但它确实有局限性。请在问答中查找更多详细信息。

  • 旧版 fortiosapi 已弃用,httpapi 是运行剧本的首选方式。

示例

- name: SNMP Remote Network Monitoring (RMON) Ethernet statistics configuration.
  fortinet.fortios.fortios_system_snmp_rmon_stat:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_snmp_rmon_stat:
          id: "3"
          owner: "<your_own_value>"
          source: "<your_own_value> (source system.interface.name)"

返回值

公共返回值在此处记录 此处,以下是此模块特有的字段。

描述

build

字符串

FortiGate 镜像的版本号

返回: 始终

示例: "1547"

http_method

字符串

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

返回: 始终

示例: "PUT"

http_status

字符串

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

返回: 始终

示例: "200"

mkey

字符串

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

返回: 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回: 始终

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 始终

示例: "webfilter"

版本号

字符串

内部版本号

返回: 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回: 始终

示例: "success"

vdom

字符串

使用的虚拟域

返回: 始终

示例: "root"

版本

字符串

FortiGate 版本

返回: 始终

示例: "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪滨 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)