f5networks.f5_modules.bigip_interface 模块 – 用于管理 BIG-IP 物理接口的模块。

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install f5networks.f5_modules

要在剧本中使用它,请指定:f5networks.f5_modules.bigip_interface

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 用于管理 BIG-IP 物理接口的模块。

参数

参数

注释

bundle

字符串

启用或禁用捆绑功能。

此选项仅在某些硬件平台和接口上受支持。

尝试在 VE 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。

选项

  • "enabled"

  • "disabled"

  • "not-supported"

bundle_speed

字符串

设置捆绑速度,仅当捆绑为 true 时适用。

此选项仅在选定的硬件平台和接口上受支持。

尝试在 VE 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。

选项

  • "100G"

  • "40G"

  • "not-supported"

description

字符串

用户定义的描述。

enabled

布尔值

指定接口的当前状态。

true 时,启用接口以传递流量。

false 时,禁用接口传递流量。

选项

  • false

  • true

flow_control

字符串

指定系统如何控制 PAUSE 帧的发送。

tx-rx 时,接口会遵守其伙伴的暂停帧,并在必要时生成暂停帧。

tx 时,接口忽略其伙伴的暂停帧,并在必要时生成暂停帧。

rx 时,接口遵守其伙伴的暂停帧,但不生成暂停帧。

当 (none) 时,接口上的流量控制被禁用。

选项

  • "none"

  • "rx"

  • "tx"

  • "tx-rx"

force_gigabit_fiber

布尔值

启用或禁用强制千兆位光纤介质。

对于千兆位光纤接口,当 true 时,将强制执行媒体设置,并且不会执行自动协商。

false 时,将仅使用一个千兆位光纤选项进行自动协商。

选项

  • false

  • true

forward_error_correction

字符串

在 100G 接口上启用或禁用 IEEE 802.3bm 第 91 条款 Reed-Solomon 前向纠错。对于 LR4 介质无效。

此选项仅在选定的硬件平台和接口上受支持。

尝试在 VE 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。

选项

  • "enabled"

  • "disabled"

  • "not-supported"

  • "auto"

lldp_admin

字符串

指定接口级别的 LLDP 设置。

disabled 时,接口既不向相邻设备发送 LLDP 消息,也不接收来自相邻设备的 LLDP 消息。

txonly 时,接口向相邻设备发送 LLDP 消息,但不接收来自相邻设备的 LLDP 消息。

rxonly 时,接口接收来自相邻设备的 LLDP 消息,但不向相邻设备发送 LLDP 消息。

txrx 时,接口向相邻设备发送 LLDP 消息并接收来自相邻设备的 LLDP 消息。

选项

  • "disable"

  • "rxonly"

  • "txonly"

  • "txrx"

lldp_tlvmap

整数

指定正在发送或接收的 LLDP 消息的内容。

使用此设置指定的每个 LLDP 属性都是可选的,并且采用类型、长度、值 (TLV) 的形式。

在计算此值时,不考虑三个强制性 TLV:Chassis IDPort IDTTL

可用的可选属性具有与其映射的特定 TLV 数值。

Port Description 属性的 TLV 值为 8

System Name 属性的 TLV 值为 16

System Description 属性的 TLV 值为 32

System Capabilities 属性的 TLV 值为 64

Management Address 属性的 TLV 值为 128

Port VLAN ID 属性的 TLV 值为 256

VLAN Name 属性的 TLV 值为 512

Port and Protocol VLAN ID 属性的 TLV 值为 1024

Protocol Identity 属性的 TLV 值为 2048

MAC/PHY Config Status 属性的 TLV 值为 4096

Link Aggregation 属性的 TLV 值为 8192

Max Frame Size 属性的 TLV 值为 32768

Product Model 属性的 TLV 值为 65536

lldp_tlvmap 是一个数值,它是所有选定属性的 TLV 值之和。

lldp_tlvmap 设置为 0 将从接口中删除所有属性。

lldp_tlvmap设置为114680将向接口添加所有属性。

media_fixed

字符串

指定固定(非可插拔)接口的设置。

仅当组合端口的固定接口不是首选端口时,才使用此选项指定固定接口的媒体类型。

选项

  • "100000-FD"

  • "100000LR4-FD"

  • "10000LR-FD"

  • "10000T-FD"

  • "1000SX-FD"

  • "100TX-FD"

  • "10T-HD"

  • "20000-FD"

  • "40000LR4-FD"

  • "100000AR4-FD"

  • "100000SR4-FD"

  • "10000SFPCU-FD"

  • "1000CX-FD"

  • "1000T-FD"

  • "100TX-HD"

  • "12000-FD"

  • "21000-FD"

  • "40000SR4-FD"

  • "100000CR4-FD"

  • "10000ER-FD"

  • "10000SR-FD"

  • "1000LX-FD"

  • "1000T-HD"

  • "10T-FD"

  • "16000-FD"

  • "40000-FD"

  • "42000-FD"

  • "auto"

  • "no-phy"

media_sfp

字符串

指定SFP(可插拔)接口的设置。

仅当组合端口的SFP接口不是首选端口时,才使用此选项指定SFP接口的媒体类型。

选项

  • "100000-FD"

  • "100000LR4-FD"

  • "10000LR-FD"

  • "10000T-FD"

  • "1000SX-FD"

  • "100TX-FD"

  • "10T-HD"

  • "20000-FD"

  • "40000LR4-FD"

  • "100000AR4-FD"

  • "100000SR4-FD"

  • "10000SFPCU-FD"

  • "1000CX-FD"

  • "1000T-FD"

  • "100TX-HD"

  • "12000-FD"

  • "21000-FD"

  • "40000SR4-FD"

  • "100000CR4-FD"

  • "10000ER-FD"

  • "10000SR-FD"

  • "1000LX-FD"

  • "1000T-HD"

  • "10T-FD"

  • "16000-FD"

  • "40000-FD"

  • "42000-FD"

  • "auto"

  • "no-phy"

name

字符串 / 必需

指定要管理的接口的名称。

port_fwd_mode

字符串

指定操作模式。

选项

  • "l3"

  • "passive"

  • "virtual-wire"

prefer_port

字符串

如果组合端口的两侧都可能存在外部链路,则指示接口使用组合端口的哪一侧。

组合端口的默认值为sfp。不要对非组合端口使用此选项。

选项

  • "sfp"

  • "fixed"

provider

字典

在f5networks.f5_modules 1.0.0中添加

包含连接详细信息的字典对象。

auth_provider

字符串

配置身份验证提供程序,以从远程设备获取身份验证令牌。

使用BIG-IQ设备时才会真正使用此选项。

no_f5_teem

布尔值

如果为yes,则不会将TEEM遥测数据发送到F5。

您可以通过设置环境变量F5_TELEMETRY_OFF来省略此选项。

先前使用的变量F5_TEEM已弃用,因为其名称令人困惑。

选项

  • false ← (默认)

  • true

password

别名:pass,pwd

字符串 / 必需

用于连接到BIG-IP或BIG-IQ的用户帐户的密码。

您可以通过设置环境变量F5_PASSWORD来省略此选项。

server

字符串 / 必需

BIG-IP主机或BIG-IQ主机。

您可以通过设置环境变量F5_SERVER来省略此选项。

server_port

整数

BIG-IP服务器端口。

您可以通过设置环境变量F5_SERVER_PORT来省略此选项。

默认: 443

timeout

整数

指定与网络设备通信的超时时间(以秒为单位),用于连接或发送命令。如果在操作完成之前超时,模块将出错。

transport

字符串

配置连接到远程设备时要使用的传输连接。

选项

  • "rest" ← (默认)

user

字符串 / 必需

连接到BIG-IP或BIG-IQ的用户名。此用户必须具有设备上的管理员权限。

您可以通过设置环境变量F5_USER来省略此选项。

validate_certs

布尔值

如果为no,则不会验证SSL证书。仅在使用自签名证书的个人控制站点上使用此选项。

您可以通过设置环境变量F5_VALIDATE_CERTS来省略此选项。

选项

  • false

  • true ← (默认)

sflow

字典

指定接口的sFlow设置。

poll_interval

整数

指定两次轮询之间的最大间隔(以秒为单位)。

要使此设置生效,必须将poll_interval_global设置为false

有效范围为0-4294967295。

poll_interval_global

布尔值

指定全局接口poll_interval设置是否覆盖对象级别的poll_interval设置。

当为true时,poll_interval设置无效。

选项

  • false

  • true

stp

布尔值

启用或禁用STP。

选项

  • false

  • true

stp_auto_edge_port

布尔值

为接口设置STP自动边缘端口检测。

当为true时,系统会监控接口是否有传入的STP、RSTP或MSTP数据包。如果在足够长的时间段(大约三秒钟)内未收到此类数据包,则接口将自动赋予边缘端口状态。

当为false时,系统永远不会自动为接口赋予边缘端口状态。在每个接口的基础上设置的任何STP设置都适用于所有生成树实例。

选项

  • false

  • true

stp_edge_port

布尔值

指定接口连接到终端站而不是另一个生成树桥梁。

选项

  • false

  • true

字符串

指定接口的STP链路类型。

选项

  • "auto"

  • "p2p"

  • "shared"

注释

注意

  • 有关使用Ansible管理F5 Networks设备的更多信息,请参见https://ansible.org.cn/integrations/networks/f5

  • 需要BIG-IP软件版本>= 12。

  • F5模块仅操作F5产品的运行配置。为确保BIG-IP特定配置持久保存到磁盘,请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。有关如何正确使用模块保存运行配置的信息,请参阅模块的文档。

示例

- name: Update Interface Settings
  bigip_interface:
    name: 1.1
    stp: true
    stp_auto_edge_port: false
    stp_edge_port: true
    stp_link_type: shared
    description: my description
    flow_control: tx
    lldp_admin: txrx
    lldp_tlvmap: 8
    force_gigabit_fiber: false
    sflow:
      - poll_interval: 10
      - poll_interval_global: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Disable Interface
  bigip_interface:
    name: 1.1
    enabled: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Change sflow interface settings
  bigip_interface:
    name: 1.1
    sflow:
      - poll_interval: 0
      - poll_interval_global: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

Key

描述

bundle

字符串

启用或禁用捆绑功能。

已返回:changed

示例: "not-supported"

bundle_speed

字符串

捆绑速度。

已返回:changed

示例: "100G"

description

字符串

用户定义的描述。

已返回:changed

示例: "我的描述"

enabled

布尔值

接口的当前状态。

已返回:changed

示例: true

flow_control

字符串

指定系统如何控制 PAUSE 帧的发送。

已返回:changed

示例: "tx"

force_gigabit_fiber

布尔值

启用或禁用强制千兆位光纤介质。

已返回:changed

示例: true

forward_error_correction

字符串

启用或禁用前向纠错。

已返回:changed

示例: "auto"

lldp_admin

字符串

接口级别的LLDP设置。

已返回:changed

示例: "txrx"

lldp_tlvmap

整数

正在发送或接收的LLDP消息的内容。

已返回:changed

示例: 136

media_fixed

字符串

固定接口的设置。

已返回:changed

示例: "100000-FD"

media_sfp

字符串

SFP接口的设置。

已返回:changed

示例: "100000-FD"

port_fwd_mode

字符串

操作模式。

已返回:changed

示例: "passive"

prefer_port

字符串

接口使用的组合端口的一侧。

已返回:changed

示例: "fixed"

sflow

complex

指定接口的sFlow设置。

已返回:changed

示例: "值散列/字典"

poll_interval

整数

两次轮询之间的最大间隔(以秒为单位)。

已返回:changed

示例: 128

poll_interval_global

布尔值

全局sFlow设置覆盖。

已返回:changed

示例: true

stp

布尔值

启用或禁用STP。

已返回:changed

示例: false

stp_auto_edge_port

布尔值

为接口设置STP自动边缘端口检测。

已返回:changed

示例: true

stp_edge_port

布尔值

指定接口连接到终端站而不是另一个生成树桥梁。

已返回:changed

示例: false

字符串

接口的STP链路类型。

已返回:changed

示例: "shared"

作者

  • Wojciech Wypior (@wojtek0806)