f5networks / f5networks.f5os / 1.7.0 / module / f5os_device_info Collect information from F5OS devices | "added in version" 1.0.0 of f5networks.f5os" Authors: Wojciech Wypior (@wojtek0806)f5networks.f5os.f5os_device_info (1.7.0) — module
Install with ansible-galaxy collection install f5networks.f5os:==1.7.0
collections: - name: f5networks.f5os version: 1.7.0
Collect information from F5OS devices.
- 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"
gather_subset: aliases: - include choices: - all - interfaces - lag-interfaces - vlans - controller-images - partition-images - tenant-images - system-info - '!all' - '!interfaces' - '!lag-interfaces' - '!vlans' - '!controller-images' - '!partition-images' - '!tenant-images' - '!system-info' 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 that a specific subset should not be collected. elements: str required: true type: list
interfaces: contains: admin_status: description: - Returns the interface admin status as set by the user. returned: queried sample: DOWN type: str enabled: description: - Indicates if the interface is enabled. returned: queried sample: true type: bool l2_counters: contains: in-8021q-frames: description: Number of incoming 802.1Q frames. returned: queried sample: 0 type: str in-crc-errors: description: Number of incoming frames with cyclic redundancy check error returned: queried sample: 0 type: str in-fragment-frames: description: Number of incoming fragment frames. returned: queried sample: 0 type: str in-jabber-frames: description: Number of incoming jabber frames. returned: queried sample: 0 type: str in-mac-control-frames: description: Number of incoming mac control frames. returned: queried sample: 0 type: str in-mac-pause-frames: description: Number of incoming mac pause frames. returned: queried sample: 0 type: str in-oversize-frames: description: Number of incoming oversize frames. returned: queried sample: 0 type: str out-8021q-frames: description: Number of outbound 802.1Q frames. returned: queried sample: 0 type: str out-mac-control-frames: description: Number of outbound mac control frames. returned: queried sample: 0 type: str out-mac-pause-frames: description: Number of outbound mac pause frames. returned: queried sample: 0 type: str description: Frames interface counters. returned: queried sample: hash/dictionary of values type: dict l3_counters: contains: in-broadcast-pkts: description: Number of broadcasts packets received. returned: queried sample: 0 type: str in-discards: description: Number of inbound packets discarded for reasons other than content error. returned: queried sample: 0 type: str in-errors: description: Number of inbound packets discarded for content error. returned: queried sample: 0 type: str in-fcs-errors: description: Number of inbound packets with frame check sequence error. returned: queried sample: 0 type: str in-multicast-pkts: description: Number of multicast packets received. returned: queried sample: 0 type: str in-octets: description: Number of octets received. returned: queried sample: 0 type: str in-unicast-pkts: description: Number of unicast packets received. returned: queried sample: 0 type: str out-broadcast-pkts: description: Number of outbound broadcast packets. returned: queried sample: 0 type: str out-discards: description: Number of outbound packets discarded for reasons other than content error. returned: queried sample: 0 type: str out-errors: description: Number of outbound packets discarded for content errors. returned: queried sample: 0 type: str out-multicast-pkts: description: Number of outbound multicast packets. returned: queried sample: 0 type: str out-octets: description: Number of outbound octets. returned: queried sample: 0 type: str out-unicast-pkts: description: Number of outbound unicast packets. returned: queried sample: 0 type: str description: - Packets interface counters. returned: queried sample: hash/dictionary of values type: dict loopback_mode: description: - Indicates if the interface is set in loopback mode. returned: queried sample: false type: bool mac_address: description: - Returns the MAC address of the interface. returned: queried sample: 00:94:a1:69:4f:02 type: str name: description: - Name of the interface as designated on the F5OS device. returned: queried sample: 1.1 type: str operational_status: description: - Returns the interface operational status. returned: queried sample: UP type: str port_speed: description: - Returns the set port speed of the interface. returned: queried sample: 25G type: str description: Information about interfaces on the platform. returned: When C(interfaces) is specified in C(gather_subset). sample: hash/dictionary of values type: complex lag_interfaces: contains: distribution_hash: description: - The type of LAG hashing algorithm. returned: queried sample: src-dst-ipport type: str enabled: description: - Indicates if the LAG interface is enabled. returned: queried sample: true type: bool lag_speed: description: - Returns the speed of the LAG interface. returned: queried sample: 100 type: int lag_type: description: - Returns the type of LAG interface. returned: queried sample: STATIC type: str mac_address: description: - Returns the MAC address of the LAG interface. returned: queried sample: 00:94:a1:69:5d:17 type: str members: contains: name: description: - Name of the interface. returned: queried sample: '1.0' type: str status: description: - Status of the interface. returned: queried sample: DOWN type: str description: - Returns the list of members of the LAG interface. returned: queried sample: hash/dictionary of values type: dict mtu: description: - Returns the MTU value of the LAG interface. returned: queried sample: 9600 type: int name: description: - Name of the LAG interface as designated on the F5OS device. returned: queried sample: backbone_trunk type: str native_vlan: description: - Returns the vlan id of the native vlan associated with the LAG interface. returned: queried sample: 100 type: int operational_status: description: - Returns the LAG interface operational status. returned: queried sample: UP type: str trunk_vlans: description: - Returns the list of vlan ids of trunk vlans associated with the LAG interface. returned: queried sample: - 100 - 200 type: list description: Information about Link Aggregate Group (LAG) interfaces on the platform. returned: When C(lag-interfaces) is specified in C(gather_subset). sample: hash/dictionary of values type: complex system_info: contains: components: contains: description: description: - Full name of the platform. - Only collected on rSeries. returned: queried sample: r10900 type: str memory_usage: contains: free: description: Free memory in bytes available on the platform. returned: queried sample: 17659666432 type: int total: description: Total memory in bytes present on the platform. returned: queried sample: 19356536832 type: int used_percent: description: Percentage of used memory on the platform. returned: queried sample: 25 type: int description: Overall memory usage on the platform. returned: queried sample: hash/dictionary of values type: complex name: description: - Name of the component. returned: queried sample: blade-1 type: str part_no: description: - Part number of the component. returned: queried sample: 000-9999-88 REV 99 type: str serial_no: description: - Serial number of the component. returned: queried sample: f5-abcd-efgh type: str system_temperature: contains: average: description: Average temperature measured on the system during its uptime. returned: queried sample: 35.4 type: float current: description: Current temperature as measured on the system. returned: queried sample: 25.4 type: float maximum: description: Maximum temperature recorded on the system during its uptime. returned: queried sample: 39.2 type: float minimum: description: Minimum temperature recorded on the system during its uptime. returned: queried sample: 20.1 type: float description: General information on system temperature, all values given in Celsius. returned: queried sample: hash/dictionary of values type: complex description: - 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. returned: queried type: complex installed_license: contains: base_registration_key: description: Base registration key of the license. returned: queried sample: YYYYY-XXXXX-FFFFF-GGGG-JJJJJJ type: str dossier: description: Dossier generated by device. returned: queried sample: 01350fe7daea9e21a4ee type: str license_date: description: Date when the system was licensed. returned: queried sample: 2021/08/01 type: str service_check_date: description: Date when last service check was performed on the license. returned: queried sample: 2021/12/01 type: str description: License information as present on the platform. returned: queried sample: hash/dictionary of values type: complex platform_type: description: Type of platform on which the info is being gathered. returned: queried sample: rSeries Platform type: str running_software: contains: blade_name: description: - Blade on which the software is running. - This is only collected when querying VELOS partitions. returned: queried sample: blade-1 type: str controller_name: description: - Controller on which the software is running. - This is only collected when querying VELOS controllers. returned: queried sample: controller-1 type: str os_version: description: - Version of OS component in the current running software. returned: queried sample: 1.3.2-9645 type: str service_version: description: - Version of service component in the current running software. returned: queried sample: 1.3.2-9645 type: str description: Information on the current version of F5OS software running on the device. returned: queried sample: hash/dictionary of values type: complex description: System Information on the F5OS platform. returned: When C(system-info) is specified in C(gather_subset). sample: hash/dictionary of values type: complex tenant_images: contains: in_use: description: - Indicates if the tenant image is currently in use. returned: queried sample: false type: bool name: description: - Name of the uploaded ISO file. returned: queried sample: BIGIP-15.1.5-0.0.10.ALL-F5OS.qcow2.zip.bundle type: str status: description: - Status of the uploaded tenant image ISO. returned: queried sample: verified type: str description: Information about tenant images uploaded on the F5OS platform. returned: When C(tenant-images) is specified in C(gather_subset). sample: hash/dictionary of values type: complex velos_controller_images: contains: os: description: - Version of OS component in the uploaded ISO file. returned: queried sample: 1.2.1-10781 type: str service: description: - Version of service component in the uploaded ISO file. returned: queried sample: 1.2.1-10781 type: str version: description: - Version of the uploaded ISO file. returned: queried sample: 1.2.1-10781 type: str description: Information about F5OS controller ISO images uploaded on the VELOS controller. returned: When C(controller-images) is specified in C(gather_subset). sample: hash/dictionary of values type: complex velos_partition_images: contains: os: description: - Version of OS component in the uploaded F5OS ISO file. returned: queried sample: 1.2.1-10781 type: str service: description: - Version of service component in the uploaded F5OS ISO file. returned: queried sample: 1.2.1-10781 type: str version: description: - Version of the uploaded F5OS ISO file. returned: queried sample: 1.2.1-10781 type: str description: Information about F5OS partition ISO images uploaded on the VELOS controller. returned: When C(partition-images) is specified in C(gather_subset). sample: hash/dictionary of values type: complex vlans: contains: name: description: - Name of the VLAN returned: queried sample: vlan-444 type: str vlan_id: description: - VLAN tag as configured on device. returned: queried sample: 444 type: int description: Information about VLANs on the platform. returned: When C(vlans) is specified in C(gather_subset). sample: hash/dictionary of values type: complex