fortinet.fortios.fortios_system_sflow 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 sFlow。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_system_sflow

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 sFlow。

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

字符串

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

默认值: "root"

备注

注意

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

示例

- name: Configure sFlow.
  fortinet.fortios.fortios_system_sflow:
      vdom: "{{ vdom }}"
      system_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"

返回值

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

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)