fortinet.fortios.fortios_firewall_identity_based_route 模块 – 在 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_firewall_identity_based_route

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改防火墙功能和基于身份的路由类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数,在使用前需要将值调整到数据源。在 FOS v6.0.0 上测试。

需求

执行此模块的主机需要以下需求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

firewall_identity_based_route

字典

配置基于身份的路由。

comments

字符串

注释。

name

字符串 / 必填

名称。

rule

列表 / 元素=字典

规则。

device

字符串

规则的出站接口。源系统.接口.名称。

gateway

字符串

网关的 IPv4 地址(格式:xxx.xxx.xxx.xxx)。

groups

列表 / 元素=字典

从允许使用此路由的可用组中选择一个或多个组。用空格分隔组名称。

name

字符串 / 必填

组名。源用户.组.名称。

id

整数 / 必填

规则 ID。参见 注释

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必填

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

选项

  • "present"

  • "absent"

vdom

字符串

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

默认: "root"

注释

注意

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

  • 此模块支持 check_mode。

示例

- name: Configure identity based routing.
  fortinet.fortios.fortios_firewall_identity_based_route:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_identity_based_route:
          comments: "<your_own_value>"
          name: "default_name_4"
          rule:
              -
                  device: "<your_own_value> (source system.interface.name)"
                  gateway: "<your_own_value>"
                  groups:
                      -
                          name: "default_name_9 (source user.group.name)"
                  id: "10"

返回值

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

描述

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"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)