fortinet.fortios.fortios_system_vdom_property 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 VDOM 属性。

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortios.fortios_system_vdom_property。

fortinet.fortios 2.0.0 中的新增功能

概要 

此模块能够通过允许用户设置和修改系统功能和 vdom_property 类别来配置 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_property 字典	配置 VDOM 属性。
custom_service 列表 / 元素=字符串	防火墙自定义服务的最大保证数量。
description 字符串	描述。
dialup_tunnel 列表 / 元素=字符串	拨号隧道的最大保证数量。
firewall_address 列表 / 元素=字符串	防火墙地址的最大保证数量（IPv4、IPv6、组播）。
firewall_addrgrp 列表 / 元素=字符串	防火墙地址组的最大保证数量（IPv4、IPv6）。
firewall_policy 列表 / 元素=字符串	防火墙策略的最大保证数量（策略、DoS-policy4、DoS-policy6、组播）。
ipsec_phase1 列表 / 元素=字符串	VPN IPsec 第 1 阶段隧道的最大保证数量。
ipsec_phase1_interface 列表 / 元素=字符串	VPN IPsec 第 1 阶段接口隧道的最大保证数量。
ipsec_phase2 列表 / 元素=字符串	VPN IPsec 第 2 阶段隧道的最大保证数量。
ipsec_phase2_interface 列表 / 元素=字符串	VPN IPsec 第 2 阶段接口隧道的最大保证数量。
log_disk_quota 列表 / 元素=字符串	日志磁盘配额（以 MB 为单位）。范围取决于可用的磁盘空间大小。
name 字符串 / 必需	VDOM 名称。来源 system.vdom.name。
onetime_schedule 列表 / 元素=字符串	防火墙一次性计划的最大保证数量。
proxy 列表 / 元素=字符串	并发代理用户的最大保证数量。
recurring_schedule 列表 / 元素=字符串	防火墙定期计划的最大保证数量。
service_group 列表 / 元素=字符串	防火墙服务组的最大保证数量。
session 列表 / 元素=字符串	会话的最大保证数量。
snmp_index 整数	虚拟域的永久 SNMP 索引 (1 - 2147483647)。
sslvpn 列表 / 元素=字符串	SSL-VPN 的最大保证数量。
user 列表 / 元素=字符串	本地用户的最大保证数量。
user_group 列表 / 元素=字符串	用户组的最大保证数量。
vdom 字符串	虚拟域，在之前定义的那些域中。VDOM 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。默认： `"root"`

备注 

注意

旧版 fortiosapi 已弃用，httpapi 是运行剧本的首选方法。
该模块支持 check_mode。

示例 

- name: Configure VDOM property.
  fortinet.fortios.fortios_system_vdom_property:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_vdom_property:
          custom_service: "<your_own_value>"
          description: "<your_own_value>"
          dialup_tunnel: "<your_own_value>"
          firewall_address: "<your_own_value>"
          firewall_addrgrp: "<your_own_value>"
          firewall_policy: "<your_own_value>"
          ipsec_phase1: "<your_own_value>"
          ipsec_phase1_interface: "<your_own_value>"
          ipsec_phase2: "<your_own_value>"
          ipsec_phase2_interface: "<your_own_value>"
          log_disk_quota: "<your_own_value>"
          name: "default_name_14 (source system.vdom.name)"
          onetime_schedule: "<your_own_value>"
          proxy: "<your_own_value>"
          recurring_schedule: "<your_own_value>"
          service_group: "<your_own_value>"
          session: "<your_own_value>"
          snmp_index: "0"
          sslvpn: "<your_own_value>"
          user: "<your_own_value>"
          user_group: "<your_own_value>"

返回值 

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

键	描述
build 字符串	FortiGate 镜像的构建编号。返回：始终示例： `"1547"`
http_method 字符串	上次用于将内容置备到 FortiGate 的方法。返回：始终示例： `"PUT"`
http_status 字符串	FortiGate 在应用的上次操作上给出的最后结果。返回：始终示例： `"200"`
mkey 字符串	上次调用 FortiGate 时使用的主密钥 (ID)。返回：成功示例： `"id"`
name 字符串	name 返回：始终用于完成请求的表的名称。
示例： `"urlfilter"` 字符串	path 返回：始终用于完成请求的表的路径。
示例： `"webfilter"` 字符串	revision 返回：始终内部修订号。
示例： `"17.0.2.10658"` 字符串	serial 返回：始终设备的序列号。
示例： `"FGVMEVYYQT3AB5352"` 字符串	status 返回：始终操作结果的指示。
vdom 字符串	示例： `"success"` 返回：始终 vdom
使用的虚拟域。字符串	示例： `"root"` 返回：始终 version

作者

郑林 (@chillancezen)
薛杰 (@JieX19)
卢洪斌 (@fgtdev-hblu)
沈方 (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)