onbar argument: Backup the storage spaces (SQL administration API)

Use the onbar argument with the admin() or task() function to backup the storage spaces.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-EXECUTE FUNCTION--+-admin-+--(--"onbar backup---------------->
                     '-task--'                     

>--+-+--------------+--+--------------+-+--"--)--;-------------><
   | '-whole system-'  '-level--level-' |            
   '-logs-------------------------------'            

Element Purpose Key considerations
onbar backup Performs a complete backup of the storage spaces If you do not specify a level, a level 0 backup is performed.
whole system Performs a whole-system backup This is equivalent of issuing the onbar command with the -w option from the command line. If you do not specify a level, a level 0 backup is performed.
level level Specifies the level of backup to perform on storage spaces:
  • 0 for a complete backup. This is the default.
  • 1 for changes since the last level-0 backup
  • 2 for changes since the last level-1 backup
If you request an incremental backup and a level backup has not been performed for a particular storage space, this function backs up that storage space at the previous level.

For example, if you request a level-1 backup, and the function finds no level-0 backup, a level-0 backup is made instead.

This is equivalent of issuing the onbar command with the -L level option from the command line.

logs Performs a back of the logical-log files This is equivalent of issuing the onbar command with the -l option from the command line.

Usage

This function is equivalent to invoking specific options of the onbar command to create backups of the storage spaces and logical-log files.

Examples

The following example creates a level 0 backup of the storage spaces:
EXECUTE FUNCTION task("onbar backup");
     
The following example creates a level 1 backup of the storage spaces:
EXECUTE FUNCTION task("onbar backup level 1");
     
The following example creates a level 1 backup of the logical-log files:
EXECUTE FUNCTION task("onbar backup logs");
     
The following example creates a whole system level 0 backup of the storage spaces:
EXECUTE FUNCTION task("onbar backup whole system");
     
The following example creates a whole system level 2 backup of the storage spaces:
EXECUTE FUNCTION task("onbar backup whole system level 2");
     

Copyright© 2019 HCL Technologies Limited