Scripting Guide Twelfth Edition (March 2009) Part Number: T2558-96327
© Copyright 2009 Hewlett-Packard Development Company, L.P. Hewlett-Packard Company makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Table of Contents Chapter 1 Introduction .........................................................1-1 Resources ......................................................................................... 1-1 Conventions used in this guide ......................................................... 1-2 Chapter 2 Clients and Scripts ................................................2-1 The Command Line Client ................................................................. 2-1 Storage Mirroring scripts ..........
Chapter 9 Data Transmission ................................................9-1 Controlling transmission manually ................................................... 9-1 Controlling a target manually ........................................................... 9-3 Scheduling transmission criteria ....................................................... 9-4 Transmission schedule examples ............................................................................. 9-7 Setting bandwidth limitations ...........
Creating a backup or snapshot of the target by inserting a task command during replication ........................................................................... 17-4 Creating a backup of the target by rotating connections ................. 17-5 Index........................................................................................
Introduction Welcome to HP StorageWorks Storage Mirroring! Storage Mirroring has its own scripting language which is explained in this manual. This guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the features and functions, see the Storage Mirroring User’s Guide. Resources You have many resources available to you when using Storage Mirroring.
Conventions used in this guide The following conventions are used throughout this guide: Bold is used for items you click or select with the mouse, such as menu names and items, dialog box options, or button names. For example, when you see File, Options, you should select the File menu and then choose Options from the pull-down menu. Blue italics is used for cross-references to other sections or chapters in this guide.
Clients and Scripts The Storage Mirroring scripting language can be used in the Storage Mirroring Command Line Client or in script files, which use the same set of commands. The Command Line Client The Command Line Client is run from the operating system command line, and then Storage Mirroring commands are run from the Storage Mirroring Command line.
Storage Mirroring scripts You can create script files to execute series and combinations of Storage Mirroring commands to meet specific needs. When working with scripts, keep in mind the following. When creating Storage Mirroring scripts, each commented line must start and end with the pound (or number) sign (#). Storage Mirroring 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.
Logging on and off of Storage Mirroring To ensure protection of your data, Storage Mirroring uses native operating system security and requires a valid system username and password. If you do not have a valid system username and password for a selected machine, you will not be able to configure Storage Mirroring for that machine. As you enter DTCL commands, Storage Mirroring automatically attempts to log on to the source or target machine. You can verify your access by the resulting message.
Getting Help 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 Press any key to scroll through the list of commands. Press q to exit the help function. You can also type dtcl help from the directory where the Storage Mirroring program files are installed to display the DTCL commands and their syntax.
Replication Sets NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. Using the Storage Mirroring commands, you can perform the following functions to manage your replication sets.
2. Specify it as the active replication set by using the repset use command. 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. 3. Define a replication set rule by using the repset rule add command.
5. If you need to remove a rule, use the repset rule remove command. Command REPSET RULE REMOVE Description Removes a rule from a replication set Syntax REPSET RULE REMOVE [FROM ] Options path—Volume, directory, wild card, and/or file name repset—Name of the replication set Examples repset rule remove "c:\data" from DataFiles Notes If you do not specify a replication set name, the current replication set will be used.
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 command. repset list 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 repset display DataFiles Notes 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.
5. Add a new rule by using the 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.
Deleting a replication set 1. View the replication sets associated with the active source machine by using the command. repset list 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.
Calculating replication set size 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 repset calculate DataFiles Notes 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 log file.
Establishing a Connection NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. After you have created a replication set, you can establish a connection by connecting the replication set to a target. 1.
Options ...
Simulating a Connection NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. After you have created a replication set, you can simulate a connection by connecting the replication set to the TDU. 1.
Notes 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 . For details on DTStat, see the Storage Mirroring User’s Guide. Options that contain non-alphanumeric characters must be enclosed in quotation marks.
Managing Connections NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. Using the Storage Mirroring commands, you can perform the following functions to manage your connections.
Notes The conid list and variable=conid commands are two separate commands. If no machine name is specified in the conid list command, the active source will be used. Options that contain non-alphanumeric characters must be enclosed in quotation marks. 2. Use the Storage Mirroring status command to display statistical and informational data.
Controlling an automatic mirror Use the AutoRemirror option with the get and set commands to configure if a mirror is intiitated automatically when a connection is automatically reconnected. See Server Settings on page 15-1 for more information on using these commands with a Storage Mirroring program setting.
Configuring compression 1. To determine the current compression setting, use the default, compression is disabled. compression list command. By Command COMPRESSION LIST Description Identifies the compression level set and if compression is enabled Syntax COMPRESSION LIST 2. To set the level of compression, use the compression set command.
Disconnecting a connection Use the disconnect command to disconnect the source/target connection.
Mirroring and Replication NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. Using the Storage Mirroring commands, you can perform the following functions to manage mirroring and replication.
Options Examples 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 that are different based on block checksum comparisons NOCHECKSUM—Does not perform a checksum comparison when mirroring files ORPHANS—Moves or deletes orphan files on the target NOORPHANS—Does n
Controlling an automatic mirror Use the AutoRemirror option with the get and set commands to configure if a mirror is intiitated automatically when a connection is automatically reconnected. See Server Settings on page 15-1 for more information on using these commands with a Storage Mirroring program setting. Configuring customized mirror scripts 1. To determine any current mirroring scripts, use the account list command.
Options con_id—Connection ID assigned to the source/target connection source—Name of the source target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types Examples Notes MIRRORSTART—This script starts when the target receives the first mirror operation.
3. To specify the account to use when running the mirror scripts, use the command. script account Command SCRIPT ACCOUNT Description Specifies the user account that will be used to run scripts Syntax SCRIPT ACCOUNT [domain] Options machine—Name of the machine username—Name of the user password—Password associated with the user name domain—If logging in using a domain account, this is the domain name.
4. If you want to test your mirror script, use the script test command. Command SCRIPT TEST Description Tests a mirroring script Syntax SCRIPT TEST [arguments] [INTERACT|NOINTERACT] Options Examples Notes 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.
5. If you need to remove a mirror script, use the script remove command.
Configuring and 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.
5. If you want to stop removing orphan files after it has been started, use the command.
Starting replication Start replication by using the replication start command.
5. The data is applied on the target as it is received. Since the task command was inserted inline, the replication data from the source is applied to the target first. When the target gets to the Storage Mirroring task command, the target data will be in the exact same state as the source data when the source application service was stopped. Since this was a stable point on the source, it is also a stable point on the target. 6.
Options Examples Notes 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. The number zero (0) indicates there is no timeout delay and the next operation is immediately processed.
Verification NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. With Storage Mirroring commands, verification can only be initiatied after a connection is established. 1. Log on to the source using the login command.
3. Initiate the verification process by using the verify command. Command VERIFY Description Verifies the integrity of the data between the source and target machines.
Data Transmission NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. Using the Storage Mirroring commands, you can perform the following functions to manage your connections.
2. To stop the transmission process, use the transmission stop command. Command TRANSMISSION STOP Description Stops the transmission process 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 uses to access the target, you may need to specify the fully qualified domain name.
Controlling a target manually 1. Pause the execution of operations on the target by using the target that you are logged in to.
Scheduling transmission criteria You can clear an existing schedule, disable or enable the use of a schedule, and set start, stop, and window criteria. 1. To clear all existing transmission options, use the schedule clear command.
3. Examples schedule beta disable Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks. You can specify a start time, a repeat interval, and queue usage criteria.
4. You can specify a transmission duration and a maximum number of bytes. Command SCHEDULE END Description Sets criteria to end the transmission of data from the source to the target Syntax SCHEDULE END [ DURATION = ] [ BYTES = ] Options target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Storage Mirroring uses to access the target, you may need to specify the fully qualified domain name.
Transmission schedule examples This section shows examples of how the different schedule commands could be used together. NOTE: The numbers and times were randomly selected for these examples. Be sure to use values that work for your environment. Example 1—In this example, transmission is set to begin on January 12, 2008, at 10:30 p.m. and to end after 6 hours.
Setting bandwidth limitations 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 user-specified 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
4. If you want to review the schedule for a target, use the command. 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 uses to access the target, you may need to specify the fully qualified domain name.
7. You can enable the 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. Depending on the network route Storage Mirroring uses to access the target, you may need to specify the fully qualified domain name.
Snapshots NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. You can use Storage Mirroring commands to create a snapshot schedule, initiate a manual snapshot, apply a snapshot on the target, or delete a snapshot from the target.
2. After you have created a snapshot schedule, you can view the configuration of the schedule by using the snapshot schedule display command.
Initiating a manual snapshot Use the snapshot create command to take a manual snapshot.
Deleting a snapshot Because Storage Mirroring 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 Storage Mirroring commands to delete snapshots on the target. 1.
Archiving NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. You can use Storage Mirroring commands to manually archive your files and to recall archived files from the target. Manual archiving 1. To start archiving, use the archive start command.
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.
Recalling 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 fromthe 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.
Restoration NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. 1. Login to your target by using the login command.
3. Restore Storage Mirroring data from target to the source by using the restore command.
Failover NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. Using the Storage Mirroring commands, you can perform the following functions to manage failover.
2. Determine what NICs are available on the specified target by using the niclist command. 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.
5. Configure the monitor settings (including the IP address to monitor, the target NIC that will assume the IP address when it fails, the monitor interval and missed packets) by using the monitor move command.
6. To remove an IP address from an established monitor, use the monitor remove command. Command MONITOR REMOVE Description Removes an IP address that is currently being monitored Syntax MONITOR REMOVE [monitor] Options IP_address—The currently monitored IP address that should be removed monitor—Name of the source machine designated as the monitor Examples Notes monitor remove 205.31.2.57 alpha monitor remove 205.31.2.
Options Examples 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 c
8. If you specified to failover or failback the hostname in the monitor option command. You will need to specify a user and the associated password that has update privileges within Active Directory using the monitor account add command. This allows SPNs to be created and deleted during failover and failback.
Notes 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. 10. Remove any scripts by using the monitor script remove command.
Notes 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. 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 configuration 1. Retrieve your monitor information by using the monitor get command. Command MONITOR GET Description Retrieves and displays the machines that are currently being monitored by the specified target machine Syntax MONITOR GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples monitor get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2.
Stopping failover monitoring 1. Retrieve your monitor information by using the monitor get command. Command MONITOR GET Description Retrieves and displays the machines that are currently being monitored by the specified target machine Syntax MONITOR GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples monitor get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2.
Removing failover configuration 1. Retrieve your monitor information by using the monitor get command. Command MONITOR GET Description Retrieves and displays the machines that are currently being monitored by the specified target machine Syntax MONITOR GET Options target—Name of the target, an IP address on the target, or a virtual IP address Examples monitor get beta Notes Monitor names that contain non-alphanumeric characters must be enclosed in quotation marks. 2.
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.
Failback NOTE: As noted in the Scripting Guide Introduction on page 1-1, this guide does not explain Storage Mirroring features and functions, only the scripting aspects of Storage Mirroring. For details on the different features and functions, see the Storage Mirroring User’s Guide. 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.
3. Identify the machine you just logged into as the target 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 target beta Notes 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. 4.
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.
Server Settings While only a subset of the server settings are available through the Management Console, all of the Storage Mirroring server settings are accessible through DTCL. You can retrieve the value of a setting or you can update the value of a setting. Retrieving setting values—To retrieve the current value of a setting, use the Storage Mirroring get command. This command will return the value of the specified setting from the specified server.
Notes Some settings, although immediately applied to Storage Mirroring, 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. The following table lists all of the Storage Mirroring server settings, in decimal values.
Server Setting AllMustFail Description Specifies whether or not all IP addresses must fail for failover to take place Values: 0 any IP address can fail 1 All IP addresses must fail Default: 1 GUI Setting: Failover Control Center, Monitor Settings, Failover Trigger, All Monitored IP Addresses Fail ArchiveExclusion Directories Specifies directories that, if included in the replication set, will be excluded from the archiving process Values: Any valid path Default: DTArchiveBin RECYCLER GUI Setting: None A
Server Setting ArchiveUseDNS Name 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 AutoCalcEula Accepted Used internally by the Management Console. Do not modify this entry.
Server Setting CalculateBy Volume Description Calculates the approximate size of a replication set by using the size of the volume and subtracting the free space Values: 0 Disabled 1 Enabled Default: 0 GUI Setting: None If your replication set contains a large number of files, for example, ten thousand or more, you may want to disable the calculation of the replication set size so that data will start being mirrored sooner.
Server Setting CreateDumpOnAck Errors Description Enables additional logging for out of order acknowledgement errors Values: 0 Do not create a logging file 1 Create a logging file Default: 0 GUI Setting: None DataPath The location of the Storage Mirroring file attribute, replication set, connection, and schedule database files Values: any valid path Default: the location where the Storage Mirroring files were installed GUI Setting: Server Properties, Database tab, Database Files, Folder DefaultAddress
Server Setting DropOpOnHandle Error Description Determines if an additional attempt is made to access a file by a Microsoft API call if the Storage Mirroring call fails.
Server Setting EmailFromAddress Description Specifies the e-mail address that will appear in the From field of Storage Mirroring generated e-mail messages.
Server Setting EmailSmtpLogin Description Specifies if SMTP server authentication for e-mail notification is enabled or disabled Values: 0 SMTP authentation is disabled 1 SMTP authenticaion is enabled Default: 0 GUI Setting: Server Properties, E-mail Notification tab, Log on to SMTP Server Your SMTP server must support the LOGIN authentication method to use this feature.
Server Setting EnableRoot Encryption Description Specifies if the top-level folders of a replication set are encrypted on the source, they will be encrypted on the target as well Values: 0 Disabled 1 Enabled Default: 1 GUI Setting: None If the top-level folders in a replication set are not encrypted, disabling this option may obtain a small performance improvement.
Server Setting FailoverOnRoute Failure Description Determines if failover will occur when receiving a router message back from an IP address on the network Values: 0 Failover will not occur when receiving a destination host unreachable message 1 Failover will occur when receiving a destination host unreachable message Default: 1 GUI Setting: None FCCHelpPath The path and file name to the Failover Control Center online help file Default: C:\Program Files\StorageWorks\Storage Mirroring\online help\fcc\ wwh
Server Setting HardLinkInterval Description Specifies the length of time, in seconds, to generate a hard link report Values: any valid integer Default: 3600 GUI Setting: None HardLinkLogPath Specifies the location where hard links will be logged. If no path is specified, the location defined in LogDir will be used. Values: any valid path Default: None GUI Setting: None HBLoopback This entry is no longer used.
Server Setting 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 Properties, Source tab, Replication, Ignore Delete Operations IgnorePPP Addresses Identifies if Storage Mirroring will use PPP (Point-to-Point Protocol) or SLIP (Serial Line Internet Protocol) adapters Values:0 Storage Mirroring will send out h
Server Setting Intermediate QueueLimit 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: 512-4194304 Default: 65536 GUI Setting: None The Storage Mirroring service must be restarted in order for this change to take effect.
Server Setting LogAllOrphans Description Specifies whether orphan files are logged to the Storage Mirroring log on the target Values:0 Do not log the orphan files to the Storage Mirroring log on the target 1 Log the orphan files to the Storage Mirroring log on the target Default: 0 GUI Setting: Connection Manager/Restoration Manager, Orphans tab, Log Orphaned Files to Target List LogDir The location of the Storage Mirroring messages/alerts, verification, and statistics log files Values: any valid path De
Server Setting MaxLogFileSize Description Maximum size, in bytes, of any .dtl log file Values:limited by available disk space Default: 1048576 GUI Setting: Server Properties, Logging tab, Messages & Alerts, Maximum Length MaxLogPathname The maximum length of a file name (the entire volume\directory\filename including slashes, spaces, periods, extensions, and so on) that will be displayed in the Storage Mirroring log file and the Windows Event Viewer.
Server Setting MemoryAllocator CallbackMode Description Determines what action is taken when the MemoryQueueToDiskThreshold is met Values: 0 Auto-disconnect—Auto-disconnect processing is initiated when the MemoryQueueToDiskThreshold has been met. Connections will be reestablished when auto-reconnect occurs. 1 Pause—The Storage Mirroring service stops pulling operations from the driver when the MemoryQueue ToDiskThreshold has been met. The target will pause the source.
Server Setting Description MirrorPrompting This entry is no longer used.
Server Setting 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 NetworkRetry Specifies the interval, in seconds, at which Storage Mirroring will attempt to reconnect to the target Values: any positive number Default: 10 GUI Setting: None NetworkStatus Interval This entry is no longer used.
Server Setting OpLogging Description Specifies whether operations from the Storage Mirroring driver are logged Values: 0 Do not log operations 1 Log operations Default: 0 GUI Setting: None PingFrequency Specifies, in seconds, how often a ping is sent to the source from a monitoring target Values: 1 - 65535 Default: 5 GUI Setting: Failover Control Center, Monitor Settings, Monitor Interval Port Port connection for core Storage Mirroring communications Values: 1025 - 65535 Default: 6320 GUI Setting: Serv
Server Setting PreFailbackScript Args Description Arguments to be used with the target pre-failback script Values: Any valid argument Default: GUI Setting: Failover Control Center, Monitor Settings, Scripts, Target, Pre-Failback, Arguments PreFailbackWait Specifies whether or not to wait for the target pre-failback script to complete before finishing a failback Values: 0 Do not wait 1 Wait Default: 0 GUI Setting: Failover Control Center, Monitor Settings, Scripts, Target, Pre-Failback, Delay fail
Server Setting PriorityClass Description The priority level at which the Storage Mirroring service runs. Values: 3 Default: 3 GUI Setting: None The Storage Mirroring service runs at normal priority by default, which is adequate in most cases. However, there are some high-load situations where Storage Mirroring needs a higher priority in order to move data through its queues and transmit the data to the target. One specific example is with bulk inserts to a SQL Server® database.
Server Setting QJournalSpaceMax Description The maximum amount of disk space, in MB, in the specified QJournalDir that can be used for Storage Mirroring queuing. When this limit is reached, Storage Mirroring will automatically begin the auto-disconnect process.
Server Setting RemoveAllOrphans Description Specifies if all orphan files will be removed or only those based on RemoveOrphanTime Values: 0 Remove orphans based on the entry RemoveOrphansTime 1 Remove all orphans Default: 1 GUI Setting: Connection/Restoration Manager, Orphans tab, Remove All Orphans RemoveOrphans Time Specifies the amount of time that must be expired before an orphan file is removed Values: 1 - 131072 minutes Default: 60 minutes GUI Setting: Connection/Restoration Manager, Orphans tab, R
Server Setting RepSetDBName Description Name of the database that contains replication set information Values: any valid file name Default: DblTake.
Server Setting SendFileTimesOn Create 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.
Server Setting ShortFileName ScanInterval Minutes Description Specifies how often, in minutes, the registry is scanned for short file names for use in full-server failover and recovery Values: any valid integer Default: 240 GUI Setting: None ShutdownReboot TimeoutMinutes Specifies the amount of time, in minutes, to wait for the source to shutdown during failover when using Full-Server Failover Values: any valid integer Default: 5 GUI Setting: None ShutdownTimeout The amount of time, in seconds, for the
Server Setting SourcePost FailbackScriptArgs 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 SSMShutdown Services Used by Full-Server Failover to determine services to shutdown during failover. Do not modify this entry. SSMUseDisk Signature Used by Full-Server Failover to determine how target disk signatures are used.
Server Setting Description StatsWriteInterval Interval, in minutes, in which statistics are written to the statistic.sts file Values: 0 - 65535 Default: 5 GUI Setting: Server Properties, Logging tab, Statistics, Write Interval SystemMemory Limit Set by the Storage Mirroring service, each time it is started, to record the amount of available memory. TargetPaused Internal setting that indicates if the target machine is paused. Do not modify this setting.
Server Setting TGCloseDelay Description The length of time, in milliseconds, a file is held open on the target Values: 0 - 2000 Default: 1000 GUI Setting: None If disk caching on the target is disabled either manually or by default (for example, by default on disks that host Active Directory database files), the target system may be slow during a mirror. If so, descreasing this setting to 100, 10, and 0 will result in incremental improvements, with 0 returning the system performance to normal.
Server Setting TGMirrorCapacity Low Description Minimum percentage of system memory that can contain mirror data before the target signals the source to resume the sending of mirror operations. Values: 1-75 Default: 15 GUI Setting: Server Properties, Target tab, Files, Target Mirror Capacity Low Percentage The maximum value forTGMirrorCapacityLow is either 75 or TGMirrorCapacityHigh, which ever is lower.
Server Setting TGWriteFailure BeforeNotification 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. Values: 0-1024 Default: 10 GUI Setting: None If you change the setting to 0, the notification will be disabled. Changing this option will only affect how the status is changed on the Target Status field of the Management Console.
Server Setting VerifyLogLimit Description Maximum size of the DTVerify.log file in bytes Values: limited by available hard drive space, up to 4 GB Default: 1048576 GUI Setting: Server Properties, Logging tab, Verification, Maximum Length VerifyLogName Name of the verification log file Values: any valid file name Default: DTVerify.
Storage Mirroring Commands The Storage Mirroring commands are listed in alphabetical order on the following pages. Each command includes the following: Command name Description of the command Exact syntax for using the command Options, if any Examples, if necessary Notes, if any For details on the conventions used for the command syntax, see Conventions used in this guide on page 1-2.
Archive Start Command ARCHIVE START Description Starts the archive process Syntax ARCHIVE START FILEAGE FILESIZE Options 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. Examples size—Any number indicating the size, in KB, of the files that you want archived.
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 Iden
ConID Command CONID Description Allows you to to assign the value of a connection ID to a variable Lists the target and replication set for all connection IDs for a source Syntax Options Examples 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 source—Name of the source Notes =CONID <
Connect Command CONNECT Description Establishes a connection between a replication set and a target machine Syntax CONNECT TO MAP EXACT | MAP BASE | MAP TO [,...
Examples Notes connect DataFiles to beta map exact connect UserData to beta map base d:\UserData\ connect UserFiles to beta map exact orphans, compression 2 The default settings for this command are mirror, replicate, nomonitor, and noorphans. The options (no)mirror, (no)replicate, (no)monitor, (no)orphans, and compression can be used in any combination and in any order.
Disconnect Command DISCONNECT Description Disconnects a specified source/target connection for the currently selected source Syntax DISCONNECT Options con_id—Connection ID assigned to the source/target connection *—Specifies all connection IDs Examples disconnect 1 disconnect * 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 enclo
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 MailServer Command EMAIL MAILSERVER Description Specifies the name of the SMTP mail server for e-mail notification Syntax EMAIL MAILSERVER [username][password] Options server_name—Name of the SMTP mail server ip_address—IP address of the SMTP mail server username—User ID required for SMTP server authentication password—Password associated with the specified user name Examples email mailserver xchng administrator ******* Notes Your SMTP server mus
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 INFO—Information messages will be sent via e-mail WARNING—Warning messages will be sent via e-mail ERROR—Error messages will be sent via e-mail Examples Notes EXCLUDEIDS ID1,ID2-ID4,...—A comma separated list of IDs or ID ranges.
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 Examples NOPREFIX—No prefix will be inserted at the front of the subject line for each Storage Mirroring generated e-mail message DESCRIPTION—Append the message description to the end of the subject line NODESCRIPTION—Do not append the message description to the end of
Email Test Command EMAIL TEST Description Sends a test message to demonstrate e-mail notification Syntax EMAIL TEST [SENDTO ] [TEXT ] Options Examples Notes 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.
Failback Command FAILBACK Description Initiates the failback process for the specified monitor machine Syntax FAILBACK [ON ] REMONITOR|NOREMONITOR Options 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.
Get Command GET Description Requests the value of a Storage Mirroring program setting from the specified server Syntax GET [machine] Options setting—See the table Double-Take Server Settings on page 10-2 for a complete list of the Storage Mirroring program settings machine—Name of the machine Examples Notes get netport get VerifyLogName get DefaultAddress If you do not specify a machine name, the value from the current source will be returned.
Get Local Command GETLOCAL Description Requests the value of a Storage Mirroring program setting from the local machine Syntax GETLOCAL Options setting—See the table Double-Take Server Settings on page 10-2 for a complete list of the Storage Mirroring program settings Examples getlocal netport getlocal VerifyLogName getlocal DefaultAddress Help Command HELP Description Displays the DTCL commands and their syntax Syntax HELP Notes Press any key to scroll through the list
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 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 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
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 uses to access the target, you may need to specify the fully qualified domain name.
Load Source Command LOAD SOURCE Description Loads the Storage Mirroring 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.
Login Command LOGIN Description Log on to a Storage Mirroring machine Syntax LOGIN [domain] Options 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.
Mirror Pause Command MIRROR PAUSE Description Pauses a mirror that is in progress Syntax MIRROR PAUSE Options con_id—Connection ID assigned to the source/target connection *—Specifies all connection IDs. Examples mirror pause 1 mirror pause * Mirror Resume Command MIRROR RESUME Description Resumes a paused mirror Syntax MIRROR RESUME Options con_id—Connection ID assigned to the source/target connection *—Specifies all connection IDs.
Mirror Start Command MIRROR START Description Initiates the mirror process Syntax MIRROR START [DIFFERENT [,NEWER] ,CHECKSUM | NOCHECKSUM] [ORPHANS |NOORPHANS] [CALCULATE | NOCALCULATE] [CLEARRESTOREREQUIRED] Options Examples 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
Mirror Stop Command MIRROR STOP Description Stops a paused mirror Syntax MIRROR STOP Options con_id—Connection ID assigned to the source/target connection *—Specifies all connection IDs Examples mirror stop 1 mirror stop * Monitor Account Add Command MONITOR ACCOUNT ADD Description Identifies a user account with update permissions within Active Directory Syntax MONITOR ACCOUNT ADD [monitor] Options username—Name of the user in the format dom
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 monitor clear alpha Notes 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.
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 monitor display alpha Notes 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.
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 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 NETWORK—Monitors the source by looking
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 MOVENAME—M
Options Examples 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 c
Monitor Remove Command MONITOR REMOVE Description Removes an IP address that is currently being monitored Syntax MONITOR REMOVE [monitor] Options IP_address—The currently monitored IP address that should be removed monitor—Name of the source machine designated as the monitor Examples Notes monitor remove 205.31.2.57 alpha monitor remove 205.31.2.68 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 Examples Notes 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-failba
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 Examples Notes 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 scr
Monitor Stop Command MONITOR STOP Description Stops monitoring the source machine for a failure Syntax MONITOR STOP [ON ] Options 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 monitor stop alpha on beta Notes Option names that contain non-alphanumeric characters must be enclosed in quotation marks.
NICList 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 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 Start Command ORPHANS START Description Manual operation to remove any orphan files on the target Syntax ORPHANS START con_id [CLEARRESTOREREQUIRED] Options 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—Conn
Ping Command PING Description Checks a specified machine to see if Storage Mirroring 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.
Options Examples Notes 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. The number zero (0) indicates there is no timeout delay and the next operation is immediately processed.
Recall Pause Command RECALL PAUSE Description Pauses the process to recall all archived files fromthe 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 fromthe target Syntax RECALL RESUME Options con_id—Connection ID assigned to the source/target connection Examples recall resume 1 Recall Start Command R
Replication Start Command REPLICATION START Description Initiates the replication process Syntax REPLICATION START [CLEARRESTOREREQUIRED] Options conid—Connection ID assigned to the source/target connection *—Specifies all connection IDs CLEARRESTOREREQUIRED—Clears the restore required flag and initiates replication Examples replication start 1 replication start * Replication Stop Command REPLICATION STOP Description Stops the replication process Syntax REPLICATION
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 The name of the replication set should not be a Storage Mirroring 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 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 path—Volume, directory, wild card, and/or file name repset—Name of the replication set Examples repset rule remove "c:\data" from DataFiles Notes 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.
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 repset—Name of the replication set target—Name of the target, an IP address on the target, or a virtual IP address original_source—Name of the original source OVERWRI
Resume Target Command RESUMETARGET Description Allows you to resume the execution of Storage Mirroring operations on the target Syntax RESUMETARGET [FROM ] Options 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 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 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 uses to access the target, you may need to specify the fully qualified domain name. Examples schedule beta enable Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
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 Examples Notes target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Storage Mirroring uses to access the target, you may need to specify the fully qualified domain name
Schedule Window Command SCHEDULE WINDOW Description Sets criteria to only allow transmissions during a certain period of time Syntax SCHEDULE WINDOW TO Options target—Name of the target, an IP address on the target, or a virtual IP address Depending on the network route Storage Mirroring 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 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 con_id—Connection ID assigned to the source/target connection source—Name of the source target—Name of the target, an IP address on the target, or a virtual IP address type—Any of the following script types MIRRORST
Examples Notes script add 1 alpha on beta mirrorstart="C:\Program Files\StorageWorks\Storage Mirroring\Scripts\MirrorStartScript.bat" args="arg1 arg2" delay interact The default settings for this command are nodelay and nointeract. Machine names that contain non-alphanumeric characters must be enclosed in quotation marks.
Script Test Command SCRIPT TEST Description Tests a mirroring script Syntax SCRIPT TEST [arguments] [INTERACT|NOINTERACT] Options Examples Notes 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.
Set Command SET Description Modifies the value of a Storage Mirroring program setting for the specified server Syntax SET = [machine] Options setting—See the table Double-Take Server Settings on page 10-2 for a complete list of the Storage Mirroring program settings value—See the table Double-Take Server Settings on page 10-2 for a complete list of the Storage Mirroring program settings machine—Name of the machine Examples Notes set netport=1100 set DefaultAddress="129.
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 Delete Command SNAPSHOT DELETE Description Deletes the specified snapshot(s) from the target Syntax SNAPSHOT DELETE [ON ] Options con_id—Connection ID assigned to the source/target connection snapshot_list_number—The snapshot number retrieved from the SNAPSHOT LIST command ALL—Deletes all snapshots OLD—Deletes only the oldest snapshot Examples Notes GOOD—If specified, deletes only good snaps
Snapshot Revert Command SNAPSHOT REVERT Description Revert the target to the last good automatic snapshot Syntax SNAPSHOT REVERT [ON ] Options 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 snapshot revert 1 Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Snapshot Schedule Display Command SNAPSHOT SCHEDULE DISPLAY Description Displays the snapshot schedule Syntax SNAPSHOT SCHEDULE DISPLAY [ON ] Options 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 snapshot schedule 1 display Notes Target names that contain non-alphanumeric 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 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 b
StatsLog Start Command STATSLOG START Description Starts the DTStats statistics logging utility. Syntax STATSLOG START [TO ] [EVERY ] [MAXSIZE ] Options Examples Notes machine—Name of the machine filename—Any valid path and filename to which the statistical information will be logged minutes—The number of minutes to write to the log file kilobytes—The maximum file size in kilobytes statslog start alpha to "dtstat.
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.
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 target beta Notes 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.
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 uses to access the target, you may need to specify the fully qualified domain name. Examples transmission pause beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Transmission Stop Command TRANSMISSION STOP Description Stops the transmission process 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 uses to access the target, you may need to specify the fully qualified domain name. Examples transmission stop beta Notes Target names that contain non-alphanumeric characters must be enclosed in quotation marks.
Unload Target Command UNLOAD TARGET Description Unloads the Storage Mirroring target module Syntax UNLOAD TARGET Options machine—Name of the machine Examples unload target beta 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.
Version Command VERSION Description Displays the Storage Mirroring version currently installed Syntax VERSION [MACHINE] Options MACHINE—Name of the machine Examples version alpha Notes 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 on Restore Command WAITONRESTORE 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.
Scripting Examples This chapter contains sample Storage Mirroring 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. NOTE: See Storage Mirroring scripts on page 2-2 for information on using Storage Mirroring scripts.
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 Storage Mirroring commands. The $connectionID variable will contain the connection ID for the connection established. This variable can then be used to establish a verification schedule.
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 Storage Mirroring commands to pause 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 task command into the Storage Mirroring replication process, and then restarts the services. REM net net net net stop stop stop stop Stop the services on the source so that data changes are stopped.
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.
Index B I bandwidth limitations 9-8 batch files 2-2 IF conditional 2-2 scripts in-band control batch files 2-2 See task command processing comments 2-2 flow control 2-2 mirroring 7-3 L overview 2-2 logging on/off 2-3 variables 2-2 server properties 15-1 simulating a connection 5-1 M snapshots mirroring applying on the target 10-3 automatic 6-3, 7-3 deleting on the target 10-4 manual controls 7-1 manual controls 10-3 scripts 7-3 scheduling 10-1 monitoring connections 6-1 C Command Line Client 2-1 command
