3.1 DswCli.exe Syntax Overview

AUTHENTICATION PARAMETERS
Authentication Parameters for Each Command
[-servername [-port [-username [-password]]]]
PAIR ACTIONS
Add a Pair
DswCli.exe -PAIR -ADD
         -name=<pairname>
         -primarypath=<path>
         -secondaryPath=<path>
         [-description=<"text">]
         [-pairType=<"standard"|"retention">]
         [-secondaryCloud=<cloudId>]          ; use with retention pairs only
         [-reviewUsers=<See FORMAT>]          ; use with retention pairs only
         [-reviewGroups=<See FORMAT>]         ; use with retention pairs only
         [authentication_parameters]
         If pairType is not specified,the default is "standard".
Modify a Pair
DswCli.exe -PAIR -MODIFY
         -pairId=<pairname|GUID>
         [-description=<"text">]
         [-addReviewUsers=<See FORMAT>]      ; use with retention pairs only
         [-addReviewGroups=<See FORMAT>]     ; use with retention pairs only
         [-deleteReviewUsers=<See FORMAT>]   ; use with retention pairs only
         [-deleteReviewGroups=<See FORMAT>]  ; use with retention pairs only
         [authentication_parameters]
Unlink a Pair
DswCli.exe -PAIR -DELETE
         -pairId=<pairname|GUID>
         [authentication_parameters]
List All Pairs
DswCli.exe -PAIR
         [authentication_parameters]
List Details for a Pair
DswCli.exe -PAIR -DETAIL
         -pairId=<pairname|GUID>
         [authentication_parameters]
Add Exclude/Include Paths for a Pair
DswCli.exe -PAIR -ADDEXCLUDEINCLUDEPATHS
         -pairId=<pairname|GUID>
         -flags=<exclude|include|none> ; None disables exclude/include policy
         [-paths=<path1[;path2;path3...]>] ; Required to add paths
         [authentication_parameters]
Delete Exclude/Include Paths from a Pair
DswCli.exe -PAIR -DELETEEXCLUDEINCLUDEPATHS
         -pairId=<pairname|GUID>
         -flags=<exclude|include|none> ; None disables exclude/include policy
         [-paths=<path1[;path2;path3...]>] ; Required to remove paths
         [authentication_parameters]
Associate a Policy and Pair
DswCli.exe -PAIR -ASSOCIATE
         -pairId=<pairname|GUID>
         -policyId=<policyname|GUID>
         [authentication_parameters]
Disassociate a Policy and Pair
DswCli.exe -PAIR -DISASSOCIATE
         -pairId=<pairname|GUID>
         -policyId=<policyname|GUID>
         [authentication_parameters]
Associate a Review Schedule to a Retention Pair
DswCli.exe -PAIR -ASSOCIATE
         -pairId=<pairname|GUID>
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
Disassociate a Review Schedule from a Retention Pair
DswCli.exe -PAIR -DISASSOCIATE
         -pairId=<pairname|GUID>
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
Execute a List of Policies for a Pair
DswCli.exe -PAIR -EXECUTE
         -pairId=<pairname|GUID>
         -policyIdList=<<policyname|GUID>[,<policyname|GUID>,...]>
         [authentication_parameters]
Move a List of Files or Folders on a Pair
DswCli.exe -PAIR -MOVE
          ‑pairId=<pairname|GUID> 
          <-folderList="filename" | -fileList="filename">
          <-primaryToSecondary | -secondaryToPrimary>
         [authentication_parameters]
POLICY ACTIONS
Add a Policy
DswCli.exe -POLICY -ADD
         -name=<policyname>
         [-description=<"text">]
         <-primaryToSecondary | -secondaryToPrimary>
         [-fileExtension=<SEE FORMAT>]
         [-fileOwners=<SEE FORMAT>]
         [-groups=<SEE FORMAT>]
         [-lastAccessed=<SEE FORMAT>]
         [-lastModified=<SEE FORMAT>]
         [-fileTypes=<SEE FORMAT> [-fileContent]]
         [-fileSize=<SEE FORMAT>]
         [-noOwner]
         [authentication_parameters]
Modify a Policy
DswCli.exe -POLICY -MODIFY
         ‑policyId=<"policyname"|"GUID">
         [‑name=<new_policyname>]
         [-description"text"]
         [-primaryToSecondary | -secondaryToPrimary]
         [-fileExtension=<SEE FORMAT>]
         [-fileOwners=<SEE FORMAT>]
         [-groups=<SEE FORMAT>]
         [-lastAccessed=<SEE FORMAT>]
         [-lastModified=<SEE FORMAT>]
         [-fileTypes=<SEE FORMAT> [-fileContent]]
         [-fileSize=<SEE FORMAT>]
         [-noOwner]
         [authentication_parameters]
Delete a Policy
DswCli.exe -POLICY -DELETE
         -policyId=<policyname|GUID>
         [authentication_parameters]
List All Policies
DswCli.exe -POLICY
         [authentication_parameters]
List Details for a Policy
DswCli.exe -POLICY -DETAIL
         -policyId=<policyname|GUID>
         [authentication_parameters]
Associate a Policy Schedule to a Policy
DswCli.exe -POLICY -ASSOCIATE
         -policyId=<policyname|GUID>
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
Disassociate a Policy Schedule from a Policy
DswCli.exe -POLICY -DISASSOCIATE
         -policyId=<policyname|GUID>
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
SCHEDULE ACTIONS
Add a Review Schedule
DswCli.exe -SCHEDULE -ADD
         -name=<schedulename>
         -scheduleType="review"
         [-description=<"text">]
         [-monthly=<SEE FORMAT>]
         [-quarterly=<SEE FORMAT>]
         [-yearly=<SEE FORMAT>]
         [-custom=<SEE FORMAT>]
         [authentication_parameters]
Add a Policy Schedule
DswCli.exe -SCHEDULE -ADD
         -name=<schedulename>
         -scheduleType="policy"
         [-description=<"text">]
         [-time=<SEE FORMAT>]   ; Note: -time not allowed with -hourly
         [-hourly=<SEE FORMAT>]
         [-daily=<SEE FORMAT>]
         [-weekly=<SEE FORMAT>]
         [-monthly=<SEE FORMAT>]
         [-quarterly=<SEE FORMAT>]
         [-yearly=<SEE FORMAT>]
         [-custom=<SEE FORMAT>]
         [authentication_parameters]
Modify a Review Schedule
DswCli.exe -SCHEDULE -MODIFY
         -scheduleId=<schedulename|GUID>
         [-name=<new_schedulename>]
         [-description=<"text">]
         [-monthly=<SEE FORMAT>]
         [-quarterly=<SEE FORMAT>]
         [-yearly=<SEE FORMAT>]
         [-custom=<SEE FORMAT>]
         [authentication_parameters]
Modify a Policy Schedule
DswCli.exe -SCHEDULE -MODIFY
         -scheduleId=<schedulename|GUID>
         [-name=<new_schedulename>]
         [-description=<"text">]
         [-time=<SEE FORMAT>] ; Note: -time not allowed with -hourly
         [-hourly=<SEE FORMAT>]
         [-daily=<SEE FORMAT>]
         [-weekly=<SEE FORMAT>]
         [-monthly=<SEE FORMAT>]
         [-quarterly=<SEE FORMAT>]
         [-yearly=<SEE FORMAT>]
         [-custom=<SEE FORMAT>]
         [authentication_parameters]
Delete a Review Schedule or a Policy Schedule
DswCli.exe -SCHEDULE -DELETE
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
List All Schedules
DswCli.exe -SCHEDULE
         [authentication_parameters]
List All Review Schedules
DswCli.exe -SCHEDULE
         -scheduleType="review"
         [authentication_parameters]
List All Policy Schedules
DswCli.exe -SCHEDULE
         -scheduleType="policy"
         [authentication_parameters]
List Details of a Review Schedule or Policy Schedule
DswCli.exe -SCHEDULE -DETAIL
         -scheduleId=<schedulename|GUID>
         [authentication_parameters]
REGISTRATION ACTIONS
Register a License Key
DswCli.exe -REGISTRATION 
         -regFilePath=<"filename">
         [authentication_parameters]
Display the Registration Status
DswCli.exe -REGISTRATION
         [authentication_parameters]
Dump the Contents of the License If the Product Is Registered
DswCli.exe -REGISTRATION
         -dumpLicense
         [authentication_parameters]
CLOUD PROVIDERS ACTION
List All Cloud Providers
DswCli.exe -CLOUDPROVIDERS
         [authentication_parameters]
CLOUD ACTIONS
Add a Cloud Account
DswCli.exe -CLOUD -ADD 
         -name=<cloud_account_name> 
         [-description=<"text">] 
         -cloudProvider=<amazons3|box|cloudme|dropbox> 
         [-cloudAccountName=<acc_login_name> 
            -cloudAccountPwd=<acc_pwd>
            ] ; Use for CloudMe(TM) or Box(TM)
         [-cloudAccountAppKey=<app_key> 
            -cloudAccountAppSecret=<app_secret> 
           [-cloudAccoutBucket=<bucketname>]
           [-folderPath=<"folder_path">] 
           ] ; Use for Amazon S3(TM)
         [-cloudAccountAppKey=<app_key> 
            -cloudAccountAppSecret=<app_secret> 
           [-phase1 | -phase2]
           ] ; Use for DropBox(TM)
         [-cloudPath=<"/cloud_path">]     
         [authentication_parameters]
Modify a Cloud Account
DswCli.exe -CLOUD -MODIFY
         -cloudId=<cloud_account_name|GUID> 
         [-name=<cloud_account_name>] 
         [-description=<"text">] 
         [-cloudAccountName=<acc_login_name> 
            -cloudAccountPwd=<acc_pwd>
            ] ; Use for CloudMe(TM) or Box(TM)
         [-cloudAccountAppKey=<app_key> 
            -cloudAccountAppSecret=<app_secret> 
            [-cloudAccoutBucket=<bucketname>]
            [-folderPath=<"folder_path">] 
            ] ; Use for Amazon S3(TM)
         [-cloudAccountAppKey=<app_key> 
            -cloudAccountAppSecret=<app_secret> 
            [-phase1 | -phase2]
            ] ; Use for DropBox(TM)
         [-cloudPath=<"/cloud_path">]    
         [authentication_parameters]
Delete a Cloud Account
DswCli.exe -CLOUD -DELETE
         -cloudId=<cloud_account_name|GUID> 
         [authentication_parameters]
List All Cloud Accounts
DswCli.exe -CLOUD
         [authentication_parameters]
List Details of a Cloud Account
DswCli.exe -CLOUD -DETAIL
         -cloudId=<cloud_account_name|GUID>
         [authentication_parameters]