Keywords and values used in batch files
Table: Keywords and values used in batch files describes the keywords and values that can be used in batch files.
Table: Keywords and values used in batch files
Keyword | Values | Required? | Default | Description |
|---|---|---|---|---|
ALTCLIENT (Same as BROWSECLIENT) | string | no | none | Restores the images from a host other than the local host. |
BACKUPMODEL | BACKUPMODEL_ CONVENTIONAL, BACKUPMODEL_ SNAPSHOT | no | BACKUPMODEL_CONVENTIONAL | Valid only for restore. Indicates whether the backup was originated from a snapshot method |
BATCHSIZE | integer | no | 1 | Number of backup operations to start simultaneously, per database instance. Applies to all of the operations in the batch file. Must appear before the end of the first operation. Range is 1 - 32. |
BLOCKSIZE | integer | no | 0 | Applicable for backup operations only. Block size is calculated as 512 bytes * 2BLOCKSIZE. Range is 0 - 7. |
BROWSECLIENT (Same as ALTCLIENT) | string | no | none | Restores the images from a host other than the local host. |
BUFFERS | See NUMBUFS. | |||
CONSISTENCYCHECK | FULLINCLUDINGINDICES, FULLEXCLUDINGINDICES, PHYSICALCHECKONLY, CHECKCATALOG | no | none | Performs the specified consistency check after the restore has been completed. |
CONVERTBACKUP | TRUE, FALSE | no | FALSE | If no previous full backup exists for the database or filegroup, then NetBackup converts the differential or log backup to a full backup. This option also detects if a full recovery database was switched to the simple recovery model and back to the full recovery model. In this scenario, the log chain is broken and SQL Server requires a differential backup before a subsequent log backup can be created. If NetBackup detects this situation, the backup is converted to a differential database backup. |
COPYONLY | TRUE, FALSE | no | See description | If TRUE, SQL Server creates an out-of-band backup so that it does not interfere with the normal backup sequence. The default value is FALSE except for full database Instant Recovery backups. |
DATABASE | string | yes | none | Name of database. For backup operations, specify value $ALL to designate all databases (except for tempdb.) |
DBMS | MSSQL | no | MSSQL | You can specify MSSQL only. |
DSN | string | no | saved from GUI user session | ODBC data source name. Deprecated. |
DUMPOPTION | INCREMENTAL | no | none | Specifies INCREMENTAL restoring from an incremental backup. |
ENABLESERVICEBROKER | TRUE | no | none | Enables SQL Server Service Broker after a restore operation. To take effect, RECOVERED STATE must be set to RECOVERED. Include this keyword in each individual RESTORE operation. |
ENDOPER | TRUE | yes | none | Terminates each operation that is specified in the batch file. |
EXCLUDE | string | no | none | Name of a database to exclude when DATABASE $ALL is specified in a batch operation EXCLUDE can be used in a batch file only if DATABASE $ALL is used. |
GROUPSIZE | integer between 1 and 32 | no | none | The number of databases that are snapped as a single SQL Server backup image. (Legacy policies) For availability group backups, all databases in the grouped backup must be part of the availability group. NetBackup does not support any grouped snapshot backups that include both standard and availability databases. (Intelligent Policies) NetBackup does not support grouped snapshot backups. |
INHIBITALTBUFFER METHOD | TRUE, FALSE | no | FALSE | Tells NetBackup whether to consider the candidacy of alternate buffer method. |
MAXRESTARTSETS | integer | no | none | Use MAXRESTARTSETS to enable file checkpointing. This parameter specifies the number of separate streams into which the backup request is sub-divided. Range is 2 - 32. |
MAXTRANSFERSIZE | integer | no | 0 | Maximum transfer size is calculated as 64 kilobytes bytes * 2MAXTRANSFERSIZE. Range is 0 - 6. |
MOVE | filegroup | no | none | Specifies a filegroup name. Used for the MOVE restore type. For any backups that were made with a SQL Server legacy policy, the PARTIAL restore type also applies. |
NBIMAGE | string | yes* | none | Specifies a NetBackup image for the restore operations. See note for NBSERVER. * Required for restore operations. |
NBSCHED | string | no | none | If the NetBackup policy has several Application Backup Policy schedules, use NBSCHED to select amongst them. |
NBSERVER | string | no | none | Specifies which master server to use for the backup or restore operation. Note: If NBSERVER is not specified in a batch file operation, the master server defaults to the name that is specified at HKEY_CURRENT_USER\Software\VERITAS\NetBackup\NetBackup for Microsoft SQL Server\DEFAULT_SQL_NB_MASTER_SERVER. |
NUMBUFS | integer | no | 1 | Number of buffers per stripe. Range is 1 - 32. |
NUMRETRIES | See NUMRESTARTS. | |||
NUMRESTARTS | 1-9 | no | 1 | The number of times to retry a backup if RESTARTTYPE AUTO is specified. Use this keyword only once in the batch file and in the first operation of the batch file. |
OBJECTNAME | string | yes* | none | Specifies a file or a filegroup name for file or for filegroup backups and restores, * If OBJECTTYPE= FILE or FILEGROUP. |
OBJECTTYPE | DATABASE, TRXLOG, FILEGROUP, FILE | no | DATABASE | Specifies the object you want to back up or restore, a database, transaction log, filegroup, or file. |
OPERATION | BACKUP, RESTORE | no | BACKUP | Type of operation, either backup or restore. |
PAGE | Page ID | no | none | Ignored for a restore if the backup was performed with SQL Server Intelligent Policy. Specifies a page ID for a page restore operation. |
PARTIAL | TRUE, FALSE | no | FALSE | Ignored for a restore if the backup was performed with SQL Server Intelligent Policy. Specifies NetBackup perform a partial backup or restore. |
PASSWORD | string | no | null | Password for logging into SQL Server. This keyword is ignored if you use integrated security. |
PREFERREDREPLICA | NONE, PRIMARY, PREFERRED,SKIP, TRUE, FALSE | no | PRIMARY | For each operation in the batch file, include this keyword. (All NetBackup versions) TRUE honors your SQL Server backup preferences. FALSE indicates there is no preference for the replica that is used for backup. (NetBackup 8.2 and later clients) NONE means the backup is performed on the specified instance. Use SKIP to ignore any availability databases on the instance. Use this value to protect only standard databases when the policy includes any instances that contain both standalone databases and availability databases. PRIMARY and PREFERRED apply to availability replicas and to instances that have both standard and availability databases. PRIMARY means that the primary replica is used for backup. PREFERRED honors your SQL Server backup preferences. These preferences include the preferred replica, backup priority, and excluded replicas. Note that NetBackup initiates a backup job on each replica. The backup is skipped on any replica that isn't the intended backup source. |
RECOVERED STATE | RECOVERED, STANDBY, NOTRECOVERED, TRUE, FALSE | no | RECOVERED | RECOVERED means that the database should be restored to the recovered state. NOTRECOVERED means that it should remain in the loading state following the restore. STANDBY means that the database should be restored to standby state. If STANDBY is used, then the STANDBYPATH keyword is also required. TRUE and FALSE, when used as values for RECOVEREDSTATE, are synonyms for RECOVERED and NOTRECOVERED. |
RESTARTTYPE | AUTO, MANUAL | no | none | Available only for backups. Use AUTO to automatically retry backup of failed objects. Use MANUAL to create a batch file for backing up any of the objects that were not successfully backed up. Use this keyword only once in the batch file and in the first operation of the batch file. |
RESTARTWAITSECONDS | integer number | no | 60 | The time to make a second attempt following a backup failure. Use this keyword only once in the batch file and in the first operation of the batch file. |
RESTOREBEFOREMARK | string | no | none | Specify transaction log mark. |
RESTOREBEFOREMARK AFTERTIME | string | no | none | Specify transaction log mark. |
RESTOREOPTION | REPLACE | no | none | Tells NetBackup to use the SQL Server replace option on a restore. |
RESTOREPAGES | TRUE, FALSE | no | FALSE | Ignored for a restore if the backup was performed with SQL Server Intelligent Policy. Specifies that NetBackup perform a page restore operation. |
RESTORETOMARK | string | no | none | Specify transaction log mark. |
RESTORETOMARK AFTERTIME | string | no | none | Specify transaction log mark. |
RESTORETYPE | FULL, PARTIAL, MOVE | no | FULL | Full = Full database restore, Move = Database move RESTORETYPE is applicable only to RESTORE database operations. If MOVE is used, then the batch file should contain a series of one or more <MOVE><filegroup> and <TO><file path> sequences. (SQL Server legacy policies only) Partial = Partial database restore. If PARTIAL is used, the sequence for PARTIAL must specify all of the filegroups in the database whose backup image is referenced by the NBIMAGE keyword. |
RETRYTYPE | See RESTARTTYPE. | |||
RETRYWAITSECONDS | See RESTARTWAITSECONDS. | |||
ROLLBACKVOLUME | TRUE, FALSE | no | FALSE | Tells NetBackup to do the recovery of an Instant Recovery backup using the volume rollback method. |
SQLCOMPRESSION | TRUE, FALSE | no | FALSE | Uses SQL Server compression on the backup image. If you enable SQL Server compression, do not enable NetBackup compression. |
SQLHOST | string | no | Name of SQL Server host. If SQLHOST is not specified in a batch file operation, then the SQL Server host is obtained from HKEY_CURRENT_USER\Software\VERITAS\NetBackup\NetBackup for Microsoft SQL Server\DEFAULT_SQL_HOST. If the SQLINSTANCE keyword is not included, then the default SQL Server instance is assumed for the SQL Host. | |
SQLINSTANCE | string | no | Name of the SQL Server instance. Or for backup operations specify $ALL to designate all SQL Server instances including the default instance. If SQLINSTANCE $ALL is used, then it must appear in the first operation of the batch file. Each operation in the batch file is performed for all SQL Server instances on the client where the batch file is executed. Also, it is not necessary to specify an SQLHOST or SQLINSTANCE on any subsequent operations. | |
STANDBYPATH | string | no | none | Specify a fully- qualified file path to use for the standby redo log. |
STOPAFTER | datetime string | no | none | Specifies datetime for RESTORETOMARK options. The datetime string is formatted as YYYY/MMDDHH:MM:SS. |
STOPAT | datetime string | no | none | Specifies the point-in-time recovery of a transaction log. The datetime string is formatted as YYYY/MMDDHH:MM:SS. |
STORAGEIMAGE | string | no | none | Used for restoring a database that was backed up using a grouped Snapshot Client snapshot. STORAGEIMAGE identifies the image with which the physical files are associated. |
STRIPES | integer | no | 1 | Number of stripes. Range is 1 - 32. |
TO | file path | no | none | Specifies a filegroup destination path. Required for each MOVE keyword. Also must sequentially follow each MOVE entry. The value may be delimited with single quotes. |
TRACELEVEL | MIN, MID, MAX | no | MIN | Trace level. |
TRXOPTION | NOTRUNC, TAILLOG | no | none | SQL Server transaction log backup options. If NOTRUNC is not selected, then the transaction log can be backed up and truncated. If TAILLOG is selected, the tail log is backed up and restored. |
USERID | string | no | sa | User ID for logging into SQL Server. This keyword is ignored if you use integrated security. |
VDITIMEOUTSECONDS | integer | no | 300 | Timeout interval for SQL Server Virtual Device Interface. |
VERIFYONLY | TRUE, FALSE | no | FALSE | Tells SQL Server to verify a backup image but not to restore it. |
VERIFYOPTION | NONE, STOPONERROR CONTINUEAFTERERROR | no | NONE | This option is only valid for the databases that have an active page. STOPONERROR performs verification and stops if a verification error occurs. CONTINUEAFTERERROR performs verification but continues if a verification error occurs. |