5.1 DswPairCheck

5.1.1 Description

The Dynamic File Services Pair Check utility is used to detect duplicate files in the pair structure or to detect folders with attribute or ACL permission differences. It can generate reports in CSV and XML format.

The Pair Check utility is typically used for standard pairs to detect duplicate files that are hidden by the merged view, and to verify ACLs. Duplicate files do not occur in a retention pair because the retention repository in the secondary location has a different file structure than the primary path. In addition, the Pair Check utility does not support being run on a retention pair that uses cloud storage as the secondary path. In the cloud, the ACL metadata is stored in a database and not with the files.

IMPORTANT:The Dynamic File Service can be running or not running when you run the Pair Check utility, but policies must not be running against the pair.

5.1.2 Syntax

DswPairCheck.exe -pair="<pairname|guid>" [options]
DswPairCheck.exe –source="path" –target="path" [options]

Make sure there are no policies running against the pair (that is, the pair status is Idle), then run the DswPairCheck.exe command on the server where Dynamic File Services is installed.

Rights Needed to Run the Command

The Pair Check utility can be run by any user with Administrator privileges on the primary server and that has file system rights on the primary path and secondary path.

IMPORTANT:Typically, the username provided is a user identity that has Administrator privileges. If a remote secondary path is used in a pair, you must provide the username of a user that also has Administrator privileges on the DynamicFS server, rights on the remote share, and NTFS file system access rights on the secondary path. Otherwise, the secondary location is reported as missing. One way to do this is to add the username as a member of the Dynamic File Services Storage Rights group. It does not matter if the user is also a member of the Dynamic File Services group.

Syntax for Scripts

If you are using this command in a script, you must escape the quotation mark characters by preceding them with a backslash (\). You can also use the -silent option to turn off the screen output. For example:

DswPairCheck.exe -pair=\"<pairname|guid>\" [options] -silent

DswPairCheck.exe –source=\"path\" –target=\"path\" [options] -silent

5.1.3 Using the Utility

  1. Log in to the Dynamic File Services server as the Administrator user or as a user with Administrator privileges.

  2. Open the Management Console, select the pair, then verify that the pair status is in the Idle state.

    Policies must not be running against the pair when you start the Pair Check utility. If policies are running, wait until they are done, or stop them manually. Wait until the pair status is idle before continuing.

  3. Open an Administrator Command Prompt console. Select Start > All Programs > Accessories, right-click Command Prompt, then select Run as Administrator.

    If you are prompted to confirm that you want to run the program as Administrator, click Continue.

  4. Change directory to go to the C:\Program Files\Dynamic File Services folder (or the folder where you installed Dynamic File Services).

  5. At the command prompt, enter one of the following commands:

    DswPairCheck.exe -pair="<pairname|guid>" [options]
    
    DswPairCheck.exe –source="path" –target="path" [options]
    
  6. When you are prompted, enter the username of a user with rights to all of the paths in the pair.

5.1.4 Check Action Options

-files

If this option is specified, a check is performed for duplicate files on the specified source and target paths.

Example

-files
-folders

If this option is specified, a check is performed for folder attribute and ACL permission differences on the specified source and target paths.

Example

-folders

5.1.5 Control Options

-h , --help

Displays help for DswPairCheck.exe, then exits.

-pair=”<pairname | guid>”

Use this option to look for the specified pair in the pair database to determine the paths to use for the source and target paths. Do not use this option with the -source and -target options.

Example

-pair="MyPair"
-silent

If this option is specified, screen output is not generated.

Example

-silent
-source="path"

Use this option to specify the path to use for the primary path. This option must be used in combination with the ‑target option.

Do not use this option with the -pair option.

Example

-source="c:\primary"
-target="path"

Use this option to specify the path to use for the secondary path. This option must be used in combination with the -source option.

Do not use this option with the -pair option.

Example

-target="g:\shadow"

5.1.6 Report Options

-csv=”reportname”

Use this option to generate an output report in CSV format.

If this option is used with the -files option, the output file is named reportname.files.csv.

If this option is used with the -folders option, the output file is named reportname.folders.csv.

Example

-csv=”csvReport”

The possible reports generated are csvReport.files.csv and csvReport.folders.csv.

-xml="reportname"

Use this option to generate an output report in XML format.

If this option is used with the -files option, the output file is named reportname.files.xml.

If this option is used with the -folders option, the output file is named reportname.folders.xml.

Example

-xml=”xmlReport”

The possible reports generated are xmlReport.files.xml and xmlReport.folders.xml.

5.1.7 Examples

Check for Duplicate Files and Produce a CSV Report

DswPairCheck.exe -pair="My DSW Pair" -files -csv="myCsvReport"

Looks in the pair database for the source and target paths of the pair named My DSW Pair. Checks for duplicate files on the source and target paths. Produces a report in CSV format. The report file generated is myCsvReport.files.csv.

Check for Folders with Mismatched Attributes and ACLs and Produce an XML Report

DswPairCheck.exe -pair="My DSW Pair" -folders -xml="myXmlReport"

Looks in the pair database for the source and target paths of the pair named My DSW Pair. Checks for folders that have mismatched attributes and ACLs on the source and target paths. Produces a report in XML format. The report file generated is myXmlReport.folders.xml.

Check Files and Folders and Produce CSV and XML Reports

DswPairCheck.exe -pair="My DSW Pair" -folders -files -xml="myXmlReport" ‑csv=”myCsvReport”

Looks in the pair database for the source and target paths of the pair named My DSW Pair. Checks for duplicate files and for folders that have mismatched attributes and ACLs on the source and target paths. Produces a report in XML format and in CSV format.

The report files generated are:

  • myCsvReport.files.csv
  • myCsvReport.folders.csv
  • myXmlReport.files.xml
  • myXmlReport.folders.xml