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 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。 选择 “已启用” “已禁用” “不支持”
bundle_speed 字符串	设置捆绑速度，仅当 bundle 为 true 时适用。 此选项仅在选定的硬件平台和接口上受支持。 尝试在 VE 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。 选择 “100G” “40G” “不支持”
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 或任何其他不受支持的平台/接口上启用此选项将导致模块运行失败。 选择 “已启用” “已禁用” “不支持” “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 ID、Port ID 和 TTL。 可用的可选属性具有映射到它们的特定 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_link_type 字符串	指定接口的 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

返回值

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

键	描述
bundle 字符串	启用或禁用捆绑功能。 返回： changed 示例： "not-supported"
bundle_speed 字符串	捆绑速度。 返回： changed 示例： "100G"
description 字符串	用户定义的描述。 返回： changed 示例： "my description"
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 复杂	指定接口的 sFlow 设置。 返回： changed 示例： "hash/dictionary of values"
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_link_type 字符串	接口的 STP 链路类型。 返回： changed 示例： "shared"

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）