nmon – Health Monitoring

Synopsis

This module allows to record local system statistics of a logical partition (LPAR).

Requirements

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

  • AIX

  • Python >= 3.6

  • Privileged user with authorizations

Parameters

filename (optional, str, None)

Specifies that the output is in spreadsheet format and the name of the output file is filename

file_containing_disk_groups (optional, str, None)

Specifies the file that contains the user-defined disk groups.

Each line in the file begins with a group name. The list of disks follows the group name and is separated with spaces.

A disk can belong to various disk groups, the file can contain a maximum of 64 disk groups

disklist (optional, list, None)

Specifies a list of disks to be recorded.

save_to_dir (optional, str, None)

Changes the directory before the command saves the data to a file.

disks_per_line (optional, int, None)

Specifies the number of disks to list on each line.

timestamp_size (optional, int, None)

Specifies the size of timestamp (Tnnnn) to be recorded.

The timestamp is recorded in the .csv file.

The value of the number parameter ranges from 4 through 16, for NMON analyzer, use the values 4 or 8.

percentage_of_process_threshold (optional, int, None)

Specifies the percentage of process threshold at which the command ignores the TOP processes statistics.

The default percentage is 0.1.

The command does not save the TOP processes statistics if the process is using less processor than the specified percentage.

priority (optional, int, None)

Specifies the priority of the nmon command that is running.

A value of -20 means important. A value of 20 means not important.

Only root user can specify a negative value.

runname (optional, str, None)

Specifies the value for the runname field written to the spreadsheet file.

By default, the value is the hostname.

interval_seconds (optional, int, None)

Specifies the interval in seconds between 2 consecutive recording snapshots.

output_path (optional, str, None)

Specifies the file name or directory to which the recorded file is to be stored.

include_async (optional, bool, False)

Includes the Asynchronous I/O section in the view.

number_of_snapshots (optional, int, None)

Specifies the number snapshots that must be taken by the command.

The default value is 10000000 for the NMON command.

include_disk_service_time (optional, bool, False)

Includes the Disk Service Time section in the view.

skip_disk_config (optional, bool, False)

Skips the Disk Configuration section.

skip_ess_config (optional, bool, False)

Skips the ESS Configuration section.

spreadsheet_output (optional, bool, False)

Specifies that the output is in spreadsheet format.

By default, the command takes 288 snapshots of system data with an interval of 300 seconds between each snapshot.

The name of the output file is in the format of hostname_YYMMDD_HHMM.nmon.

use_greenwhich_time (optional, bool, False)

Uses Greenwich mean time (GMT) instead of local time.

This method is helpful when you compare nmon files from many LPAR of 1 system for processor view but the LPAR are in different time zones.

report_thread_level_stats (optional, bool, False)

Reports thread level statistics.

skip_JFS_section (optional, bool, False)

Skips the JFS section.

include_raw_kernal_section (optional, bool, False)

Includes the RAW Kernel section and the LPAR section in the recording file.

If set, it dumps the raw numbers of the corresponding data structure.

The memory dump is readable and can be used when the command is recording the data.

include_large_page_analysis (optional, bool, False)

Includes the large page analysis section.

include_mempages_section (optional, bool, False)

Includes the MEMPAGES section in the recording file.

The MEMPAGES section displays detailed memory statistics per page size.

include_nfs_section (optional, bool, False)

Includes the NFS section in the recording file

include_nfsv4_section (optional, bool, False)

Includes the NFSv4 section in the recording file

include_sea_vios_section (optional, bool, False)

Includes the Shared Ethernet adapter (SEA) VIOS sections in the recording file.

include_paging_space_section (optional, bool, False)

Includes the Paging Space section in the recording file.

include_wlm_section_with_subclasses (optional, bool, False)

Includes WLM sections with subclasses in the recording file.

include_top_processes (optional, bool, False)

Includes the top processes in the output.

include_top_processes_and_save_cli_agrs (optional, bool, False)

Includes the top processes in the output and saves the command-line arguments into the UARG section.

include_disk_vg_section (optional, bool, False)

Includes disk volume group section.

include_wlm_section (optional, bool, False)

Includes the WLM sections into the recording file.

sensible_recording_for_one_day (optional, bool, False)

Specifies the sensible spreadsheet recording for duration of 1 day for capacity planning.

By default, the recording is done every 900 seconds for 96 times.

This flag is equivalent to -ft -s 900 -c 96.

sensible_recording_for_one_hr (optional, bool, False)

Specifies the sensible spreadsheet recording for duration of 1 hour for capacity planning.

By default, the recording is done every 30 seconds for 120 times.

This flag is equivalent to -ft -s 30 -c 120.

scpu_details (optional, str, None)

Enables or disables recording of Scaled CPU (SCPU) sections, which are nothing but metrics that start with SCPU.

These metrics are based on Scaled Processor Utilization of Resources Register (SPURR).

pcpu_details (optional, str, None)

Enables or disables recording of Physical CPU (PCPU) sections, which are nothing but metrics that start with PCPU.

These metrics are based on Processor Utilization of Resources Register (PURR).

include_top_processes_with_commands (optional, bool, False)

Includes the top process in the recording with all of the commands of the same name that are added and recorded.

sensible_recording_one_day_without_top (optional, bool, False)

Specifies the sensible spreadsheet recording for duration of 1day for capacity planning.

By default, the recording is done every 900 seconds for 96 times. This flag is equivalent to -f -s 900 -c 96.

include_fibre_channel_section (optional, bool, False)

Includes the Fibre Channel (FC) sections.

restrict_commands_in_listing (optional, list, None)

Restricts the process that are listed

delete_previous (optional, bool, False)

Deletes previous nmon files with the same name before creating the new one.

Notes

Note

Examples

- name: Generate the nmon recording in the current directory for two hours, capturing data every 30 seconds
  ibm.power_aix.nmon:
    spreadsheet_output: true
    interval_seconds: 30
    number_of_snapshots: 240
    output_path: /nmonfiles/

- name: Generate nmon recording that includes raw kernal section
  ibm.power_aix.nmon:
    spreadsheet_output: true
    interval_seconds: 30
    number_of_snapshots: 2
    include_raw_kernal_section: true
    output_path: /nmonfiles/kernal_data

- name: Generate nmon recording that includes live page analysis
  ibm.power_aix.nmon:
    spreadsheet_output: true
    interval_seconds: 30
    number_of_snapshots: 4
    include_large_page_analysis: true
    output_path: /nmonfiles/livepage_data

- name: Generate nmon recording that includes nfsv4 section in the recording mode
  ibm.power_aix.nmon:
    spreadsheet_output: true
    interval_seconds: 30
    number_of_snapshots: 2
    include_nfsv4_section: true
    output_path: /nmonfiles/nfsv4_data

Return Values

msg (always, str, )

The execution message.

rc (always, int, )

The return code.

stdout (If the command failed., str, )

The standard output.

stderr (If the command failed., str, )

The standard error.

changed (always, bool, )

Tells whether any change occured on the system

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]

  • This module is maintained by community.

Authors

  • AIX Development Team (@schamola)