fortinet.fortios.fortios_system_vdom_exception 模块 – Fortinet 的 FortiOS 和 FortiGate 中可在不同 HA 对等体之间针对所有 VDOM 或已定义的 VDOM 范围独立配置的全局配置对象。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

摘要

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

字典

可在不同 HA 对等体之间针对所有 VDOM 或已定义的 VDOM 范围独立配置的全局配置对象。

id

整数 / 必需

索引 (1 - 4096)。参见 备注。

object

字符串

可针对所有 VDOM 独立配置的配置对象的名称。

选项

  • "log.fortianalyzer.setting"

  • "log.fortianalyzer.override-setting"

  • "log.fortianalyzer2.setting"

  • "log.fortianalyzer2.override-setting"

  • "log.fortianalyzer3.setting"

  • "log.fortianalyzer3.override-setting"

  • "log.fortianalyzer-cloud.setting"

  • "log.fortianalyzer-cloud.override-setting"

  • "log.syslogd.setting"

  • "log.syslogd.override-setting"

  • "log.syslogd2.setting"

  • "log.syslogd2.override-setting"

  • "log.syslogd3.setting"

  • "log.syslogd3.override-setting"

  • "log.syslogd4.setting"

  • "log.syslogd4.override-setting"

  • "system.gre-tunnel"

  • "system.central-management"

  • "system.csf"

  • "user.radius"

  • "system.interface"

  • "vpn.ipsec.phase1-interface"

  • "vpn.ipsec.phase2-interface"

  • "router.bgp"

  • "router.route-map"

  • "router.prefix-list"

  • "firewall.ippool"

  • "firewall.ippool6"

  • "router.static"

  • "router.static6"

  • "firewall.vip"

  • "firewall.vip6"

  • "system.sdwan"

  • "system.saml"

  • "router.policy"

  • "router.policy6"

  • "log.syslogd.setting"

  • "log.syslogd.override-setting"

  • "firewall.address"

  • "firewall.vip46"

  • "firewall.vip64"

oid

整数

对象 ID。

scope

字符串

确定配置对象是否可以针对所有 VDOM 单独配置，或者某些 VDOM 是否共享相同的配置。

选项

  • "all"

  • "inclusive"

  • "exclusive"

vdom

列表 / 元素=字典

VDOM 的名称。

name

字符串 / 必需

VDOM 名称。来源 system.vdom.name。

vdom

字符串

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

默认值： "root"

备注

注意

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

  • 传统 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方法。

  • 该模块支持 check_mode。

示例

- name: Global configuration objects that can be configured independently across different ha peers for all VDOMs or for the defined VDOM scope.
  fortinet.fortios.fortios_system_vdom_exception:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vdom_exception:
          id: "3"
          object: "log.fortianalyzer.setting"
          oid: "32767"
          scope: "all"
          vdom:
              -
                  name: "default_name_8 (source system.vdom.name)"

返回值

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

键

描述

build

字符串

FortiGate 镜像的版本号。

返回：始终

示例： "1547"

http_method

字符串

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

返回：始终

示例： "PUT"

http_status

字符串

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

返回：始终

示例： "200"

mkey

字符串

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

返回：成功

示例： "id"

name

字符串

用于满足请求的表名称

返回：始终

示例： "urlfilter"

路径

字符串

用于满足请求的表路径

返回：始终

示例： "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)