fortinet.fortios.fortios_system_vdom_sflow 模块 – 为每个 VDOM 配置 sFlow，以添加或更改此 VDOM 中 FortiGate sFlow 代理用于将 sFlow 数据报文发送到 Fortinet 的 FortiOS 和 FortiGate 中 sFlow 收集器的 IP 地址和 UDP 端口。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 vdom_sflow 类别来配置 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"

system_vdom_sflow

字典

为每个 VDOM 配置 sFlow，以添加或更改此 VDOM 中 FortiGate sFlow 代理用于将 sFlow 数据报文发送到 sFlow 收集器的 IP 地址和 UDP 端口。

collector_ip

字符串

sFlow 收集器的 IP 地址，此 VDOM 中添加到接口的 sFlow 代理将 sFlow 数据报文发送到该地址。

collector_port

整数

用于发送 sFlow 数据报文的 UDP 端口号（仅当您的 sFlow 收集器或网络配置需要时才配置）（0 - 65535）。

collectors

列表 / 元素=字典

sFlow 收集器。

collector_ip

字符串

sFlow 收集器的 IP 地址，此 VDOM 中添加到接口的 sFlow 代理将 sFlow 数据报文发送到这些地址。

collector_port

整数

用于发送 sFlow 数据报文的 UDP 端口号（仅当您的 sFlow 收集器或网络配置需要时才配置）（0 - 65535）。

id

整数 / 必需

ID。参见 注释。

interface

字符串

指定到达服务器的出站接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

source_ip

字符串

sFlow 代理的源 IP 地址。

interface

字符串

指定到达服务器的出站接口。源 system.interface.name。

interface_select_method

字符串

指定如何选择到达服务器的出站接口。

选项

  • "auto"

  • "sdwan"

  • "specify"

source_ip

字符串

sFlow 代理的源 IP 地址。

vdom_sflow

字符串

启用/禁用当前 VDOM 的 sFlow 配置。

选项

  • "enable"

  • "disable"

vdom

字符串

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

默认值： "root"

注释

注意

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

示例

- name: Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow
   collector.
  fortinet.fortios.fortios_system_vdom_sflow:
      vdom: "{{ vdom }}"
      system_vdom_sflow:
          collector_ip: "<your_own_value>"
          collector_port: "6343"
          collectors:
              -
                  collector_ip: "<your_own_value>"
                  collector_port: "6343"
                  id: "8"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  source_ip: "84.230.14.43"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          source_ip: "84.230.14.43"
          vdom_sflow: "enable"

返回值

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

键

描述

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"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)