Connect to an SFTP Server

See more SFTP Examples

Demonstrates the Chilkat SFtp.Connect method, which establishes the SSH connection to an SFTP server. The first argument is the hostname (a DNS name or numeric IPv4/IPv6 address) and the second is the TCP port, usually 22. Connecting is the first of three setup steps.

integer li_rc
integer li_Success
oleobject loo_Sftp
integer li_Port
string ls_Password

li_Success = 0

//  Demonstrates the SFtp.Connect method, which establishes the SSH connection to an SFTP server.
//  The 1st argument is the hostname (a DNS name or numeric IP) and the 2nd is the TCP port.
//  
//  Connecting is only the first of three steps.  The full sequence is:
//    1. Connect
//    2. AuthenticatePw (or another authentication method)
//    3. InitializeSftp

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Step 1: Connect the SSH transport.  Port 22 is the usual port.
li_Port = 22
li_Success = loo_Sftp.Connect("sftp.example.com",li_Port)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
ls_Password = "mySshPassword"

li_Success = loo_Sftp.AuthenticatePw("mySshLogin",ls_Password)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

//  Step 3: Open the SFTP subsystem.  This must be done after authentication and before any
//  file or directory operations.
li_Success = loo_Sftp.InitializeSftp()
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    return
end if

Write-Debug "Connected, authenticated, and SFTP subsystem initialized."

loo_Sftp.Disconnect()


destroy loo_Sftp