dtscli Command—Manage Data Transfers

The DTSCLI collects related arguments together in groups because of the large number of command-line arguments. Arguments are specified left-to-right on the command line and are interpreted in terms of the most recently specified argument group.

Command format:

dtscli [-tos parameters]

[-sos parameters]
[-transfer parameters]
[-job parameters]
[-schedule parameters]
[-mode mode]
[-log parameters]
[-c comments-string]
[@filename]

dtscli [-agent parameters]

[-log parameters]
[-c comments-string]
[@filename]

dtscli -help [group[argument]]
dtscli -version

Note: The -a|t convention in the examples throughout this guide denotes that the examples work either as managed transfer or as agent-to-agent transfer. Do not use -a|t literally; use -a (or-agent) and -t (or -transfer) appropriately.

-mode

(Optional) Specifies the object lifetime mode, controlling whether transfers created by the DTSCLI are activated after creation and, if so, whether they are deleted after the transfer completes.

Note: The -mode operand can be abbreviated as -m.

Valid values are as follows:

defer

Creates the transfer job but does not perform the transfer, allowing the transfer job to be attached to a schedule for deferred processing.

Example: The following example creates an agent-to-agent transfer with an object lifetime mode of defer. Defer mode creates the transfer and transfer job, but does not activate them, allowing the transfer job to be attached to a schedule for activation later.

dtscli -tos host=SomewhereElse user=Administrator::password
	-t "ipath=branch2002::c:\daily_receipts\aug1000.xls"
	"rpath=hq050::c:\daily_receipts\aug1000.xls"
	-m defer

delete

Performs the transfer job and deletes the dynamically created transfers and transfer jobs after they either complete successfully or fail.

deleteonsuccess

Performs the transfer job and deletes the dynamically created transfers and transfer jobs only if they complete successfully.

keep

Performs the transfer job and keeps the dynamically created transfer objects, so that the transfer job can be reactivated. Use this option when you want to use the dynamically created transfer job or to copy it to create a new transfer job.

Example: The following example creates a managed transfer with an object lifetime mode of keep. You scan specify keep mode when you want to reuse a transfer job, for example, for a file that is updated daily and sent to headquarters each evening for processing.

dtscli -tos host=SomewhereElse user=Administrator::password

	-t "ipath=branch2002::c:\daily_receipts\aug1000.xls"
	rpath=hq050::c:\daily_receipts\aug1000.xls"
	-m keep

Default: delete

-c

(Optional) Specifies a comment string.

Default: None

@filename

(Optional) Specifies the full path name of the command file to be read and used as input. You can specify both the file name and more operands (such as -a, -mode, and so n) in the same dtscli command.

Default: None

Example: The following example executes the command lines specified in the dist_sales_rpt.txt file as input for an agent-to-agent transfer:

dtscli -a @dist_sales_rpt.txt

-help

Provides hierarchical help for each dtscli command parameter and its options.

Note: The -help operand can be abbreviated as -h.

Examples:

View top-level help:
```
dtscli -h
```
View a list of the transfer parameters:
```
dtscli -h transfer
```
View help for the transfer parameter named delivery:
```
dtscli -h transfer delivery
```

-version

Displays version information for the dtscli command-line interface.

Note: The -version operand can be abbreviated as -v.

Example:

dtscli -v