fortinet.fortios.fortios_system_ipam 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 IP 地址管理服务。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 以了解详情。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

system_ipam

字典

配置 IP 地址管理服务。

automatic_conflict_resolution

字符串

启用/禁用自动冲突解决。

选项

  • "disable"

  • "enable"

manage_lan_addresses

字符串

启用/禁用 LAN 接口地址的默认管理。

选项

  • "disable"

  • "enable"

manage_lan_extension_addresses

字符串

启用/禁用 FortiExtender LAN 扩展接口地址的默认管理。

选项

  • "disable"

  • "enable"

manage_ssid_addresses

字符串

启用/禁用 FortiAP SSID 地址的默认管理。

选项

  • "disable"

  • "enable"

pool_subnet

字符串

配置 IPAM 池子网,A 类 - B 类子网。

pools

列表 / 元素=字典

配置 IPAM 池。

description

字符串

描述。

exclude

列表 / 元素=字典

配置池排除子网。

exclude_subnet

字符串

配置要从 IPAM 池中排除的子网。

ID

整数 / 必填

排除 ID。请参见 注释

name

字符串 / 必填

IPAM 池名称。

subnet

字符串

配置 IPAM 池子网,A 类 - B 类子网。

require_subnet_size_match

字符串

启用/禁用子网的重新分配,以使请求的大小和实际大小匹配。

选项

  • "disable"

  • "enable"

rules

列表 / 元素=字典

配置 IPAM 分配规则。

description

字符串

描述。

device

列表 / 元素=字典

配置要匹配的 FortiGate 序列号或通配符。

name

字符串 / 必填

FortiGate 序列号或通配符。

dhcp

字符串

启用/禁用匹配 IPAM 接口的 DHCP 服务器。

选项

  • "enable"

  • "disable"

interface

列表 / 元素=字典

配置要匹配的接口名称或通配符。

name

字符串 / 必填

接口名称或通配符。

name

字符串 / 必填

IPAM 规则名称。

pool

列表 / 元素=字典

配置要使用的 IPAM 池名称。

name

字符串 / 必填

IPAM 池名称。来源 system.ipam.pools.name。

role

字符串

配置要匹配的接口角色。

选项

  • "any"

  • "lan"

  • "wan"

  • "dmz"

  • "undefined"

server_type

字符串

配置要使用的 IPAM 服务器类型。

选项

  • "fabric-root"

  • "cloud"

status

字符串

启用/禁用 IP 地址管理服务。

选项

  • "enable"

  • "disable"

vdom

字符串

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

默认值: "root"

注释

注意

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

示例

- name: Configure IP address management services.
  fortinet.fortios.fortios_system_ipam:
      vdom: "{{ vdom }}"
      system_ipam:
          automatic_conflict_resolution: "disable"
          manage_lan_addresses: "disable"
          manage_lan_extension_addresses: "disable"
          manage_ssid_addresses: "disable"
          pool_subnet: "<your_own_value>"
          pools:
              -
                  description: "<your_own_value>"
                  exclude:
                      -
                          exclude_subnet: "<your_own_value>"
                          ID: "<you_own_value>"
                  name: "default_name_13"
                  subnet: "<your_own_value>"
          require_subnet_size_match: "disable"
          rules:
              -
                  description: "<your_own_value>"
                  device:
                      -
                          name: "default_name_19"
                  dhcp: "enable"
                  interface:
                      -
                          name: "default_name_22"
                  name: "default_name_23"
                  pool:
                      -
                          name: "default_name_25 (source system.ipam.pools.name)"
                  role: "any"
          server_type: "fabric-root"
          status: "enable"

返回值

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

描述

build

字符串

FortiGate 镜像的构建编号

返回:始终

示例: "1547"

http_method

字符串

用于将内容置备到 FortiGate 的最后一种方法

返回:始终

示例: "PUT"

http_status

字符串

FortiGate 在最后一次应用的操作中给出的最后结果

返回:始终

示例: "200"

mkey

字符串

在最后一次调用 FortiGate 时使用的主密钥 (id)

返回:成功

示例: "id"

name

字符串

用于完成请求的表的名称

返回:始终

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回:始终

示例: "webfilter"

版本号

字符串

内部版本号

返回:始终

示例: "17.0.2.10658"

序列号

字符串

设备序列号

返回:始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果指示

返回:始终

示例: "success"

vdom

字符串

使用的虚拟域

返回:始终

示例: "root"

版本

字符串

FortiGate 版本

返回:始终

示例: "v5.6.3"

作者

  • 郑琳 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)