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。

要在剧本中使用它，请指定：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 列表 / 元素=字符串 / 必需	提供此参数时，它会将返回的信息限制为给定的子集。 您可以指定一个值列表以包含更大的子集。 值也可以与初始 ! 一起使用，以指定不应收集特定子集。 选项 "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 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在使用 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 ← (默认)

备注

注意

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

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

作者

• Tim Rupp (@caphrim007)

资源链接

• 问题跟踪器
• 主页
• 代码仓库