# $Header$ # #******************************************************************************** # $Copyright: Copyright (c) 2022 Veritas Technologies LLC. All rights reserved $ #******************************************************************************** # # backint parameters # # switch_list: is required and is used as a control file to communicate with # BACKINT and BRBACKUP for online backups. A switch list file is created # every time BRBACKUP wants to backup a file or when it wants to indicate that # a backup is finished. The switch_list parameter must be set to a file path # that is located in: $ORACLE_HOME/sapbackup/.switch.lis. # switch_list /oracle/SAP/sapbackup/.switch.lis # # # switch_sem: is required and is used as a control file which is used between # BACKINT and BRBACKUP to communicate. After the switch list file has been # created and closed, BACKINT creates the switch semaphore file and waits until # it is deleted by BRBACKUP. The switch_sem parameter must be set to a file # path that is located in: $ORACLE_HOME/sapbackup/.switch.sem. # switch_sem /oracle/SAP/sapbackup/.switch.sem # # # switch_log: is required and is used as a control file which is used between # BACKINT and BRBACKUP to communicate. After the switch semaphore file has # been deleted, BACKINT opens and reads the switch log file to determine if # the process is successful. The switch log file is created by BRBACKUP. The # switch_log parameter must be set to a file path that is located in: # $ORACLE_HOME/sapbackup/.switch_log. # switch_log /oracle/SAP/sapbackup/.switch.log # # # backint_dir: is an optional parameter and must be set to a directory that is # public. BACKINT uses this directory for work space and to store files called # backint.times, which keeps track of backup information. # #backint_dir /oracle/SAP/sapscript/backint_dir # # # server: is an optional parameter and is the machine name of the NetBackup # Master server. The NetBackup Master server is the name of the machine that # provides most of the administration and control for NetBackup operations and # contains the NetBackup database. If BACKINT finds a $SAP_SERVER environment # variable, the server parameter's value will be overriden by the value of # $SAP_SERVER. Also, if the server parameter is not specified and there is # no environment variable then the currently configured server for # the NetBackup Client will be used. # #server jupiter # # # client: is an optional parameter and must be set to a machine name that has # the NetBackup client software, an Oracle database, and a SAP environment. # In some cases the server and client machine will be the same machine. If # BACKINT finds a $SAP_CLIENT environment variable, the client parameter value # will be overriden by the assigned environment variable. If the client parameter # is not specified and there is no environment variable then the currently # configured NetBackup Client will be used. If BACKINT could not get the currently # configured NetBackup Client also, then it uses the value returned by # the gethostname() library function. # #client jupiter # # # drives: is an optional parameter and should be set to the number of # simultaneous tape drives to kickoff backup. Set NetBackup Server to support # multiple simultaneous client backups and the number of storage units/tape # drives for this backup policy. Based on the number of drives specified # BACKINT will simultaneously run the same number of backup jobs. # So for example, if the drives parameter is set to 5, then 5 backup jobs will # run at the same time. # The drives parameter should be set to the following rule: # # drives = Number of storage units per policy X MPX number # # The drives parameter value should not exceed the Set Maxium Jobs per Client # global attribute. If BACKINT finds a $SAP_DRIVES environment variable, the # drive parameter value will be overriden by the value of the $SAP_DRIVES # variable. If the drive parameter is not specified and there is no # environment variable, default value of one will be used. # #drives 1 # # # policy: is an optionl parameter and should be set to the name of a SAP policy # type that has been defined in NetBackup. The SAP policy must have a schedule # type of Application Backup defined in order for BACKINT to work. If BACKINT finds # a $SAP_POLICY environment variable, the policy parameter value will be # overriden by the value of the $SAP_POLICY variable. If the policy parameter # is not specified and there is no environment variable, then BACKINT will # exit with an error. # #policy sap_backup # # # schedule: Is optional and must be set to the name of type Application Backup # schedule that is associates with a SAP policy type. The schedule can # define aspects of the backup such as how long NetBackup retains images, # maximum MPX per drive, storage unit, and volume pool. If BACKINT finds a # $SAP_SCHED environment variable, the schedule parameter value will be # overriden by the value of the $SAP_SCHED environment variable. If the # schedule parameter is not specified and there is no environment variable, # then, NetBackup uses the first schedule of type Application Backup # that it finds. It is higly recommended to set schedule parameter in *.utl file. # #schedule Default-Application-Backup # # # policy2: is optional and is the name of a policy to be used for the # secondary SAP backup. The secondary backup is performed for each SAP # database backup on files that are needed to track SAP backup information. # This option would be used to save the backup information on a different # media. If policy2 is not specified, then the policy parameter value is used. # #policy2 sap_sec_backup # # # schedule2: is optional and is the name of a Application Backup schedule to be # used for the secondary SAP backup. The secondary backup is performed for # each SAP database backup on files that are needed to track SAP backup # information. This option would be used to save the backup information on a # different media. If schedule2 is not specified, then the schedule parameter # value is used. # #schedule2 userbkps # # # sort_backup_type: [size | custom | device | drive ] # This parameter is optional and is used to specify four different backup # sort option. If sort_backup_type is not specified it will default to # the size option. # #sort_backup_type size # # sort_restore_type: [image | custom | drive ] # This parameter is optional and is used to specify three different restore # sort option. If sort_restore_type is not specified it will default to # the image option. This option is only applicable for pre 6.0 releases. # #sort_restore_type image # # # custom_sort_file: is optional and is used in conjunction with the # sort_backup_type and sort_restore_type parameter. If the custom option is # specified on either the sort_backup_type or sort_restore_type parameter, # then the custom_sort_file parameter needs to be set to a valid file. The # value for this parameter must be a full path name to a custom sort file and # must have public permissions. # #custom_sort_file /oracle/SAP/sapscripts/custom_sort_file # # # master_time_offset: is an option parameter used to restore old backups # if there was a time difference between the master and client machines. # This option should only be used for restoring 3.0 or older backup or if a # backint restore can't find a specified backup. The master_time_offset is # specified in minutes. The value will be subtracted from the start time and # added to the end time for a restore or inquire. # #master_time_offset 2 # # #sleep: is optional and is used to specify a sleep time to monitor the # bpbackup or bprestore logs. The default is 5 seconds. When BACKINT is # called a number of bpbackup/bprestore commands can be running at the # sametime. BACKINT monitors each command and display the information to the # -o parameter. In some cases bpbackup/bprestore information is not displayed # because of the monitoring cycle. Therefore this option is used mainly for # debug reasons. This option is only applicable for pre 6.0 releases. # #sleep 5 # # # policy_log: is optional and is the name of a policy to be used for # backing up a second copy of an archive log. If this option is specified # then two backups will be performed on the same archive log. The first # backup will go to the "policy" name option and the second backup will go # to the "policy_log" name option. # #policy_log sap_archive_logs # # # sched_log: is optional and is the name of a schedule to create a second # backing up of an archive log. If this option is specified then two backups # will be performed on the same archive log. The first backup will go to the # "schedule" option and the second backup will be go to the "sched_log" and # option. The "sched_log" name must be a valid schedule name under the # "policy_log" name option, otherwise it must be a valid schedule name under # the "policy" name option. # #sched_log Default-Application-Backup # # # retry_backup: is an optional parameter and should be set to the number of # retries for a failed backup. If this option is specified BACKINT will # retry a failed backup job. The number of retries is determine by the # value on the retry_backup parameter. # #retry_backup 2 # # # fail_backup: is optional and is used to stop the backup process immediately # when an error occurs. The standard behavior of BACKINT is to continue # processing even in the event of an error and then report what files failed # and what files were successful. If this parameter is specified then BACKINT # will stop process on the first error and report failures for all the # files that were not backed up. # #fail_backup # # # media_notify_script: is optional and is used to call a script when a # "Waiting mount" is displayed in a bpbackup/bprestore log. The value for this # option must be the full path name to a script. The script should also have # the right file permissions and should be tested before implementation. If # the message is encountered and this optional is specified, then the # following commands will be executed from BACKINT: # MEDIA_ID=A001;export MEDIA_ID # NETBACKUP_SERVER=saturn;export NETBACKUP_SERVER # /oracle/SAP/sapscripts/sap_media_notify # This option is only applicable for pre 6.0 releases. # #media_notify_script /oracle/SAP/sapscripts/sap_media_notify # # # restore_filter: is optional and is used to resolve linked file paths on a # restore. This parameter should be commented out and should be used only on # rare occasions. The following are the cases were this parameter is needed: # 1) Oracle table spaces use file paths # 2) The directory paths to the Oracle table spaces are linked paths # 3) The linked directory paths don't exist at restore time # The value for this parameter must be a fully qualified file path name to a # script, which has the right permissions and has been tested before being # implemented. The script must have an input and output parameter and be able # to modify the contents of a text file which contains file paths. The script # is responsible for converting linked directory paths into absolute directory # paths. See /usr/openv/netbackup/ext/db_ext/sap/scripts/restore_filter for # an example. # #restore_filter /oracle/SAP/sapscripts/restore_filter.sh # # # bplist_filter: is optional and is used to resolve linked file passes on an # inquire. This parameter should be commented out and should be used only on # rare occasions. Like the restore_filter_script parameter this is needed # for the following cases: # 1) Oracle table spaces use file paths # 2) The directory paths to the Oracle table spaces are linked paths # 3) The linked directory paths don't exist at restore time # The value for this option must be a fully qualified path name to a script, # which has the right file permission and has been tested before being # implemented. The script must have an input and output parameter and be able # to modify the contents of a text file, which contains file paths. The script # is responsible for converting absolute directory paths into linked directory # paths. This is just the opposite of the restore filter script. See # /usr/openv/netbackup/ext/db_ext/sap/scripts/bplist_filter for an example. # #bplist_filter /oracle/SAP/sapscripts/restore_filter.sh # # # check_directory_flag: is optional and is used to allow directory and # subdirectory backups. The parameter value can be either set to a 1 for true # or 0 for false. The SAP Tools only allows file backups, not directories or # subdirectories. The SAP Tools requires BACKINT to report an error if a # directory being backed up. This option provides the ability to override # this design and gives the SAP Tools the ability to backup directories and # subdirectories. The default is not to allow directory and subdirectory # backups. This option is only applicable for pre 6.0 releases. # #check_directory_flag 1 # # # second_secondary_archive: is optional, and it can have value of 0 or 1. # If value is one, then 2 copies of secondary backup will be made. This # parameter will have an effect only if policy_log and/or schedule_log are # specified. The first backup will go to the "policy" name option and the # second backup will go to the "policy_log" name option. Furthermore, it # will serve brarchive but it will have no effect on brbackup. # #second_secondary_archive 0 # # backup_stream_buffersize: is optional. This parameter can be used to # specify the value of buffer size in case of stream backup. Data is # received through stream (pipe) in case of SAPDB. When passing this # data to netbackup, the buffer size specified by this value will be used. # #backup_stream_buffersize 65535 # # restore_stream_buffersize: is optional. This parameter can be used to # specify the value of buffer size in case of stream restore. Data is # received from netbackup and passed to SAPDB through stream (pipe) in case # of restore. When receiving data from netbackup and copying it to pipe, # the buffer size specified by this value will be used. # #restore_stream_buffersize 65535 # #inquire_query_period: In case of #NULL based inquire query, SAP agent will #restrict the catalog search to six months by default. This parameter can be #used to specify the query period (in months). For example if user wants to #restrict the result of #NULL inquire query search to last 10 months then this #parameter should be set to 10. # #inquire_query_period 10 # # multistream_restore: is optional, and it can have value of 0 or 1. # If value is 0, then NetBackup master server (BPRD process) takes care of performing # an efficient restore job from selected backup images. If value is 1, then # parallel restore streams will be started (similar to pre NBU 6.0 version), # number of restore streams will be decided based on values of "drives" and "sort_restore_type". # The default value of multistream_restore is set to 0. # # multistream_restore 0