Ruby

Send an FTP SITE Command

Demonstrates the Chilkat Ftp2.Site method, which sends a server-specific SITE command. The only argument is the text following SITE, for example CHMOD 644 index.html.

Background: SITE is FTP's extension point for features outside the standard — each server defines its own subcommands. The best-known is SITE CHMOD on Unix servers to set file permissions, but others cover mainframe dataset attributes, quotas, and more. Because these are non-standard and often privileged, expect them to vary by server and to require appropriate rights.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ftp2.Site method, which sends a server-specific SITE command.  The only
#  argument is the text following "SITE".

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  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.
ftp.put_Password("myPassword")

#  Connect and log in (Connect performs both).
success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

#  SITE subcommands are defined by the server, not by the FTP standard, and may require special
#  permissions.  A common example is changing file permissions on a Unix FTP server.
success = ftp.Site("CHMOD 644 public_html/index.html")
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

print "SITE command accepted." + "\n";

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