Ruby

Open a Remote Directory on an SFTP Server

Demonstrates the Chilkat SFtp.OpenDir method, which opens a remote directory and returns a handle for reading its entries. The only argument is the directory path. Close the handle with CloseHandle when finished.

Background: Listing a directory in SFTP is a handle-based operation, mirroring file access: open the directory to get a handle, read its entries, then close it. The handle is passed to ReadDirListing to retrieve the names and attributes. As with file handles, the directory handle is a server-side resource that should be closed to avoid exhausting the server's limits.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the SFtp.OpenDir method, which opens a remote directory and returns a handle for
#  reading its entries.  The only argument is the directory path.

sftp = Chilkat::CkSFtp.new()

#  Connect, authenticate, and initialize the SFTP subsystem.
port = 22
success = sftp.Connect("sftp.example.com",port)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

#  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.
password = "mySshPassword"

success = sftp.AuthenticatePw("mySshLogin",password)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

success = sftp.InitializeSftp()
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

#  Open the remote directory.  OpenDir returns a handle string.
handle = sftp.openDir("subdir")
if (sftp.get_LastMethodSuccess() == false)
    print sftp.lastErrorText() + "\n";
    exit
end

print "Opened directory, handle = " + handle + "\n";

#  The directory entries are read with ReadDirListing using this handle.

#  Close the handle when finished.
success = sftp.CloseHandle(handle)
if (success == false)
    print sftp.lastErrorText() + "\n";
    exit
end

sftp.Disconnect()