Scp Perl Reference Documentation

CkScp

Current Version: 10.1.2

Requires Chilkat Bundle License

An API for SCP over SSH. (SCP is the Secure Copy Protocol.) It is for transferring files or directory trees to or from remote servers. SCP is a simpler protocol than SFTP, and thus the functionality is more limited. However, SCP does not require that an SSH server support the SFTP subsystem. In cases where a server does not allow for SFTP, then SCP is a good choice for file transfer.

Object Creation

$obj = chilkat::CkScp->new();

Properties

AbortCurrent

# $boolVal is a boolean
$boolVal = $scp->get_AbortCurrent();
$scp->put_AbortCurrent($boolVal);

Introduced in version 9.5.0.58

When set to 1, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$scp->get_DebugLogFilePath($ckStr);
$strVal = $scp->debugLogFilePath();
$scp->put_DebugLogFilePath($strVal);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorHtml($ckStr);
$strVal = $scp->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorText($ckStr);
$strVal = $scp->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$scp->get_LastErrorXml($ckStr);
$strVal = $scp->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $scp->get_LastMethodSuccess();
$scp->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

SendEnv

# $strVal is a string
# $ckStr is a CkString
$scp->get_SendEnv($ckStr);
$strVal = $scp->sendEnv();
$scp->put_SendEnv($strVal);

Introduced in version 9.5.0.79

A JSON string specifying environment variables that are to be set for each SCP upload or download. For example:

{
    "LCS_PASSWORD": "myPassword",
    "SOME_ENV_VAR": "some_value",
...
}

More Information and Examples

Setting Environment Variables for SCP Transfers

SyncedFiles

# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncedFiles($ckStr);
$strVal = $scp->syncedFiles();
$scp->put_SyncedFiles($strVal);

Introduced in version 9.5.0.51

The paths of the files uploaded or downloaded in the last call to SyncUploadTree or SyncDownloadTree. The paths are listed one per line. In both cases (for upload and download) each line contains the full local file path (not the remote path).

More Information and Examples

SCP Sync Tree Download SCP Sync Tree Upload

SyncMustMatch

# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustMatch($ckStr);
$strVal = $scp->syncMustMatch();
$scp->put_SyncMustMatch($strVal);

Introduced in version 9.5.0.51

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will only transfer files having a filename that matches any one of these patterns.

More Information and Examples

SCP Sync Tree Download SCP Sync Tree Upload SCP Download Files Matching a Pattern, such as *.txt

SyncMustMatchDir

# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustMatchDir($ckStr);
$strVal = $scp->syncMustMatchDir();
$scp->put_SyncMustMatchDir($strVal);

Introduced in version 9.5.0.58

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will only traverse into a directory that matches any one of these patterns.

SyncMustNotMatch

# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustNotMatch($ckStr);
$strVal = $scp->syncMustNotMatch();
$scp->put_SyncMustNotMatch($strVal);

Introduced in version 9.5.0.51

Can contain a wildcarded list of filename patterns separated by semicolons. For example, "*.xml; *.txt; *.csv". If set, the SyncTreeUpload and SyncTreeDownload methods will not transfer files having a filename that matches any one of these patterns.

More Information and Examples

SCP Sync Tree Download SCP Sync Tree Upload

SyncMustNotMatchDir

# $strVal is a string
# $ckStr is a CkString
$scp->get_SyncMustNotMatchDir($ckStr);
$strVal = $scp->syncMustNotMatchDir();
$scp->put_SyncMustNotMatchDir($strVal);

Introduced in version 9.5.0.58

Can contain a wildcarded list of directory name patterns separated by semicolons. For example, "a*; b*; c*". If set, the SyncTreeUpload and SyncTreeDownload methods will not traverse into a directory that matches any one of these patterns.

UncommonOptions

# $strVal is a string
# $ckStr is a CkString
$scp->get_UncommonOptions($ckStr);
$strVal = $scp->uncommonOptions();
$scp->put_UncommonOptions($strVal);

Introduced in version 9.5.0.77

This is a catch-all property to be used for uncommon needs. The default value is the empty string.

Can be set to a list of the following comma separated keywords:

FilenameOnly - Introduced in v9.5.0.77. Set this property to the keyword "FilenameOnly" if only the filename should be used in the "scp -t" command. (LANCOM routers using SCP seem to need it.)
ProtectFromVpn - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.

UnixPermOverride

# $strVal is a string
# $ckStr is a CkString
$scp->get_UnixPermOverride($ckStr);
$strVal = $scp->unixPermOverride();
$scp->put_UnixPermOverride($strVal);

Introduced in version 9.5.0.77

When Chilkat uploads a file by SCP, the UNIX permissions of the remote file are set based on the permissions of the local file being uploaded. Usually this is OK, but in some cases the access permissions of the local file are not what is wanted for the remote file. This property can be set to an octal permissions string, such as "0644", to force the remote file permissions to this value.

The default value of this property is the empty string (remote files permissions mirror the permissions of the local file being uploaded).

Utf8

# $boolVal is a boolean
$boolVal = $scp->get_Utf8();
$scp->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging

# $boolVal is a boolean
$boolVal = $scp->get_VerboseLogging();
$scp->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

# $strVal is a string
# $ckStr is a CkString
$scp->get_Version($ckStr);
$strVal = $scp->version();

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

DownloadBd

# $remotePath is a string
# $bd is a CkBinData
$status = $scp->DownloadBd($remotePath, $bd);

Introduced in version 9.5.0.77

Downloads a binary file from the SSH server and appends to the contents of bd.

Returns 1 for success, 0 for failure.

DownloadBdAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $bd is a CkBinData
$ret_task = $scp->DownloadBdAsync($remotePath, $bd);

Introduced in version 9.5.0.77

Creates an asynchronous task to call the DownloadBd method with the arguments provided.

Returns null on failure

DownloadBinary

# $remotePath is a string
# $outBytes is a CkByteData (output)
$status = $scp->DownloadBinary($remotePath, $outData);

Introduced in version 9.5.0.51

Downloads a binary file from the SSH server and returns the contents.

Returns 1 for success, 0 for failure.

DownloadBinaryAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
$ret_task = $scp->DownloadBinaryAsync($remotePath);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadBinary method with the arguments provided.

Returns null on failure

DownloadBinaryEncoded

# $remotePath is a string
# $encoding is a string
# $outStr is a CkString (output)
$status = $scp->DownloadBinaryEncoded($remotePath, $encoding, $outStr);
$retStr = $scp->downloadBinaryEncoded($remotePath, $encoding);

Introduced in version 9.5.0.51

Downloads a file from the SSH server returns the contents in an encoded string (using an encoding such as base64).

Returns 1 for success, 0 for failure.

More Information and Examples

List of Supported Encodings (Base64, Hex, etc.)SCP Download/Upload Binary Files as Encoded Strings

DownloadBinaryEncodedAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $encoding is a string
$ret_task = $scp->DownloadBinaryEncodedAsync($remotePath, $encoding);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadBinaryEncoded method with the arguments provided.

Returns null on failure

DownloadFile

# $remotePath is a string
# $localPath is a string
$status = $scp->DownloadFile($remotePath, $localPath);

Introduced in version 9.5.0.51

Downloads a file from the remote SSH server to the local filesystem.

Returns 1 for success, 0 for failure.

More Information and Examples

SCP Download File SCP Download from a Specific Directory

DownloadFileAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $localPath is a string
$ret_task = $scp->DownloadFileAsync($remotePath, $localPath);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadFile method with the arguments provided.

Returns null on failure

DownloadString

# $remotePath is a string
# $charset is a string
# $outStr is a CkString (output)
$status = $scp->DownloadString($remotePath, $charset, $outStr);
$retStr = $scp->downloadString($remotePath, $charset);

Introduced in version 9.5.0.51

Downloads a text file from the SSH server and returns the contents as a string.

Returns 1 for success, 0 for failure.

More Information and Examples

SCP Download Text File to String Variable

DownloadStringAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $charset is a string
$ret_task = $scp->DownloadStringAsync($remotePath, $charset);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the DownloadString method with the arguments provided.

Returns null on failure

LoadTaskCaller

# $task is a CkTask
$status = $scp->LoadTaskCaller($task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

SyncTreeDownload

# $remoteRoot is a string
# $localRoot is a string
# $mode is an integer
# $bRecurse is a boolean
$status = $scp->SyncTreeDownload($remoteRoot, $localRoot, $mode, $bRecurse);

Introduced in version 9.5.0.51

Downloads files from the SSH server to a local directory tree. Synchronization modes include:

mode=0: Download all files
mode=1: Download all files that do not exist on the local filesystem.
mode=2: Download newer or non-existant files.
mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
mode=5: Download only missing files or files with size differences.
mode=6: Same as mode 5, but also download newer files.

Returns 1 for success, 0 for failure.

More Information and Examples

SCP Sync Tree Download

SyncTreeDownloadAsync ⁽¹⁾

# returns a CkTask
# $remoteRoot is a string
# $localRoot is a string
# $mode is an integer
# $bRecurse is a boolean
$ret_task = $scp->SyncTreeDownloadAsync($remoteRoot, $localRoot, $mode, $bRecurse);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the SyncTreeDownload method with the arguments provided.

Returns null on failure

SyncTreeUpload

# $localBaseDir is a string
# $remoteBaseDir is a string
# $mode is an integer
# $bRecurse is a boolean
$status = $scp->SyncTreeUpload($localBaseDir, $remoteBaseDir, $mode, $bRecurse);

Introduced in version 9.5.0.51

Uploads a directory tree from the local filesystem to the SSH server. Synchronization modes include:

mode=0: Upload all files
mode=1: Upload all files that do not exist on the FTP server.
mode=2: Upload newer or non-existant files.
mode=3: Upload only newer files. If a file does not already exist on the FTP server, it is not uploaded.
mode=4: transfer missing files or files with size differences.
mode=5: same as mode 4, but also newer files.

Returns 1 for success, 0 for failure.

SyncTreeUploadAsync ⁽¹⁾

# returns a CkTask
# $localBaseDir is a string
# $remoteBaseDir is a string
# $mode is an integer
# $bRecurse is a boolean
$ret_task = $scp->SyncTreeUploadAsync($localBaseDir, $remoteBaseDir, $mode, $bRecurse);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the SyncTreeUpload method with the arguments provided.

Returns null on failure

UploadBd

# $remotePath is a string
# $bd is a CkBinData
$status = $scp->UploadBd($remotePath, $bd);

Introduced in version 9.5.0.77

Uploads the contents of bd to a file on the SSH server.

Returns 1 for success, 0 for failure.

UploadBdAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $bd is a CkBinData
$ret_task = $scp->UploadBdAsync($remotePath, $bd);

Introduced in version 9.5.0.77

Creates an asynchronous task to call the UploadBd method with the arguments provided.

Returns null on failure

UploadBinary

# $remotePath is a string
# $binData is a CkByteData
$status = $scp->UploadBinary($remotePath, $binData);

Introduced in version 9.5.0.51

Uploads binary data to a file on the SSH server.

Returns 1 for success, 0 for failure.

UploadBinaryAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $binData is a CkByteData
$ret_task = $scp->UploadBinaryAsync($remotePath, $binData);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadBinary method with the arguments provided.

Returns null on failure

UploadBinaryEncoded

# $remotePath is a string
# $encodedData is a string
# $encoding is a string
$status = $scp->UploadBinaryEncoded($remotePath, $encodedData, $encoding);

Introduced in version 9.5.0.51

Uploads the binary data to a file on the remote SSH server. The binary data is passed in encoded string representation (such as base64, or hex).

Returns 1 for success, 0 for failure.

More Information and Examples

List of Supported Encodings (Base64, Hex, etc.)SCP Download/Upload Binary Files as Encoded Strings

UploadBinaryEncodedAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $encodedData is a string
# $encoding is a string
$ret_task = $scp->UploadBinaryEncodedAsync($remotePath, $encodedData, $encoding);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadBinaryEncoded method with the arguments provided.

Returns null on failure

UploadFile

# $localPath is a string
# $remotePath is a string
$status = $scp->UploadFile($localPath, $remotePath);

Introduced in version 9.5.0.51

Uploads a file from the local filesystem to the remote SSH server.

Returns 1 for success, 0 for failure.

More Information and Examples

SCP Upload File SCP Upload to a Specific Remote Directory

UploadFileAsync ⁽¹⁾

# returns a CkTask
# $localPath is a string
# $remotePath is a string
$ret_task = $scp->UploadFileAsync($localPath, $remotePath);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadFile method with the arguments provided.

Returns null on failure

UploadString

# $remotePath is a string
# $textData is a string
# $charset is a string
$status = $scp->UploadString($remotePath, $textData, $charset);

Introduced in version 9.5.0.51

Uploads the contents of a string to a file on the remote SSH server.

Returns 1 for success, 0 for failure.

More Information and Examples

SCP Upload Contents of String to Remote File

UploadStringAsync ⁽¹⁾

# returns a CkTask
# $remotePath is a string
# $textData is a string
# $charset is a string
$ret_task = $scp->UploadStringAsync($remotePath, $textData, $charset);

Introduced in version 9.5.0.51

Creates an asynchronous task to call the UploadString method with the arguments provided.

Returns null on failure

UseSsh

# $sshConnection is a CkSsh
$status = $scp->UseSsh($sshConnection);

Introduced in version 9.5.0.51

Uses the SSH connection of sshConnection for the SCP transfers. All of the connection and socket related properties, proxy properites, timeout properties, session log, etc. set on the SSH object apply to the SCP methods (because internally it is the SSH object that is used to do the work of the file transfers).

Returns 1 for success, 0 for failure.