dtscli -job Parameter Group—Manage Transfer Jobs

dtscli Command—Manage Data Transfers › dtscli -job Parameter Group—Manage Transfer Jobs

dtscli -job Parameter Group—Manage Transfer Jobs

(Optional) The -job parameter group creates, deletes, and invokes other methods on transfer job objects.

Note: In addition to the following operands, you may want to use the transfer (-t) skip logic operand cskip|fskip=. This operand is an optional transfer parameter that applies only to transfers in sequential transfer jobs. For each individual transfer in a sequential transfer job, skip logic allows you to skip the next n transfers or skip forward to another transfer when this transfer completes or fails.

Syntax format:

dtscli -job [id=object_id] ["description=description"] [label=label]

method=method "method_parameters=method_parameters" [sequential=y|n] [transfers=transfer_object_ids] [data1=userdata1] [data2=userdata2]

Note: The -job operand can be abbreviated as -j.

id=object_id

(Optional) Applies a transfer method, transfer job method, or schedule method appropriately to one, more, or all specified transfers, transfer jobs, or schedules.

Note: Required for existing transfer jobs only. Do not specify this operand when creating a transfer job (method=create).

Default: None

Examples:

Apply a method (see method=method) to a single transfer job:
```
dtscli -j method=method id=id
```
Specify multiple transfer jobs, use either the id= operand or the label=label operand. For the id= operand, if you specify two or more transfer job IDs when applying a method, enclose the entire id= expression in quotation marks:
```
dtscli -j method=method "id=120 130 140"
```

Add two transfers (123 and 124) to a transfer job (789):

dtscli -j id="789" method=add method_parameters="123 124"

Apply a method to all transfer jobs, specify id=all:
```
dtscli -j method=method id=all
```

"description=description"

(Optional) Specifies a description for the transfer job. If the description includes one or more spaces, enclose the entire expression in quotation marks.

Limits: 1–255 characters

Default: None

label=label

(Optional) Specifies the label for the transfer job you are creating. To assign a label, use the label=label operand and supply a non-numeric value, preferably a logical, simple name. You can specify a label only at object creation time, when you enter the dtscli command that creates the object.

Using a label provides an alias, an alternate means besides the object ID for identifying one or more objects. If desired, you can give two or more objects the same label, so that you can apply the same method to all of those objects in a single command, by specifying a single label value instead of multiple object ID values.

A label used in this way is a two-step process:

Create each object, using the label=label operand to specify the same label for each object. (As a result, each object has a unique object ID but the same label.)
To apply the desired method to all of the objects, specify id=label instead of the "id=id1 id2 id3..." expression.

Examples: Create three jobs whose label is "red":

dtscli -j label=red -t "ipath=ipath" "rpath=rpath" -mode defer

dtscli -j label=red -t "ipath=ipath" "rpath=rpath" -t "ipath=ipath" "rpath=rpath" -mode defer
dtscli -j label=red -t "ipath=ipath" "rpath=rpath" -t "ipath=ipath" "rpath=rpath" -mode defer

Activate all three:
```
dtscli -j id=red method=activate
```
Apply the same method to all transfer jobs that have a label:
```
dtscli -j method=method label=all
```

Note: Specifying the same label and applying the same method to a group of objects applies to transfers, transfer jobs, and schedules.

method=method

Specifies the method to be applied to the transfer job or the transfers within a specific transfer job. The transfer job methods are:

Note: When invoking any method other than create, the only valid operands are id= (mandatory), method= (mandatory), and, if the method takes parameters, method_parameters.

abort

Halts a progressing transfer job.

activate

Causes all of the transfers in a transfer job to be performed.

add

Adds the specified transfers to the transfer job, at the end of the list of transfers in the job. This method takes parameters; for details, see "method_parameters=method_parameters".

create

Creates a new transfer job.

delete

Deletes the specified transfer job.

insert

Adds the specified transfers to the transfer job, at the position you specify in the list of transfers in the job. This method takes parameters; for details, see "method_parameters=method_parameters".

remove

Deletes the specified transfer from the transfer job. This method takes parameters; for details, see "method_parameters=method_parameters".

reset

Resets all transfers in the transfer job. This action enables the application using Data Transport Service to reuse and, therefore, to reactivate predefined transfers.

resume

Restarts the transfers in the transfer job that were either interrupted by a suspend method or failed, but can be restarted.

suspend

Halts the specified transfers in the transfer job. However, the transfers are retained in a state under which they can be resumed later.

status

Reports the status, or transfer state, of one or more transfer jobs.

urgent

Applies to discreet and default transfer jobs only. Forces the specified discreet or default transfer to become an urgent transfer. This method overrides any and all transfer priority settings and DTS agent discreet_mode settings that specify discreet mode. Consequently, the transfer is sent and received as a normal transfer.

discreet

Applies to any transfer in the job that you specify. Forces a transfer to be sent and received as discreet transfer. This method overrides any and all transfer priority settings and DTS agent discreet_mode settings that specify normal mode or urgent mode.

The transfer is processed at the time, using the transfer rate for discreet transfers determined by Data Transport Service during the lifetime of the transfer. The lifetime of a discreet transfer is determined by the delivery and expiry transfer parameters.

default

Forces the transfer priority settings to be the default. As a result, the DTS agent discreet_mode settings for the computers in the transfer determine which mode (normal or discreet) is used for sending the transfer and which mode is used for receiving the transfer.

Note: The urgent, discreet, and default methods can be applied to active transfer jobs only. Therefore, enter the following commands to activate the transfer job and make it urgent, default, or discreet:

dtscli -j id=nnn method=activate

dtscli -j id=nnn method=urgent|discreet|default

"method_parameters=method_parameters"

Specifies the parameters for transfer job methods. The method_parameters= parameter applies only to add, insert, and, remove transfer job methods.

Separate parameter values with spaces and enclose the entire method_parameters expression in quotation marks, as shown in the examples.

add

Specifies a list of transfer object IDs to be added.

Example: Add transfers 123–126 into transfer job 220:

dtscli -j id=220 method=add "method_parameters=123 124 125 126"

remove

Specifies a list of transfer object IDs to be removed.

Example: This example removes transfers 123–126 from transfer job 220.

dtscli -j id=220 method=remove "method_parameters=123 124 125 126"

insert

Inserts new transfer jobs in an existing transfer job. Used with the position parameter, which must be the first method_parameter specified; the remaining method_parameters are the object IDs of the transfers to be inserted.

Keep in mind that the position of a transfer in a transfer job is not important unless the transfers are performed sequentially (see sequential=y|n). By default, the transfers in a transfer job are performed simultaneously, not sequentially.

Examples:

Insert transfers 123–126 into transfer job 388, starting at position 1 (in front of all previously existing transfers).
```
	dtscli -j id=388 method=insert "method_parameters=1 123 124 125 126" 
```
Insert transfers 123–126 into transfer job 388, starting at position 0. Position 0 means that these objects are appended to the list after all previously existing transfers.
```
	dtscli -j id=388 method=insert "method_parameters=0 123 124 125 126" 
```

position

Specifies the position of a transfer to be added to a list of transfers in a sequential transfer job. The position number specifies when the transfer is performed. For example, if you specify position=3 for a transfer to be added to a list of sequential transfers, the new transfer will be the third transfer performed when the transfer job is executed. Specify position=0 to add the transfer at the end of the list of transfers.

Note: The position parameter is specified as the first parameter in the method_parameters argument. This parameter applies only to the insert method.

As mentioned previously, the position of a transfer in a transfer job is not important unless the transfers are performed sequentially (see sequential=y|n). By default, the transfers in a transfer job are performed simultaneously, not sequentially.

status

Reports the status, or transfer state, of transfer jobs. To display the status of one or more transfer jobs, use the following format:

dtscli -j "id=id1 id2 id3 ..." method=status

The string "id=id1 id2 id3 ..." specifies the object ID of the transfer jobs whose status you want to display.

Examples:

Display only the transfer jobs that have a specific status:

	dtscli -j id="id1 id2 id3 ..." method=status method_parameters=transfer_state

Display all transfer job(s) whose status is COMPLETE:
```
	dtscli -j id=all method=status "method_parameters=COMPLETE" 
```
In the resulting output, only the jobs with status=COMPLETE are reported.

Note: The method_parameters=transfer_state expression is case-sensitive. Specify the transfer state completely in UPPERCASE.

Default: None

sequential=y|n

(Optional) Indicates whether all transfers in the transfer job should be activated and performed sequentially. Specify sequential=y if you want all transfers in the transfer job to be activated and performed sequentially (one after the other, in the order you specify). See "method_parameters=method_parameters".

Specify sequential=n if you want all transfers in the transfer job to be activated and performed simultaneously (at the same time).

Default: n

transfers=transfer_object_ids

(Optional) Specifies the list of transfers in a transfer job. When the transfer job is activated, each transfer activates and performs. The transfers must already be created and you must know the object ID of each transfer. Enclose the list of transfers in a space-separated list enclosed in quotation marks.

Note: Required only for the method=add, insert, or remove parameters.

Example: Create a simple transfer job containing transfers 110, 114, and 118:

dtscli -j transfers="110 114 118"

Note: The default transfer job method is create.

data1=user_data1

(Optional) Allows user-defined data to be associated with the transfer job.

Default: None

data2=user_data2

(Optional) Allows user-defined data to be associated with the transfer job.

Default: None

More information:

dtscli Command—Manage Transfer Jobs

dtscli Command—Use Skip Logic

Discreet Mode

Transfer States