f5networks.f5_modules.bigiq_device_info 模块 – 从 F5 BIG-IQ 设备收集信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigiq_device_info。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 从 F5 BIG-IQ 设备收集信息。

• 在 Ansible 2.9 之前，此模块名为 bigiq_device_facts。用法没有改变。

别名：bigia_device_facts

参数

参数	注释
gather_subset list / elements=string / required	如果提供此参数，则此参数会将返回的信息限制为给定的子集。 您可以指定一个值列表以包含更大的子集。 值也可以与初始 ! 一起使用，以指定不应收集特定的子集。 选择 "all" "applications" "managed-devices" "purchased-pool-licenses" "regkey-pools" "system-info" "vlans" "!all" "!applications" "!managed-devices" "!purchased-pool-licenses" "!regkey-pools" "!system-info" "!vlans"
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 字符串 / required	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / required	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。如果在操作完成之前超过超时时间，则模块将出错。
transport 字符串	配置连接到远程设备时要使用的传输连接。 选择 "rest" ← (默认)
user 字符串 / required	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)

注释

注意

• 所有 BIG-IQ 版本均支持此模块

• 对于 BIGIQ 7.0 及更高版本，不包括/不支持一些元数据字段（例如，正常运行时间、product_changelist、product_jobid）

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

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

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

示例

- name: Collect BIG-IQ information
  bigiq_device_info:
    gather_subset:
      - system-info
      - vlans
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IQ information
  bigiq_device_info:
    gather_subset:
      - all
    provider:
      server: cm.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Collect all BIG-IP information except trunks
  bigiq_device_info:
    gather_subset:
      - all
      - "!trunks"
    provider:
      server: cm.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
applications 复杂	应用相关信息 返回: 当在 gather_subset 中指定 managed-devices 时。 示例: "值的哈希/字典"
active_alerts 整数	应用上处于活动状态的警报数量。 返回: changed 示例: 0
bad_traffic 浮点数	被确定为“不良”的应用程序流量的百分比。 此值取决于是否启用了 protection_mode。 返回: changed 示例: 1.7498
bad_traffic_growth 布尔值	是否配置为触发不良流量增长警报。 返回: changed 示例: false
connections 浮点数	当前与应用程序建立的连接数。 返回: changed 示例: 3.06
enhanced_analytics 布尔值	是否为应用程序启用了增强分析。 返回: changed 示例: true
health 字符串	应用程序的健康状况。 返回: changed 示例: "良好"
id 字符串	BIG-IQ 已知的应用程序 ID。 返回: changed 示例: "996baae8-5d1d-3662-8a2d-3612fa2aceae"
name 字符串	应用程序的名称。 返回: changed 示例: "site12http.example.com"
new_connections 浮点数	每秒建立的新连接数。 返回: changed 示例: 0.35
protection_mode 字符串	应用程序上 F5 Web 应用程序安全服务的保护类型。 返回: changed 示例: "未受保护"
response_time 浮点数	以毫秒为单位测量的应用程序响应时间。 返回: changed 示例: 0.02
status 字符串	应用程序的当前状态。 返回: changed 示例: "已部署"
transactions_per_second 浮点数	当前应用程序每秒处理的事务数。 返回: changed 示例: 0.87
managed_devices 复杂	托管设备相关信息。 返回: 当在 gather_subset 中指定 managed-devices 时。 示例: "值的哈希/字典"
address 字符串	发现设备的地址。 返回: changed 示例: "10.10.10.10"
build 字符串	版本的构建版本。 返回: changed 示例: "0.0.4"
device_uri 字符串	用于访问设备管理界面的 URI。 返回: changed 示例: "https://10.10.10.10:443"
edition 字符串	产品版本的版本字符串。 返回: changed 示例: "最终版"
group_name 字符串	该设备所属的 BIG-IQ 组。 返回: changed 示例: "cm-bigip-allBigIpDevices"
hostname 字符串	发现的设备主机名。 返回: changed 示例: "tier2labB1.lab.fp.foo.com"
https_port 整数	设备管理界面上可用的 HTTPS 端口。 返回: changed 示例: 443
is_clustered 布尔值	该设备是否是集群设备。 返回: changed 示例: false
is_license_expired 布尔值	设备上的许可证是否已过期。 返回: changed 示例: true
is_virtual 布尔值	该设备是否是虚拟版本。 返回: changed 示例: true
machine_id 字符串	BIG-IQ 为此设备分配的特定于机器的 ID。 返回: changed 示例: "c141bc88-f734-4434-be64-a3e9ea98356e"
management_address 字符串	设备管理界面的 IP 地址。 返回: changed 示例: "10.10.10.10"
mcp_device_name 字符串	BIG-IP 上 MCPD 已知的设备名称。 返回: changed 示例: "/Common/tier2labB1.lab.fp.foo.com"
product 字符串	托管设备标识为的产品。 返回: changed 示例: "BIG-IP"
rest_framework_version 字符串	设备上运行的 REST 框架版本 返回: changed 示例: "13.1.1-0.0.4"
self_link 字符串	BIG-IQ 中对托管设备的内部引用。 返回: changed 示例: "https://127.0.0.1/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e"
slots 字典	设备上的卷和这些卷中安装的软件版本。 返回: changed 示例: {"build": "0.0.4", "isActive": "yes", "product": "BIG-IP", "version": "13.1.1", "volume": "HD1.1"}
state 字符串	设备的状态。 返回: changed 示例: "活动"
tags 字典	分配给设备的杂项标签。 返回: changed 示例: {"BIGIQ_SSG_name": "tim-ssg", "BIGIQ_tier_2_device": "2018-08-22T13:30:47.693-07:00"}
trust_domain_guid 字符串	设备所属的信任域的 GUID。 返回: changed 示例: "40ddf541-e604-4905-bde3005056813e36"
uuid 字符串	BIG-IQ 中设备的 UUID。 返回: changed 示例: "c141bc88-f734-4434-be64-a3e9ea98356e"
version 字符串	设备上安装的 TMOS 版本。 返回: changed 示例: "13.1.1"
purchased_pool_licenses 复杂	已购买的许可证池相关信息。 返回: 当在 gather_subset 中指定 purchased-pool-licenses 时。 示例: "值的哈希/字典"
base_reg_key 字符串	已购买的池的基本注册密钥 返回: changed 示例: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
dossier 字符串	已购买的许可证池的卷宗 返回: changed 示例: "d6bd4b8ba5...e9a1a1199b73af9932948a"
evaluation_end_date_time 字符串	评估许可证结束的日期。 返回: changed 示例: "2018-10-11T00:00:00-07:00"
evaluation_start_date_time 字符串	评估许可证开始的日期。 返回: changed 示例: "2018-09-09T00:00:00-07:00"
free_device_licenses 整数	剩余的免费许可证数量。 返回: changed 示例: 34
license_end_date_time 字符串	许可证过期的日期。 返回: changed 示例: "2018-10-11T00:00:00-07:00"
license_start_date_time 字符串	许可证开始的日期。 返回: changed 示例: "2018-09-09T00:00:00-07:00"
licensed_date_time 字符串	池获得许可的时间戳。 返回: changed 示例: "2018-09-10T00:00:00-07:00"
licensed_version 字符串	获得许可的 BIG-IQ 版本。 返回: changed 示例: "6.0.1"
name 字符串	已购买的池的名称 返回: changed 示例: "my-pool1"
registration_key 字符串	已购买的许可证池密钥。 返回: changed 示例: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
state 字符串	已购买的许可证池的状态 返回: changed 示例: "已许可"
total_device_licenses 整数	池中的许可证总数。 返回: changed 示例: 40
uuid 字符串	已购买的许可证池的 UUID 返回: changed 示例: "b2112329-cba7-4f1f-9a26-fab9be416d60"
vendor 字符串	提供许可证的供应商 返回: changed 示例: "F5 Networks, Inc"
regkey_pools 复杂	Regkey 池相关信息。 返回: 当在 gather_subset 中指定 regkey-pools 时。 示例: "值的哈希/字典"
id 字符串	regkey 池的 ID。 返回: changed 示例: "4f9b565c-0831-4657-b6c2-6dde6182a502"
name 字符串	regkey 池的名称。 返回: changed 示例: "pool1"
offerings 复杂	池中的产品列表。 返回: 成功 示例: "值的哈希/字典"
dossier 字符串	许可证的卷宗。 返回: changed 示例: "d6bd4b8ba5...e9a1a1199b73af9932948a"
evaluation_end_date_time 字符串	评估许可证结束的日期。 返回: changed 示例: "2018-10-11T00:00:00-07:00"
evaluation_start_date_time 字符串	评估许可证开始的日期。 返回: changed 示例: "2018-09-09T00:00:00-07:00"
license_end_date_time 字符串	许可证过期的日期。 返回: changed 示例: "2018-10-11T00:00:00-07:00"
license_start_date_time 字符串	许可证开始的日期。 返回: changed 示例: "2018-09-09T00:00:00-07:00"
licensed_date_time 字符串	regkey 获得许可的时间戳。 返回: changed 示例: "2018-09-10T00:00:00-07:00"
licensed_version 字符串	获得许可的 BIG-IQ 版本。 返回: changed 示例: "6.0.1"
name 字符串	regkey 的名称。 返回: changed 示例: "regkey1"
registration_key 字符串	注册许可证密钥。 返回: changed 示例: "XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX"
state 字符串	regkey 许可证的状态 返回: changed 示例: "已许可"
total_offerings 整数	池中的产品总数 返回: changed 示例： 10
system_info 复杂	与系统信息相关的信息。 返回： 当 gather_subset 中指定了 system-info 时返回。 示例: "值的哈希/字典"
base_mac_address 字符串	设备的媒体访问控制地址（MAC 地址）。 返回: changed 示例： "fa:16:3e:c3:42:6f"
chassis_serial 字符串	机箱的序列号 返回: 成功 示例： "11111111-2222-3333-444444444444"
hardware_information 复杂	与系统硬件（驱动器和 CPU）相关的信息。 返回: changed
model 字符串	硬件的型号。 返回: 成功 示例： "Virtual Disk"
name 字符串	硬件的名称。 返回: 成功 示例： "HD1"
type 字符串	硬件的类型。 返回: 成功 示例： "physical-disk"
versions 复杂	硬件特定属性 返回: 成功
name 字符串	属性的名称 返回: 成功 示例： "Size"
version 字符串	属性的值 返回: 成功 示例： "154.00G"
host_board_part_revision 字符串	主机板的修订版本。 返回: 成功
host_board_serial 字符串	主机板的序列号。 返回: 成功
is_admin_password_changed 布尔值	管理员密码是否已从默认值更改。 返回: changed 示例: true
is_root_password_changed 布尔值	root 密码是否已从默认值更改。 返回: changed 示例: false
is_system_setup 布尔值	系统是否已设置。 返回: changed 示例: true
marketing_name 字符串	设备平台的市场名称。 返回: changed 示例： "BIG-IQ Virtual Edition"
package_edition 字符串	显示软件版本。 返回: changed 示例： "Point Release 7"
package_version 字符串	一个组合了 product_build 和 product_build_date 的字符串。 返回: 成功 示例： "Build 0.0.1 - Tue May 15 15:26:30 PDT 2018"
platform 字符串	平台标识符。 返回: 成功 示例： "Z100"
product_build 字符串	发布版本的构建版本。 返回: 成功 示例： "0.0.1"
product_build_date 字符串	人类可读的构建日期。 返回: 成功 示例： "Tue May 15 15:26:30 PDT 2018"
product_built 整数	产品构建时的 Unix 时间戳。 返回: 成功 示例： 180515152630
product_changelist 整数	产品分支的更改列表。 BIGIQ 7.0 及更高版本不支持 返回: 成功 示例： 2557198
product_code 字符串	标识产品的代码。 返回: 成功 示例： "BIG-IQ"
product_jobid 整数	构建产品版本的工作 ID。 BIGIQ 7.0 及更高版本不支持 返回: 成功 示例： 1012030
product_version 字符串	正在运行的软件的主要产品版本。 返回: 成功 示例： "6.0.0"
switch_board_part_revision 字符串	交换机板修订版本。 返回: 成功
switch_board_serial 字符串	交换机板的序列号。 返回: 成功
time 复杂	将当前时间信息映射到特定的以时间命名的键。 返回: changed
day 整数	当前月份的日期，以数字形式表示。 返回: changed 示例： 7
hour 整数	当前一天的小时数，以 24 小时制表示。 返回: changed 示例： 18
minute 整数	当前小时的分钟数。 返回: changed 示例： 16
month 整数	当前月份，以数字形式表示。 返回: changed 示例： 6
second 整数	当前分钟的秒数。 返回: changed 示例： 51
year 整数	当前年份，以 4 位数字形式表示。 返回: changed 示例： 2018
uptime 整数	自系统启动以来经过的时间，以秒为单位。 BIGIQ 7.0 及更高版本不支持 返回: 成功 示例： 603202
vlans 复杂	VLAN 信息列表。 返回： 当 gather_subset 中指定了 vlans 时返回。 示例: "值的哈希/字典"
auto_lasthop 字符串	允许系统将返回流量发送到传输请求的 MAC 地址，即使路由表指向不同的网络或接口。 返回: changed 示例： "enabled"
cmp_hash_algorithm 字符串	指定如何在 VLAN 上分离流量。 返回: changed 示例： "default"
description 字符串	VLAN 的描述。 返回: changed 示例： "My vlan"
failsafe_action 字符串	当触发故障安全机制时，系统应采取的措施。 返回: changed 示例： "reboot"
failsafe_enabled 布尔值	是否启用故障安全。 返回: changed 示例: true
failsafe_timeout 整数	活动单元在检测到此 VLAN 上的网络流量之前可以运行的秒数，之后它将启动故障转移。 返回: changed 示例： 90
if_index 整数	分配给此 VLAN 的索引。它是为 SNMP IF-MIB 中显示的所有对象分配的唯一标识符。 返回: changed 示例： 176
interfaces 复杂	要为 VLAN 配置的已标记或未标记的接口和中继列表。 返回: changed
full_path 字符串	BIG-IP 已知的资源的完整名称。 返回: changed 示例： "1.3"
name 字符串	BIG-IP 中资源的相对名称。 返回: changed 示例： "1.3"
tagged 布尔值	接口是否已标记。 返回: changed 示例: false
learning_mode 字符串	放置在 VLAN 中的交换机端口配置为交换机学习、仅转发还是丢弃。 返回: changed 示例： "enable-forward"
mtu 整数	VLAN 的特定最大传输单元 (MTU)。 返回: changed 示例： 1500
sflow_poll_interval 整数	两次轮询之间的最大间隔（以秒为单位）。 返回: changed 示例: 0
sflow_poll_interval_global 布尔值	全局 VLAN 轮询间隔设置是否覆盖对象级别的轮询间隔设置。 返回: changed 示例: false
sflow_sampling_rate 整数	观察到的数据包与生成的样本的比率。 返回: changed 示例: 0
sflow_sampling_rate_global 布尔值	全局 VLAN 采样率设置是否覆盖对象级别的采样率设置。 返回: changed 示例: true
source_check_enabled 布尔值	指定仅接受在路由表中具有返回路由的连接。 返回: changed 示例: true
tag 整数	VLAN 的标签号。 返回: changed 示例： 30
true_mac_address 字符串	分配给此 VLAN 的编号最小的接口的媒体访问控制 (MAC) 地址。 返回: changed 示例： "fa:16:3e:10:da:ff"

作者

• Tim Rupp (@caphrim007)

集合链接

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