HP StorageWorks Storage Mirroring Recover Scripting Guide HP Part Number: T5437-96022 Published: November 2010
© Copyright 1996-2010 Hewlett-Packard Development Company, L.P. and Double-Take Software, Inc. All rights reserved. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Table of Contents Client and scripts 9 Command Line client 10 Scripts 12 Command syntax conventions 14 Getting help for scripting commands 15 Replication sets 16 Creating a replication set 17 Modifying a replication set 21 Deleting a replication set 25 Calculating replication set size 27 Establishing a connection 30 Simulating a connection 33 Connections 35 Monitoring connections 36 Queuing Storage Mirroring Recover data 38 Reconnecting automatically 40 Pausing and resuming t
Stopping, starting, pausing, and resuming transmission 73 Scheduling data transmission 76 Transmission schedule examples 82 Limiting transmission bandwidth 83 Compressing data for transmission 89 Snapshots 91 Scheduling snapshots 92 Initiating a manual snapshot 96 Applying a snapshot on the target 97 Deleting a snapshot 98 Archiving 100 Archiving files manually 101 Recalling archived files from the target 104 Restoring data 106 Failover 110 Configuring failover monitoring 111
Using variables to pause a target 202 Using variables to resume a target 203 Creating a backup or snapshot of the target by inserting a task command during replication 204 Creating a backup of the target by rotating connections Scripting commands 206 208 Archive Pause 213 Archive Resume 214 Archive Start 215 Archive Stop 216 Block All 217 Compression Disable 218 Compression Enable 219 Compression List 220 Compression Set 221 ConID 222 Connect 223 Connect TDU 225 Disconnect 226
Environment 239 Exit 240 Failback 241 Failover 242 Get 243 GetEnvStr 244 Get Local 245 Help 246 Limit Bandwidth 247 Limit Bandwidth Disable 248 Limit Bandwidth Schedule Add 249 Limit Bandwidth Schedule Clear 251 Limit Bandwidth Schedule Enable 252 Limit Bandwidth Schedule List 253 Limit Bandwidth Schedule Remove 254 Load Source 255 Load System State 256 Load Target 257 Login 258 Logout 259 Mirror Pause 260 Mirror Resume 261 Mirror Start 262 Mirror Stop 263 Mon
Monitor Display 269 Monitor Get 270 Monitor List 271 Monitor Move 272 Monitor Option 274 Monitor Remove 277 Monitor Script Add 278 Monitor Script Remove 280 Monitor Start 281 Monitor Stop 282 Monitor Use 283 NIC List 284 Orphans Disable 285 Orphans Enable 286 Orphans Start 287 Orphans Stop 288 Pause Target 289 Ping 290 Queue Task 291 Quit 294 Recall Pause 295 Recall Resume 296 Recall Start 297 Recall Stop 298 Replication Start 299 Replication Stop 300 Reps
Repset Display 304 Repset List 305 Repset Resync 306 Repset Rule Add 307 Repset Rule Remove 308 Repset Save 309 Repset Use 310 Restore 311 Resume Target 313 Schedule Clear 314 Schedule Disable 315 Schedule Enable 316 Schedule End 317 Schedule Start 318 Schedule Window 320 Script Account 321 Script Add 322 Script List 324 Script Remove 325 Script Test 326 Set 328 Set Local 329 Shutdown 330 Snapshot Create 331 Snapshot Delete 332 Snapshot List 333 Snapshot R
Snapshot Schedule Enable 337 Snapshot Schedule Every 338 Source 339 StatsLog Start 340 StatsLog Status 341 StatsLog Stop 342 Status 343 Target 344 Test Connections 345 Time Now 346 Transmission Pause 347 Transmission Resume 348 Transmission Start 349 Transmission Stop 350 Unblock All 351 Unload Source 352 Unload System State 353 Unload Target 354 Verify 355 Version 357 Wait 358 Wait on Mirror 359 Wait on Restore 360 Wait on Target 361 Write 362 Index 363
Client and scripts Storage Mirroring Recover has its own scripting language to control some, but not all Storage Mirroring Recover features. This Scripting Guide does not explain Storage Mirroring Recover features and functions, only the scripting aspects of Storage Mirroring Recover. For details on the features and functions, see the Storage Mirroring Recover User's Guide. The scripting language can be used in the Storage Mirroring Recover Command Line client or in script files.
Command Line client There are three different methods of executing commands from the Command Line client. l Interactive Entry—At the directory prompt where Storage Mirroring Recover is installed, type the command DTCL –i. A Command prompt will appear and the scripting commands can be entered from that prompt. Any resulting errors are immediately displayed.
Note: Because the Windows command process (cmd.exe) strips two layers of quotation marks during processing, any scripting command that you use that requires quotation marks must have three quotation marks around it. For example, if your machine name had a space in it, login "machine name" username password would be sufficient for the Command Line client interactive entry or file entry. But for the Command Line client single line entry, you would have to use login """machine name""" username password.
Scripts You can create script files to execute series and combinations of scripting commands to meet specific needs. When working with scripts, keep in mind the following. l l l l l When creating scripts, each commented line must start and end with the pound (or number) sign (#). Scripts must use ANSI coding. Do not use Unicode or other formats. Variables can be used in commands to replace items that vary such as machine or domain names.
exceeds the end value. If a step value is not provided, the default adds one to the variable. Use the following syntax for the FOR loop. FOR = TO [STEP ] DO END l WHILE Loop—The WHILE loop evaluates a relational expression and, if it is true, then the statement block is executed. When the statement block has completed execution, the expression will be reevaluated again and, if it is true, the statement block is executed again.
Command syntax conventions The following conventions are used for the scripting commands. l l l l l l UPPERCASE letters indicate syntax that must be typed exactly as shown. lowercase italic blue letters are variables such as file names, user names, or machine names. Angle brackets, < and >, surround required items that must be supplied with the command. Square brackets, [ and ], surround optional items that can be supplied with the command but are not required.
Getting help for scripting commands A listing of the DTCL commands and their syntax is available by typing the help command. Command HELP Description Displays the DTCL commands and their syntax Syntax HELP Notes l Press any key to scroll through the list of commands. l Press q to exit the help function. l You can also type dtcl help from the directory where the Storage Mirroring Recover program files are installed to display the DTCL commands and their syntax.
Replication sets Using the scripting commands, you can perform the following functions to manage your replication sets.
Creating a replication set Before you can establish a connection, you must create a replication set. 1. Use the repset create command to create a new replication set. Command REPSET CREATE Description Creates a replication set Syntax REPSET CREATE Options name—Name of the replication set Examples repset create DataFiles Notes l l The name of the replication set should not be a Storage Mirroring Recover keyword. These are any DTCL command (source, target, and so on.
Options repset—Name of the replication set Examples repset use DataFiles Notes Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. 3. Define a replication set rule by using the repset rule add command. Command REPSET RULE ADD Description Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names.
Notes l l l l The default settings for this command are include and recursive. The options include/exclude and recursive/nonrecursive can be used in any combination and in any order. The first option does not require a comma, but the second option does require a comma before the option. If you do not specify a replication set name, the current replication set will be used. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 4.
6. After you have added all of the rules, save the replication set by using the repset save command.
Modifying a replication set Make modifications to a replication set when you want to change the data you wish to protect. 1. View the replication sets associated with the active source machine by using the repset list command. Command REPSET LIST Description Lists all replication set names for the currently selected source Syntax REPSET LIST 2. Identify a replication set as active by using the repset use command.
3. View the replication set’s rules by using the repset display command. Command REPSET DISPLAY Description Displays the replication set rules Syntax REPSET DISPlay [repset] Options repset—Name of the replication set Examples l repset display DataFiles l repset disp DataFiles Notes l l If you do not specify a replication set name, the current replication set will be used. Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks. 4.
Examples l repset rule remove "c:\data" from DataFiles l repset rule rem "c:\temp" Notes l l If you do not specify a replication set name, the current replication set will be used. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 5. Add a new rule by using the repset rule add command. Command REPSET RULE ADD Description Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names.
Notes l l l l The default settings for this command are include and recursive. The options include/exclude and recursive/nonrecursive can be used in any combination and in any order. The first option does not require a comma, but the second option does require a comma before the option. If you do not specify a replication set name, the current replication set will be used. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 6.
Deleting a replication set 1. View the replication sets associated with the active source machine by using the repset list command. Command REPSET LIST Description Lists all replication set names for the currently selected source Syntax REPSET LIST 2. Delete the replication set by using the repset delete command.
3. After deleting the replication set, use the repset save command so that the deletion will be registered by other Storage Mirroring Recover clients.
Calculating replication set size 1. Use the repset calculate command to manually calculate the size of a replication set. Command REPSET CALCULATE Description Calculates the size of a replication set Syntax REPSET CALCulate [repset] Options repset—Name of the replication set Examples l repset calculate DataFiles l repset calc DataFiles Notes l l l If a replication set name is not specified, the active replication set will be used.
Description Requests the value of a Storage Mirroring Recover program setting from the specified server Syntax GET [machine] Options l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings l machine—Name of the machine l get AutoRemirror l get MoveOrphansDir Examples Notes l l If you do not specify a machine name, the value from the current source will be returned. If you have not identified an active source, no data will be returned.
Examples l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Notes l l l Some settings, although immediately applied to Storage Mirroring Recover, will not take effect until the service is restarted. If you do not specify a machine name, the value from the current source will be updated. If you have not identified an active source, no changes will be made. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Establishing a connection After you have created a replication set, you can establish a connection by connecting the replication set to a target. 1. If you do not know which replication set you will be connecting to the target machine, the repset list command will display the available replication sets for that source. Command REPSET LIST Description Lists all replication set names for the currently selected source Syntax REPSET LIST 2.
Options l l l l l l l l l l l l l l repset—Name of the replication set target—Name of the target, an IP address on the target, or a virtual IP address MAP EXACT—Specifies that the replication set data will be sent to the same logical volume on the target (c:\data and d:\files is copied to c:\data and d:\files, respectively) MAP BASE target_path—Substitute a complete path, including the volume, for target_path and the data will be replicated to target_path\SrcVolName on the target machine MAP so
l l l COMPRESSion level—Enables compression of data being sent to the target at the level specified. Valid levels are 1 (minimum), 2 (moderate), or 3 (maximum).
Simulating a connection After you have created a replication set, you can simulate a connection by connecting the replication set to the TDU. 1. If you do not know which replication set you will be connecting to the target machine, the repset list command will display the available replication sets for that source. Command REPSET LIST Description Lists all replication set names for the currently selected source Syntax REPSET LIST 2. To initiate a connection to the TDU, use the connect TDU command.
l connection_flags—The same options available in the standard connect command Examples l connect DataFiles to TDU l connect UserData to TDU map c:\userdata to e:\backup\userdata Notes l l The statistic file that the TDU creates can be viewed using DTStat. By default, the file is called statistic.sts. To view the statistic file, type DTStat -f . Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Connections Using the scripting commands, you can perform the following functions to manage your connections.
Monitoring connections 1. Identify the connection ID that you want to monitor by using the conID command.
2. Use the status command to display statistical and informational data.
Queuing Storage Mirroring Recover data Use the get and set commands with the following options to configure how Storage Mirroring Recover queues data.
Command SET Description Modifies the value of a Storage Mirroring Recover program setting for the specified server Syntax SET = [machine] Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some settings,
Reconnecting automatically Use the AutoReconnect option with the get and set commands to configure Storage Mirroring Recover to reconnect connections automatically.
Syntax SET = [machine] Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some settings, although immediately applied to Storage Mirroring Recover, will not take effect until the service is restarted.
Pausing and resuming target processing 1. Pause the execution of operations on the target by using the pausetarget command on a target that you are logged in to.
Description Allows you to resume the execution of Storage Mirroring Recover operations on the target Syntax RESUMETARGET [FROM ] Options l l target—Name of the target, an IP address on the target, or a virtual IP address source—Name of the source Examples resumetarget beta Notes l l You must be logged on to the target machine for this command to work. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Disconnecting a connection Use the disconnect command to disconnect the source/target connection.
Mirroring Using the scripting commands, you can perform the following functions to manage mirroring.
Stopping, starting, pausing, or resuming mirroring You can start, stop, pause, or resume a mirror.
Notes The default settings for this command are noorphans and calculate.
Notes l mirror pause 1 l mir pause * Command MIRROR RESUME Description Resumes a paused mirror Syntax MIRror RESUME Options l con_id—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l mirror resume 1 l mir resume * Notes
Mirroring automatically Use the AutoRemirror option with the get and set commands to configure if a mirror is initiated automatically when a connection is automatically reconnected.
Syntax SET = [machine] Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some settings, although immediately applied to Storage Mirroring Recover, will not take effect until the service is restarted.
Using mirror scripts 1. To determine any current mirroring scripts, use the script list command.
Syntax SCRIPT ADD [source] = [ARGS=arguments] [DELAY|NODELAY] [INTERACT|NOINTERACT] Options l con_id—Connection ID assigned to the source/target connection l source—Name of the source l l l l l l l target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types MIRRORSTART—This script starts when the target receives the first mirror operation.
enclosed in quotation marks and separated by a space. Also, if an argument contains non-alphanumeric characters, you must enclose it in quotation marks. Arguments cannot contain nested quotation marks. Therefore, if you are passing more than one argument to your script, none of the arguments can require quotation marks. To work around this limitation, you can use 8.3 file naming.
Options l machine—Name of the machine l username—Name of the user l password—Password associated with the user name l domain—If logging in using a domain account, this is the domain name. If logging in using a local account, this is the machine name. Examples script account alpha administrator ********* domain Notes l l l The password associated with the username cannot be blank. The password cannot be a Storage Mirroring Recover keyword. These are any DTCL command (source, target, and so on.
l l l arguments—Specify any arguments, valid for your script, that are required to execute your script. INTERACT—Display script processing on the screen NOINTERACT—Do not display script processing. Execute the script silently in the background Examples script test beta "C:\Program Files\StorageWorks\Storage Mirroring\Scripts\MirrorStartScript. bat" "arg1 arg2" interact Notes l l l l The default setting for this command is nointeract.
Options l con_id—Connection ID assigned to the source/target connection l source—Name of the source machine l l l l l target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types MIRRORSTART—Script that was being processed before the mirroring process starts MIRRORSTOP—Script that was being processed when the mirroring process stops MIRRORCOMPLETE—Script that was being processed when the mirroring process is complete Examples l script remov
Removing orphan files 1. To configure orphan removal or deletion during mirror, verification, and restoration processes, use the orphans enable command. Command ORPHANS ENABLE Description Enables orphan file removal during subsequent mirror or verification processes Syntax ORPHANS ENABLE con_id Options con_id—Connection ID assigned to the source/target connection Examples orphans enable 1 2.
l machine—Name of the machine l get AutoRemirror l get MoveOrphansDir Examples Notes l l If you do not specify a machine name, the value from the current source will be returned. If you have not identified an active source, no data will be returned. Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
l l If you do not specify a machine name, the value from the current source will be updated. If you have not identified an active source, no changes will be made. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 3. To disable orphan removal or deletion, use the orphans disable command.
Options l l con_id—Connection ID assigned to the source/target connection CLEARRESTOREREQUIRED—Clears the restore required flag and initiates the orphan operation Examples orphans start 1 5. If you want to stop removing orphan files after it has been started, use the orphans stop command.
Replication Using the scripting commands, you can perform the following functions to manage replication.
Starting replication Start replication by using the replication start command.
Inserting tasks during replication Task command processing is a Storage Mirroring Recover feature that allows you to insert and run tasks at various points during the replication of data. Because the tasks are user-defined, you can achieve a wide variety of goals with this feature. For example, you might insert a task to create a snapshot or run a backup on the target after a certain segment of data from the source has been applied on the target.
6. The target processes the Storage Mirroring Recover task command and completes whatever task is defined, perhaps a snapshot or backup. Since the Storage Mirroring Recover task command is user-defined, you can insert any valid executable or batch file. Storage Mirroring Recover task command processing must be enabled, and there must be an active Storage Mirroring Recover connection for task command processing to function properly. To insert a task command, you would use the queuetask command.
l l l l l task—The path and filename of the task to run relative to the machine it will be run on. Tasks include any valid executable or batch file. The executables or files must exist in the specified location on the machine where they will be executed args—Arguments or options which need to be supplied with the task. Multiple arguments can be supplied in a space-separated list enclosed in quotation marks.
l l l l l A task may be discarded if all connections to a target are manually disconnected, replication is stopped for all connections to a target, or an auto-disconnect occurs. If a task is submitted after replication is stopped, the task will be executed immediately. If you disable task command processing while tasks are in queue, those tasks will not be executed.
Verifying your target data With scripting commands, verification can only be initiated after a connection is established. 1. Log on to the source using the login command. Command LOGIN Description Log on to a Storage Mirroring Recover machine Syntax LOGIN [domain] Options l l l l machine—Name of the machine username—Name of the user. The username is limited to 100 characters. password—Password associated with the user name. The password is limited to 100 characters.
2. Identify the source that you want to initiate verification for by using the source command. Command SOURCE Description Identifies a machine as the active source machine Syntax SOUrce Options source—Name of the source Examples l source alpha l sou alpha Notes Source names that contain non-alphanumeric characters must be enclosed in quotation marks. 3. Initiate the verification process by using the verify command.
Options l con_id—Connection ID assigned to the source/target connection l SYNC—Synchronizes any data that is different l l l l l l l l NEWER—Synchronizes only those files that are newer on the source than on the target NOSYNC—Do not synchronize any data that is different CHECKSUM—Compares and/or synchronizes those blocks that are different on the source than on the target based on checksum comparisons NOCHECKSUM—Does not perform a checksum comparison when comparing and/or synchronizing files STAR
4. Use the VerifyLogName, VerifyLogAppend, and VerifyLogLimit options with the get and set commands to configure the verification log.
Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some settings, although immediately applied to Storage Mirroring Recover, will not take effect until the service is restarted.
Data transmission Using the scripting commands, you can perform the following functions to manage your Storage Mirroring Recover transmissions.
Stopping, starting, pausing, and resuming transmission You can stop, start, pause, or resume transmission. 1. To start the transmission process, use the transmission start command. Command TRANSMISSION START Description Initiates the transmission pause Syntax TRANSmission START Options target—Name of the target, an IP address on the target, or a virtual IP address.
Syntax TRANSmission STOP Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l transmission stop beta l trans stop beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 3. To pause the transmission process, use the transmission pause command.
Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 4. To resume the transmission process, use the transmission resume command. Command TRANSMISSION RESUME Description Resumes a paused transmission pause Syntax TRANSmission RESUME Options target—Name of the target, an IP address on the target, or a virtual IP address.
Scheduling data transmission You can clear an existing schedule, disable or enable the use of a schedule, and set start, stop, and window criteria. Note: All transmission options are stored on the source machine until they are either cleared or the option is updated. At this time, there is not a command to display the existing transmission options. 1. To clear all existing transmission options, use the schedule clear command.
enable or disable transmission limiting. Command SCHEDULE ENABLE Description Enables the transmission schedule Syntax SCHEDule ENABLE Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l schedule beta disable l sched beta disable Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 3. You can specify a start time, a repeat interval, and queue usage criteria using the schedule start command.
l l l bytes—Number of bytes that must be in the source disk queue to initiate the transmission process number—Any number indicating how often the transmission process will be repeated time_units—Minutes (min), hours (hr), or days (day) Examples l l schedule beta start starttime=03/11/07 03:30, queuesize=10000, every 6 hr sched beta start queuesize=100000000 Notes l l l The start option EVERY cannot be used by itself and cannot be the first option in a string of options.
specify the fully qualified domain name. l number—Any number indicating the length of time before the transmission ends l time_units—Minutes (min), hours (hr), or days (day) l bytes—Number of bytes transmitted before the transmission ends l schedule beta end duration=3 hr bytes=1500000 l sched beta end duration=6 hr Examples Notes l l If you use both of the end options, duration and bytes, the transmission will be stopped when the first end option value is met.
Examples l schedule beta window 23:00 to 06:00 l sche beta window 20:00 to 4:00 Notes l l Establishing a transmission window by itself is not sufficient to start a transmission. You will need to specify a start criteria. Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Transmission schedule examples This section shows examples of how the different schedule commands could be used together. The numbers and times were randomly selected for these examples. Be sure to use values that work for your environment. l Example 1—In this example, transmission is set to begin on January 12, 2010, at 10:30 p.m. and to end after 6 hours. This schedule is also set to repeat every day.
Limiting transmission bandwidth You can set a fixed bandwidth limit or a bandwidth schedule. 1. With a fixed bandwidth limit, data will be transmitted at all times according to the user-specified bandwidth configuration. If you want to set a fixed bandwidth limit, use the limit bandwidth command.
2. With a scheduled bandwidth limit, data will be transmitted according to the userspecified schedule and the user-specified bandwidth configuration. Implementing a schedule requires several steps and DTCL commands. Create a scheduled event using the limit bandwidth schedule add command. Command LIMIT BANDWIDTH SCHEDULE ADD Description Creates a scheduled bandwidth event for limiting transmission of data from the source to the target Syntax LIMIT BANDWIDTH SCHEDULE ADD
Notes l l This command transmits in bursts, not bytes per seconds. The time identifies how long to wait before transmitting again. For example, if 5 seconds are specified and it only takes 2 seconds to send the specified bytes, Storage Mirroring Recover will wait an additional 3 seconds before transmitting again. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 3. Repeat the limit bandwidth schedule add command to create a comprehensive bandwidth schedule.
Examples limit bandwidth schedule list beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 5. If you need to remove a scheduled event, use the limit bandwidth schedule remove command.
Command LIMIT BANDWIDTH SCHEDULE CLEAR Description Clears a bandwidth schedule Syntax LIMIT BANDWIDTH SCHEDULE CLEAR Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples limit bandwidth schedule clear beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 7.
Examples limit bandwidth disable on beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 8. You can enable a disabled schedule by using the limit bandwidth schedule enable command. Command LIMIT BANDWIDTH SCHEDULE ENABLE Description Enables a bandwidth schedule Syntax LIMIT BANDWIDTH SCHEDULE ENABLE ON Options target—Name of the target, an IP address on the target, or a virtual IP address.
Compressing data for transmission 1. To determine the current compression setting, use the compression list command. By default, compression is disabled. Command COMPRESSION LIST Description Identifies the compression level and if compression is enabled Syntax COMPRESSion LIST 2. To set the level of compression, use the compression set command.
3. To initiate compression, use the compression enable command. Command COMPRESSION ENABLE Description Enables compression Syntax COMPRESSion ENABLE Options con_id—Connection ID assigned to the source/target connection Examples compression enable 1 4. If you need to stop compression, use the compression disable command.
Snapshots Using the scripting commands, you can perform the following functions to manage your Storage Mirroring Recover snapshots.
Scheduling snapshots Use the snapshot schedule commands to establish scheduled snapshots. 1. To establish and initiate a snapshot schedule, use the snapshot schedule every command.
2. After you have created a snapshot schedule, you can view the configuration of the schedule by using the snapshot schedule display command.
Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot schedule 1 disable l snap sched 1 disable Notes l l This command only disables the snapshot schedule for this connection so that it will not run. It does not clear the snapshot schedule parameters. Target names that contain non-alphnumeric characters must be enclosed in quotation marks. 4.
Notes Target names that contain non-alphnumeric characters must be enclosed in quotation marks.
Initiating a manual snapshot Use the snapshot create command to take a manual snapshot.
Applying a snapshot on the target Apply a snapshot to the target by using the snapshot revert command.
Deleting a snapshot Because Storage Mirroring Recover uses the Microsoft Volume Shadow Copy service to create snapshots, the snapshots can be managed through the Volume Shadow Copy command line administrator. You can also view, copy, or restore files from the Previous Version tab by accessing the file properties through a share using Windows Explorer. See your Volume Shadow Copy documentation for details. Additionally, you can use the scripting commands to delete snapshots on the target. 1.
Description Deletes the specified snapshot(s) from the target Syntax SNAPshot DELete [ON ] Options l l con_id—Connection ID assigned to the source/target connection snapshot_list_number—The snapshot number retrieved from the SNAPSHOT LIST command l ALL—Deletes all snapshots l OLD—Deletes only the oldest snapshot l l l GOOD—If specified, deletes only good snapshot. If used with ALL, all good snapshots will be deleted.
Archiving Using the scripting commands, you can manually archive your files and recall archived files.
Archiving files manually 1. To start archiving, use the archive start command. Command ARCHIVE START Description Starts the archive process Syntax ARCHIVE START FILEAGE FILESIZE Options l l l con_id—Connection ID assigned to the source/target connection number_days—Any number indicating the age, in days, of the files that you want archived. Any file older than the days specified will be archived.
Options con_id—Connection ID assigned to the source/target connection Examples archive pause 1 3. To resume archiving, use the archive resume command. Command ARCHIVE RESUME Description Resumes the archive process Syntax ARCHIVE RESUME Options con_id—Connection ID assigned to the source/target connection Examples archive resume 1 4. To stop archiving, use the archive stop command.
Examples archive stop 1
Recalling archived files from the target 1. To start the process to recall all files from the target, use the recall start command. Command RECALL START Description Starts the process to recall all archived files from the target Syntax RECALL START Options con_id—Connection ID assigned to the source/target connection Examples recall start 1 2. To pause the process to recall all files from the target, use the recall pause command.
3. To resume the process to recall all files from the target, use the recall resume command. Command RECALL RESUME Description Resumes the process to recall all archived files from the target Syntax RECALL RESUME Options con_id—Connection ID assigned to the source/target connection Examples recall resume 1 4. To stop the process to recall all files from the target, use the recall stop command.
Restoring data 1. Log on to your target using the login command. Command LOGIN Description Log on to a Storage Mirroring Recover machine Syntax LOGIN [domain] Options l l l l machine—Name of the machine username—Name of the user. The username is limited to 100 characters. password—Password associated with the user name. The password is limited to 100 characters. domain—If logging in using a domain account, this is the domain name.
Command SOURCE Description Identifies a machine as the active source machine Syntax SOUrce Options source—Name of the source Examples l source alpha l sou alpha Notes Source names that contain non-alphanumeric characters must be enclosed in quotation marks. 3. Restore Storage Mirroring Recover data from the target to the source by using the restore command.
Options l l repset—Name of the replication set target—Name of the target, an IP address on the target, or a virtual IP address l original_source—Name of the original source l OVERWRITE—Overwrites files on the source l NOOVERWRITE—Does not overwrite files on the source l l l l l l l l l l OVERWRITENEWER—Overwrites files on the source even if the source file is newer than on the target NOOVERWRITENEWER—Does not overwrite files on the source that are newer on the source than on the target USET
l l This command requires the original source option. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 4. After the restoration is complete, the connection will remain connected and continue replicating data changes from the target to the source until the restoration connection is manually disconnected on the target using the disconnect command.
Failover Using the scripting commands, you can perform the following functions to manage failover.
Configuring failover monitoring 1. Specify a target machine by using the target command. Command TARGET Description Identifies a machine as the active target machine Syntax TARget Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l target beta l tar beta Notes l l You must be logged into a machine using the login command before using the target command. Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Syntax NICLIST [target] Options target—Name of the target, an IP address on the target, or a virtual IP address Examples niclist beta Notes l l l If you do not specify a machine name, the value from the current target will be returned. If you have not identified a target, no data will be returned. If you have not logged into the target machine, no data will be displayed. Target names that contain non-alphanumeric characters must be enclosed in quotation marks. 3.
Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks. 4. Specify that you want to use the monitor that was just created by using the monitor use command. Command MONITOR USE Description Specifies the source machine designated as the monitor that will be used in subsequent monitor commands Syntax MONitor USE Options monitor—Name of the source machine designated as the monitor .
Description Designates the IP address that will be failed over to the specified target NIC Syntax MONitor MOVE TO NIC USE NONE | NETWORK INTERVAL TIMEOUT | SERVICE INTERVAL TIMEOUT | [monitor] Options l l l l l l l l l IP_address—The IP address which should be moved during failover target_NIC—The integer value of the target NIC obtained from the niclist command NONE—Does not actively monitor the source machine.
Notes l l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected. If you choose to use the service option, your source and target must be using the same Storage Mirroring Recover port settings. If you choose to use the network option, the port settings can be different.
l Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 7. Configure the failover settings by using the monitor option command.
l l l l l l l l l l l l l l l l FAILONE—When multiple IP addresses exist on a monitor machine, only the failed address is failed over to the target machine FAILALL—When multiple IP addresses exist on a monitor machine, all of the addresses will fail over to the target machine even if only one address fails FODELAY—Guarantees that the pre-failover script has completed before failing over NOFODELAY—Does not guarantee that the pre-failbover script has completed before failing over FBDELAY—Guara
l monitor option nomoveshares, nousesharefile, failone, nointervention Notes l l l The default settings are movename, moveaddress, moveshares, add, usesharefile, failall, fodelay, fbdelay, apply, intervention, nofohostname, and nofbhostname. The options can be used in any combination and in any order. The first option does not require a comma, but the second and remaining options do require a comma before the option.
Notes l l l The password cannot be a Storage Mirroring Recover keyword. These are any DTCL commands (source, target, and so on) or any DTCL shortcut commands (env, mon, rep, and so on). The password cannot be blank. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 9. Specify any scripts by using the monitor script add command.
l monitor—Name of the source machine designated as the monitor Examples l l monitor script add prefailback "C:\Program Files\StorageWorks\Storage Mirroring\scripts\preback.bat" mon script add prefailback "C:\Program Files\StorageWorks\Storage Mirroring\scripts\preback.bat" Notes l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected.
l l SRCPOSTFAILBACK—The file is a post-failback script to be run on the source after failback monitor—Name of the source machine designated as the monitor Examples l monitor script remove prefailback l mon script rem postfailover Notes l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected.
selected. l l Depending on your sequence of commands, you may need to use the monitor get command to specify an active monitor before using monitor display. Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 12. Start failover monitoring by using the monitor start command.
Editing failover monitoring configuration 1. Specify your active monitor by using the monitor get command. Command MONITOR GET Description Identifies a machine as the active monitor machine Syntax MONitor GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor get beta l mon get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2.
Examples l monitor display alpha l mon disp alpha Notes l l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected. Depending on your sequence of commands, you may need to use the monitor get command to specify an active monitor before using monitor display.
Failing over Verify that the source machine is offline and not connected to the network to avoid IP address conflicts. Trigger failover using the failover command.
Stopping failover monitoring 1. Specify your active monitor by using the monitor get command. Command MONITOR GET Description Identifies a machine as the active monitor machine Syntax MONitor GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor get beta l mon get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2. To stop failover monitoring, use the monitor stop command.
Options l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor stop alpha on beta l mon stop alpha Notes Option names that contain non-alphanumeric characters must be enclosed in quotation marks.
Deleting failover monitoring configuration 1. Specify your active monitor by using the monitor get command. Command MONITOR GET Description Identifies a machine as the active monitor machine Syntax MONitor GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor get beta l mon get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2. To delete the monitor, use the monitor delete command.
Examples l monitor delete alpha l mon del alpha Notes l l In order to successfully delete a monitor, the monitor must not be running on the server. Use the monitor stop command to ensure the monitor is not running. Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks.
Failing back 1. If you are performing failback before restoring, verify that your source machine is not connected to the network and that the issue(s) that caused the failure is resolved. If you have already performed a restoration, your source should already be connected to the network using a unique identity. 2. Login to the target machine that is currently standing in for the failed source by using the login command.
l When scripting with this command, it will return one of three positive numbers: 0 (no access granted), 1 (monitor access granted), or 2 (full access granted). 3. Identify the machine you just logged into as the target by using the target command.
Syntax MONitor GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor get beta l mon get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 5. Initiate failback by using the failback command. If you specified a pre-failback script in your failover configuration, that script will be executed at this time.
Notes l l Options that contain non-alphanumeric characters must be enclosed in quotation marks. The source machine must be online and Storage Mirroring Recover must be running to ensure that the source post-failback script can be started. If the source has not completed its boot process, the command to start the script may be lost and the script will not be initiated.
Configuring server settings While only a subset of the server settings are available through the Management Console, all of the Storage Mirroring Recover server settings are accessible through the get and set commands. See Server settings for a complete list of the server settings. l l Retrieving setting values—To retrieve the current value of a setting, use the get command. This command will return the value of the specified setting from the specified server.
Command SET Description Modifies the value of a Storage Mirroring Recover program setting for the specified server Syntax SET = [machine] Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some settings,
Server settings The following table lists all of the server settings, in decimal value. ActivationCode Description—24-character Storage Mirroring Recover activation code Values—Unique value for each customer Default—N/A GUI Setting—Server Properties, Licensing tab, Activation Code Service restart required—No AdapterFlags Description—Specifies the adapter to use when establishing a connection. This option should not be changed.
GUI Setting—Server Properties, Setup tab, Advertise service with Active Directory Service restart required—Yes Notes—If Active Directory advertisement is enabled, there is a 200 byte impact on the Active Directory service for each server that registers. The Storage Mirroring service registers with Active Directory at startup and unregisters at shutdown.
ArchiveExclusionFiles Description—Specifies files that, if included in the replication set, will be excluded from the archiving process. Wildcard characters are not allowed. Values—any valid file name Default—autoexec.bat config.
Values—any valid integer Default—10485760 GUI Setting—Server Properties.
ArchiveUseDNSName Description—Specifies if the archive file name uses a name or IP address Values—0 Archived files are stored with the server source IP address, 1 Archived files are stored with the source server name Default—0 GUI Setting—None Service restart required—No AutoCalcEulaAccepted Description—Used internally by the Management Console. Do not modify this entry.
Values—any integer Default—30 GUI Setting—None Service restart required—No AutoRetransmit Description—Determines whether or not a source that has lost its connection with a target will attempt to reconnect to the target Values—0 Do not attempt to reconnect, 1 Attempt to reconnect Default—1 GUI Setting—None Service restart required—No BackupDir Description—Location on the target of the backup of the replication sets Values—any valid path Default—the location where the Storage Mirroring Recover files were ins
bytes remaining to be mirrored. CalculateByVolume can be enabled as a workaround. This setting will get the amount of disk space in use for the entire volume from the operating system, so the calculation occurs instantaneously. However, if the entire volume is not being replicated, the mirror percentage complete and bytes remaining will be incorrect accordingly.
ConnectionFile Description—Name of the database file containing connection information Values—any valid file name Default—connect.
Values—2 IPv4 protocol only, 23 IPv4 and IPv6 protocols, 3 TDU (Throughput Diagnostics Utility) Default—2 GUI Setting—None Service restart required—Yes DefaultReaderType Description—Internal setting used by Storage Mirroring Replicate for recoveries. Do not modify this setting. DelayGCArbitration Description—Number of seconds to delay the arbitration process.
DisableAttributeReplication Description—Specifies whether or not attributes (read-only, hidden, and so on) are replicated to the target Values—0 Enable attribute replication, 1 Disable attribute replication Default—0 GUI Setting—None Service restart required—No DropOpOnAccessDeniedError Description—Specifies whether or not operations are dropped or retried after an access denied error Values—0 The operation will be retried, 1 The operation will be dropped Default—1 GUI Setting—None Service restart required—
DumpDiskQuotaIntervalMinutes Description—Specifies how often, in minutes, a snapshot of the disk quota is taken as a backup in case the live registry is not usable at failover Values—any integer Default—240 GUI Setting—None This option is for full-server products.
GUI Setting—Server Properties, E-mail Notification tab, Exclude these Event IDs Service restart required—Yes from DTCL, No from GUI EmailFromAddress Description—Specifies the e-mail address that will appear in the From field of Storage Mirroring Recover generated e-mail messages.
GUI Setting—Server Properties, E-mail Notification tab, Log on to SMTP Server, Password Service restart required—No Notes—Since the password is encrypted for security, this entry cannot be displayed or changed through the registry or through DTCL.
EmailSubjectDesc Description—Specifies if the Event Viewer message will be appended to the end of the subject line for e-mail notification Values—0 Event Viewer message is not included in the subject line, 1 Event Viewer message is included in the subject line Default—1 GUI Setting—Server Properties, E-mail Notification tab, Add event description to subject Service restart required—No EmailSubjectPrefix Description—Specifies unique text which will be inserted at the front of the subject line for each Storag
Service restart required—No EnableFileOpenTracing Description—Specifies if debug-level messages are enabled to trace all mirroring and replicated files that are opened Values—0 Do not trace files that are opened, 1 Trace files that are opened Default—0 GUI Setting—None Service restart required—Yes Notes—This option should only be enabled (1) for temporary, debug sessions as instructed by technical support. EnablePerformanceTracking Description—This entry will be used in the future.
EnableSnapshots Description—Specifies whether Storage Mirroring Recover snapshot functionality is enabled Values—0 Storage Mirroring Recover snapshot functionality is disabled, 1 Storage Mirroring Recover snapshot functionality is enabled Default—1 GUI Setting—None Service restart required—Yes Notes—This setting only impacts Storage Mirroring Recover snapshot functionality. If this setting is disabled, other snapshot software such as Microsoft Volume Shadow Copy will be not be impacted.
ExtensionNumber Description—Used by the Storage Mirroring Recover log files. FailbackHostname Description—Returns the host SPN (Service Principle Name) to its original setting on failback Values—0 Disabled, 1 Enabled Default—0 GUI Setting—Failover Control Center, Monitor Settings, Active Directory, Failback Hostname Service restart required—No Notes—If you are using Active Directory, this option should be enabled or you may experience problems with failback.
FileAccessRetry Description—The number of times a failed driver call will be retried by the service. Values—1 - 65535 Default—10 GUI Setting—None Service restart required—No FileQueueSize Description—When a mirror is started, one thread reads from the disk and builds the file queue. Another set of threads reads files off of the queue and sends them to the target. This setting is the maximum size of the queue in entries.
Values—0 Verification is not performed with every difference mirror, 1 Verification is performed with every difference mirror Default—0 GUI Setting—None Service restart required—No HardLinkInterval Description—Specifies the length of time, in seconds, to generate a hard link report Values—any valid integer Default—3600 GUI Setting—None Service restart required—No HardLinkLogPath Description—Specifies the location where hard links will be logged.
Values—0 - 65535 Default—10 GUI Setting—None Service restart required—No HeartbeatIgnoreIPs Description—Indicates the IP address(es) to be ignored by the Management Console. An ignored IP address will not be displayed in the Management Console servers tree. Values—a semi-colon separate list of IP addresses in the format x.x.x.
IgnoreArchiveBit Description—Specifies if the archive bit is compared during verification Values—0 Archive bit is compared during a verification, 1 Archive bit is not compared during a verification Default—1 GUI Setting—None Service restart required—No IgnoreDeleteOps Description—Specifies if file and directory delete operations will be replicated to the target Values—0 Delete operations are replicated to the target, 1 Delete operations are not replicated to the target Default—0 GUI Setting—Server Propertie
IgnoreThumbnailStreams Description—Specifies if thumbnails will be replicated to the target. Values—0 Storage Mirroring Recover will mirror and replicate all data streams, 1 Storage Mirroring Recover will not mirror or replicate any data about the alternate data streams for thumbnail images. When comparing data for a verification or difference mirror,alternate data streams for thumbnails will not be reported as different.
InstallVersionInfo Description—Installation number specified during the Storage Mirroring Recover installation. Do not modify this entry. IntermediateQueueLimit Description—Amount of memory, in KB, that may be allocated to the intermediate queue by the system memory manager when MemoryAllocatorMode is set to mixed mode (2).
Values—Depends on LanguagesSupported Default—Language used during the installation GUI Setting—Server Properties, Logging, Verification, Language Service restart required—Yes LanguagesSupported Description—Specifies the available languages for the verification log. Do not modify this setting. If you need to add or remove language support, use the Storage Mirroring Recover installation program.
GUI Setting—Connection Manager/Restoration Manager, Orphans tab, Log Orphaned Files to Target List Service restart required—No LogDir Description—The location of the Storage Mirroring Recover messages/alerts, verification, and statistics log files Values—any valid path Default—the location where the Storage Mirroring Recover files were installed GUI Setting—Server Properties, Logging tab, Folder Service restart required—Yes LogFile Description—The name of the Storage Mirroring Recover messages/alerts log fi
Service restart required—No LoopbackID Description—This entry is no longer used. Service restart required—No MaxChecksumBlocks Description—Specifies the number of checksum values retrieved from the target Values—any integer Default—32 GUI Setting—None Service restart required—No MaxConnections Description—Number of network requests that can be processed simultaneously. Windows is limited to 5 simultaneous requests.
MaxDisplayablePath will be truncated and will be followed by an ellipsis (...). Values—1-32760 Default—32760 GUI Setting—None Service restart required—No MaxNumberofLogFiles Description—Maximum number of .dtl log files that can exist at one time. When Storage Mirroring Recover creates a new .dtl file, if this number is exceeded, the oldest .dtl file is deleted.
Service restart required—Yes MaxWriteChunkSize Description—Maximum merged op size (in bytes) used during replication Values—1 - 131072 Default—65536 GUI Setting—None Service restart required—No MCHelpPath Description—This entry is no longer used. MemoryAllocatorCallbackMode Description—Determines what action is taken when the MemoryQueueToDiskThreshold is met Values—0 Auto-disconnect processing is initiated when theMemoryQueueToDiskThreshold has been met.
MinCompressionFileSize Description—The minimum file size, in bytes, that will be compressed. Files smaller than this size will not be compressed.
MirrorPrompting Description—This entry is no longer used.
MissedHeartbeats Description—Specifies the number of heartbeats that can go unanswered by the source before failover occurs, when using Storage Mirroring service responses to monitor for failover Values—1 - 65535 Default—20 GUI Setting—Failover Control Center, Monitor Settings, Missed Packets Service restart required—No MissedPackets Description—Specifies the number of requests sent by the target that go unanswered by the source before failover occurs, when using network responses to monitor for failover Va
NameFailover Description—Specifies whether or not to failover machine names Values—0 Do not failover machine names, 1 Failover machine names Default—1 GUI Setting—Failover Control Center, Monitor Settings, Items to Failover, Server Name Service restart required—No NetPort Description—Port used by pre-5.
GUI Setting—None Service restart required—No Notes—If you are archiving files and it takes longer than the NetworkTimeout specified (for example, this may happen if the DTArchiveBin is located on an alternate volume), the archive operation will complete on the target, but the full file will not be changed to a link on the source because the source detected the network timeout. NewAcquireData Description—An internal setting for mirroring. Do not modify this setting.
OpBuffersCount Description—An internal setting for memory buffering. Do not modify this setting.
GUI Setting—Server Properties, Network tab, Communications Port and Management Console, File, Options, Configuration tab, Communications Port Service restart required—Yes PostFailbackScript Description—Location on the target where the target post-failback script is located Values—Any valid path Default— GUI Setting—Failover Control Center, Monitor Settings, Scripts, Target, Post-Failback Service restart required—No PostFailbackScriptArgs Description—Arguments to be used with the target post-failback s
GUI Setting—Failover Control Center, Monitor Settings, Scripts, Target, Post-Failover, Arguments Service restart required—No PreFailbackScript Description—Location on the target where the target pre-failback script is located Values—Any valid path Default— GUI Setting—Failover Control Center, Monitor Settings, Scripts, Target, Pre-Failback Service restart required—No PreFailbackScriptArgs Description—Arguments to be used with the target pre-failback script Values—Any valid argument Default— GUI
GUI Setting—Failover Control Center, Monitor Settings, Scripts, Target, Pre-Failover Service restart required—No PreFailoverScriptArgs Description—Arguments to be used with the target pre-failover script Values—Any valid argument Default— GUI Setting—Failover Control Center, Monitor Settings, Scripts, Target, Pre-Failover, Arguments Service restart required—No PreFailoverWait Description—Specifies whether or not to wait for the target pre-failover script to complete before finishing a failover Values—
ProductCode Description—Used by the Storage Mirroring Recover installation program to maintain the installation settings for an upgrade. Do not modify this entry. ProductName Description—Used by the Storage Mirroring Recover installation program to maintain the installation settings for an upgrade. Do not modify this entry. QJournalDir Description—The location where the queue is stored.
Notes—The QJournalFreeSpaceMin should be less than the amount of physical disk space minus QJournalSpaceMax. QJournalPreload Description—The number of operations being pulled from the disk queue at one time. Do not modify this setting. QJournalSpaceMax Description—The maximum amount of disk space, in MB, in the specified QJournalDir that can be used for Storage Mirroring Recover queuing. When this limit is reached, Storage Mirroring Recover will automatically begin the auto-disconnect process.
Values—dependent on the amount of physical memory available; minimum of 32 MB Default—128 or 512 MB, depending on your operating system GUI Setting—Server Properties, Queue tab, Memory and Disk Usage, Maximum system memory for queue Service restart required—Yes QueryOnQuorumFile Description—Identifies if the Storage Mirroring service will reopen closed files on the quorum drive Values—0 The Storage Mirroring service will not attempt to reopen a closed file on the quroum drive to get security descriptors or
GUI Setting—Connection/Restoration Manager, Orphans tab, Remove All Orphans Service restart required—No RemoveOrphansTime Description—Specifies the amount of time, in minutes, that must be expired before an orphan file is removed Values—1 - 131072 Default—60 GUI Setting—Connection/Restoration Manager, Orphans tab, Remove Orphans not modified within the following time period Service restart required—No RemoveSharesOnDisconnect Description—Specifies if shares are removed on the target machine when a Storage M
Default—0 GUI Setting—Server Properties, Source tab, Replication, Replicate NT Security by Name Service restart required—No ReplicationDiskCheckScript Description—Specifies the script to run if validation of the replication drive fails Values—Any valid path and script file Default— GUI Setting—None Service restart required—No ReplicationDiskCheckTimeOut Description—Specifies the interval, in seconds, between validation checks when ReplicationDiskCheckSript is populated Values—any integer Default—300 S
GUI Setting—Restoration Manager, Servers tab, Overwrite existing files during restore Service restart required—No RestorePrompting Description—This entry is no longer used. RetentionFlag Description—This entry will be used in the future.
SaveStatFile Description—Determines if the statistic.sts (statistics logging) file is saved or ovewritten Values—0 overwrite, 1 saved as statistic-old.sts Default—1 GUI Setting—None Service restart required—No ScheduleFile Description—Name of the database file that contains transmission scheduling information Values—any valid file name Default—Schedule.
SendFileTimesOnCreate Description—Specifies whether a file is accessed twice so that the file’s creation time can be modified to match the source Values—0 The Storage Mirroring service will not access newly created files that have not been modified. These files on the target will have the date and time of when the file was created on the target, 1 The Storage Mirroring service will access newly created files. These files on the target will have the same date and time as the source.
Notes—If system processing delays (such as the system cache manager not flushing quickly enough) are causing delays in processing the last modified time, you may want to consider disabling this option (0).
Default—240 GUI Setting—None Service restart required—No ShutdownRebootTimeoutMinutes Description—Specifies the amount of time, in minutes, to wait for the source to shutdown during failover when protecting a full-server workload Values—any valid integer Default—5 GUI Setting—None Service restart required—No ShutdownTimeout Description—The amount of time, in seconds, for the service to wait prior to completing the shutdown so that Storage Mirroring Recover can persist data on the target in an attempt to avo
SnapshotType Description—Specifies the type of snapshot that Storage Mirroring Recover takes Values—0 Create a client-accessible snapshot based on the type of connection established, 1 Always create a client-accessible snapshot, 2 Always create a non-client-accessible snapshot Default—0 GUI Setting—None Service restart required—No SourceNewerMaxFileCount Description—The number of files to compare during a source newer difference mirror Values—1-1000 Default—16 GUI Setting—None Service restart required—No So
SourcePostFailbackScript Description—Path on the source where the source post-failback script is located Values—Any valid path Default— GUI Setting—Failover Control Center, Monitor Settings, Scripts, Source, Post-Failback Service restart required—No SourcePostFailbackScriptArgs Description—Arguments to be used with the source post-failback script Values—Any valid argument Default— GUI Setting—Failover Control Center, Monitor Settings, Scripts, Source, Post-Failback, Arguments Service restart req
SSMStagingBase Description—Specifies the folder to use for staging system state files for full-server failover. Do not modify this entry. SSMUseDiskSignature Description—Used by full-server workloads to determine how target disk signatures are used. Do not modify this entry. StartupScript Description—Used by full-server workloads to control the post-failover script after reboot after failover. Do not modify this entry.
GUI Setting—Server Properties, Setup tab, Setup Options, Log Statistics Automatically Service restart required—No StatsMaxFileSize Description—Maximum size, in MB, for the statistic.sts file Values—limited by available disk space Default—10485760 GUI Setting—Server Properties, Logging tab, Statistics, Maximum Length Service restart required—No StatsMaxObjects Description—This entry is no longer used. StatsPort Description—Port used by pre-5.
TargetPaused Description—Internal setting that indicates if the target machine is paused. Do not modify this setting. TargetPausedVirtual Description—Internal setting that indicates which target machines are paused. Do not modify this setting. TCPBufferSize Description—Size of the TCP/IP buffer in bytes. Values—4096-7500000 Default—375000 GUI Setting—None Service restart required—Yes Notes—The default setting creates a TCP window that will accommodate most environments.
Service restart required—No TGBlockOnConnect Description—Blocks the target path for all connections, regardless of the source, so that the data cannot be modified Values—0 Target paths are not blocked, 1 Target paths are blocked Default—0 GUI Setting—None Description—Do not modify this setting without assistance from Technical Support.
TGDisableAttributeReplication Description—Specifies whether or not the attributes compression, ACL, and file mask are written to the target during mirroring and replication Values—0 Enable attribute replication 1 Disable attribute replication Default—0 GUI Setting—None Service restart required—No TGExecutionRetryLimit Description—The number of times an unfinished operation will be retried on the target before it is discarded.
Default—20 GUI Setting—Server Properties, Target tab, Files, Target Mirror Capacity High Percentage Service restart required—No TGMirrorCapacityLow Description—Minimum percentage of system memory that can contain mirror data before the target signals the source to resume the sending of mirror operations.
GUI Setting—Server Properties, Target tab, Move Deleted Files, Moved deleted files to the following location Service restart required—No TGMoveFilesSingleDirectory Description—Specifies if deleted files that will be moved on the target (see TGMoveFilesOnDelete) will be moved to a single directory structure Values—0 Use the same directory structure on the target as the source to store deleted files, 1 Use a single directory structure on the target to store deleted files Default—0 GUI Setting—None Service res
TGWriteCache Description—Specifies whether or not Storage Mirroring Recover uses the intermediate cache Values—0 Bypass the intermediate cache and write directly to disk, 1 Do not bypass the intermediate cache Default—1 GUI Setting—None Service restart required—No TGWriteFailureBeforeNotification Description—Specifies the number of times an operation will be retried on the target before a notification is sent to the source to update the Target Status field of the Management Console.
UseChangeJournal Description—Specifies if the Windows NTFS change journal is used to track file changes. If the source is rebooted, only the files identified in the change journal will be remirrored to the target. This setting helps improve mirror times.
UseScheduledPause Description—Used by Storage Mirroring Recover for internal schedule processing. Do not modify this setting. UseShareFile Description—Specifies whether to create and use a share file or to use the shares that are currently stored in the target memory Values—0 Use the shares that are currently stored in the target memory, 1 Create and use a file containing the share information Default—1 GUI Setting—Failover Control Center, Monitor Settings, Use .
VerifyRetryInterval Description—The time, in minutes, between when one verification fails and a retry is scheduled to begin. Values—any valid number Default—3 GUI Setting—None Service restart required—No VerifyRetryLimit Description—The number of time a verification will be retried. Values—any valid number Default—5 GUI Setting—None Service restart required—No VersionInfo Description—The version of Storage Mirroring Recover that was installed. Do not modify this entry.
Scripting examples Below are links to sample Storage Mirroring Recover scripts. Most of the sample scripts must be modified. They cannot be used as-is. Modify them to fit your environment. If you need basic assistance with script modifications, contact Technical Support. Assistance with advanced scripting will be referred to Professional Services.
Creating and connecting a replication set The following script will start a Storage Mirroring Recover connection by creating a replication set called DataFiles on the source alpha and connecting it to the target beta.
Creating and connecting a replication set with failover monitoring The following script will start a Storage Mirroring Recover connection by creating a replication set called DataFiles on the source alpha and connecting it to the target beta. This script will also configure and start failover monitoring.
Restoring a replication set The following script will restore the data in the DataFiles replication set from the target machine beta to the original source machine.
Using variables to create and connect a replication set and run verification The following script uses variables to identify the source, target, and replication set. These variables are then used in the scripting commands. The $connectionID variable will contain the connection ID for the connection established. This variable can then be used to establish a verification schedule.
Controlling a mirror using flow control The following script uses the IF conditional, FOR loop, and WHILE loop commands. In the following examples the FOR loop will start a mirror for all connections between 1 and 10. The IF conditional will return the error command "mirror failed to start" if a value of 0 is not obtained. The WHILE loop will wait for a mirror to end and disconnect as long as the returned value is less than 10.
Using variables to pause a target The following script uses variables to identify the target and credentials to login to that target. These variables are then used in the scripting commands to pause the target. $TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.
Using variables to resume a target The following script uses variables to identify the target and credentials to login to that target. These variables are then used in the scripting commands to resume the target. $TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDomain = "domain.
Creating a backup or snapshot of the target by inserting a task command during replication The following script stops the services on the source, pauses the script to allow the source time to write the remaining application data to disk, inserts a Storage Mirroring Recover task command into the Storage Mirroring Recover replication process, and then restarts the services. REM REM net net net net Stop the services on the source so that data changes are stopped.
REM REM REM REM net net net net with Storage Mirroring Recover replication, the services can be restarted. New changes to the data will fall inline behind the task command just inserted.
Creating a backup of the target by rotating connections The following two scripts create multiple copies of your data on the target, but only one copy is active at a time. This allows you the time and availability to backup the inactive copy of data. This is especially helpful when you have applications with interdependent files. Backups occur sequentially from the first file to the last file.
$TheRepSet = "DataFiles"; login $TheSource $TheUser $ThePassword $TheDomain; login $TheTarget $TheUser $ThePassword $TheDomain; source $TheSource; $FirstConnection = conid $TheRepSet to $TheTarget map base c:\first_ location; disconnect $FirstConnection; $SecondConnection = connect $TheRepSet to $TheTarget map base c:\second_ location, nomirror; mirror start $SecondConnection different, checksum; # Script 2 # $TheSource = "alpha"; $TheTarget = "beta"; $TheUser = "admin"; $ThePassword = "password"; $TheDoma
Scripting commands Each scripting command includes the following. l Command name l Description of the command l Exact syntax for using the command l Options, if any l Examples, if necessary l Notes, if any For details on the conventions used for the command syntax, see Command syntax conventions.
l Email Test l Environment l Exit l Failback l Failover l Get l GetEnvStr l Get Local l Help l Limit Bandwidth l Limit Bandwidth Disable l Limit Bandwidth Schedule Add l Limit Bandwidth Schedule Clear l Limit Bandwidth Schedule Enable l Limit Bandwidth Schedule List l Limit Bandwidth Schedule Remove l Load Source l Load System State l Load Target l Login l Logout l Mirror Pause l Mirror Resume l Mirror Start l Mirror Stop l Monitor Account Add l Monitor A
l Monitor Remove l Monitor Script Add l Monitor Script Remove l Monitor Start l Monitor Stop l Monitor Use l NIC List l Orphans Disable l Orphans Enable l Orphans Start l Orphans Stop l Pause Target l Ping l Queue Task l Quit l Recall Pause l Recall Resume l Recall Start l Recall Stop l Replication Start l Replication Stop l Repset Calculate l Repset Create l Repset Delete l Repset Display l Repset List l Repset Resync l Repset Rule Add l Repset Rule
l Schedule Enable l Schedule End l Schedule Start l Schedule Window l Script Account l Script Add l Script List l Script Remove l Script Test l Set l Set Local l Shutdown l Snapshot Create l Snapshot Delete l Snapshot List l Snapshot Revert l Snapshot Schedule Disable l Snapshot Schedule Display l Snapshot Schedule Enable l Snapshot Schedule Every l Source l StatsLog Start l StatsLog Status l StatsLog Stop l Status l Target l Test Connections l Time Now
l Unload Target l Verify l Version l Wait l Wait on Mirror l Wait on Restore l Wait on Target l Write
Archive Pause Command ARCHIVE PAUSE Description Pauses the archive process Syntax ARCHIVE PAUSE Options con_id—Connection ID assigned to the source/target connection Examples archive pause 1
Archive Resume Command ARCHIVE RESUME Description Resumes the archive process Syntax ARCHIVE RESUME Options con_id—Connection ID assigned to the source/target connection Examples archive resume 1
Archive Start Command ARCHIVE START Description Starts the archive process Syntax ARCHIVE START FILEAGE FILESIZE Options l l l con_id—Connection ID assigned to the source/target connection number_days—Any number indicating the age, in days, of the files that you want archived. Any file older than the days specified will be archived. size—Any number indicating the size, in KB, of the files that you want archived.
Archive Stop Command ARCHIVE STOP Description Stops the archive process Syntax ARCHIVE STOP Options con_id—Connection ID assigned to the source/target connection Examples archive stop 1
Block All Command BLOCK ALL Description Allows you to block writing to the data located in the replication set target paths. You can block all of the paths for every connection to that target or only those paths associated with a particular connection. This keeps the data from being changed outside of Storage Mirroring Recover processing.
Compression Disable Command COMPRESSION DISABLE Description Disables compression Syntax COMPRESSion DISABLE Options con_id—Connection ID assigned to the source/target connection Examples compression disable 1
Compression Enable Command COMPRESSION ENABLE Description Enables compression Syntax COMPRESSion ENABLE Options con_id—Connection ID assigned to the source/target connection Examples compression enable 1
Compression List Command COMPRESSION LIST Description Identifies the compression level and if compression is enabled Syntax COMPRESSion LIST
Compression Set Command COMPRESSION SET Description Sets the compression level Syntax COMPRESSion SET Options l l con_id—Connection ID assigned to the source/target connection level—Any whole number from 1 to 3 where 1 is minimum compression and 3 is maximum compression Examples compression set 1 2 Notes This command only sets the level of compression. It does not initiate compression.
ConID Command CONID Description l Allows you to to assign the value of a connection ID to a variable l Lists the target and replication set for all connection IDs for a source l =CONID TO l CONID LIST [source] Syntax Options l l l variable—Name of the variable that you want to use to store the connection ID repset—Replication set that was used to establish the connection target—Name of the target, an IP address on the target, or a virtual IP address l source—Name of
Connect Command CONNECT Description Establishes a connection between a replication set and a target machine Syntax CONnect TO MAP EXACT | MAP BASE | MAP TO [,...
l l l l l l l MONitor—Specifies that the target is going to monitor the specified source machine for failover. The source machine must have already been defined as a monitor machine. NOMONitor—Specifies that the target is not going to monitor the source machine for failover ORPHANS—Moves or deletes orphan files on the target. Orphan files will not be immediately processed when you create the connection.
Connect TDU Command CONNECT TDU Description Establishes a simulation connection between a replication set and the Throughput Diagnostics Utility. This connection imitate a normal connection without transmitting any data across the network.
Disconnect Command DISCONNECT Description Disconnects a specified source/target connection for the currently selected source Syntax DISCONnect Options l con_id—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l disconnect 1 l disconnect * Examples
Email Add Command EMAIL ADD Description Adds an e-mail address to the e-mail notification distribution list Syntax EMAIL ADD Options email_address—A valid e-mail address enclosed in quotation marks Examples email add "administrator@domain.com" Notes l l You can repeat this command to add additional addresses to the distribution list. You must have an active source specified for any e-mail command to work properly.
Email Disable Command EMAIL DISABLE Description Disables e-mail notification Syntax EMAIL DISABLE Notes You must have an active source specified for any e-mail command to work properly.
Email Enable Command EMAIL ENABLE Description Enables e-mail notification Syntax EMAIL ENABLE Notes You must have an active source specified for any e-mail command to work properly.
Email Filter Command EMAIL FILTER Description Displays the filter configuration from the email setfilterinclude command Syntax EMAIL FILTER Notes You must have an active source specified for any e-mail command to work properly
Email From Address Command EMAIL FROMADDRESS Description Specifies the e-mail address that will appear in the From field of Storage Mirroring Recover generated e-mail messages Syntax EMAIL FROMADDRESS Options email_address—A valid e-mail address enclosed in quotation marks Examples email fromaddress "administrator@domain.com" Notes You must have an active source specified for any e-mail command to work properly.
Email Get Email Config Command EMAIL GET EMAILCONFIG Description Displays e-mail notification configuration information Syntax EMAIL GET EMAILCONFIG Notes You must have an active source specified for any e-mail command to work properly.
Email Mail Server Command EMAIL MAILSERVER Description Specifies the name of the SMTP mail server for e-mail notification Syntax EMAIL MAILSERVER [username][password] Options l server_name—Name of the SMTP mail server l ip_address—IP address of the SMTP mail server l username—User ID required for SMTP server authentication l password—Password associated with the specified user name Examples email mailserver xchng administrator ******* Notes l l l Your SMTP server must s
Email Remove Command EMAIL REMOVE Description Removes an e-mail address from the e-mail notification distribution list Syntax EMAIL REMOVE Options email_address—An e-mail address, listed in the current distribution list, enclosed in quotation marks Examples email remove "administrator@domain.com" Notes You must have an active source specified for any e-mail command to work properly.
Email Set Filter Include Command EMAIL SETFILTERINCLUDE Description Specifies which Event Viewer messages are sent via e-mail Syntax EMAIL SETFILTERINCLUDE [INFO, WARNING, ERROR] [EXCLUDEIDS ""] Options l INFO—Information messages will be sent via e-mail l WARNING—Warning messages will be sent via e-mail l ERROR—Error messages will be sent via e-mail l EXCLUDEIDS ID1,ID2-ID4,...—A comma separated list of IDs or ID ranges.
l You must have an active source specified for any e-mail command to work properly.
Email Subject Command EMAIL SUBJECT Description Specifies if additional text will be displayed in the subject of the e-mail message Syntax EMAIL SUBJECT [PREFIX | NOPREFIX] [DESCRIPTION | NODESCRIPTION] Options l l l l PREFIX prefix—Text which will be inserted at the front of the subject line for each Storage Mirroring Recover generated e-mail message. This will help distinguish the Storage Mirroring Recover messages from other messages.
Email Test Command EMAIL TEST Description Sends a test message to demonstrate e-mail notification Syntax EMAIL TEST [SENDTO ] [TEXT ] Options l l email_address—Specifies the e-mail address(es) to send the test message to if you do not want to use the e-mail addresses configured with the EMAIL ADD command. This is a comma separated list of addresses. The entire list should be enclosed in quotation marks.
Environment Command ENVIRONMENT Description Displays a list of all Storage Mirroring Recover machines available to the specified machine. Each machine is identified by machine name, IP addresses and whether or not the source and/or target modules are loaded. If no machine is specified, the information is provided for the machine currently specified as the source.
Exit Command EXIT Description Exits the Command Line Interactive client Syntax EXIT
Failback Command FAILBACK Description Initiates the failback process for the specified monitor machine Syntax FAILBACK [ON ] REMONITOR|NOREMONITOR Options l l l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address REMONITOR—Automatically continues monitoring the source machine after failback NOREMONITOR—Automatically discontinues monitoring the source machine after failback.
Failover Command FAILOVER Description Manually initiates the failover process for the specified monitor machine Syntax FAILOVER [ON ] [APPLY | DISCARD | REVERT] Options l l l l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address APPLY—Apply the data that is in the target queue before beginning failover DISCARD—Discard the data that is in the target queue and begin failover immediately REVERT—Reve
Get Command GET Description Requests the value of a Storage Mirroring Recover program setting from the specified server Syntax GET [machine] Options l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings l machine—Name of the machine l get AutoRemirror l get MoveOrphansDir Examples Notes l l If you do not specify a machine name, the value from the current source will be returned.
GetEnvStr Command GETENVSTR Description Retrieves an operating system environment variable and stores the value in a Storage Mirroring Recover variable Syntax GETENVSTR $ Options l l env_variable—Name of the operating system environment variable that you want to store in the user defined variable variable_name—Name of the variable you want to create. This variable will store the operating system environment variable specified.
Get Local Command GETLOCAL Description Requests the value of a Storage Mirroring Recover program setting from the local machine Syntax GETLOCAL Options setting—See Server settings for a complete list of the Storage Mirroring Recover program settings Examples l getlocal AutoRemirror l getlocal MoveOrphansDir
Help Command HELP Description Displays the DTCL commands and their syntax Syntax HELP Notes l Press any key to scroll through the list of commands. l Press q to exit the help function. l You can also type dtcl help from the directory where the Storage Mirroring Recover program files are installed to display the DTCL commands and their syntax.
Limit Bandwidth Command LIMIT BANDWIDTH Description Sets a fixed bandwidth limitation for transmitting data from the source to the target Syntax LIMIT BANDWIDTH , TO Options l l l bytes—Number of bytes to be transmitted seconds—Maximum number of seconds to wait before transmitting again target—Name of the target, an IP address on the target, or a virtual IP address.
Limit Bandwidth Disable Command LIMIT BANDWIDTH DISABLE Description Disables a bandwidth schedule without losing the schedule settings Syntax LIMIT BANDWIDTH DISABLE ON Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Limit Bandwidth Schedule Add Command LIMIT BANDWIDTH SCHEDULE ADD Description Creates a scheduled bandwidth event for limiting transmission of data from the source to the target Syntax LIMIT BANDWIDTH SCHEDULE ADD
bytes, Storage Mirroring Recover will wait an additional 3 seconds before transmitting again. l Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Limit Bandwidth Schedule Clear Command LIMIT BANDWIDTH SCHEDULE CLEAR Description Clears a bandwidth schedule Syntax LIMIT BANDWIDTH SCHEDULE CLEAR Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Limit Bandwidth Schedule Enable Command LIMIT BANDWIDTH SCHEDULE ENABLE Description Enables a bandwidth schedule Syntax LIMIT BANDWIDTH SCHEDULE ENABLE ON Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Limit Bandwidth Schedule List Command LIMIT BANDWIDTH SCHEDULE LIST Description Displays the bandwidth schedule for a target Syntax LIMIT BANDWIDTH SCHEDULE LIST Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Limit Bandwidth Schedule Remove Command LIMIT BANDWIDTH SCHEDULE REMOVE Description Removes a scheduled bandwidth event Syntax LIMIT BANDWIDTH SCHEDULE REMOVE
Load Source Command LOAD SOURCE Description Loads the Storage Mirroring Recover source module Syntax LOAD SOURCE Options machine—Name of the machine Examples load source alpha Notes Machine names that contain non-alphanumeric characters should be enclosed in quotation marks.
Load System State Command LOAD SYSTEMSTATE Description Loads the Storage Mirroring Recover system state module Syntax LOAD SYSTEMSTATE Options machine—Name of the machine Examples load systemstate beta Notes Machine names that contain non-alphanumeric characters should be enclosed in quotation marks.
Load Target Command LOAD TARGET Description Loads the Storage Mirroring Recover target module Syntax LOAD TARGET Options machine—Name of the machine Examples load target beta Notes Machine names that contain non-alphanumeric characters should be enclosed in quotation marks.
Login Command LOGIN Description Log on to a Storage Mirroring Recover machine Syntax LOGIN [domain] Options l l l l machine—Name of the machine username—Name of the user. The username is limited to 100 characters. password—Password associated with the user name. The password is limited to 100 characters. domain—If logging in using a domain account, this is the domain name. If logging in using a local account, this is the machine name.
Logout Command LOGOUT Description Logs off of a Storage Mirroring Recover machine Syntax LOGOUT Options machine—Name of the machine Examples logout alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Mirror Pause Command MIRROR PAUSE Description Pauses a mirror that is in progress Syntax MIRror PAUSE Options l con_id—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l mirror pause 1 l mir pause * Notes
Mirror Resume Command MIRROR RESUME Description Resumes a paused mirror Syntax MIRror RESUME Options l con_id—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l mirror resume 1 l mir resume * Notes
Mirror Start Command MIRROR START Description Initiates the mirror process Syntax MIRror START [DIFFERENT [,NEWER] ,CHECKSUM | NOCHECKSUM] [ORPHANS |NOORPHANS] [CALCulate | NOCALCulate] [CLEARRESTOREREQUIRED] Options l l l l l con_id—Connection ID assigned to the source/target connection DIFFERENT—Mirrors only those files that are different based on the file date, time, and/or size NEWER—Mirrors only those files that are newer on the source than on the target CHECKSUM—Mirrors only those blocks
Mirror Stop Command MIRROR STOP Description Stops a mirror Syntax MIRror STOP Options l con_id—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l mirror stop 1 l mir stop * Examples
Monitor Account Add Command MONITOR ACCOUNT ADD Description Identifies a user account with update permissions within Active Directory Syntax MONitor ACCOUNT ADD [monitor] Options l username—Name of the user in the format domain\user or user@domain. Since the format requires non-alphanumeric characters, enclose the name in quotation marks.
Monitor Account Remove Command MONITOR ACCOUNT REMOVE Description Removes the user account used to failover Active Directory Syntax MONitor ACCOUNT REMove Options monitor—Name of the source machine designated as the monitor Examples l monitor account remove alpha l mon account rem alpha Notes l l If you do not specify a monitor, the current source designated as the monitor will be used.
Monitor Clear Command MONITOR CLEAR Description Clears all of the failover configuration and monitoring parameters for the specified monitor machine Syntax MONitor CLEAR [monitor] Options monitor—Name of the source machine designated as the monitor Examples l monitor clear alpha l mon clear alpha Notes l l If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected.
Monitor Create Command MONITOR CREATE Description Establishes a source as a failover monitor. This is the machine that will be monitored by a target in case it should experience a failure. Syntax MONitor CREATE Options source—Name of the source Examples l monitor create alpha l mon create alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Monitor Delete Command MONITOR DELETE Description Deletes the specified failover monitor and all of its parameters Syntax MONitor DELete Options monitor—Name of the source machine designated as the monitor Examples l monitor delete alpha l mon del alpha Notes l l In order to successfully delete a monitor, the monitor must not be running on the server. Use the monitor stop command to ensure the monitor is not running.
Monitor Display Command MONITOR DISPLAY Description Displays the monitoring and failover configuration settings for the specified monitor machine Syntax MONitor DISPlay Options monitor—Name of the source machine designated as the monitor Examples l monitor display alpha l mon disp alpha Notes l l l If you do not specify a monitor, the current source designated as the monitor will be used.
Monitor Get Command MONITOR GET Description Identifies a machine as the active monitor machine Syntax MONitor GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor get beta l mon get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks.
Monitor List Command MONITOR LIST Description Displays a list of all failover monitor machines Syntax MONitor LIST Options l monitor list l mon list Notes You must use the monitor get command to specify an active monitor before using monitor list.
Monitor Move Command MONITOR MOVE Description Designates the IP address that will be failed over to the specified target NIC Syntax MONitor MOVE TO NIC USE NONE | NETWORK INTERVAL TIMEOUT | SERVICE INTERVAL TIMEOUT | [monitor] Options l l l l l l l l IP_address—The IP address which should be moved during failover target_NIC—The integer value of the target NIC obtained from the niclist command NONE—Does not actively monitor t
l mon move 205.31.2.68 to nic 2 use none notest Notes l l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected. If you choose to use the service option, your source and target must be using the same Storage Mirroring Recover port settings. If you choose to use the network option, the port settings can be different.
Monitor Option Command MONITOR OPTION Description Configures the settings to determine how failover will be performed Syntax MONitor OPTION [MOVENAME | NOMOVENAME] [, MOVEADDRESSES | NOMOVEADDRESSES] [, MOVESHARES | NOMOVESHARES] [, ADD | REPLACE] [, USESHAREFILE | NOUSESHAREFILE][, FAILONE | FAILALL] [, FODELAY | NOFODELAY] [, FBDELAY | NOFBDELAY] [, APPLY | DISCARD | REVERT] [, INTERVENTION | NOINTERVENTION] [, FOHOSTNAME | NOFOHOSTNAME] [, FBHOSTNAME | NOFBHOSTNAME] [monitor] Options l MOVENAME—Moves th
l l l l l l l l l l l l l l FAILALL—When multiple IP addresses exist on a monitor machine, all of the addresses will fail over to the target machine even if only one address fails FODELAY—Guarantees that the pre-failover script has completed before failing over NOFODELAY—Does not guarantee that the pre-failbover script has completed before failing over FBDELAY—Guarantees that the pre-failback script has completed before failing back NOFBDELAY—Does not guarantee that the pre-failback script has
and nofbhostname. l l The options can be used in any combination and in any order. The first option does not require a comma, but the second and remaining options do require a comma before the option. Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks.
Monitor Remove Command MONITOR REMOVE Description Removes an IP address that is currently being monitored Syntax MONitor REMove [monitor] Options l IP_address—The currently monitored IP address that should be removed l monitor—Name of the source machine designated as the monitor l monitor remove 205.31.2.57 alpha l mon rem 205.31.2.68 Examples Notes l l If you do not specify a monitor, the current source designated as the monitor will be used.
Monitor Script Add Command MONITOR SCRIPT ADD Description Specifies the scripts that should be run during the failover and failback processes Syntax MONitor SCRIPT ADD [ARGS=] [monitor] Options l l l l l l l l l type—Any of the following script types PREFAILOVER—The file is a pre-failover script to be run on the target before failover POSTFAILOVER—The file is a post-failover script to be run on the target after failover PREFAILBACK—The file is a pre-failback script to
Notes l l If you do not specify a monitor, the current source designated as the monitor will be used. If you have not identified a monitor, you will receive an error message stating that a monitor has not been selected. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Monitor Script Remove Command MONITOR SCRIPT REMOVE Description Specifies the scripts that should not be run during the failover and failback processes Syntax MONitor SCRIPT REMove [monitor] Options l l l l l l type—Any of the following script types PREFAILOVER—The file is a pre-failover script to be run on the target before failover POSTFAILOVER—The file is a post-failover script to be run on the target after failover PREFAILBACK—The file is a pre-failback script to be run on the target before
Monitor Start Command MONITOR START Description Initiates failover monitoring Syntax MONitor START [ON ] Options l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address Examples l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address Notes Option names that contain non-alphanumeric characters must be enclosed i
Monitor Stop Command MONITOR STOP Description Stops monitoring the source machine for failure Syntax MONitor STOP [ON ] Options l l monitor—Name of the source machine designated as the monitor target—Name of the target, an IP address on the target, or a virtual IP address Examples l monitor stop alpha on beta l mon stop alpha Notes Option names that contain non-alphanumeric characters must be enclosed in quotation marks.
Monitor Use Command MONITOR USE Description Specifies the source machine designated as the monitor that will be used in subsequent monitor commands Syntax MONitor USE Options monitor—Name of the source machine designated as the monitor . Examples l monitor use alpha l mon use alpha Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks.
NIC List Command NICLIST Description Displays the NICs available on the specified target machine. Each NIC is assigned an integer value and this value is used in the monitor move command. Syntax NICLIST [target] Options target—Name of the target, an IP address on the target, or a virtual IP address Examples niclist beta Notes l l l If you do not specify a machine name, the value from the current target will be returned. If you have not identified a target, no data will be returned.
Orphans Disable Command ORPHANS DISABLE Description Disables orphan file removal during subsequent mirror or verification processes Syntax ORPHANS DISABLE con_id Options con_id—Connection ID assigned to the source/target connection Examples orphans disable 1
Orphans Enable Command ORPHANS ENABLE Description Enables orphan file removal during subsequent mirror or verification processes Syntax ORPHANS ENABLE con_id Options con_id—Connection ID assigned to the source/target connection Examples orphans enable 1
Orphans Start Command ORPHANS START Description Manual operation to remove any orphan files on the target Syntax ORPHANS START con_id [CLEARRESTOREREQUIRED] Options l l con_id—Connection ID assigned to the source/target connection CLEARRESTOREREQUIRED—Clears the restore required flag and initiates the orphan operation Examples orphans start 1
Orphans Stop Command ORPHANS STOP Description Stops the process to remove orphan files on the target Syntax ORPHANS STOP con_id Options con_id—Connection ID assigned to the source/target connection Examples orphans stop 1
Pause Target Command PAUSE TARGET Description Allows you to pause the execution of Storage Mirroring Recover operations on the target Syntax PAUSETARGET [FROM ] Options l l target—Name of the target, an IP address on the target, or a virtual IP address source—Name of the source Examples pausetarget beta Notes l l l You must be logged on to the target machine for this command to work.
Ping Command PING Description Checks a specified machine to see if Storage Mirroring Recover is running Syntax PING Options machine—Name of the machine Examples ping alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Queue Task Command QUEUETASK Description Queues tasks inline with replication data Syntax QueueTASK TO ONQueue = [args] | ONTRANSmit = [args] | ONRECeive = [args] | ONEXECute = [args] [TIMEOUT = ] [INTERACT | NOINTERACT] Options l l l l l l l job_name—Unique job name assigned to this task. This will be the identifier you see in the log files. target—Name of the target, an IP address on the target, or a virtual IP address.
l l l l args—Arguments or options which need to be supplied with the task. Multiple arguments can be supplied in a space-separated list enclosed in quotation marks. TIMEOUT timeout—Valid number followed by an optional time indicator indicating the length of time ot pause while waiting for the task to complete. The valid time indicators include seconds, minutes, hours, and days. If you do not specify a time indicator, it will default to seconds.
l l l If you disable task command processing while tasks are in queue, those tasks will not be executed. The user submitting the task command must be a member of the Double-Take Admin security group on both the source and target and the Storage Mirroring service must have proper privileges to access the files or run the commands specified in the task. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Quit Command QUIT Description Quits the Command Line Interactive client Syntax QUIT
Recall Pause Command RECALL PAUSE Description Pauses the process to recall all archived files from the target Syntax RECALL PAUSE Options con_id—Connection ID assigned to the source/target connection Examples recall pause 1
Recall Resume Command RECALL RESUME Description Resumes the process to recall all archived files from the target Syntax RECALL RESUME Options con_id—Connection ID assigned to the source/target connection Examples recall resume 1
Recall Start Command RECALL START Description Starts the process to recall all archived files from the target Syntax RECALL START Options con_id—Connection ID assigned to the source/target connection Examples recall start 1
Recall Stop Command RECALL STOP Description Stops the process to recall all archived files from the target Syntax RECALL STOP Options con_id—Connection ID assigned to the source/target connection Examples recall stop 1
Replication Start Command REPLICATION START Description Initiates the replication process Syntax REPlication START [CLEARRESTOREREQUIRED] Options l conid—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l CLEARRESTOREREQUIRED—Clears the restore required flag and initiates replication Examples l replication start 1 l rep start *
Replication Stop Command REPLICATION STOP Description Stops the replication process Syntax REPLlication STOP Options l conid—Connection ID assigned to the source/target connection l *—Specifies all connection IDs l replication stop 1 l rep stop * Examples
Repset Calculate Command REPSET CALCULATE Description Calculates the size of a replication set Syntax REPSET CALCulate [repset] Options repset—Name of the replication set Examples l repset calculate DataFiles l repset calc DataFiles Notes l l l If a replication set name is not specified, the active replication set will be used. The results of the calculation are logged to the Storage Mirroring Recover log file.
Repset Create Command REPSET CREATE Description Creates a replication set Syntax REPSET CREATE Options name—Name of the replication set Examples repset create DataFiles Notes l l The name of the replication set should not be a Storage Mirroring Recover keyword. These are any DTCL command (source, target, and so on.) or any DTCL shortcut command (env, mon, rep, and so on). Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks.
Repset Delete Command REPSET DELETE Description Deletes the specified replication set Syntax REPSET DELete Options repset—Name of the replication set Examples l repset delete DataFiles l repset del DataFiles Notes Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks.
Repset Display Command REPSET DISPLAY Description Displays the replication set rules Syntax REPSET DISPlay [repset] Options repset—Name of the replication set Examples l repset display DataFiles l repset disp DataFiles Notes l l If you do not specify a replication set name, the current replication set will be used. Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks.
Repset List Command REPSET LIST Description Lists all replication set names for the currently selected source Syntax REPSET LIST
Repset Resync Command REPSET RESYNC Description Retrieves the last saved replication set settings, clearing any unsaved changes Syntax REPSET RESYNC
Repset Rule Add Command REPSET RULE ADD Description Adds a rule to a replication set. A rule is the specification of a path including volume, directories, wild cards, and/or file names.
Repset Rule Remove Command REPSET RULE REMOVE Description Removes a rule from a replication set Syntax REPSET RULE REMove [FROM ] Options l path—Volume, directory, wild card, and/or file name l repset—Name of the replication set l repset rule remove "c:\data" from DataFiles l repset rule rem "c:\temp" Examples Notes l l If you do not specify a replication set name, the current replication set will be used.
Repset Save Command REPSET SAVE Description Saves all replication set rules for the currently selected source Syntax REPSET SAVE
Repset Use Command REPSET USE Description Specifies a replication set as the active replication set Syntax REPSET USE Options repset—Name of the replication set Examples repset use DataFiles Notes Replication set names that contain non-alphanumeric characters must be enclosed in quotation marks.
Restore Command RESTORE Description Initiates the restoration process Syntax RESTORE FROM ORIGINAL [, OVERWRITE | NOOVERWRITE] [, OVERWRITENEWER | NOOVERWRITENEWER] [, USETARGETDB | NOUSETARGETDB] [, RESTOREDBTOO | NORESTOREDBTOO] [, CHECKSUM | NOCHECKSUM][, ORPHANS | NOORPHANS] Options l l repset—Name of the replication set target—Name of the target, an IP address on the target, or a virtual IP address l original_source—Name of the original source l OVERWRITE—Overwr
l ORPHANS—Moves or deletes orphan files on the source l NOORPHANS—Does not move or delete orphan files on the source Examples restore DataFiles from beta ,overwritenewer ,usetargetdb Notes l l l l l The default settings for this command are overwrite, overwritenewer, usetargetdb, restoredbtoo, and noorphans. The options can be used in any combination and in any order. The first option does not require a comma, but the second and remaining options do require a comma before the option.
Resume Target Command RESUME TARGET Description Allows you to resume the execution of Storage Mirroring Recover operations on the target Syntax RESUMETARGET [FROM ] Options l l target—Name of the target, an IP address on the target, or a virtual IP address source—Name of the source Examples resumetarget beta Notes l l You must be logged on to the target machine for this command to work. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Schedule Clear Command SCHEDULE CLEAR Description Clears the existing transmission schedule for the specified target Syntax SCHEDule CLEAR Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Schedule Disable Command SCHEDULE DISABLE Description Disables the transmission schedule without clearing the schedule data Syntax SCHEDule DISABLE Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Schedule Enable Command SCHEDULE ENABLE Description Enables the transmission schedule Syntax SCHEDule ENABLE Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l schedule beta enable l sched beta enable Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Schedule End Command SCHEDULE END Description Sets criteria to end the transmission of data from the source to the target Syntax SCHEDule END [ DURATION = ] [ BYTES = ] Options l l target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Schedule Start Command SCHEDULE START Description Sets criteria to start the transmission of data from the source to the target Syntax SCHEDule START [STARTTIME = ] [MEMLIMIT = ] [QUEUESIZE = ] [EVERY ] Options l l l l l l l target—Name of the target, an IP address on the target, or a virtual IP address.
l l If you use more than one start option, the transmission will begin when the first start option value is met. Additionally, each option after the first must be separated by a comma, as illustrated in the Examples. Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Schedule Window Command SCHEDULE WINDOW Description Sets criteria to only allow transmissions during a certain period of time Syntax SCHEDule WINDOW TO Options l l target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. hh:mm—Time in hour:minute format using the 24-hour clock.
Script Account Command SCRIPT ACCOUNT Description Specifies the user account that will be used to run scripts Syntax SCRIPT ACCOUNT [domain] Options l machine—Name of the machine l username—Name of the user l password—Password associated with the user name l domain—If logging in using a domain account, this is the domain name. If logging in using a local account, this is the machine name.
Script Add Command SCRIPT ADD Description Specifies the scripts that should be run at a particular point-in-time during a process Syntax SCRIPT ADD [source] = [ARGS=arguments] [DELAY|NODELAY] [INTERACT|NOINTERACT] Options l con_id—Connection ID assigned to the source/target connection l source—Name of the source l l l l l l target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types MIRRORSTART—This script s
the path and file name. Enclose the path in quotation marks. The file name you specify for your script should be the primary executable of the command being run. If you are using a command shell to execute a script, put the command shell execturable as the script file name and pass another script name in as an argument. l l l l l arguments—Specify any arguments, valid for your script, that are required to execute your script.
Script List Command SCRIPT LIST Description Displays a list of mirroring scripts Syntax SCRIPT LIST [source] [ON target] Options l con_id—Connection ID assigned to the source/target connection l source—Name of the source machine l target—Name of the target, an IP address on the target, or a virtual IP address Examples script list 1 alpha on beta Notes Machine names that contain non-alphanumeric characters must be enclosed in qutoation marks.
Script Remove Command SCRIPT REMOVE Description Removes the specified mirroring script Syntax SCRIPT REMove [source] [ON target] Options l con_id—Connection ID assigned to the source/target connection l source—Name of the source machine l l l l l target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types MIRRORSTART—Script that was being processed before the mirroring process starts MIRRORSTOP—Script that was being processed
Script Test Command SCRIPT TEST Description Tests a mirroring script Syntax SCRIPT TEST [arguments] [INTERACT|NOINTERACT] Options l l l l l machine—Name of the machine where you want to execute the script as a test path—Specify the full path and file name (including the file extension) to the mirroring script. Do not include arguments with the path, only the path and file name. Enclose the path in quotation marks.
quotation marks. To work around this limitation, you can use 8.3 file naming. l Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Set Command SET Description Modifies the value of a Storage Mirroring Recover program setting for the specified server Syntax SET = [machine] Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting l machine—Name of the machine l set AutoRemirror=3 l set MoveOrphansDir="C:\OrphanFiles" Examples Notes l l l Some setti
Set Local Command SET LOCAL Description Modifies the value of a Storage Mirroring Recover program setting for the local machine Syntax SETLOCAL = Options l l setting—See Server settings for a complete list of the Storage Mirroring Recover program settings value—See Server settings for a complete list of the values for each Storage Mirroring Recover program setting Examples l setlocal AutoRemirror=3 l setlocal MoveOrphansDir="C:\OrphanFiles" Notes l l Some settings, although immediat
Shutdown Command SHUTDOWN Description Stops the Storage Mirroring service . Syntax SHUTDOWN Options machine—Name of the machine Examples shutdown alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Snapshot Create Command SNAPSHOT CREATE Description Creates a manual snapshot of the replication set data on the target Syntax SNAPshot CREATE [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot create 1 l snap create 1 Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Snapshot Delete Command SNAPSHOT DELETE Description Deletes the specified snapshot(s) from the target Syntax SNAPshot DELete [ON ] Options l l con_id—Connection ID assigned to the source/target connection snapshot_list_number—The snapshot number retrieved from the SNAPSHOT LIST command l ALL—Deletes all snapshots l OLD—Deletes only the oldest snapshot l l l GOOD—If specified, deletes only good snapshot.
Snapshot List Command SNAPSHOT LIST Description Displays a list of snapshots associated with a connection Syntax SNAPshot LIST [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot list 1 l snap list 1 Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Snapshot Revert Command SNAPSHOT REVERT Description Revert the target to the last good automatic snapshot Syntax SNAPshot REVERT [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot revert 1 l snap revert 1 Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Snapshot Schedule Disable Command SNAPSHOT SCHEDULE DISABLE Description Disables a snapshot schedule Syntax SNAPshot SCHEDule DISABLE [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot schedule 1 disable l snap sched 1 disable Notes l l This command only disables the snapshot schedule for this connection so that it will not run.
Snapshot Schedule Display Command SNAPSHOT SCHEDULE DISPLAY Description Displays the snapshot schedule Syntax SNAPshot SCHEDule DISPlay [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot schedule 1 display l snap sched 1 disp Notes Target names that contain non-alphnumeric characters must be enclosed in quotation marks.
Snapshot Schedule Enable Command SNAPSHOT SCHEDULE ENABLE Description Enables a disabled snapshot schedule Syntax SNAPshot SCHEDule ENABLE [ON ] Options l l con_id—Connection ID assigned to the source/target connection target—Name of the target, an IP address on the target, or a virtual IP address Examples l snapshot schedule 1 enable l snap sched 1 enable Notes Target names that contain non-alphnumeric characters must be enclosed in quotation marks.
Snapshot Schedule Every Command SNAPSHOT SCHEDULE EVERY Description Configures and initiates a snapshot schedule Syntax SNAPshot SCHEDule EVERY [STARTTIME = [hh:mm] ] [ON ] Options l l l l l l con_id—Connection ID assigned to the source/target connection number—Any number indicating the frequency for the scheduled snapshots time_units—Minutes (min), hours (hr), or days (day) mm/dd/yy—Date in month/day/year format indicating when the schedule will begin h
Source Command SOURCE Description Identifies a machine as the active source machine Syntax SOUrce Options source—Name of the source Examples l source alpha l sou alpha Notes Source names that contain non-alphanumeric characters must be enclosed in quotation marks.
StatsLog Start Command STATSLOG START Description Starts the DTStats statistics logging utility Syntax STATSLOG START [TO ] [EVERY ] [MAXSIZE ] Options l l machine—Name of the machine filename—Any valid path and filename to which the statistical information will be logged l minutes—The number of minutes to write to the log file l kilobytes—The maximum file size in kilobytes Examples statslog start alpha to "dtstat.
StatsLog Status Command STATSLOG STATUS Description Identifies whether the DTStats statistics logging utility is currently running Syntax STATSLOG STATUS Options machine—Name of the machine Examples statslog status alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
StatsLog Stop Command STATSLOG STOP Description Stops the DTStats statistics logging utility Syntax STATSLOG STOP Options machine—Name of the machine Examples statslog stop alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Status Command STATUS Description Requests connection and statistical information Syntax STATUS BLOCK [ON ] | CONnect | MIRror | REPlicate | TRANsmit | TARget Options l l l BLOCK—Displays whether replication set path on the specified target is being blocked target—Name of the target, an IP address on the target, or a virtual IP address CONnect—Displays connection information for the connection ID specified l con_id—Connection ID assigned to the sourc
Target Command TARGET Description Identifies a machine as the active target machine Syntax TARget Options target—Name of the target, an IP address on the target, or a virtual IP address Examples l target beta l tar beta Notes l l You must be logged into a machine using the login command before using the target command. Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Test Connections Command TEST CONNECTIONS Description Sends a test command to determine if Storage Mirroring Recover is running. If there are active connections, the replication set(s), IP address(es), and connection ID(s) will be included in the testcon log file. Syntax TESTCONnections [ filename [OVERWRITE]] Options l l machine—The name of the machine filename—The name of the log file. The file extension .dts is appended to any file name supplied.
Time Now Command TIME NOW Description Prints the current date and time. This command is useful for scripting to determine process start and stop times.
Transmission Pause Command TRANSMISSION PAUSE Description Pauses the transmission pause Syntax TRANSmission PAUSE Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l transmission pause beta l trans pause beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Transmission Resume Command TRANSMISSION RESUME Description Resumes a paused transmission pause Syntax TRANSmission RESUME Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name.
Transmission Start Command TRANSMISSION START Description Initiates the transmission pause Syntax TRANSmission START Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l transmission start beta l trans start beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Transmission Stop Command TRANSMISSION STOP Description Stops the transmission pause Syntax TRANSmission STOP Options target—Name of the target, an IP address on the target, or a virtual IP address. Depending on the network route Storage Mirroring Recover uses to access the target, you may need to specify the fully qualified domain name. Examples l transmission stop beta l trans stop beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Unblock All Command UNBLOCK ALL Description Unblocks the replication set target paths that were previously blocked. Any process can now update data in the replication set target path.
Unload Source Command UNLOAD SOURCE Description Unloads the Storage Mirroring Recover source module Syntax UNLOAD SOURCE Options machine—Name of the machine Examples unload source alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Unload System State Command UNLOAD SYSTEM STATE Description Unloads the Storage Mirroring Recover system state module Syntax UNLOAD SYSTEMSTATE Options machine—Name of the machine Examples unload systemstate alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Unload Target Command UNLOAD TARGET Description Unloads the Storage Mirroring Recover target module Syntax UNLOAD TARGET Options machine—Name of the machine Examples unload target alpha Notes Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Verify Command VERIFY Description Verifies the integrity of the data between the source and target machines Syntax VERIFY [ SYNC [,NEWER] | NOSYNC] [,CHECKSUM | NOCHECKSUM] [STARTTIME= [hh:mm]] [EVERY ] [ORPHANS | NOORPHANS] [CLEARRESTOREREQUIRED] Options l con_id—Connection ID assigned to the source/target connection l SYNC—Synchronizes any data that is different l l l l l l l NEWER—Synchronizes only those files that are newer on the source than on the targe
Examples l verify 1 l verify 2 sync, newer l verify 2 every 2 hr Notes The default verification settings are sync, checksum, and noorphans.
Version Command VERSION Description Displays the Storage Mirroring Recover version currently installed Syntax VERSION [machine] Options machine—Name of the machine Examples version alpha Notes l l If no machine name is specified, the version of the active source will be displayed. If there is no active source, no version information will be displayed. Machine names that contain non-alpanumeric characters must be enclosed in quotation marks.
Wait Command WAIT Description This command is used in scripts to force the script to stop executing until the specified number of milliseconds has elapsed. Syntax WAIT Options ms—Length of time in milliseconds Examples wait 5000 Notes This example waits for 5 seconds.
Wait on Mirror Command WAIT ON MIRROR Description This command is used in scripts to force the script to stop executing until the connection has finished mirroring or verifying Syntax WAITONMIRROR Options con_id—Connection ID assigned to the source/target connection Examples waitonmirror 1
Wait on Restore Command WAIT ON RESTORE Description This command is used in scripts to force the script to stop executing until the connection has finished restoring Syntax WAITONRESTORE Options rest_id—Restoration ID assigned to the source/target connection Examples waitonrestore 1 Notes This command requires using the source command immediately before the waitonrestore command.
Wait on Target Command WAIT ON TARGET Description This command is used in scripts to force the script to stop executing until the target queue has been empty for the time specified Syntax WAITONTARGET [FROM ]
Write Command WRITE Description Displays the value of a Storage Mirroring Recover variable Syntax WRITE $ Options variable_name—The name of the variable that you have established and want to display Examples l write $thetarget l write $dbrepset
Index A archive pause 101, 213 archive resume 101, 214 archive start 101, 215 archive stop 101, 216 archiving manually 101 recalling 104 automatic reconnections 40 remirror 49 B bandwidth block all 83 217 C Command Line client 10 commands conventions list compressing data 14 208 89 compression disable 89, 218 compression enable 89, 219 compression list 89, 220 compression set 89, 221 conid 36, 222
connect 30, 223 connect TDU 33, 225 connection establishing 30 monitoring 36 reconnecting 40 simulation 33 conventions 14 D disconnect 44, 106, 226 E email add 227 email disable 228 email enable 229 email filter 230 email from address 231 email get email config 232 email mail server 233 email remove 234 email subject 237 email test 238 environment 239 exit 240 F failback 130 failover 125, 242 configuring failover monitoring 111
deleting failover monitoring 128 editing failover monitoring configuration 123 failing back 130 failing over 125 stopping monitoring 126 flow control 12 FOR loop 12 G get 27, 38, 40, 49, 57, 67, 134, 243 get env str 244 get local 245 H help 15, 246 I IF conditional 12 in-band control 63 L limit bandwidth 83, 247 limit bandwidth schedule add 83, 249 limit bandwidth schedule clear 83, 251 limit bandwidth schedule disable 83 limit bandwidth schedule enable 83, 252 limit band
login logout 67, 106, 130, 258 259 M mirror pause 46 mirror resume 46, 261 mirror start 46, 262 mirror stop 46, 263 mirroring 46 automatically 49 scripts 51 monitor account add 111, 264 monitor account remove 265 monitor clear 266 monitor create 111, 267 monitor delete 128, 268 monitor display 111, 123, 269 monitor get 123, 126, 128, 130, 270 monitor list 271 monitor move 111, 272 monitor option 111, 274 monitor remove monitor script add monitor script remove 111 111, 27
N niclist 111, 284 O orphan files 57 orphans disable 57 orphans enable 57, 286 orphans start 57, 287 orphans stop 57, 288 overview 9 P pause target ping 42, 289 290 Q queue task queuing data quit 63, 291 38 294 R recall pause 104, 295 recall resume 104, 296 recall start 104, 297 recall stop 104, 298 recalling archived files 104 replication starting 62 tasks 63
replication set calculating 27 creating 17 deleting 25 modifying 21 replication start 62, 299 replication stop 300 repset calculate 27, 301 repset create 17, 302 repset delete 25, 303 repset display 21, 304 repset list repset resync 21, 25, 30, 33, 305 21, 306 repset rule add 17, 21, 307 repset rule remove 17, 21, 308 repset save repset use restore 17, 21, 25, 309 17, 21, 310 106, 311 restoring data 106 resume target 42, 313 return values 12 S schedule clear 76, 314 sched
script add 51, 322 script list 51, 324 script remove 51, 325 script test 51, 326 scripts 12 comments 12 mirroring 51 sample creating and connecting 197 creating and connecting with failover 198 flow control 201 replication task 204 restoring 199 rotating connections for backup 206 variables creating connecting verifying 200 variables pause target 202 variables resume 203 server settings configuring 134 list 136 set 27, 38, 40, 49, 57, 67, 134, 328 set local 329 shutdo
snapshot schedule enable 92, 337 snapshot schedule every 92, 338 snapshots applying 97 deleting 98 manually creating 96 scheduling 92 source 67, 106, 339 stats log start 340 stats log status 341 stats log stop 342 status 36, 343 syntax 14 T target 111, 130, 344 target processing 42 task command processing 63 test connections 345 time now 346 transmission bandwidth 83 compression 89 controlling 73 examples 76 scheduling 76 transmission pause 73, 347 transmission
U unblock all 351 unload source 352 unload system state 353 unload target 354 V variables 12 verification 67 verify version 67, 355 357 W wait 358 wait on mirror 359 wait on restore 360 wait on target 361 WHILE loop 12 write WRITE flow control command 362 12
