community.general.mksysb – Generates AIX mksysb rootvg backups.
Note
This plugin is part of the community.general collection (version 3.8.1).
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 |
| Backup encrypted files. |
| backup_dmapi_fs boolean |
| Back up DMAPI filesystem files. |
| create_map_files boolean |
| Creates a new MAP files. |
| exclude_files boolean |
| Excludes files using /etc/rootvg.exclude. |
| exclude_wpar_files boolean |
| Excludes WPAR files. |
| extended_attrs boolean |
| Backup extended attributes. |
| name string / required | Backup name | |
| new_image_data boolean |
| Creates a new file data. |
| software_packing boolean |
| 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 |
| 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/mksysb_module.html