sysdumpdev – Manage system dump settings

Synopsis

This module allows to update and display the system dump settings

Requirements

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

  • AIX

  • Python >= 3.6

  • Privileged user with authorizations

Parameters

state (optional, str, present)

Specifies the action to be performed

present specifies to update the system dump settings

fact specifies to retrieve the current system dump settings

primary (optional, path, None)

Specifies the primary dump device

secondary (optional, path, None)

Specifies the secondary dump device

permanent (optional, bool, False)

Makes updates to the primary or secondary dump device setting permanent

copy_directory (optional, path, None)

Specifies the directory to where the dump is copied to at system boot

forced_copy_flag (optional, bool, None)

If set to true specifies to copy the system dump to an external media if the copy fails at boot time.

If set to false specifies to ignore the system dump if the copy fails at boot time.

Requires the copy_directory option to be specified

always_allow_dump (optional, bool, None)

If true and machine has a key mode switch, the reset button or the dump key sequences will force a dump with the key in the normal position.

If false and machine has a key mode switch, it is required to be in the service position before a dump can be forced.

dump_type (optional, str, None)

Specifies whether a traditional or fw-assisted system dump is performed

fw-assisted will required a reboot to become active

dump_mode (optional, str, None)

Specifies the dump mode. fw-assisted dump type must be active before this setting can be modified.

If the system was configured with traditional dump type it first must been rebooted in order to modify the dump_mode.

disallow specifies that neither the full memory system dump mode nor the kernel memory system dump mode is allowed.

allow_full specifies that the full memory system dump mode is allowed.

require_full specifies that the full memory system dump mode is allowed and is always performed.

Requires the dump_type=fw-assisted option to be specified

nx_gzip (optional, bool, None)

If set to true enables the Nest Accelerators (NX) GZIP accelerated dump compression

If set to false disables the Nest Accelerators (NX) GZIP dump compression

Notes

Note

Examples

- name: Configure primary and secondary dump devices permanently
  ibm.power_aix.sysdumpdev:
    primary: /dev/sysdump0
    secondary: /dev/sysdump1
    permanent: true

- name: Configure system dump copy directory and set the forced copy flag to False
  ibm.power_aix.sysdumpdev:
    copy_directory: /var/adm/ras
    forced_copy_flag: true

- name: Retrieve the current dump configuration
  ibm.power_aix.sysdumpdev:
    state: fact

- name: Configure fw-assisted dump with full memory system dump mode
  ibm.power_aix.sysdumpdev:
    dump_type: fw-assisted
    dump_mode: require_full

Return Values

command (always, str, sysdumpdev -D /var/adm/ras)

The sysdumpdev command which was executed to update the dump configuration

rc (If the command failed., int, )

The return code.

stdout (always, str, )

The standard output.

stderr (always, str, )

The standard error.

msg (when failed or no action required, str, )

The message if the module is exited with a failure or if no actions were required

Status

Authors

  • Oliver Stadler (@staoli)