community.general.mksysb – Generates AIX mksysb rootvg backups.

Note

This plugin is part of the community.general collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.mksysb.

Synopsis

  • This module manages a basic AIX mksysb (image) of rootvg.

Parameters

Parameter Choices/Defaults Comments
backup_crypt_files
boolean
    Choices:
  • no
  • yes ←
Backup encrypted files.
backup_dmapi_fs
boolean
    Choices:
  • no
  • yes ←
Back up DMAPI filesystem files.
create_map_files
boolean
    Choices:
  • no ←
  • yes
Creates a new MAP files.
exclude_files
boolean
    Choices:
  • no ←
  • yes
Excludes files using /etc/rootvg.exclude.
exclude_wpar_files
boolean
    Choices:
  • no ←
  • yes
Excludes WPAR files.
extended_attrs
boolean
    Choices:
  • no
  • yes ←
Backup extended attributes.
name
string / required
Backup name
new_image_data
boolean
    Choices:
  • no
  • yes ←
Creates a new file data.
software_packing
boolean
    Choices:
  • no ←
  • yes
Exclude files from packing option listed in /etc/exclude_packing.rootvg.
storage_path
string / required
Storage path where the mksysb will stored.
use_snapshot
boolean
    Choices:
  • no ←
  • yes
Creates backup using snapshots.

Examples

- name: Running a backup image mksysb
  community.general.mksysb:
    name: myserver
    storage_path: /repository/images
    exclude_files: yes
    exclude_wpar_files: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
boolean
always
Return changed for mksysb actions as true or false.

msg
string
always
Return message regarding the action.



Authors

  • Kairo Araujo (@kairoaraujo)