lparstat – Collects LPAR statistics using the lparstat command on AIX
Synopsis
Gather LPAR configuration, CPU, memory, hypervisor, and performance statistics using the AIX lparstat command.
Requirements
The below requirements are needed on the host that executes this module.
AIX >= 7.1
Parameters
- config_info (optional, bool, False)
Show general LPAR configuration information (-i).
- wpar_output (optional, bool, False)
Show Workload Partition (WPAR) information (-W).
- service_info (optional, bool, False)
Display service partition statistics (-s).
- energy_tuning (optional, bool, False)
Show energy tuning parameters (-P).
- security_mode (optional, bool, False)
Display extended security and environment information (-x).
- detailed_cpu_stats (optional, bool, False)
Show detailed CPU statistics (-d).
- memory_stats (optional, bool, False)
Display comprehensive memory statistics (-m).
- io_memory_pools (optional, bool, False)
Display I/O memory entitlement pool statistics (-e).
- page_coalescing (optional, bool, False)
Display page coalescing statistics (-p).
- page_coalescing_wide (optional, bool, False)
Wide output for page coalescing statistics (-w).
- reset_once (optional, bool, False)
Reset I/O memory entitlement high watermark once (-r).
- reset_each_interval (optional, bool, False)
Reset I/O memory entitlement high watermark at each interval (-R).
- hypervisor_stat_short (optional, bool, False)
Show short hypervisor statistics (-h).
- hypervisor_stat_long (optional, bool, False)
Show detailed hypervisor statistics (-H).
- export_xml (optional, bool, False)
Export output in XML format (-X).
- output_file (optional, str, None)
Path to the output file for XML or stored results.
- spurr_based_metrics (optional, bool, False)
Report SPURR-based CPU utilization (-E).
- spurr_based_metrics_wide (optional, bool, False)
Wide-format SPURR metrics (-Ew).
- timestamp (optional, bool, False)
Include timestamp in output (-t).
- micro_partition (optional, bool, False)
Display micro-partitioning statistics (-G).
- utilization (optional, bool, False)
Display CPU utilization (-u).
- interval (optional, int, None)
Interval (seconds) between samples.
- count (optional, int, None)
Number of samples collected.
- concatenated_output (True, bool, None)
Whether to append output to the recorded file.
- recorded_output (optional, str, None)
Path to store recorded output.
Notes
Note
Refer to IBM documentation for more information at https://www.ibm.com/docs/en/aix/7.3.0?topic=l-lparstat-command.
Examples
- name: Run lparstat with basic configuration info
ibm.power_aix.lparstat:
config_info: true
- name: Run lparstat with WPAR and service information
ibm.power_aix.lparstat:
config_info: true
wpar_output: true
service_info: true
energy_tuning: true
- name: Run detailed memory and I/O stats with page coalescing
ibm.power_aix.lparstat:
memory_stats: true
io_memory_pools: true
page_coalescing: true
page_coalescing_wide: true
reset_once: true
- name: Collect SPURR-based CPU metrics
ibm.power_aix.lparstat:
spurr_based_metrics: true
spurr_based_metrics_wide: true
- name: Gather repeated interval samples
ibm.power_aix.lparstat:
detailed_cpu_stats: true
interval: 2
count: 5
- name: Export output in XML format
ibm.power_aix.lparstat:
export_xml: true
output_file: "/tmp/lparstat_report.xml"
- name: Record output to a file with append mode
ibm.power_aix.lparstat:
config_info: true
recorded_output: "/tmp/lparstat_output.txt"
concatenated_output: true
Return Values
- msg (always, str, lparstat executed successfully with given options.)
The execution message indicating success or failure.
- cmd (always, str, )
The full lparstat command that was executed.
- rc (always, int, )
The return code from the lparstat command.
- stdout (always, str, )
The standard output returned by the lparstat command.
- stderr (on failure, str, )
The standard error (if any) returned by the command.
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.