You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

This module is part of the community.general collection (version 6.6.2).

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	Comments
backup_crypt_files boolean	Backup encrypted files. Choices: false true ← (default)
backup_dmapi_fs boolean	Back up DMAPI filesystem files. Choices: false true ← (default)
create_map_files boolean	Creates a new MAP files. Choices: false ← (default) true
exclude_files boolean	Excludes files using /etc/rootvg.exclude. Choices: false ← (default) true
exclude_wpar_files boolean	Excludes WPAR files. Choices: false ← (default) true
extended_attrs boolean	Backup extended attributes. Choices: false true ← (default)
name string / required	Backup name
new_image_data boolean	Creates a new file data. Choices: false true ← (default)
software_packing boolean	Exclude files from packing option listed in /etc/exclude_packing.rootvg. Choices: false ← (default) true
storage_path string / required	Storage path where the mksysb will stored.
use_snapshot boolean	Creates backup using snapshots. Choices: false ← (default) true

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

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

Return Values

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

Key	Description
changed boolean	Return changed for mksysb actions as true or false. Returned: always
msg string	Return message regarding the action. Returned: always

Authors

• Kairo Araujo (@kairoaraujo)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication