clvupdate – Run the AIX clvupdate command to clean up failed Live Update operations

Synopsis 

Wrapper around the AIX clvupdate command, which cleans up the system after a failed Live Update operation and the default cleanup attempt has not been successful.

The module allows you to call clvupdate with specific flags such as removing surrogate boot disks, unlocking the Live Update lock, ignoring kernel state or status, using an alternate liveupdate configuration file, etc.

For full command semantics, see the AIX documentation for clvupdate.

Requirements 

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

AIX 7.2 or later.
The clvupdate binary must be available in $PATH on the managed node.

Parameters 

remove_surrogate_disks (optional, bool, False)
Remove surrogate boot disks created by a failed Live Update in PowerVC mode.

Maps to -d.

ignore_state (optional, bool, False)
Ignore the Live Update kernel state and proceed with cleanup anyway.

Use this when the partition has been rebooted after a failed Live Update attempt, but cleanup is still required.

Maps to -e.

unlock_only (optional, bool, False)
Unlock the Live Update lock only, without doing a full cleanup.

Maps to -l.

run_error_scripts (optional, bool, False)
Run only the LVUP_ERROR phase scripts from other system components, instead of a full cleanup.

Maps to -n.

ignore_status (optional, bool, False)
Ignore the Live Update kernel status and proceed with cleanup anyway.

Use this when clvupdate reports that some live update processes might still be running, but you know they are not.

Maps to -u.

force_original_shutdown (optional, bool, False)
Force the original partition to be shut down before cleanup proceeds.

Use this when the workload was moved to a surrogate partition after blackout time and the original partition is still active.

Maps to -o.

reset_state_only (optional, bool, False)
Reset the Live Update kernel state and status only, without performing a full cleanup.

Use this when a manual cleanup was already performed but kernel variables were not reset.

Maps to -r.

remove_lvup_vg (optional, bool, False)
Remove the temporary lvup_rootvg volume group that was used by the surrogate partition during Live Update.

Requires valid PowerVC authentication via pvcauth.

Maps to -v.

alt_hmc_hostname (optional, str, None)
Host name or IP address of an alternative HMC for authentication.

Use this when the HMC used during Live Update is unresponsive.

Maps to -a HMChostname.

alt_hmc_username (optional, str, None)
User name for the alternative HMC for authentication.

Must have required privileges on the HMC.

Maps to -U HMCusername.

alt_cf_file (optional, str, None)
Path of an alternative liveupdate.cf file generated by a previous Live Update operation.

Use this when you want to undo changes from a specific failed Live Update attempt.

Maps to -f AltCfFile.

executable (optional, str, clvupdate)
Override path to the clvupdate binary if it is not in $PATH.

Examples 

- name: Basic cleanup using default liveupdate.cf
  ibm.power_aix.clvupdate:
  register: result

- name: Remove Live Update lock only
  ibm.power_aix.clvupdate:
    unlock_only: true

- name: Cleanup after rebooted partition, ignoring kernel state
  ibm.power_aix.clvupdate:
    ignore_state: true

- name: Ignore Live Update status and force cleanup
  ibm.power_aix.clvupdate:
    ignore_status: true

- name: Remove surrogate boot disks after failed PowerVC Live Update
  ibm.power_aix.clvupdate:
    remove_surrogate_disks: true

- name: Reset Live Update kernel variables only
  ibm.power_aix.clvupdate:
    reset_state_only: true

- name: Use alternate liveupdate.cf file from previous attempt
  ibm.power_aix.clvupdate:
    alt_cf_file: /var/adm/ras/liveupdate/liveupdate.cf.alt

- name: Use alternate HMC for cleanup coordination
  ibm.power_aix.clvupdate:
    alt_hmc_hostname: hmc1.example.com
    alt_hmc_username: hmcuser

Return Values 

cmd (always, str, ): Full command line executed.
rc (always, int, ): Return code from the clvupdate command.
stdout (when rc is not 0 or when verbosity is requested, str, ): Standard output from the clvupdate command.
stderr (when rc is not 0, str, ): Standard error from the clvupdate command.
changed (always, bool, ): Whether the module caused any changes.

Status 

Authors

Nitish K Mishra (@nitismis)