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

Note

This module is part of the community.general collection (version 5.4.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

Comments

backup_crypt_files

boolean

Backup encrypted files.

Choices:

  • no

  • yes ← (default)

backup_dmapi_fs

boolean

Back up DMAPI filesystem files.

Choices:

  • no

  • yes ← (default)

create_map_files

boolean

Creates a new MAP files.

Choices:

  • no ← (default)

  • yes

exclude_files

boolean

Excludes files using /etc/rootvg.exclude.

Choices:

  • no ← (default)

  • yes

exclude_wpar_files

boolean

Excludes WPAR files.

Choices:

  • no ← (default)

  • yes

extended_attrs

boolean

Backup extended attributes.

Choices:

  • no

  • yes ← (default)

name

string / required

Backup name

new_image_data

boolean

Creates a new file data.

Choices:

  • no

  • yes ← (default)

software_packing

boolean

Exclude files from packing option listed in /etc/exclude_packing.rootvg.

Choices:

  • no ← (default)

  • yes

storage_path

string / required

Storage path where the mksysb will stored.

use_snapshot

boolean

Creates backup using snapshots.

Choices:

  • no ← (default)

  • yes

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

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)