Home | Concept/Dataflow | Usage | Typical Scenarios | Troubleshoot

Usage

The Execution Tool
Following is the command line usage of the execution tool. Please refer to Typical Scenarios for typical scenarios that are supported by this tool.

SQL Azure Data Protector, Execution Tool (1.0.0.0)

Command Line Parameters:

-P[rofile] <profilename>     The profile containing the endpoint information.
-H[elp] | -?                 Show this help text.
-B[ackup]                    Perform a backup operation.
-R[estore] <bacpacname>      Perform a restore operation from the specified backpac file.
-R[e]n[ame] <newdbname>      Use this new database name when restoring from a backup.
-S(uppress)No(tification)    Suppress the notification after an operation.
-T(est)C(onnectivity)O(nly)  Perform connectivity tests only.

Usage:

Backup a database by using a specified profile:
   ExecutionTool -p profile1 -b

Restore a database by using a specified profile and a specified bacpac file: (*1)
   ExecutionTool -p profile1 -r pocdb.2012-05-01-00-30-00.bacpac

Restore a database by using a specified profile, a specified bacpac file and also a new database name: (*1)
   ExecutionTool -p profile1 -r pocdb.2012-05-01-00-30-00.bacpac -rn NewDatabaseName

Backup a database by using a specified profile and suppress the completion notification:
   ExecutionTool -p profile1 -b -sno

Only test connectivity of the specified profile: (*2)
   ExecutionTool -p profile1 -tco

*Notes and caveats:

1. On restore the database with the same name must not exist. A new database is
   always created. The original database name, edition and max size will be automatically applied.
2. By default, the connectivity will always be tested before running any operations.


Notes and caveats:
  • A profile (-p) is always required when performing backup, restore or test connectivity operations
  • A restore operation will by default try to use the original name of the database when the bacpac file was created; however, you can use the -rn (rename) option to specify a new database name when necessary
  • The -tco (test connectivity only) option is used to test the connectivity to all the configured endpoints that will participate in the operations. Connectivity test will always be executed when running an operation; however, this option provides the ability to test the connectivity explicitly
  • The notification suppression (-sno) option is not supported yet and has no effects when specified; however, this tool emits well defined error codes to Window event log, so that an existing Ops tool like SCOM can be used to monitor the backup operations. Please refer to section 3 for all the defined error codes and recommended troubleshooting actions
The Admin Tool
Following is the GUI guide of the admin tool. Please refer to section 2.3 for typical scenarios that are supported by this tool.

image004.png
Image 1

image005.png
Image 2

image006.png
Image 3

image007.png
Image 4

Notes and caveats:
  • Use file menu to load/save the profile data (Image 1)
  • Use the tree view on left side to navigate configurations for different steps (Image 2)
  • *Notification is not supported yet. The “Notification Recipients” configuration has no effects for the tool execution
  • “Days to keep a bacpac file (Retention)” specify the max days that an archive file will be kept
  • For most of the configuration pages that can be navigated on the left tree view, there is a “Test Connection…” button to provide ad-hoc connectivity test ability for quick validation of the configurations
  • The profile data is actually an xml file in the same folder where the tools live with the name “SqlAzureDataProtector.profile”. It is not recommended but still able to modify the file directly. The credentials are encrypted. In order to manually modify that information, the Enc/Dec Tool which can be executed from “Admin Tool --> Tool --> Enc/Dec Tool…” is designed to support this scenario (Image 3, Image 4)

Last edited Nov 2, 2012 at 8:24 AM by jack4it, version 3

Comments

No comments yet.