Last updated on: 2024-04-01 03:24:20.
f5os_device_info – Collect information from F5OS devices¶
New in version 1.0.0.
Parameters¶
| Parameter | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
gather_subset
list
/ elements=string / required
|
|
When supplied, this argument restricts the information returned to a given subset.
You can specify a list of values to include a larger subset.
Values can also be used with an initial
! to specify that a specific subset should not be collected.aliases: include |
Examples¶
- name: Collect interface and vlan information on F5OS device
f5os_device_info:
gather_subset:
- interfaces
- vlans
- name: Collect all F5OS device information
f5os_device_info:
gather_subset:
- all
- name: Collect all F5OS device information except system-info
f5os_device_info:
gather_subset:
- all
- "!system-info"
Return Values¶
The following are the fields unique to this module:
| Key | Returned | Description | |||
|---|---|---|---|---|---|
|
interfaces
complex
|
When interfaces is specified in gather_subset. |
Information about interfaces on the platform.
Sample:
hash/dictionary of values
|
|||
|
admin_status
string
|
queried |
Returns the interface admin status as set by the user.
Sample:
DOWN
|
|||
|
enabled
boolean
|
queried |
Indicates if the interface is enabled.
Sample:
True
|
|||
|
l2_counters
dictionary
|
queried |
Frames interface counters.
Sample:
hash/dictionary of values
|
|||
|
in-8021q-frames
string
|
queried |
Number of incoming 802.1Q frames.
|
|||
|
in-crc-errors
string
|
queried |
Number of incoming frames with cyclic redundancy check error
|
|||
|
in-fragment-frames
string
|
queried |
Number of incoming fragment frames.
|
|||
|
in-jabber-frames
string
|
queried |
Number of incoming jabber frames.
|
|||
|
in-mac-control-frames
string
|
queried |
Number of incoming mac control frames.
|
|||
|
in-mac-pause-frames
string
|
queried |
Number of incoming mac pause frames.
|
|||
|
in-oversize-frames
string
|
queried |
Number of incoming oversize frames.
|
|||
|
out-8021q-frames
string
|
queried |
Number of outbound 802.1Q frames.
|
|||
|
out-mac-control-frames
string
|
queried |
Number of outbound mac control frames.
|
|||
|
out-mac-pause-frames
string
|
queried |
Number of outbound mac pause frames.
|
|||
|
l3_counters
dictionary
|
queried |
Packets interface counters.
Sample:
hash/dictionary of values
|
|||
|
in-broadcast-pkts
string
|
queried |
Number of broadcasts packets received.
|
|||
|
in-discards
string
|
queried |
Number of inbound packets discarded for reasons other than content error.
|
|||
|
in-errors
string
|
queried |
Number of inbound packets discarded for content error.
|
|||
|
in-fcs-errors
string
|
queried |
Number of inbound packets with frame check sequence error.
|
|||
|
in-multicast-pkts
string
|
queried |
Number of multicast packets received.
|
|||
|
in-octets
string
|
queried |
Number of octets received.
|
|||
|
in-unicast-pkts
string
|
queried |
Number of unicast packets received.
|
|||
|
out-broadcast-pkts
string
|
queried |
Number of outbound broadcast packets.
|
|||
|
out-discards
string
|
queried |
Number of outbound packets discarded for reasons other than content error.
|
|||
|
out-errors
string
|
queried |
Number of outbound packets discarded for content errors.
|
|||
|
out-multicast-pkts
string
|
queried |
Number of outbound multicast packets.
|
|||
|
out-octets
string
|
queried |
Number of outbound octets.
|
|||
|
out-unicast-pkts
string
|
queried |
Number of outbound unicast packets.
|
|||
|
loopback_mode
boolean
|
queried |
Indicates if the interface is set in loopback mode.
|
|||
|
mac_address
string
|
queried |
Returns the MAC address of the interface.
Sample:
00:94:a1:69:4f:02
|
|||
|
name
string
|
queried |
Name of the interface as designated on the F5OS device.
Sample:
1.1
|
|||
|
operational_status
string
|
queried |
Returns the interface operational status.
Sample:
UP
|
|||
|
port_speed
string
|
queried |
Returns the set port speed of the interface.
Sample:
25G
|
|||
|
lag_interfaces
complex
|
When lag-interfaces is specified in gather_subset. |
Information about Link Aggregate Group (LAG) interfaces on the platform.
Sample:
hash/dictionary of values
|
|||
|
distribution_hash
string
|
queried |
The type of LAG hashing algorithm.
Sample:
src-dst-ipport
|
|||
|
enabled
boolean
|
queried |
Indicates if the LAG interface is enabled.
Sample:
True
|
|||
|
lag_speed
integer
|
queried |
Returns the speed of the LAG interface.
Sample:
100
|
|||
|
lag_type
string
|
queried |
Returns the type of LAG interface.
Sample:
STATIC
|
|||
|
mac_address
string
|
queried |
Returns the MAC address of the LAG interface.
Sample:
00:94:a1:69:5d:17
|
|||
|
members
dictionary
|
queried |
Returns the list of members of the LAG interface.
Sample:
hash/dictionary of values
|
|||
|
name
string
|
queried |
Name of the interface.
Sample:
1.0
|
|||
|
status
string
|
queried |
Status of the interface.
Sample:
DOWN
|
|||
|
mtu
integer
|
queried |
Returns the MTU value of the LAG interface.
Sample:
9600
|
|||
|
name
string
|
queried |
Name of the LAG interface as designated on the F5OS device.
Sample:
backbone_trunk
|
|||
|
native_vlan
integer
|
queried |
Returns the vlan id of the native vlan associated with the LAG interface.
Sample:
100
|
|||
|
operational_status
string
|
queried |
Returns the LAG interface operational status.
Sample:
UP
|
|||
|
trunk_vlans
list
|
queried |
Returns the list of vlan ids of trunk vlans associated with the LAG interface.
Sample:
[100, 200]
|
|||
|
system_info
complex
|
When system-info is specified in gather_subset. |
System Information on the F5OS platform.
Sample:
hash/dictionary of values
|
|||
|
components
complex
|
queried |
Specifies a list of components of the target platform.
Currently only blade, chassis, and controller components information is collected on VELOS platform.
General platform information is collected for rSeries devices.
|
|||
|
description
string
|
queried |
Full name of the platform.
Only collected on rSeries.
Sample:
r10900
|
|||
|
memory_usage
complex
|
queried |
Overall memory usage on the platform.
Sample:
hash/dictionary of values
|
|||
|
free
integer
|
queried |
Free memory in bytes available on the platform.
Sample:
17659666432
|
|||
|
total
integer
|
queried |
Total memory in bytes present on the platform.
Sample:
19356536832
|
|||
|
used_percent
integer
|
queried |
Percentage of used memory on the platform.
Sample:
25
|
|||
|
name
string
|
queried |
Name of the component.
Sample:
blade-1
|
|||
|
part_no
string
|
queried |
Part number of the component.
Sample:
000-9999-88 REV 99
|
|||
|
serial_no
string
|
queried |
Serial number of the component.
Sample:
f5-abcd-efgh
|
|||
|
system_temperature
complex
|
queried |
General information on system temperature, all values given in Celsius.
Sample:
hash/dictionary of values
|
|||
|
average
float
|
queried |
Average temperature measured on the system during its uptime.
Sample:
35.4
|
|||
|
current
float
|
queried |
Current temperature as measured on the system.
Sample:
25.4
|
|||
|
maximum
float
|
queried |
Maximum temperature recorded on the system during its uptime.
Sample:
39.2
|
|||
|
minimum
float
|
queried |
Minimum temperature recorded on the system during its uptime.
Sample:
20.1
|
|||
|
installed_license
complex
|
queried |
License information as present on the platform.
Sample:
hash/dictionary of values
|
|||
|
base_registration_key
string
|
queried |
Base registration key of the license.
Sample:
YYYYY-XXXXX-FFFFF-GGGG-JJJJJJ
|
|||
|
dossier
string
|
queried |
Dossier generated by device.
Sample:
01350fe7daea9e21a4ee
|
|||
|
license_date
string
|
queried |
Date when the system was licensed.
Sample:
2021/08/01
|
|||
|
service_check_date
string
|
queried |
Date when last service check was performed on the license.
Sample:
2021/12/01
|
|||
|
platform_type
string
|
queried |
Type of platform on which the info is being gathered.
Sample:
rSeries Platform
|
|||
|
running_software
complex
|
queried |
Information on the current version of F5OS software running on the device.
Sample:
hash/dictionary of values
|
|||
|
blade_name
string
|
queried |
Blade on which the software is running.
This is only collected when querying VELOS partitions.
Sample:
blade-1
|
|||
|
controller_name
string
|
queried |
Controller on which the software is running.
This is only collected when querying VELOS controllers.
Sample:
controller-1
|
|||
|
os_version
string
|
queried |
Version of OS component in the current running software.
Sample:
1.3.2-9645
|
|||
|
service_version
string
|
queried |
Version of service component in the current running software.
Sample:
1.3.2-9645
|
|||
|
tenant_images
complex
|
When tenant-images is specified in gather_subset. |
Information about tenant images uploaded on the F5OS platform.
Sample:
hash/dictionary of values
|
|||
|
in_use
boolean
|
queried |
Indicates if the tenant image is currently in use.
|
|||
|
name
string
|
queried |
Name of the uploaded ISO file.
Sample:
BIGIP-15.1.5-0.0.10.ALL-F5OS.qcow2.zip.bundle
|
|||
|
status
string
|
queried |
Status of the uploaded tenant image ISO.
Sample:
verified
|
|||
|
velos_controller_images
complex
|
When controller-images is specified in gather_subset. |
Information about F5OS controller ISO images uploaded on the VELOS controller.
Sample:
hash/dictionary of values
|
|||
|
os
string
|
queried |
Version of OS component in the uploaded ISO file.
Sample:
1.2.1-10781
|
|||
|
service
string
|
queried |
Version of service component in the uploaded ISO file.
Sample:
1.2.1-10781
|
|||
|
version
string
|
queried |
Version of the uploaded ISO file.
Sample:
1.2.1-10781
|
|||
|
velos_partition_images
complex
|
When partition-images is specified in gather_subset. |
Information about F5OS partition ISO images uploaded on the VELOS controller.
Sample:
hash/dictionary of values
|
|||
|
os
string
|
queried |
Version of OS component in the uploaded F5OS ISO file.
Sample:
1.2.1-10781
|
|||
|
service
string
|
queried |
Version of service component in the uploaded F5OS ISO file.
Sample:
1.2.1-10781
|
|||
|
version
string
|
queried |
Version of the uploaded F5OS ISO file.
Sample:
1.2.1-10781
|
|||
|
vlans
complex
|
When vlans is specified in gather_subset. |
Information about VLANs on the platform.
Sample:
hash/dictionary of values
|
|||
|
name
string
|
queried |
Name of the VLAN
Sample:
vlan-444
|
|||
|
vlan_id
integer
|
queried |
VLAN tag as configured on device.
Sample:
444
|
|||