fortinet.fortios.fortios_system_sdn_proxy 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 SDN 代理。

注意

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

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

要安装它,请使用: ansible-galaxy collection install fortinet.fortios。您需要满足进一步的要求才能使用此模块,有关详细信息,请参阅 要求

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

字典

配置 SDN 代理。

name

字符串 / 必需

SDN 代理名称。

password

字符串

SDN 代理密码。

server

字符串

SDN 代理的服务器地址。

server_port

整数

SDN 代理的端口号。

type

字符串

SDN 代理的类型。

选项

  • "general"

  • "fortimanager"

username

字符串

SDN 代理用户名。

vdom

字符串

虚拟域,在之前定义的那些中。vdom 是 FortiGate 的一个虚拟实例,可以配置并用作不同的单元。

默认值: "root"

注释

注意

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

示例

- name: Configure SDN proxy.
  fortinet.fortios.fortios_system_sdn_proxy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sdn_proxy:
          name: "default_name_3"
          password: "<your_own_value>"
          server: "192.168.100.40"
          server_port: "0"
          type: "general"
          username: "<your_own_value>"

返回值

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

描述

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"

version

字符串

FortiGate 的版本

已返回:始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈 Frank (@frankshen01)

  • 米格尔·安赫尔·穆尼奥斯 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)