vmstat – Run the AIX vmstat command to report system stats.
Synopsis
Enables Ansible to invoke AIX’s vmstat utility with full flag support.
Requirements
The below requirements are needed on the host that executes this module.
AIX >= 7.1
Parameters
- show_fork_stats (optional, bool, False)
Reports the number of forks since system startup.
- show_interrupts (optional, bool, False)
Displays the number of interrupts by the device since system startup.
- show_paging_stats (optional, bool, False)
Shows the absolute count of paging events since system initialization.
- io_view (optional, bool, False)
Displays I/O-oriented view with additional I/O wait columns.
- with_fs_wait (optional, bool, False)
Adds file system wait column to I/O view. Used with
io_view
.- timestamp (optional, bool, False)
Prints timestamp for each output line.
- vmm_stats (optional, bool, False)
Shows detailed VMM statistics.
- hypervisor_stats (optional, bool, False)
Shows hypervisor paging-related statistics.
- wide_output (optional, bool, False)
Enables wide mode display.
- large_page_stats (optional, bool, False)
Displays large page section details.
- recorded_output (optional, str, None)
Folder path to command output in machine .
- wpar_name (optional, str, None)
Specifies WPAR name or ALL to report stats per WPAR.
- pagesize_stats (optional, str, None)
Appends stats for specified page size or physical volume (-p).
- page_stats_only (optional, str, None)
Displays only stats for specified page size or volume (-P).
- scale_power (optional, int, None)
Scaling factor for percentage values (e.g., 0-3 for 10^power).
- interval (optional, int, None)
Number of seconds between each report.
- count (optional, int, None)
Number of reports to generate. Used with
interval
.- concatenated_output (True, bool, None)
Controls whether the output of the vmstat command is appended to the output file or is overwrited.
If set to true, output will be appended to the file.
If set to false, the file will be overwritten with fresh output.
Notes
Note
You can refer to the IBM documentation for additional information on the vmstat command at https://www.ibm.com/docs/en/aix/7.3.0?topic=v-vmstat-command.
Examples
- name: Run vmstat with timestamp
vmstat_command:
timestamp: true
interval: 2
count: 5
- name: Run vmstat with showing paging stat
vmstat_command:
show_paging_stats: true
wpar_name: "ALL"
interval: 1
count: 3
Return Values
- msg (always, str, Group: foo SUCCESSFULLY created.)
The execution message.
- cmd (always, str, )
The command executed.
- rc (When the command is executed., int, )
The command return code.
- stdout’ (If the command failed., str, )
The standard output.
- stderr’ (If the command failed., str, )
The standard error.
Status
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by community.