iostat – Run the AIX iostat command to monitor system I/O statistics.

Synopsis

Enables Ansible to invoke AIX’s iostat utility with comprehensive flag support.

Requirements

The below requirements are needed on the host that executes this module.

  • AIX >= 7.1

Parameters

adapter_report (optional, bool, False)

Display the adapter throughput report (-a).

block_io (optional, bool, False)

Displays the block I/O device utilization statistics. The -b flag is mutually exclusive to all flags, except the -T flag.

no_tty_cpu (optional, bool, False)

Turns off the display of TTY utilization report or CPU utilization report.

If you do not specify the -d or -p flag, then by default the -d flag is turned on.

The -t and -d flags together turn off both disks and TTY or CPU statistics, allowed only with the -a or -s flags.

The -d flag is mutually exclusive with the -t flag unless you specify the -a or -s flag, too.

The -d flag is mutually exclusive with the -p flag unless you specify the -a or -s flag, too.

extended_drive (optional, bool, False)

Display extended tape/drive utilization.

fs_utilization (optional, bool, False)

Display file system utilization (-f).

fs_only (optional, bool, False)

Displays the file system utilization report, and turns off other utilization reports..

filesystems (optional, str, None)

List of file filesystem to be used.

long_list (optional, bool, False)

Displays the output in long listing mode.

path_utilization (optional, bool, False)

Displays the path utilization report.

reset_ext_stats (optional, bool, False)

Specifies that the reset of min* and max* values should happen at each interval.

The default is to reset the values once when iostat is started.

The -R flag can be specified only with the -D flag

system_throughput (optional, bool, False)

Specifies the system throughput report.

You can specify the -a flag with the -A flag, but not when you have specified the -q or -Q flag.

no_disk (optional, bool, False)

Turns off the display of disk utilization report.

The -t and -d flags together turn off both disks and TTY or CPU statistics, allowed only with the -a or -s flags

show_timestamp (optional, bool, False)

Displays the time stamp.

nonzero_stats (optional, bool, False)

Display valid nonzero statistics.

reset_io (optional, bool, False)

Resets the disk input/output statistics.

Only root users can use this option.

xml_output (optional, bool, False)

Generates the XML output.

The default file name is iostat_DDMMYYHHMM.xml unless you specify a different file name by using the -o option.

scale_power (optional, int, None)

Displays the processor statistics that are multiplied by a value of 10power.

The default value of the power parameter is 0

options_override (optional, str, None)

Changes the content and presentation of the iostat report based on the values specified in option parameters.

wpar_stats (optional, str, None)

Reports I/O activities of a workload partition.

Specify -@ ‘ALL’ to display the activity for the global environment and all workload partitions in the system.

Specify the -@ flag with a list of workload partition names to display the activity for that workload partition.

Specify -@ ‘Global’ to display the activity for the global environment only.

Specify the -@ flag inside a WPAR to display system-wide statistics along with WPAR statistics.

xml_output_path (optional, str, None)

Specifies the file name for the XML output.

drives (optional, list, None)

List of drives to include in the report.

interval (optional, int, None)

Parameter specifies the amount of time in seconds between each report.

If the Interval parameter is not specified, the iostat command generates a single report containing statistics for the time since system startup (boot).

count (optional, int, None)

The Count parameter can be specified in conjunction with the Interval parameter.

If the Count parameter is specified, the value of count determines the number of reports generated at Interval seconds apart.

If the ‘count’ is not mentioned with the ‘interval’ option, then the default value of 5 will be considered.

concatenated_output (True, bool, None)

Controls whether the output of the iostat 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.

recorded_output (optional, str, None)

Path to file where command output should be written.

Notes

Note

Examples

- name: Run iostat with adapter and timestamp
  ibm.power_aix.iostat:
    adapter_report: true
    show_timestamp: true
    interval: 2
    count: 3

- name: Run iostat with XML output
  ibm.power_aix.iostat:
    xml_output: true
    xml_output_path: '/tmp/iostat_report.xml'

Return Values

msg (always, str, iostat SUCCESSFULLY executed.)

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.

Authors

  • AIX Development Team (@vivekpandeyibm)