On this page
mksysb - Generates AIX mksysb rootvg backups.
New in version 2.5.
Synopsis
- This module manages a basic AIX mksysb (image) of rootvg.
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| backup_crypt_files  
        bool
         | 
      
       
  | 
      
        
        Backup encrypted files.
         | 
     
| backup_dmapi_fs  
        bool
         | 
      
       
  | 
      
        
        Back up DMAPI filesystem files.
         | 
     
| create_map_files  
        bool
         | 
      
       
  | 
      
        
        Creates a new MAP files.
         | 
     
| exclude_files  
        bool
         | 
      
       
  | 
      
        
        Excludes files using  /etc/rootvg.exclude.
        | 
     
| exclude_wpar_files  
        bool
         | 
      
       
  | 
      
        
        Excludes WPAR files.
         | 
     
| extended_attrs  
        bool
         | 
      
       
  | 
      
        
        Backup extended attributes.
         | 
     
| name  
        required
         | 
      
        
        Backup name
         | 
     |
| new_image_data  
        bool
         | 
      
       
  | 
      
        
        Creates a new file data.
         | 
     
| software_packing  
        bool
         | 
      
       
  | 
      
        
        Exclude files from packing option listed in  /etc/exclude_packing.rootvg.
        | 
     
| storage_path  
        required
         | 
      
        
        Storage path where the mksysb will stored.
         | 
     |
| use_snapshot  
        bool
         | 
      
       
  | 
      
        
        Creates backup using snapshots.
         | 
     
Examples
- name: Running a backup image mksysb
  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
         
        (added in 2.5)
         | 
      always | 
        
        Return changed for mksysb actions as true or false.
          | 
     
| msg  
        string
         
        (added in 2.5)
         | 
      always | 
        
        Return message regarding the action.
          | 
     
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Kairo Araujo (@kairoaraujo)
 
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/2.6/modules/mksysb_module.html