MABS v3.0 allows you to create custom user defined devices, which you can use to define backup and restore options to back up devices that are not supported in the default set supplied with the MABS software. Custom devices must have the following configuration:
•
A Linux or UNIX-based operating system•
SSH, allowing password authentication and SFTP•
Appropriate compression commands (gzip, bzip2, zip, unzip) available in the PATH variable in the SSH login environment, if you want to use MABS compression featuresManaging Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 31
365-095-22451 x.2
Figure 28: Adding a Device Type – Main Screen
2. On the New Product Type screen, complete the following:
• Long Name – Enter a unique name for the device type.
• Short Name – Enter a unique short name for the device type. (Used in various drop down menus where a short version is needed)
• Version Command – Enter the version command for the device type. EX: rpm –q Casmr-core –qf %{VERSION}
• Click Create Product type.
Figure 29: Adding a Device Type – New Product Type Screen 3. Click the Backup Options tab.
4. Click Add Backup Option and complete the following on the Identity tab:
• Name – Enter a unique name for the backup option
• Short Name – Enter a unique short name of backup option (used in UI drop downs).
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 32
365-095-22451 x.2
• Option Type – Selecteither “contiguous” or “static” from the drop down box. Contiguous results in a unique backup stored in a unique folder with each execution. Static results in a single backup in a single folder with the data from the most recent execution of that backup option. Data is retrieved or overwritten based on the verification method.
• Archive type – Select either “file” or “directory” from the drop down box. Indicates whether you are backing up a single file or the contents of a directory.
• Full path – Enter the full path on the remote device that the file/directory to be backed up is located. (This field supports Tags).
• Filename – (File Archive Type only) Enter the filename of the file to be transferred to MABS from the remote device. (This field supports Tags).
• Verification method – (Static Option Type only) Enter the verification method to be used when comparing files for backup purposes.
• Compress method – Use the drop down box to select the compression method to employ before transferring the file locally to MABS.
• Click Create Backup Option.
Figure 30: Adding a Device Type – Identity Tab
5. On the Backup Options screen, Click the gear icon for the backup option you just created.
6. Click the Backup Steps tab and complete the following:
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 33
365-095-22451 x.2
• Select the applicable Step type from the drop down box. (See Table 3 – Backup/Restore Step Types for details)
• (Optional)Check stderr? box. If checked, the step will fail if any data is received on STDERR (Standard Error). Only applicable for
check_remote_process andremote_command steps.
• (Optional) Check exit code? box. If checked, the step will fail on any non- zero exit code. Only applicable forcheck_remote_process and
remote_command steps.
• Click the arrow next to the step to expand the field and enter the applicable configuration information. All parameters support the use of Tags.
• Click Update Backup option after completing each step.
• Repeat process for all remaining steps.
Figure 31: Adding a Device Type – Backup Steps 7. Click the Restore Options tab.
8. Click Add Restore Option and complete the following:
• Name – Enter a unique name for the restore option.
• Short name – Enter a unique short name for the restore option (used in UI drop downs).
• Description – Enter abrief description of what the restore option does.
• Decompress – If checked, the backup is uncompressed on the remote device after being transferred with a “transfer backup file” step type using the compression method specified for the associated backup option.
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 34
365-095-22451 x.2
Figure 32: Adding a Device Type – Restore Options Tab
9. On the Restore Options screen, click the gear icon for the restore option you just created.
10. Click the Restore Steps tab and complete the following: a. Click Add Option Step.
b. Select the applicable Step type from the drop down box. (See Table 3 – Backup/Restore Step Types for details)
c. (Optional)Check stderr? box. If checked, the step will fail if any data is received on STDERR (Standard Error). Only applicable for
check_remote_process andremote_command steps.
d. (Optional) Check exit code? box. If checked, the step will fail on any non- zero exit code. Only applicable forcheck_remote_process and
remote_command steps.
e. Click the arrow next to the step to expand the field and enter the applicable configuration information. All parameters support the use of Tags.
f. Click Update Restore option after completing each step. g. Repeat process for all remaining steps.
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 35
365-095-22451 x.2
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 36
365-095-22451 x.2
Table 2 – Text Field Tags
Tags Description
Certain MABS text fields support tags. Tags in text fields are replaced by the data they represent. <backup_id> The current backup’s unique id.
<backup_path> The backup option’s “full path” as defined on the Identity tab.
<backup_filename> The backup option’s “filename” as defined on the Identity tab.
Managing Devices
B
Motorola Automated Backup Service MABS v3.0 • User Guide 37
365-095-22451 x.2
Table 3 – Backup/Restore Step Types
Backup/Restore Step Types Description
check_remote_file Checks the remote device for the specified file. Step fails if file does not exist.
• Full path – Full path on remote device • File name – File name on the remote device
check_remote_process Checks the remote device via “ps” for the specified process. Step fails if stderr? or exit code? is checked and the criteria is met, otherwise it passes.
• Process name – Name of the process as seen by “ps –lfC”
pull_file Transfers file from the remote device to a local location on
MABS. Step fails if transfer fails.
• Remote path – The path on the remote device
• Remote filename – The file name on the remote device
• Local path – The local path on MABS • Local filename – The local file name on
MABS
push_file Transfers file locally from MABS to the remote device at
the specified location. Step fails if transfer fails. • Local path – The local path on MABS • Local filename – The local file name on
MABS
• Remote path – The path on the remote device
• Remote filename – The file name on the remote device
remote_command Executes the command on the remote device. Step fails if
stderr? or exit code? is checked and the criteria is met, otherwise it passes.
• Remote command – The remote command to be executed
remove_file Removes the specified file from the remote device. Step
fails if the removal fails.
• Remote path – The path on the remote device
• Remote filename – The file name on the remote device
transfer_backup_file Transfers the backup file specified under identity from the remote device to the backup location on MABS. Step fails if transfer fails.