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 中的新增功能

概要

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

state

字符串 / 必需

指示是创建还是删除对象。

选择

  • "present"

  • "absent"

system_vdom_exception

字典

可以跨不同 HA 对等体为所有 VDOM 或为定义的 VDOM 范围独立配置的全局配置对象。

id

整数 / 必需

索引（1 - 4096）。请参阅 <a href=’#notes’>注释</a>。

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

列表 / elements=dictionary

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"

path

字符串

用于满足请求的表的路径

返回： 始终

示例： "webfilter"

revision

字符串

内部修订号

返回： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回： 始终

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