Skip to main content

Handling Backup Actions Flow

In this document, we will explain the process of handling different actions in the backup module. The process involves retrieving parameters, setting configurations based on the action, and managing volume group backups.

The flow starts with retrieving the action and type parameters, which determine what operation will be performed. If the action is 'create', additional parameters are set to configure the backup creation. If the type is 'savevg', parameters for the volume group backup are set. The process then checks if the volume group is active and finally constructs and runs the backup command.

Flow drill down​

Handling Different Actions​

First, the main function retrieves the action and type parameters from the module. These parameters determine what operation will be performed, such as creating, restoring, or viewing a backup.

    action = module.params['action']
    params['objtype'] = module.params['type']
    params['flags'] = module.params['flags']
    params['location'] = module.params['location']

Creating a Backup​

Next, if the action is 'create', additional parameters like verbosity, data file creation, and exclusion settings are set. These parameters configure how the backup will be created, including whether to exclude certain files or extend file systems.

    if action == 'create':
        params['verbose'] = module.params['verbose']
        params['create_data_file'] = module.params['create_data_file']
        params['exclude_fs'] = module.params['exclude_fs']
        params['exclude_files'] = module.params['exclude_files']
        params['extend_fs'] = module.params['extend_fs']
        params['force'] = module.params['force']

Managing Volume Group Backups​

Then, if the type is 'savevg', the function sets the name and exclusion data parameters. These parameters specify the volume group to be backed up and whether to exclude certain data from the backup.

        elif params['objtype'] == 'savevg':
            params['name'] = module.params['name']
            params['exclude_data'] = module.params['exclude_data']

Checking Volume Group​

Moving to the savevg function, it first checks if the volume group is active by calling the check_vg function. This ensures that the volume group is available for backup.

    if not check_vg(module, vg):
        return 1

Running the Backup Command​

Finally, the savevg function constructs and runs the savevg command with the specified parameters. This command performs the actual backup of the volume group, storing the backup image at the specified location.

    cmd = ['/bin/savevg']
    if params['exclude_files']:
        cmd += ['-e']
    if params['location']:
        cmd += ['-f', params['location']]
    if params['create_data_file'].lower() == 'mapfile':
        cmd += ['-m']
    elif params['create_data_file'].lower() == 'yes':
        cmd += ['-i']
    if params['exclude_data']:
        cmd += ['-r']
    if params['verbose']:
        cmd += ['-v']
    if params['exclude_fs']:
        cmd += ['-x', params['exclude_fs']]
    if params['extend_fs']:
        cmd += ['-X']
    if params['flags']:
        for f in params['flags'].split(' '):
            cmd += [f]
    cmd += [vg]

 

This is an auto-generated document by Swimm 🌊 and has not yet been verified by a human