fortinet.fortios.fortios_switch_controller_quarantine 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch 隔离支持。

注意

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

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

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

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

在 fortinet.fortios 2.0.0 中新增

概要

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

switch_controller_quarantine

字典

配置 FortiSwitch 隔离支持。

quarantine

字符串

启用/禁用隔离。

选择

  • "enable"

  • "disable"

targets

列表 / 元素=字典

隔离 MAC 地址。

description

字符串

隔离 MAC 地址的描述。

entry_id

整数

隔离 MAC 地址的 FSW 条目 ID。

mac

字符串 / 必需

隔离 MAC 地址。

tag

列表 / 元素=字典

隔离 MAC 地址的标签。

tags

字符串 / 必需

标签字符串。例如,string1 string2 string3。

vdom

字符串

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

默认: "root"

说明

注意

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

示例

- name: Configure FortiSwitch quarantine support.
  fortinet.fortios.fortios_switch_controller_quarantine:
      vdom: "{{ vdom }}"
      switch_controller_quarantine:
          quarantine: "enable"
          targets:
              -
                  description: "<your_own_value>"
                  entry_id: "2147483647"
                  mac: "<your_own_value>"
                  tag:
                      -
                          tags: "<your_own_value>"

返回值

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

描述

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"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)