Try SpotterCollect information from F5 BIG-IQ devices
| "added in version" 1.0.0 of f5networks.f5_bigip"
Authors: Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_bigip:==3.4.0
collections:
- name: f5networks.f5_bigip
version: 3.4.0Collect information from F5 BIG-IQ devices.
- name: Collect BIG-IQ information
bigiq_device_info:
gather_subset:
- system-info
- vlans
- name: Collect all BIG-IQ information
bigiq_device_info:
gather_subset:
- all
- name: Collect all BIG-IQ information except vlans
bigiq_device_info:
gather_subset:
- all
- "!vlans"
gather_subset:
choices:
- all
- applications
- managed-devices
- purchased-pool-licenses
- regkey-pools
- system-info
- vlans
- '!all'
- '!applications'
- '!managed-devices'
- '!purchased-pool-licenses'
- '!regkey-pools'
- '!system-info'
- '!vlans'
description:
- 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 C(!) to specify a specific subset should
not be collected.
elements: str
required: true
type: list
applications:
contains:
active_alerts:
description:
- Number of alerts active on the application.
returned: changed
sample: 0
type: int
bad_traffic:
description:
- Percent of traffic to application that is determined to be 'bad'.
- This value is dependent on C(protection_mode) being enabled.
returned: changed
sample: 1.7498
type: float
bad_traffic_growth:
description:
- Whether or not Bad Traffic Growth alerts are configured to be triggered or
not.
returned: changed
sample: false
type: bool
connections:
description:
- Current number of connections established to the application.
returned: changed
sample: 3.06
type: float
enhanced_analytics:
description:
- Whether enhanced analytics is enabled for the application or not.
returned: changed
sample: true
type: bool
health:
description:
- Health of the application.
returned: changed
sample: Good
type: str
id:
description:
- ID of the application as known to the BIG-IQ.
returned: changed
sample: 996baae8-5d1d-3662-8a2d-3612fa2aceae
type: str
name:
description:
- Name of the application.
returned: changed
sample: site12http.example.com
type: str
new_connections:
description:
- Number of new connections being established per second.
returned: changed
sample: 0.35
type: float
protection_mode:
description:
- The type of F5 Web Application Security Service protection on the application.
returned: changed
sample: Not Protected
type: str
response_time:
description:
- Measured response time of the application in milliseconds.
returned: changed
sample: 0.02
type: float
status:
description:
- Current state of the application.
returned: changed
sample: DEPLOYED
type: str
transactions_per_second:
description:
- Current measurement of Transactions Per second being handled by the application.
returned: changed
sample: 0.87
type: float
description: Application related information
returned: When C(managed-devices) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex
managed_devices:
contains:
address:
description:
- Address where the device was discovered.
returned: changed
sample: 10.10.10.10
type: str
build:
description:
- Build of the version.
returned: changed
sample: 0.0.4
type: str
device_uri:
description:
- URI to reach the management interface of the device.
returned: changed
sample: https://10.10.10.10:443
type: str
edition:
description:
- Edition string of the product version.
returned: changed
sample: Final
type: str
group_name:
description:
- BIG-IQ group that the device is a member of.
returned: changed
sample: cm-bigip-allBigIpDevices
type: str
hostname:
description:
- Discovered hostname of the device.
returned: changed
sample: tier2labB1.lab.fp.foo.com
type: str
https_port:
description:
- HTTPS port available on the management interface of the device.
returned: changed
sample: 443
type: int
is_clustered:
description:
- Whether the device is clustered or not.
returned: changed
sample: false
type: bool
is_license_expired:
description:
- Whether the license on the device is expired or not.
returned: changed
sample: true
type: bool
is_virtual:
description:
- Whether the device is a virtual edition or not.
returned: changed
sample: true
type: bool
machine_id:
description:
- Machine specific ID assigned to this device by BIG-IQ.
returned: changed
sample: c141bc88-f734-4434-be64-a3e9ea98356e
type: str
management_address:
description:
- IP address of the management interface on the device.
returned: changed
sample: 10.10.10.10
type: str
mcp_device_name:
description:
- Device name as known by MCPD on the BIG-IP.
returned: changed
sample: /Common/tier2labB1.lab.fp.foo.com
type: str
product:
description:
- Product that the managed device is identified as.
returned: changed
sample: BIG-IP
type: str
rest_framework_version:
description:
- REST framework version running on the device
returned: changed
sample: 13.1.1-0.0.4
type: str
self_link:
description:
- Internal reference to the managed device in BIG-IQ.
returned: changed
sample: https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e
type: str
slots:
description:
- Volumes on the device and versions of software installed in those volumes.
returned: changed
sample:
build: 0.0.4
isActive: 'yes'
product: BIG-IP
version: 13.1.1
volume: HD1.1
type: dict
state:
description:
- State of the device.
returned: changed
sample: ACTIVE
type: str
tags:
description:
- Misc tags that are assigned to the device.
returned: changed
sample:
BIGIQ_SSG_name: tim-ssg
BIGIQ_tier_2_device: '2018-08-22T13:30:47.693-07:00'
type: dict
trust_domain_guid:
description:
- GUID of the trust domain the device is part of.
returned: changed
sample: 40ddf541-e604-4905-bde3005056813e36
type: str
uuid:
description:
- UUID of the device in BIG-IQ.
returned: changed
sample: c141bc88-f734-4434-be64-a3e9ea98356e
type: str
version:
description:
- Version of TMOS installed on the device.
returned: changed
sample: 13.1.1
type: str
description: Managed device related information.
returned: When C(managed-devices) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex
purchased_pool_licenses:
contains:
base_reg_key:
description:
- Base registration key of the purchased pool
returned: changed
sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
type: str
dossier:
description:
- Dossier of the purchased pool license
returned: changed
sample: d6bd4b8ba5...e9a1a1199b73af9932948a
type: str
evaluation_end_date_time:
description:
- Date that evaluation license ends.
returned: changed
sample: '2018-10-11T00:00:00-07:00'
type: str
evaluation_start_date_time:
description:
- Date that evaluation license starts.
returned: changed
sample: '2018-09-09T00:00:00-07:00'
type: str
free_device_licenses:
description:
- Number of free licenses remaining.
returned: changed
sample: 34
type: int
license_end_date_time:
description:
- Date that the license expires.
returned: changed
sample: '2018-10-11T00:00:00-07:00'
type: str
license_start_date_time:
description:
- Date that the license starts.
returned: changed
sample: '2018-09-09T00:00:00-07:00'
type: str
licensed_date_time:
description:
- Timestamp that the pool was licensed.
returned: changed
sample: '2018-09-10T00:00:00-07:00'
type: str
licensed_version:
description:
- Version of BIG-IQ that is licensed.
returned: changed
sample: 6.0.1
type: str
name:
description:
- Name of the purchased pool
returned: changed
sample: my-pool1
type: str
registration_key:
description:
- Purchased pool license key.
returned: changed
sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
type: str
state:
description:
- State of the purchased pool license
returned: changed
sample: LICENSED
type: str
total_device_licenses:
description:
- Total number of licenses in the pool.
returned: changed
sample: 40
type: int
uuid:
description:
- UUID of the purchased pool license
returned: changed
sample: b2112329-cba7-4f1f-9a26-fab9be416d60
type: str
vendor:
description:
- Vendor who provided the license
returned: changed
sample: F5 Networks, Inc
type: str
description: Purchased Pool License related information.
returned: When C(purchased-pool-licenses) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex
regkey_pools:
contains:
id:
description:
- ID of the regkey pool.
returned: changed
sample: 4f9b565c-0831-4657-b6c2-6dde6182a502
type: str
name:
description:
- Name of the regkey pool.
returned: changed
sample: pool1
type: str
offerings:
contains:
dossier:
description:
- Dossier of the license.
returned: changed
sample: d6bd4b8ba5...e9a1a1199b73af9932948a
type: str
evaluation_end_date_time:
description:
- Date that evaluation license ends.
returned: changed
sample: '2018-10-11T00:00:00-07:00'
type: str
evaluation_start_date_time:
description:
- Date that evaluation license starts.
returned: changed
sample: '2018-09-09T00:00:00-07:00'
type: str
license_end_date_time:
description:
- Date that the license expires.
returned: changed
sample: '2018-10-11T00:00:00-07:00'
type: str
license_start_date_time:
description:
- Date that the license starts.
returned: changed
sample: '2018-09-09T00:00:00-07:00'
type: str
licensed_date_time:
description:
- Timestamp that the regkey was licensed.
returned: changed
sample: '2018-09-10T00:00:00-07:00'
type: str
licensed_version:
description:
- Version of BIG-IQ that is licensed.
returned: changed
sample: 6.0.1
type: str
name:
description:
- Name of the regkey.
returned: changed
sample: regkey1
type: str
registration_key:
description:
- Registration license key.
returned: changed
sample: XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
type: str
state:
description:
- State of the regkey license
returned: changed
sample: LICENSED
type: str
description: List of the offerings in the pool.
sample: hash/dictionary of values
type: complex
total_offerings:
description:
- Total number of offerings in the pool
returned: changed
sample: 10
type: int
description: Regkey Pool related information.
returned: When C(regkey-pools) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex
system_info:
contains:
base_mac_address:
description:
- Media Access Control address (MAC address) of the device.
returned: changed
sample: fa:16:3e:c3:42:6f
type: str
chassis_serial:
description:
- Serial of the chassis
sample: 11111111-2222-3333-444444444444
type: str
hardware_information:
contains:
model:
description:
- The model of the hardware.
sample: Virtual Disk
type: str
name:
description:
- The name of the hardware.
sample: HD1
type: str
type:
description:
- The type of hardware.
sample: physical-disk
type: str
versions:
contains:
name:
description:
- Name of the property
sample: Size
type: str
version:
description:
- Value of the property
sample: 154.00G
type: str
description:
- Hardware specific properties
type: complex
description:
- Information related to the hardware (drives and CPUs) of the system.
returned: changed
type: complex
host_board_part_revision:
description:
- Revision of the host board.
type: str
host_board_serial:
description:
- Serial of the host board.
type: str
is_admin_password_changed:
description:
- Whether the admin password was changed from its default or not.
returned: changed
sample: true
type: bool
is_root_password_changed:
description:
- Whether the root password was changed from its default or not.
returned: changed
sample: false
type: bool
is_system_setup:
description:
- Whether the system has been setup or not.
returned: changed
sample: true
type: bool
marketing_name:
description:
- Marketing name of the device platform.
returned: changed
sample: BIG-IQ Virtual Edition
type: str
package_edition:
description:
- Displays the software edition.
returned: changed
sample: Point Release 7
type: str
package_version:
description:
- A string combining the C(product_build) and C(product_build_date).
sample: Build 0.0.1 - Tue May 15 15:26:30 PDT 2018
type: str
platform:
description:
- Platform identifier.
sample: Z100
type: str
product_build:
description:
- Build version of the release version.
sample: 0.0.1
type: str
product_build_date:
description:
- Human readable build date.
sample: Tue May 15 15:26:30 PDT 2018
type: str
product_code:
description:
- Code identifying the product.
sample: BIG-IQ
type: str
product_version:
description:
- Major product version of the running software.
sample: 6.0.0
type: str
switch_board_part_revision:
description:
- Switch board revision.
type: str
switch_board_serial:
description:
- Serial of the switch board.
type: str
time:
contains:
day:
description:
- The current day of the month, in numeric form.
returned: changed
sample: 7
type: int
hour:
description:
- The current hour of the day in 24-hour form.
returned: changed
sample: 18
type: int
minute:
description:
- The current minute of the hour.
returned: changed
sample: 16
type: int
month:
description:
- The current month, in numeric form.
returned: changed
sample: 6
type: int
second:
description:
- The current second of the minute.
returned: changed
sample: 51
type: int
year:
description:
- The current year in 4-digit form.
returned: changed
sample: 2018
type: int
description:
- Mapping of the current time information to specific time-named keys.
returned: changed
type: complex
description: System info related information.
returned: When C(system-info) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex
vlans:
contains:
auto_lasthop:
description:
- Allows the system to send return traffic to the MAC address that transmitted
the request, even if the routing table points to a different network or interface.
returned: changed
sample: enabled
type: str
cmp_hash_algorithm:
description:
- Specifies how the traffic on the VLAN will be disaggregated.
returned: changed
sample: default
type: str
description:
description:
- Description of the VLAN.
returned: changed
sample: My vlan
type: str
failsafe_action:
description:
- Action for the system to take when the fail-safe mechanism is triggered.
returned: changed
sample: reboot
type: str
failsafe_enabled:
description:
- Whether failsafe is enabled or not.
returned: changed
sample: true
type: bool
failsafe_timeout:
description:
- Number of seconds that an active unit can run without detecting network traffic
on this VLAN before it starts a failover.
returned: changed
sample: 90
type: int
if_index:
description:
- Index assigned to this VLAN. It is a unique identifier assigned for all objects
displayed in the SNMP IF-MIB.
returned: changed
sample: 176
type: int
interfaces:
contains:
full_path:
description:
- Full name of the resource as known to BIG-IP.
returned: changed
sample: 1.3
type: str
name:
description:
- Relative name of the resource in BIG-IP.
returned: changed
sample: 1.3
type: str
tagged:
description:
- Whether the interface is tagged or not.
returned: changed
sample: false
type: bool
description:
- List of tagged or untagged interfaces and trunks that you want to configure
for the VLAN.
returned: changed
type: complex
learning_mode:
description:
- Whether switch ports placed in the VLAN are configured for switch learning,
forwarding only, or dropped.
returned: changed
sample: enable-forward
type: str
mtu:
description:
- Specific maximum transition unit (MTU) for the VLAN.
returned: changed
sample: 1500
type: int
sflow_poll_interval:
description:
- Maximum interval in seconds between two pollings.
returned: changed
sample: 0
type: int
sflow_poll_interval_global:
description:
- Whether the global VLAN poll-interval setting, overrides the object-level
poll-interval setting.
returned: changed
sample: false
type: bool
sflow_sampling_rate:
description:
- Ratio of packets observed to the samples generated.
returned: changed
sample: 0
type: int
sflow_sampling_rate_global:
description:
- Whether the global VLAN sampling-rate setting, overrides the object-level
sampling-rate setting.
returned: changed
sample: true
type: bool
source_check_enabled:
description:
- Specifies that only connections that have a return route in the routing table
are accepted.
returned: changed
sample: true
type: bool
tag:
description:
- Tag number for the VLAN.
returned: changed
sample: 30
type: int
true_mac_address:
description:
- Media access control (MAC) address for the lowest-numbered interface assigned
to this VLAN.
returned: changed
sample: fa:16:3e:10:da:ff
type: str
description: List of VLAN information.
returned: When C(vlans) is specified in C(gather_subset).
sample: hash/dictionary of values
type: complex