3.4 Common Parameters

The parameters in this section can be used by Dynamic File Services pair or policy actions.

3.4.1 Description

-description

Specifies a textual description of a pair, a policy, a schedule, or a cloud account.

Syntax

-description=<"text">

Examples

-description="East site user files"
-description="Policy to move graphics files to the secondary"
-description="Run every Saturday from 0100 to 0800"
-description="Cloud account for John Doe's bucket at Amazon S3"

3.4.2 Direction to Move Files

-primaryToSecondary

Specifies that files will move from the primary to the secondary location when an action is performed. If a direction option is not specified, the default direction is primary to secondary.

Restriction: This option cannot be used with the -secondaryToPrimary option.

-secondaryToPrimary

Specifies that files will move from the secondary to the primary location when an action is performed. If a direction option is not specified, the default direction is primary to secondary.

The -secondaryToPrimary option is invalid for retention pairs.

Restriction: This option cannot be used with the -primaryToSecondary option.

3.4.3 Name

-name

Specifies a unique name on a Dynamic File Services server for a new pair, policy, schedule, or cloud account. You can modify policy names, schedule names, and cloud account names. Pair names cannot be modified; you must unlink and re-create the pair with the new name.

Syntax

-name=<"text">

Pair Examples

-name="myPair"

-name="ProjectA Pair"

Policy Examples

-name="myPolicy"

-name="Move music and videos"

Schedule Examples

-name="quarterly_1st"

-name="custom_financial"

Cloud Account Examples

-name="dropbox1"

-name="amazons3_johndoe"

3.4.4 Pair ID

-pairId

Specifies the pair identifier. You can provide the pair name, or provide the GUID (globally unique identification) of the pair. A GUID is automatically assigned by Dynamic File Services when you create a pair.

Syntax

-pairId=<"pairname"|"GUID">

Examples

-pairId="myPair"

-pairId="42e0064d-0b2c-4bb3-9825-bfa82999720e"

3.4.5 Policy ID

-policyId

Specifies the policy identifier. You can provide the policy name, or provide the GUID of the policy. A GUID is automatically assigned by Dynamic File Services when you create a policy.

Syntax

-policyId=<"policyname"|"GUID">

Examples

-policyId="myPolicy"

-policyId="My JPG and BMP Policy"

-policyId="Last Modified GT 6 Months"

-policyId="4b5b5820-da6c-4c07-b9da-07e3b83ebe02"

3.4.6 Policy ID List

-policyIdList

Specifies a comma-separated list of policyId parameters. For each policy in the list, you can provide the policy name or the GUID. Separate entries with a comma and no spaces. Place quotation marks around the list.

Syntax

-policyIdList=<"<policyname|GUID>[,<policyname"|GUID>,...]">

Examples

-policyIdList="myPolicy,myPolicy100,4b5b5820-da6c-4c07-b9da-07e3b83ebe02"

-policyIdList="My JPG and BMP Policy"

-policyIdList="Last Modified GT 6 Months,myPolicy"

3.4.7 Schedule ID

-scheduleId

Specifies the schedule identifier. You can provide the schedule name, or provide the GUID of the schedule. A GUID is automatically assigned by Dynamic File Services when you create a schedule.

Syntax

-scheduleId=<"schedulename"|"GUID">

Examples

-scheduleId="quarterly_1st"

-scheduleId="custom_financial"

-scheduleId="4b5b5820-da6c-4c07-b9da-07e3b83ebe02"

3.4.8 Schedule Type

-scheduleType

Specifies whether the type of schedule is a review schedule or a policy schedule.

Syntax

-scheduleType=<"review"|"policy">

Examples

-scheduleType="review"

-scheduleType="policy"

3.4.9 Cloud ID

-cloudId

Specifies the cloud account identifier. You can provide the cloud account name, or provide the GUID of the cloud account. A GUID is automatically assigned by Dynamic File Services when you add a cloud account.

Syntax

-cloudId=<"cloud_account_name"|"GUID">

Examples

-cloudId="dropbox1"

-cloudId="cloudme1"

-cloudId="box1"

-cloudId=""4b5b5820-da6c-4c07-b9da-07e3b83ebe03"