Swift

Create a Symbolic Link on an SFTP Server

Demonstrates the Chilkat SFtp.SymLink method, which creates a symbolic link on the server. The first argument is the link target and the second is the new symbolic-link path.

Background: A symbolic link stores a path that points at another location, so it can span directories or filesystems and can even point at something that does not exist. A common use is a stable name like latest.log that is repointed at each day's file. Argument order is a frequent source of confusion — the target comes first, the new link path second — and note that how the target string is interpreted (relative to what) is up to the server's implementation.

Chilkat Swift Downloads

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = false

    //  Demonstrates the SFtp.SymLink method, which creates a symbolic link on the server.  The 1st
    //  argument is the link target and the 2nd is the new symbolic-link path.

    let sftp = CkoSFtp()!

    //  Connect, authenticate, and initialize the SFTP subsystem.
    var port: Int = 22
    success = sftp.connect(hostname: "sftp.example.com", port: port)
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    //  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.
    var password: String? = "mySshPassword"

    success = sftp.authenticatePw(login: "mySshLogin", password: password)
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    success = sftp.initializeSftp()
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    //  Create a symbolic link "subdir/latest.log" that points at "subdir/2026-07-23.log".  The
    //  server's SFTP implementation determines how the target path is interpreted.
    success = sftp.symLink(oldPath: "subdir/2026-07-23.log", newPath: "subdir/latest.log")
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    print("Symbolic link created.")

    sftp.disconnect()

}