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

From Get docs
Ansible/docs/2.10/collections/community/general/mksysb module


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

Note

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

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

  • no
  • yes

Backup encrypted files.

backup_dmapi_fs

boolean

  • no
  • yes

Back up DMAPI filesystem files.

create_map_files

boolean

  • no

  • yes

Creates a new MAP files.

exclude_files

boolean

  • no

  • yes

Excludes files using /etc/rootvg.exclude.

exclude_wpar_files

boolean

  • no

  • yes

Excludes WPAR files.

extended_attrs

boolean

  • no
  • yes

Backup extended attributes.

name

string / required

Backup name

new_image_data

boolean

  • no
  • yes

Creates a new file data.

software_packing

boolean

  • 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

  • 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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/mksysb_module.html