AutoIt

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. AutoIt

Local $bSuccess = False

; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oSsh = ObjCreate("Chilkat.Ssh")

; Hostname may be an IP address or hostname:
Local $sHostname = "www.some-ssh-server.com"
Local $iPort = 22

; Connect to an SSH server:
$bSuccess = $oSsh.Connect($sHostname,$iPort)
If ($bSuccess <> True) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; Wait a max of 5 seconds when reading responses..
$oSsh.IdleTimeoutMs = 5000

; Authenticate using login/password:
$bSuccess = $oSsh.AuthenticatePw("myLogin","myPassword")
If ($bSuccess <> True) Then
    ConsoleWrite($oSsh.LastErrorText & @CRLF)
    Exit
EndIf

; Once the SSH object is connected and authenticated, we use it
; in our SCP object.
$oScp = ObjCreate("Chilkat.Scp")

$bSuccess = $oScp.UseSsh($oSsh)
If ($bSuccess <> True) Then
    ConsoleWrite($oScp.LastErrorText & @CRLF)
    Exit
EndIf

; This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
Local $sRemotePath = "repository/xml/hamlet.xml"

; The byte representation of the remote text file (i.e. the charset) must be
; indicated to allow the receiving software to correctly interpret the incoming
; bytes as the correct chars.
; See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
Local $sCharset = "utf-8"

Local $sFileContents = $oScp.DownloadString($sRemotePath,$sCharset)
If ($oScp.LastMethodSuccess <> True) Then
    ConsoleWrite($oScp.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("Received file:" & @CRLF)
ConsoleWrite($sFileContents & @CRLF)

ConsoleWrite("SCP download string success." & @CRLF)

; Disconnect
$oSsh.Disconnect