(Optional) The -agent parameter group performs agent-to-agent transfers.
Syntax format:
dtscli -agent [broadcast_address=broadcast_address] [checkpoint=y|n] [commit=y|n]
[delimiter_conversion=y|n] [delivery=discreet_delivery_period] [direction=s|r] [expiry=discreet_expiry_period] ["f_filters=filters"] ["p_filters=filters"] [hop_hosts=hop_hosts] "ipath=host::path" [ipriority=urgent|default|discreet] [iuser=username::password] [multicast_address=multicast_address] [output_mode=a|c|r|s|w] [parcel_size=parcel_size] [protocol=protocol] [protocol_parameters=protocol_parameters] [retry_interval=session_retry_interval] [retry_limit=session_retry_limit] "rpath=host::path" [rpriority=urgent|default|discreet] [ruser=username::password] [throttle=throttle] [transfer_mode=transfer_mode]
Note: The -agent operand can be abbreviated as -a.
Important! DTS supports IPv4 broadcast and IPv4/IPv6 multicast addressing. The BCAST point-to-many protocol is only for use with IPv4 addresses. If you want to perform a broadcast-type transfer over an IPv6 network, use the MCAST protocol with the relevant IPv6 multicast address.
(Optional) Specifies an IPv4 broadcast (bcast) address. Valid only for broadcast transfers. When you specify this parameter, also specify transfer_mode=bcast and protocol=BCAST.
Note: The type of transfer performed depends on the transfer mode: A transfer mode of bcast or mcast implies a UDP broadcast or multicast transfer.
Note: For instructions for calculating broadcast and multicast addresses, see the Data Transport Service Administration Guide.
Default: None
Example: Send a broadcast to IP address 172.24.255.255, specifying a transfer mode of broadcast (bcast):
dtscli -a "ipath=steve::c:\steve\memo2.doc"
"rpath=katie::c:\katie\memo2.doc" broadcast_address=172.24.255.255 transfer_mode=bcast protocol=bcast
A broadcast requires only one send of the data to the broadcast address. The packets are broadcast to all computers on the subnet (172.24.0.0) identified by the broadcast address (172.24.255.255). If any are listening for the broadcast, they each receive the packet.
(Optional) Specifies whether the checkpoint restart feature, which is an error recovery mechanism used by Data Transport Service, is enabled. Valid values are y (yes) and n (no). When checkpoint restart is enabled, if a failure occurs during a transfer, Data Transport Service attempts to restart the transfer from the point of failure. When checkpoint restart is disabled, the transfer is restarted from the beginning if a failure occurs during a transfer.
Default: None
(Optional) Specifies whether the commit to disk feature is enabled. Valid values are y (yes) and n (no). If enabled, the DTS agent flushes its file output buffers to hard disk after every parcel of data has been received. If commit to disk is not specified (n), the DTS agent relies upon the operating system file I/O to flush buffers when necessary.
Default: None
(Optional) Specifies whether delimiter conversion is enabled. Valid values are y (yes) and n (no). Use delimiter conversion (y) only for instances when you specify the output file name in the same format as the input file name, even though the receiving computer is running on a different platform from the sending computer. In such cross-platform transfers, delimiter conversion helps to ensure that the output path name for the transferred data is correctly delimited for the receiving platform.
Delimiter conversion is intended for cross-platform transfers when the platforms involved use similar (but not exactly the same) delimiters and file naming conventions. The intended use most commonly includes one-to-many transfers between Windows and UNIX/Linux computers. Other kinds of cross-platform transfers are also supported.
If you specify the input and output path names for your transfer completely and accurately while creating or updating a transfer, do not use delimiter conversion. Use delimiter conversion only if you specify the output file name in the same format as the input file name in a cross-platform transfer.
Note: Use delimiter conversion with caution. It does not function as an error checking or validation mechanism for the file naming or delimiter conventions of the receiving platforms.
Default: None
Example: A fanout transfer to Windows and UNIX systems:
dtscli -a "ipath=c:\input.txt"
"rpath=unixserver1::c:\tmp\output.txt" "rpath=winserver1::c:\tmp\output.txt" delimiter_conversion=y iuser=administrator::adminpass ruser=root::rootpass transfer_mode=fanout
(Optional) Specifies the discreet delivery period in minutes. This option is applicable only if you specified a transfer priority of discreet for sending the transfer (using ipriority) or for receiving the transfer (using rpriority), or if you specified both. If you specify discreet mode for both sending and receiving the transfer, the same discreet delivery period applies to both.
The discreet delivery period specifies the amount of time during which the initiating or responding DTS agent tries to send or receive the transfer in discreet mode. If the discreet send or discreet receive is not completed within this period, the transfer priority automatically changes from discreet to urgent. (The transfer priority settings are explained in the ipriority and rpriority operand descriptions.)
The time begins to be counted when the transfer is activated (not created).
The discreet delivery period (delivery) is normally used with the discreet expiry period (expiry). The discreet delivery period must be less than or equal to the discreet expiry period. If you specify one of these options (delivery or expiry) but not the other, the default value is used for the missing option.
Default: -1 (unlimited)
Example: To specify a discreet transfer with a discreet delivery period of 360 minutes (6 hours) and a discreet expiry period (expiry) of 720 minutes (12 hours), enter:
dtscli -a|t "ipath=ukwin4q::c:\winnt\tngdts.ini"
"rpath=philauk::c:\config\ukwinp4q\tngdts.ini" ipriority=discreet rpriority=discreet delivery=360 expiry=720
(Optional) Specifies whether the initiating computer in the transfer will receive or send data. Valid values are as follows:
Sends data from the initiator to the responder.
Sends data from the responder to the initiator.
Note: When using the direction=r option, remember that the source file is on the responding computer, while the destination file is on the initiating computer. (Typically, the opposite is true.)
Default: s
Example: In the following managed transfer example, the initiating computer (NYC_HQ) receives data from the responder (STORE888):
dtscli -a|t "ipath=NYC_HQ::c:\receipts\store888\010398.rcp" "rpath=STORE888::PDEV.RRARI09.RECEIPTS" direction=r
(Optional) Specifies the discreet expiry period in minutes. This option is applicable only if you specified a transfer priority of discreet for sending the transfer (using ipriority) or for receiving the transfer (using rpriority), or if you specified both. If you specify discreet mode for both sending and receiving the transfer, the same discreet expiry period applies to both.
If the transfer expires, it is deleted, and no further attempts to send it occur. The expiry period (expiry) must be greater than or equal to the discreet delivery period (delivery). If you specify one of these options (expiry or delivery) but not the other, the default value is used for the missing option.
The time begins to be counted when the transfer is activated (not created).
Default: -1 (unlimited)
Example: This example specifies a discreet transfer with a discreet delivery period (delivery) of 180 minutes (3 hours) and a discreet expiry period of 360 minutes (6 hours):
dtscli -a|t "ipath=ukwin4q::c:\winnt\tngdts.ini"
"rpath=philauk::c:\config\ukwinp4q\tngdts.ini"
ipriority=discreet rpriority=discreet delivery=180 expiry=360
(Optional) Specifies the type of filter for a transfer. File filters (f_filters) process the data being transferred one file at a time. Parcel filters (p_filters) process the data being transferred one parcel at a time. (A parcel is a smaller unit of data within the file.)
Typically, you specify filter parameters for agent-to-agent transfers only, not for managed transfers. The only exception is any encryption filter. For all other filters that require parameters, managed transfers automatically take the values supplied by the Transfer Object Server.
To specify file filters, use the following format:
dtscli -a|t "ipath=ipath" "rpath=rpath" ...
"f_filters=file_filters"
To specify parcel filters, use the following format:
dtscli -a|t "ipath=ipath" "rpath=rpath" ...
"p_filters=parcel_filters"
You can specify a single read or write filter or a matching pair of read and write filters. Enclose the entire "f_filters=file_filters" or "p_filters=parcel_filters" expression in quotation marks. Separate multiple filters with a space.
Each type of filter specification requires a colon (:) in the position as shown here:
"f|p_filters=read_filter_name[(read_filter_params)] :write_filter_name[(write_filter_params)]"
"f|p_filters=read_filter_name[(read_filter_params)]:"
"f|p_filters=:write_filter_name[(write_filter_params)]"
Filters are applied in the following order:
Read filters of the same type (file or parcel) are applied in the same order that they are specified on the command line. Write filters of the same type are applied in the reverse order that they are specified on the command line.
Default: Binary read and binary write filters
Example: The following command applies the specified filters in the following order:
dtscli -a "ipath=ukwigp3n::c:\temp\getstart.pdf"
"rpath=ukwigp3n::c:\temp\getstart2.pdf" "p_filters=BINARY_READ:BINARY_WRITE HUFFMAN_COMPRESS:HUFFMAN_UNCOMPRESS"
In this example, none of the filters have parameters.
Note: Each transfer must have either the text filters or the binary filters attached. If you specify any filters, the binary filters are not applied by default; therefore, you must specify either the text or binary filters explicitly in the same command.
(Optional) Performs a hop through the host computers for all output files. You would specify a hop, for example, if the target receiving computer or computers (end nodes) were not directly accessible to the initiator but were accessible through the hop computer.
If you must specify one or more additional hop computers, enter each computer name. Separate computer names with a space. Make sure each hop computer has enough disk space to accommodate the transfer; otherwise, the transfer fails.
When executed, the transfer travels through the hop computers in the order you specify them on the command line. You can specify a maximum of 100 output files for a single transfer, and a maximum of 25 hop computers per transfer.
Note: If you specify a hop to a different platform (other than the one the initiator is running), and the transfer protocol you specify is not supported by the platform on which the hop computer is running, the transfer fails. For information about the protocols supported on all platforms, see protocol=.
Example: Specify a transfer_mode of point-to-point (p2p) and specify a hop through the computer 172.24.213.47 for two output files:
dtscli -a "ipath=ddilgp78::c:\simpex.txt" hop_hosts=172.24.213.47
"rpath=GGilyphy::c:\qa\in\simpex.txt" "rpath=GGilyphx::c:\qa\in\simpex.txt" transfer_mode=p2p
Specifies the input file in the transfer enclosed in quotation marks. The host name is followed by two colons and the full path name of the transfer. For example:
"ipath=mmmww185::c:\receipts\010398.rcp"
"ipath=machj17::/home/receipts/010398.rcp"
"ipath=DTA_host_name::destination_path"
Note: The ipath= operand is required.
Specifies the computer's name, IP address, or IPX address. For IP addresses, use periods (.) as separators; for example, 172.24.255.255. For IPX addresses, use either periods or colons (:) as separators; for example 00000005.000000000001 or 00000005:000000000001.
A DTS agent acting as an initiator receives transfer requests from this command line utility, establishes a connection to a target responder or group of responders, and sends the data. The initiator is the computer that is initiating the transfer. If the host name is omitted, the local host is used by default.
Specifies the full path name of the input data.
Examples:
dtscli -a|t "ipath=canoes::C:\My Documents\Monthly Reports\apr2008.doc" "rpath=tipper::C:\Monthly Reports\David\apr2006.doc"
dtscli -a|t "ipath=CHICAGO12::/home/ptfiles/ptcr1000.txt" "rpath=NEWYORK20::/home/ptfiles/ptcr1000.txt"
dtscli -a|t "ipath=Miami::C:\outgoing\file.txt" "rpath=NEWYORK20::/home/incoming/file.txt"
Note: If running the dtscli command on UNIX/Linux, remember that the backslash character is the "escape" character. To specify a Windows path, the backslash characters must appear twice. For example:
dtscli -a|t "ipath=Miami::C:\\outgoing\\file.txt" "rpath=NEWYORK20::/home/incoming/file.txt"
(Optional) Specifies the transfer priority on the initiating computer in the transfer: urgent, default, or discreet, as described following. The transfer priority you specify here for the initiating computer works with the transfer priority setting for the responding computer (rpriority) and the agent DiscreetMode settings (normal or discreet) for the initiating and responding computers in the transfer. (The agent DiscreetMode setting is one of the Data Transport Agent parameters, which can also be set using the DSM Explorer.)
Note: For more information, see the Data Transport Agent Plugin Policy Group topic in the Configuration Policy section of the DSM Explorer Help.
Together, the following transfer priority settings and agent DiscreetMode settings determine which mode (normal or discreet) is used to send the transfer and which mode is used to receive the transfer.
Sends the transfer in normal mode, even if the agent DiscreetMode setting is Y (yes) on the initiating computer.
Sends the transfer in normal mode if the agent DiscreetMode setting is N (no) on the initiating computer. However, if the agent DiscreetMode setting is Y (yes) on the initiating computer, then the transfer is sent in discreet mode.
Sends the transfer in discreet mode, even if the agent DiscreetMode setting is N (no) on the initiating computer.
Discreet transfers are sent and received in the background, using minimal bandwidth, when the sending and receiving computers are not heavily loaded. Based on the load, the DTS agent determines when to send the transfer and calculates the optimal transfer rate, so that the discreet transfer has a minimal impact on the computer’s performance and the user’s productivity.
Default: default
Example: To send and receive (rpriority) a transfer in discreet mode, enter the following command using the default values for the discreet delivery period (delivery) and the discreet expiry period (expiry):
dtscli -a|t "ipath=ukwin4q::c:\winnt\tngdts.ini"
"rpath=philauk::c:\config\ukwinp4q\tngdts.ini" ipriority=discreet rpriority=discreet
(Optional) Specifies the user name and password for the initiating computer.
Note: This is a required parameter if the security mode is set to "fail" for the DTS agents involved in the transfer.
Default: None
Example: This example specifies the user name and password for both the initiating computer (ipath iuser) and the receiving computer (rpath ruser):
dtscli -a|t "ipath=NYC_HQ::c:\receipts\store888\010398.rcp" iuser=Frank::furter
"rpath=STORE888::PDEV.RRARI09.RECEIPTS" ruser=Molly::pitcher
(Optional) Specifies an IPv4 or IPv6 multicast (mcast) address. Valid multicast addresses for use with Data Transport Service fall in the range 224.0.1.0 to 238.255.255.255 (the "Global Scope Addresses"). Valid only for UDP multicast transfers. When you specify this parameter, also specify transfer_mode=mcast and protocol=MCAST.
Note: For instructions for calculating broadcast and multicast addresses, see the Data Transport Service Administration Guide.
Default: None
Examples:
dtscli -a "ipath=steve::c:\steve\memo2.doc" "rpath=katie::c:\katie\memo2.doc" multicast_address=224.1.2.3 transfer_mode=mcast protocol=mcast
dtscli -a "ipath=steve::c:\steve\memo2.doc" "rpath=katie::c:\katie\memo2.doc" multicast_address=FF15:0:1:1:1::45 transfer_mode=mcast protocol=mcast
(Optional) Specifies the output mode. Valid values are as follows:
Appends data to an existing file. If the file does not exist, the transfer fails.
Creates a new output file. If the file already exists, the transfer fails.
Replaces an existing file. If the file does not exist already, the transfer fails.
Creates a new output file. If the file already exists, data is added onto the existing file.
Creates a new output file. If the file already exists, it is replaced.
Default: w
(Optional) Specifies the maximum parcel size, in bytes, that can be sent by the initiating DTS agent in this transfer. The minimum parcel size is 128 bytes and, theoretically, the maximum parcel size is limited only by the amount of virtual memory available.
Default: 524,288 bytes
Example: This example sends a point-to-point transfer from a Windows computer named benjamin to one named joseph, using a maximum parcel size of 50,000 bytes:
dtscli -a "ipath=benjamin::c:\nhmh.c" parcel_size=50000
"rpath=joseph::c:\nhmh.c"
(Optional) Specifies the protocol for agent-to-agent transfers. Protocols require parameters under some circumstances. For details, see the protocol_parameters operand.
Valid values are as follows:
Specifies Transmission Control Protocol.
Specifies User Datagram Protocol.
Specifies Sequenced Packet Exchange.
Specifies Point to Point Protocol. Valid only for point-to-point transfers over standard telephone lines, ISDN, and other high-speed connections.
Specifies Hypertext Transfer Protocol. HTTP transfers (Internet downloads) require a specific syntax format.
Specifies broadcast. When using this protocol, you must also specify broadcast_address=broadcast_address and transfer_mode=bcast. (For use with IPv4 only.)
Specifies multicast. When using this protocol, you must also specify multicast_address=multicast_address and transfer_mode=mcast. (For use with IPv4 and IPv6.)
Default: TCP
Note: If desired, you can use the protocol= and protocol_parameters operands of the dtscli command to set the protocol and protocol parameters used for a specific transfer only. However, to set the default protocol and default protocol parameters for all transfers involving a specific computer, you must use either WorldView or the DSM Explorer to modify the computer’s protocol-related settings. For instructions for modifying these settings using WorldView, see the Data Transport Service WorldView Administration Client Help, and for instructions using the DSM Explorer, see the Configuration Policy section of the DSM Explorer Help.
(Optional) Specifies protocol-specific parameters. Typically, the following requirements and restrictions are applicable:
For further details, including which parameters are required, choose the desired protocol to view its parameters:
(Optional) Specifies the session retry interval, which is the number of seconds between retries if an attempt to connect to any computer involved in the transfer fails.
Default: 60
(Optional) Specifies the session retry limit, which is the number of retries that will be attempted if an attempt to connect to any computer involved in the transfer fails.
Default: 20
Specifies the output file in the transfer enclosed in quotation marks. The host name is followed by two colons and the full path name of the transfer. For example:
"rpath=mmmww188::c:\receipts\store888\010398.rcp"
"rpath=uxmnuu18::/home/receipts/store888/010398.rcp"
"rpath=http_host_name::http_source_file_path_name"
Note: The rpath= operand is required.
Specifies the computer's name, IP address, or IPX address. For IP addresses, use periods (.) as separators; for example, 172.24.255.255. For IPX addresses, use either periods or colons (:) as separators; for example 00000005.000000000001 or 00000005:000000000001.
A DTS agent acting as a responder listens for and responds to incoming connections. These incoming connections (incoming data transfers) are initiated by the DTS agent.
Specifies the full path name of the output data used by the responder DTS agent.
Note: When using the dtscli command to transfer data from UNIX/Linux to Windows, you must enter two backslashes to delimit each directory and path if the output path is not enclosed in quotation marks.
Examples:
dtscli -a|t "ipath=uxmnjj17::/home/receipts/010398.rcp" "rpath=mmmww188::c:\receipts\store888\010398.rcp"
dtscli -a|t ipath=iuxmnjj17::/home/receipts/010398.rcp rpath=mmmww188::c:\\receipts\\store888\\010398.rcp
Note: The requirement for double backslashes to delimit each directory and path applies only to the output path for transfers from UNIX/Linux to Windows.
(Optional) Specifies the transfer priority on the responding computer in the transfer: urgent, default, or discreet, as described following. The transfer priority you specify here works with the transfer priority setting for the initiating computer (ipriority) and the agent DiscreetMode settings (normal or discreet) for the initiating and responding computers in the transfer. (The agent DiscreetMode setting is one of the Data Transport Agent parameters, which can also be set using the DSM Explorer.)
Note: For more information, see the Data Transport Agent Plugin Policy Group topic in the Configuration Policy section of the DSM Explorer Help.
Together, the following transfer priority settings and agent DiscreetMode settings determine which mode (normal or discreet) is used to send the transfer and which mode is used to receive the transfer.
Receives the transfer in normal mode, even if the agent DiscreetMode setting is Y (for yes) on the responding computer.
Receives the transfer in normal mode if the agent DiscreetMode setting is N (for no) on the responding computer. However, if the agent DiscreetMode setting is Y on the responding computer, then the transfer is received in discreet mode.
Receives the transfer in discreet mode, even if the agent DiscreetMode setting is N on the responding computer.
Discreet transfers are sent and received in the background, using minimal bandwidth, when the sending and receiving computers are not heavily loaded. Based on the load, the DTS agent determines when to send the transfer and calculates the optimal transfer rate, so that the discreet transfer has a minimal impact on the computer’s performance and the user’s productivity.
Default: default
Example: To send (ipriority) and receive a transfer in discreet mode, enter the following command using the default values for the discreet delivery period (delivery) and the discreet expiry period (expiry):
dtscli -a|t "ipath=ukwin4q::c:\winnt\tngdts.ini"
"rpath=philauk::c:\config\ukwinp4q\tngdts.ini" ipriority=discreet rpriority=discreet
(Optional) Specifies the user name and password for the responding computer.
Note: This is a required parameter if the security mode is set to "fail" for the DTS agents involved in the transfer.
Default: None
Example: In the following example, the user specifies the user name and password for both the initiating computer (ipath) and the receiving computer (rpath):
dtacli -a|t "ipath=NYC_HQ::c:\receipts\store888\010398.rcp" iuser=polly::nomial \
"rpath=STORE888::PDEV.RRARI09.RECEIPTS" ruser=redbird::bdfeeder ... \
(Optional) Specifies the throttle factor, the amount of network bandwidth used when initiating data transfers from this computer.
Valid values are 0 (no throttling, that is, no forced delay between parcel sends) to 100. Each increment increases the delay interval between parcel send operations by 50 milliseconds. For example, if you specify 20, a 1-second delay occurs between parcel sends. If zero is specified, no forced delay occurs between parcel sends.
Default: 0
Example: To specify a throttle factor of one-half second, enter:
dtscli -a "ipath=temo33::c:\jpegs\cows.jpeg" protocol=spx
throttle=10 "rpath=kyto202::c:\jpegs\cows.jpeg"
(Optional) Specifies the transfer mode. A transfer mode of bcast or mcast implies a UDP broadcast or multicast transfer. Valid values are as follows:
Specifies point-to-point mode.
Specifies Point to Point Protocol (PPP) mode. Valid only for point-to-point transfers over standard telephone lines, ISDN, and other high-speed connections.
Specifies fanout mode.
Specifies broadcast mode. Valid only for IPv4 broadcast transfers. When using this transfer mode, also specify broadcast_address=broadcast_address and protocol=bcast.
Specifies multicast mode. Valid for IPv4 and IPv6 multicast transfers. When using this transfer mode, also specify multicast_address=multicast_address and protocol=mcast.
Default: p2p
Example: Send a fanout from a computer named LondonHQ to satellite computers named Local100 through Local110:
dtscli -a "ipath=LondonHQ::c:\mandates\memo5005.doc"
"rpath=Local100::c:\mandates\memo5005.doc" "rpath=Local101::c:\mandates\memo5005.doc" "rpath=Local102::c:\mandates\memo5005.doc" . . . "rpath=Local110::c:\mandates\memo5005.doc" transfer_mode=fanout
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|