STD.File.RemotePull( remoteURL, sourcelogicalname, destinationGroup , destinationlogicalname, [ ,timeout ] [ ,maxConnections ] [ ,allowoverwrite ] [ ,replicate ] [ ,asSuperfile ] [,forcePush ] [,transferBufferSize ] [,wrap ] [,compress ] [ ,noSplit ] [ ,expireDays])
dfuwuid := STD.File.RemotePull( remoteURL, sourcelogicalname, destinationGroup , destinationlogicalname, [ ,timeout ] [ ,maxConnections ] [ ,allowoverwrite ] [ ,replicate ] [ ,asSuperfile ] [,forcePush ] [,transferBufferSize ] [,wrap ] [,compress ] [ ,noSplit ] [ ,expireDays]);
| remoteURL | A null-terminated string containing the protocol, IP, port, and directory, or the DNS equivalent, of the remote ESP server program. This is usually the same IP and port as its ECL Watch, with "/FileSpray" appended. |
| sourcelogicalname | A null-terminated string containing the local logical name of the file. |
| destinationGroup | A null-terminated string containing the name of the destination cluster. |
| destinationlogicalname | A null-terminated string containing the logical name to give the file on the remote cluster (this must be completely specified, including the domain). |
| timeout | Optional. An integer value indicating the timeout setting. If omitted, the default is -1. If set to zero (0), execution control returns immediately to the ECL workunit without waiting for the DFU workunit to complete. |
| maxConnections | Optional. An integer specifying the maximum number of connections. If omitted, the default is -1, which indicates the system chooses a suitable default based on the size of the cluster. |
| allowoverwrite | Optional. A boolean TRUE or FALSE flag indicating whether to allow the new file to overwrite an existing file of the same name. If omitted, the default is FALSE. |
| replicate | Optional. A boolean TRUE or FALSE flag indicating whether to automatically replicate the new file. If omitted, the default is FALSE. |
| asSuperfile | Optional. A boolean TRUE or FALSE flag indicating whether to treat the file as a superfile. If omitted, the default is FALSE. If TRUE and the file to copy is a superfile, then the operation creates a superfile on the target, creating subfiles as needed while overwriting only those already existing subfiles whose content has changed. If FALSE and the file to copy is a superfile, then the operation consolidates all the superfile content into a single logical file on the target, not a superfile. |
| forcePush | Optional. A boolean TRUE or FALSE flag indicating whether to execute the copy process on the source nodes and push to the targets instead of executing on the targets and pulling from the source. If omitted, the default is FALSE. |
| transferBufferSize | Optional. An integer specifying the size in bytes of the transfer buffer. Sometimes using larger values can speed the process. If omitted, a default buffer size of 64K is used. |
| wrap | Optional. A boolean TRUE or FALSE flag indicating whether to automatically wrap the file parts when copying to smaller sized clusters. For example, copying from a 6-node cluster to a 3-node cluster, two file parts will end up on each node; the difference is whether node 1 gets parts 1 and 2 or parts 1 and 4. If omitted, the default is FALSE. |
| compress | Optional. A boolean TRUE or FALSE flag indicating whether to automatically LZW compress the new file. If omitted, the default is FALSE. |
| noSplit | Optional. A boolean TRUE or FALSE flag indicating to not split a file part to multiple target parts. Default is FALSE. |
| expireDays | Optional. Specifies the file is a temporary file to be automatically deleted after the specified number of days since the file was read. If omitted, the default is -1 (never expires). If set to 0, the file is automatically deleted when it reaches the threshold set in Sasha Server's expiryDefault setting. |
| dfuwuid | The definition name to receive the null-terminated string containing the DFU workunit ID (DFUWUID) generated for the job. |
| Return: | fRemotePull returns a null-terminated string containing the DFU workunit ID (DFUWUID). |
The RemotePull function executes on the remoteURL, copying the sourcelogicalname from the local environment that instantiated the operation to the remote environment's destinationGroup cluster, giving it the destinationlogicalname. This is very similar to using the STD.File.Copy function and specifying its espserverIPport parameter. Since the DFU workunit executes on the remote DFU server, the user name authentication must be the same on both systems, and the use must have rights to copy files on both systems.
Example:
STD.File.RemotePull('http://10.150.50.14:8010/FileSpray',
'~THOR::LOCAL::MyFile',
'RemoteThor',
'~REMOTETHOR::LOCAL::MyFile');