Set positional parameters

Positional parameters immediately follow the set command and precede the optional parameters.

To set default values in the IBM Storage Protect Snapshot configuration file, specify one of the following when you issue a set command.

ALWAYSONNode=nodename

Specify the IBM Storage Protect node name that is used to back up AlwaysOn availability databases with SQL Server 2012 and later versions. This parameter is required when you are configuring IBM Storage Protect Snapshotwith SQL Server 2012 and later versions. All availability databases in an availability group are backed up under this node name, regardless of which availability replica they are from. The databases that are not in an availability group are backed up under the standard IBM Storage Protect Snapshot node name unless you specify the USEALWAYSONnode parameter.

CAPACITYINFOINTerval=numdays

Use the CAPACITYINFOINTerval positional parameter to specify how often you want the capacity metrics report to be generated. The report, in an XML file format, is generated automatically at the end of a backup operation. The valid value range is 1 - 365 and the default value is 7 days, which means the report is generated once every 7 days.

CAPACITYINFOLOCation=pathname

Use the CAPACITYINFOLOCation positional parameter to specify the location where the capacity metrics report is to be created. If you do not specify a location, the report is not generated.

DATEformat=dateformatnum

The DATEformat parameter selects the format that you want to use to display dates.

The dateformatnum variable can range 1 - 7. The initial value is 1. The number values specify the following formats:

1: MM/DD/YYYY.
2: DD-MM-YYYY.
3: YYYY-MM-DD.
4: DD.MM.YYYY.
5: YYYY.MM.DD.
6: YYYY/MM/DD.
7: DD/MM/YYYY.

Changes to the value of the dateformat parameter can result in an undesired pruning of the IBM Storage Protect Snapshot log file (tdpsql.log by default). You can avoid losing existing log file data by running one of the following tasks:

After you change the value of the dateformat parameter, make a copy of the existing log file before you run IBM Storage Protect Snapshot.
Specify a new log file with the /logfile parameter.

FROMSQLSERVer=sqlservername

The fromsqlserver parameter specifies the SQL Server that backup objects were backed up from. This parameter is necessary only when the name of the SQL Server to restore to, as determined by the sqlserver parameter, is different from the name of the SQL Server that the backup objects were created from. Use fromsqlserver for query FCM, but use sqlserver for query SQL commands. The default value is the sqlserver value or the value that is set in the IBM Storage Protect Snapshot configuration file.

IMPORTVSSSNAPSHOTSONLYWhenneeded

Use the /IMPORTVSSSNAPSHOTSONLYWhenneeded parameter to specify whether IBM Storage Protect Snapshot automatically imports VSS snapshots to the Windows system where the snapshots are created.

Specify one of the following values:

Yes: Import VSS snapshots to the Windows system where the snapshots are created. The option is the default. During backup processing, transportable snapshots are automatically created and imported to storage systems when the snapshots are required.
Tip: For instant restore processing on IBM and non-IBM storage systems, you must specify the Yes option to enable the storage system to create transportable snapshots during backups.
No: Do not create transportable VSS snapshots during backup processing, and do not automatically import the snapshot to storage systems after the backup is completed.

LOCALDSMAgentnode=nodename

Specify the node name of the local system that runs the VSS backups. This positional parameter must be specified for VSS operations to be done.

LOGFile=logfilename

The logfile parameter specifies the name of the activity log that is generated by IBM Storage Protect Snapshot. The activity log records significant events such as completed commands and error messages. This 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.

/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, some 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.

NUMBERformat=numberformatnum

The numberformat parameter specifies the format of the numbers that are displayed by IBM Storage Protect Snapshot. The numberformatnum variable can range 1 - 6. The initial value is 1. The number values specify the following formats:

1: 1,000.00
2: 1,000,00
3: 1 000,00
4: 1 000.00
5: 1.000,00
6: 1'000,00

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 that 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. That user ID must have the SQL Server SYSADMIN fixed server role.

SQLSERVer=sqlprotocol:sqlservername

The SQLSERVersqlserver parameter specifies the SQL Server that IBM Storage Protect Snapshot logs on to. This SQL Server is the one that backup objects are restored to. However, if the backup objects were created from a different SQL Server name, you must use the fromsqlserver parameter. Use sqlserver for the query SQL command. The sqlprotocol variable specifies the communication protocol to use. You can specify one of the following protocols:

lpc: Use Shared Memory protocol.
np: Use Named Pipes protocol.
tcp: Use Transmission Control protocol.
via: Use Virtual Interface Architecture protocol.

If no protocol is specified, IBM Storage Protect Snapshot logs on to the SQL Server according to the first protocol that becomes available.

TIMEformat=timeformatnum

The timeformat parameter specifies the format of the times that are displayed by IBM Storage Protect Snapshot. The timeformatnum variable can range 1 - 4. The initial value is 1. The number values specify the following formats:

1: 23:00:00
2: 23,00,00
3: 23.00.00
4: 11:00:00A/P

Changes to the value of the timeformat parameter can result in an undesired pruning of the IBM Storage Protect Snapshot log file (tdpsql.log by default). You can avoid losing existing log file data by doing one of the following choices:

After you change the value of the timeformat parameter, make a copy of the existing log file before you run IBM Storage Protect Snapshot.
Specify a new log file with the /logfile parameter.

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.