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

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

user_quarantine

字典

配置隔离支持。

firewall_groups

字符串

包含所有隔离 MAC 地址的防火墙地址组。来源 firewall.addrgrp.name。

quarantine

字符串

启用/禁用隔离。

选择

  • "enable"

  • "disable"

targets

列表 / elements=dictionary

隔离条目以保存多个 MAC。

description

字符串

隔离条目的描述。

entry

字符串 / 必选

隔离条目名称。

macs

列表 / elements=dictionary

隔离 MAC。

description

字符串

隔离 MAC 的描述。

drop

字符串

启用/禁用丢弃隔离设备的流量。

选择

  • "disable"

  • "enable"

entry_id

整数

隔离 MAC 的 FSW 条目 ID。

mac

字符串 / 必选

隔离 MAC。

parent

字符串

父条目名称。

traffic_policy

字符串

隔离 MAC 的流量策略。来源 switch-controller.traffic-policy.name。

vdom

字符串

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

默认值: "root"

说明

注意

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

示例

- name: Configure quarantine support.
  fortinet.fortios.fortios_user_quarantine:
      vdom: "{{ vdom }}"
      user_quarantine:
          firewall_groups: "<your_own_value> (source firewall.addrgrp.name)"
          quarantine: "enable"
          targets:
              -
                  description: "<your_own_value>"
                  entry: "<your_own_value>"
                  macs:
                      -
                          description: "<your_own_value>"
                          drop: "disable"
                          entry_id: "2147483647"
                          mac: "<your_own_value>"
                          parent: "<your_own_value>"
          traffic_policy: "<your_own_value> (source switch-controller.traffic-policy.name)"

返回值

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

描述

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)