Backup optional parameters

Optional parameters follow the backup command and positional parameters.

/AAGName=AlwaysOn Availability Group name

When you back up a database list or all databases by specifying the asterisk (*) wildcard character, and you specify the /AAGName parameter, only databases from the availability group that you specify are backed up.

/ALWAYSONPriority

Use this parameter to specify that a local availability database is backed up only if it has the highest backup priority among the availability replicas that are working properly on SQL Server 2012 and later versions. You can use this parameter at the command-line interface or as part of a scheduled backup.

/BACKUPDESTination= LOCAL|TSM|BOTH

Use the /BACKUPDESTination parameter to specify the location where the backup is stored.

You can specify:

IBM Storage Protect: The backup is stored on IBM Storage Protect server storage only. This option is the default.
LOCAL: The backup is stored on local shadow volumes only. This option is only valid when the /BACKUPMETHod parameter specifies VSS.
BOTH: The backup is stored on IBM Storage Protect server storage and local shadow volumes. This option is valid only when the /BACKUPMETHod parameter specifies VSS.

The /BACKUPDESTination parameter is valid only when the full or copyfull positional parameters are used. The full and copyfull backups can be saved to IBM Storage Protect server storage, local storage, or both. The /BACKUPDESTination parameter is used to choose among options. The log, diff, file, and group backups can be stored only to IBM Storage Protect server storage. In this scenario, you cannot specify the /BACKUPDESTination parameter because IBM Storage Protect is the only viable option.

/BACKUPMETHod=LEGACY|VSS

Use the /BACKUPMETHod parameter to specify the manner in which the backup is completed.

You can specify:

LEGACY: The backup is completed with the legacy API. This backup is the SQL streaming backup and restore API as used in previous versions of IBM Storage Protect Snapshot for SQL. This option is the default value.
VSS: The backup is completed with VSS.

The /BACKUPMETHod parameter is valid only when the full or copyfull positional parameters are used. The full and copyfull backups can be completed by using VSS or legacy operations. The /BACKUPMETHod parameter is used to choose between the options. The log, diff, file, and group backups can completed only by using legacy operations. In this scenario, you cannot specify the /BACKUPMETHod parameter because the legacy method is the only viable option.

/CONFIGfile=configfilename

The /CONFIGfile parameter specifies the name of the IBM Storage Protect Snapshot configuration file. The configuration file contains the values for the IBM Storage Protect Snapshot configurable options. When you use this parameter, review the following information:

configfilename can include a fully qualified path. If configfilename does not include a path, it uses the directory where IBM Storage Protect Snapshot is installed.
If configfilename includes spaces, place the space character in double quotation marks.
If you do not specify /CONFIGfile, the default value is tdpsql.cfg.

/ENABLEREPlacementchars=No|Yes

The /ENABLEREPlacementchars parameter enables SQL Server databases that have backslash (\) or colon (:) characters in the database name to be backed up. The maximum length of the database name is 128 characters. This parameter applies only to IBM Storage Protect Snapshot for SQL Server version 7.1.1 and later versions.

You can specify the following values:

Yes: Enable IBM Storage Protect Snapshot for SQL Server to process backslash (\) or colon (:) characters in a database name, and back up the database to IBM Storage Protect. This value is the default.
No: Prevent database backups to IBM Storage Protect if a user-defined string is substituted for a backslash (\) or colon (:) character in the database name.

/EXCLUDEdb=dblist

The /EXCLUDEdb parameter specifies the name of the databases to exclude from the backup operation.

/EXCLUDEALwaysondbs

Use this parameter to exclude all AlwaysOn Availability Databases from the backup operation. If you want to exclude specific databases, use the /EXCLUDEdb parameter.

/EXCLUDESTandarddbs

Use this parameter to exclude all standard databases from the backup operation. If you want to exclude specific databases, use the /EXCLUDEdb parameter.

/FCMOPTFile=dsmoptfilename

The /FCMOPTFile parameter specifies the IBM Storage Protect Snapshot options file to use.

Considerations:

The dsmoptfilename variable can include a fully qualified path. If you do not include a path, the IBM Storage Protect Snapshot installation directory is used.
If the dsmoptfilename variable spaces, enclose it in double quotation marks.
If you do not specify /FCMOPTFile, the default value is dsm.opt.
If you specify /FCMOPTFile but not dsmoptfilename, the default is also dsm.opt.

/LOGFile=logfilename

The /LOGFile parameter specifies the name of the activity log that is generated by IBM Storage Protect Snapshot. This activity log records significant events such as completed commands and error messages. The IBM Storage Protect Snapshot activity log is distinct from the SQL Server error log. The logfilename variable identifies the name to be used for the activity log generated by IBM Storage Protect Snapshot.

Considerations:

If the specified file does not exist, it is created. If it does exist, new log entries are appended to the file.
The file name can include a fully qualified path; however, if you specify no path, the file is written to the directory where IBM Storage Protect Snapshot is installed.
You cannot turn off IBM Storage Protect Snapshot logging activity. If you do not specify /LOGFile, log records are written to the default log file. The default log file is tdpsql.log.
When you use multiple simultaneous instances of IBM Storage Protect Snapshot to run operations, use the /LOGFile parameter to specify a different log file for each instance used. This function directs logging for each instance to a different log file and prevents interspersed log file records. Failure to specify a different log file for each instance can result in unreadable log files.

/LOGPrune=numdays|No

When you prune log data, you can discard some of the generated logs according to detailed filtering criteria that you set. Depending on the option that you set for the /LOGPrune parameter, a certain number of days of data are saved. By default, 60 days of log entries are saved. The option No can be entered to disable log pruning.

Regardless of the option that you set for this parameter, you can explicitly request log pruning at any time.

Considerations:

For numdays, the range is 0 to 9999. A value of 0 deletes all entries in the activity log file except for the current command entries.
If you specify no, the log file is not pruned.
If you do not specify /LOGPrune, the default value is that specified by the logprune configurable option in the configuration file. The default value is 60.
If you specify /LOGPrune, its value is used instead of the value that is stored in the configuration file. Specifying this parameter does not change the value in the configuration file.
You can specify /LOGPrune without specifying numdays or no; in this case, the default value, 60, is used.
Changes to the value of the TIMEformat or DATEformat parameter can result in an unwanted pruning of the log file. If you are running a command that might prune the log file, and the value of the TIMEformat or DATEformat parameter is changed, complete one of the following to prevent unintentional pruning of the log file:
- Make a copy of the existing log file.
- Specify a new log file with the /LOGFile parameter or logfile setting.

/OFFLOAD

Specify this option if, after the VSS snapshot is complete, you want to offload the transfer of the data from the IBM Storage Protect server to the system specified by the REMOTEDSMAGENTNODE parameter. This option is only valid when the BACKUPDESTination parameter is set to either TSM or BOTH. The default is to not offload data.

/Quiet

This parameter prevents status information from being displayed. This function does not affect the level of information that is written to the activity log.

/SQLAUTHentication=INTegrated | SQLuserid

This parameter specifies the authorization mode that is used when you log on to the SQL Server. The integrated value specifies Windows authentication. The user ID you use to log on to Windows is the same ID you use to log on to the SQL Server. This option is the default value.

Use the sqluserid value to specify SQL Server user ID authorization. The user ID specified by the /sqluserid parameter is the ID you use to log on to the SQL Server. Any SQL user ID must have the SQL Server SYSADMIN fixed server role.

/SQLCHECKSum=No|Yes

The /SQLCHECKSum parameter is used to verify the integrity of a legacy database backup. Integrity checking is a process that validates the values in a file or configuration for unexpected changes. Values are verified between the current state and the baseline state.

You can specify the following values:

No: Do not enable integrity checking for a legacy database backup. This value is the default.
Yes: Enable integrity checking for a legacy database backup.

In the Performance Properties window of Microsoft Management Console, you can enable or disable the checksum option for all your legacy databases at once. You can override the global setting, and temporarily enable or disable the checksum option for a database backup, by setting this SQLCHECKSum parameter value to Yes or No.

/SQLPassword=sqlpasswordname

This parameter specifies the SQL password that IBM Storage Protect Snapshot uses to log on to the SQL Server that objects are backed up from or restored to.

Considerations:

Using this parameter means that you are using SQL Server authentication. The SQL Server and the SQL user ID for this password must both be configured for SQL Server authentication.
If you do not specify /SQLPassword, the default value is blank (" ").
If you specify /SQLPassword, but not sqlpasswordname, the default is also blank (" ").
This parameter is ignored if you use the /SQLAUTH=INTegrated parameter with it.

/SQLSERVer=sqlserver-connection

The /sqlserver parameter specifies the SQL Server that Data Protection for SQL Server logs on to. The sqlserver-connection comprises the sqlprotocol and sqlservername. The sqlprotocol variable specifies the communication protocol to use and with this variable, you can specify an sqlservername. You can check the SQL connection by using the SQL Server Configuration Manager tool (under SQL Server Native Client Configuration client protocols). You can choose from the following protocols:

Table 1. Table 1. SQL Server connection protocols
Protocol Name	Description	Example Usage (with sqlserver-connection details)
lpc	Shared Memory	/sqlserver=lpc:<servername>\<instancename>
np	Named Pipes	/sqlserver=np:<servername>\pipe You can optionally specify a specific named pipe instance. For example, /sqlserver=np: \\hostname\pipe\pipe name By default, the pipe name is sql\query. If you connect to a named instance, the pipe name is typically in the following format: \\<servername>\pipe\MSSQL$<instancename>\SQL\query
tcp	Transmission Control	/sqlserver=[tcp:]<servername>[\<instancename>][,port]
via	Virtual Interface Adapter	/sqlserver=via:<virtualservername>[\<instancename>]

Attention:

For tcp protocols only, you have the option of defining a port. If you do not define a port, the default port value is the SQL default port 1433.
For the via protocol, SQL Server supports this protocol only through SQL Server 2008 R2.
To enable Data Protection for SQL Server to communicate with AlwaysOn Availability Group (AAG) instances, it is not possible to connect to the SQL Server using AAG listeners. For backup and restore operations, you must use the local SQL Server instance name (or instance name and port number) to communicate with the AAG. For AAG (or non-AAG instances), you can also specify non-default port numbers.

If you do not specify a protocol, Data Protection for SQL Server logs on to the SQL Server according to the first protocol that becomes available.

Considerations:

The default value is the value specified by the SQL Server configurable option in the Data Protection for SQL Server configuration file. This is initially the local computer name.
If you specify /sqlserver but not sqlservername, the local computer name is used.
The following two shortcuts are accepted as the local computer name: . (local) That is, a period or the word local within parentheses.
If the SQL Server is a member of a fail-over cluster, the CLUSTERNODE option in the IBM Storage Protect options file must have the value YES.
If the SQL Server is not the default instance or is a member of a fail-over cluster, you must specify the name.
The format of sqlservername depends on what type of instance it is and whether it is clustered or not:
Format Instance? Clustered? Name required?
local-computername default no no
local-computername\instancename named no yes
virtualservername default yes yes
virtualservername\instancename named yes yes

Format	Instance?	Clustered?	Name required?
local-computername	default	no	no
local-computername\instancename	named	no	yes
virtualservername	default	yes	yes
virtualservername\instancename	named	yes	yes

localcomputername: The network computer name of the computer on which the SQL Server and Data Protection for SQL Server reside. The TCP/IP host name may not always be the same.
instancename: The name given to the named instance of the SQL Server that is specified during installation of the instance.
virtualservername: The name given to the clustered SQL Server that is specified during clustering service setup. This name is not the cluster or node name.

/SQLUSer=sqlusername

The /SQLUSer parameter specifies the name that IBM Storage Protect Snapshot uses to log on to the SQL Server.

Considerations:

Using this parameter means that you are using SQL Server authentication. The SQL Server and the SQL user ID for this password must both be configured for SQL Server authentication.
The SQL user ID must have the SQL Server SYSADMIN fixed server role.
If you do not specify /SQLUSer, the default is sa.
If you specify /SQLUSer but not sqlusername, the default is also sa.
This parameter is ignored if you use the /SQLAUTH=integrated parameter with it.

/USEALWAYSONnode

Specify this parameter to back up standard databases on SQL Server 2012 and later versions by using the AlwaysOn node. By setting this parameter, you can back up all availability databases and standard databases under a single node to help you to manage your database backups more easily. By default, SQL Server 2012 and later version availability databases are backed up to the AlwaysOn node.