fortinet.fortios.fortios_switch_controller_lldp_profile 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch LLDP 配置文件。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_switch_controller_lldp_profile。

fortinet.fortios 2.0.0 中的新增功能

概要

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

switch_controller_lldp_profile

字典

配置 FortiSwitch LLDP 配置文件。

auto_isl

字符串

启用/禁用自动交换机间 LAG。

选项

  • "disable"

  • "enable"

auto_isl_auth

字符串

自动交换机间 LAG 身份验证模式。

选项

  • "legacy"

  • "strict"

  • "relax"

auto_isl_auth_encrypt

字符串

自动交换机间 LAG 加密模式。

选项

  • "none"

  • "mixed"

  • "must"

auto_isl_auth_identity

字符串

自动交换机间 LAG 身份验证标识。

auto_isl_auth_macsec_profile

字符串

用于加密的自动交换机间 LAG macsec 配置文件。

auto_isl_auth_reauth

整数

自动交换机间 LAG 身份验证重新身份验证周期，以秒为单位 (10 - 3600)。

auto_isl_auth_user

字符串

自动交换机间 LAG 身份验证用户证书。

auto_isl_hello_timer

整数

自动交换机间 LAG Hello 计时器持续时间（1 - 30 秒）。

auto_isl_port_group

整数

自动交换机间 LAG 端口组 ID (0 - 9)。

auto_isl_receive_timeout

整数

如果未收到响应，则自动交换机间 LAG 超时（3 - 90 秒）。

auto_mclag_icl

字符串

启用/禁用 MCLAG 机箱间链路。

选项

  • "disable"

  • "enable"

custom_tlvs

列表 / elements=dictionary

编辑自定义 TLV 条目的配置方法。

information_string

字符串

组织定义的信息字符串（0 - 507 个十六进制字节）。

name

字符串 / 必需

TLV 名称（未发送）。

oui

字符串

组织唯一标识符 (OUI)，一个 3 字节十六进制数字，用于此 TLV。

subtype

整数

组织定义的子类型 (0 - 255)。

med_location_service

列表 / elements=dictionary

编辑媒体端点发现 (MED) 位置服务类型-长度-值 (TLV) 类别的配置方法。

name

字符串 / 必需

位置服务类型名称。

status

字符串

启用或禁用此 TLV。

选项

  • "disable"

  • "enable"

sys_location_id

字符串

位置服务 ID。源 switch-controller.location.name。

med_network_policy

列表 / elements=dictionary

编辑媒体端点发现 (MED) 网络策略类型-长度-值 (TLV) 类别的配置方法。

assign_vlan

字符串

当此配置文件应用于托管 FortiSwitch 端口时，启用/禁用 VLAN 分配。

选项

  • "disable"

  • "enable"

dscp

整数

通告的区分服务代码点 (DSCP) 值，一个数据包标头值，指示请求的流量服务级别，例如高优先级或尽力而为交付。

name

字符串 / 必需

策略类型名称。

priority

整数

通告的第 2 层优先级（0 - 7；从最低到最高优先级）。

status

字符串

启用或禁用此 TLV。

选项

  • "disable"

  • "enable"

vlan

整数

要通告的 VLAN ID，如果已在端口上配置（0 - 4094，0 = 优先级标签）。

vlan_intf

字符串

要通告的 VLAN 接口；如果在端口上配置。源 system.interface.name。

med_tlvs

列表 / elements=string

传输的 LLDP-MED TLV（类型-长度-值描述）。

选项

  • "inventory-management"

  • "network-policy"

  • "power-management"

  • "location-identification"

name

字符串 / 必需

配置文件名称。

tlvs_802dot1

列表 / elements=string

传输的 IEEE 802.1 TLV。

选项

  • "port-vlan-id"

tlvs_802dot3

列表 / elements=string

传输的 IEEE 802.3 TLV。

选项

  • "max-frame-size"

  • "power-negotiation"

vdom

字符串

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

默认值： "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure FortiSwitch LLDP profiles.
  fortinet.fortios.fortios_switch_controller_lldp_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_lldp_profile:
          tlvs_802dot1: "port-vlan-id"
          tlvs_802dot3: "max-frame-size"
          auto_isl: "disable"
          auto_isl_auth: "legacy"
          auto_isl_auth_encrypt: "none"
          auto_isl_auth_identity: "<your_own_value>"
          auto_isl_auth_macsec_profile: "<your_own_value>"
          auto_isl_auth_reauth: "3600"
          auto_isl_auth_user: "<your_own_value>"
          auto_isl_hello_timer: "3"
          auto_isl_port_group: "0"
          auto_isl_receive_timeout: "60"
          auto_mclag_icl: "disable"
          custom_tlvs:
              -
                  information_string: "<your_own_value>"
                  name: "default_name_18"
                  oui: "<your_own_value>"
                  subtype: "0"
          med_location_service:
              -
                  name: "default_name_22"
                  status: "disable"
                  sys_location_id: "<your_own_value> (source switch-controller.location.name)"
          med_network_policy:
              -
                  assign_vlan: "disable"
                  dscp: "0"
                  name: "default_name_28"
                  priority: "0"
                  status: "disable"
                  vlan: "2047"
                  vlan_intf: "<your_own_value> (source system.interface.name)"
          med_tlvs: "inventory-management"
          name: "default_name_34"

返回值

通用返回值在 此处 记录，以下是此模块特有的字段

键

描述

build

字符串

FortiGate 映像的内部版本号

返回值： 始终

示例： "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回值： 始终

示例： "PUT"

http_status

字符串

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

返回值： 始终

示例： "200"

mkey

字符串

在上次调用 FortiGate 时使用的主密钥 (id)

返回值： 成功

示例: "id"

name

字符串

用于满足请求的表的名称

返回值： 始终

示例: "urlfilter"

路径

字符串

用于满足请求的表的路径

返回值： 始终

示例: "webfilter"

修订版本

字符串

内部修订号

返回值： 始终

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回值： 始终

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