(Excel) Setting Environment Variables for SCP Transfers

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim ssh As Chilkat.Ssh
Set ssh = Chilkat.NewSsh

' First connect to an SSH server.

success = ssh.Connect("example.com",22)
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' Wait a max of 5 seconds when reading responses..
ssh.IdleTimeoutMs = 5000

' Authenticate..
success = ssh.AuthenticatePw("myLogin","myPassword")
If (success <> True) Then
    Debug.Print ssh.LastErrorText
    Exit Sub
End If

' After the SSH object is connected and authenticated, we use it
' as the underlying transport in our SCP object.
Dim scp As Chilkat.Scp
Set scp = Chilkat.NewScp

success = scp.UseSsh(ssh)
If (success <> True) Then
    Debug.Print scp.LastErrorText
    Exit Sub
End If

' Specify the environment variables to be set in JSON as follows.
' This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
Dim jsonEnvVars As Chilkat.JsonObject
Set jsonEnvVars = Chilkat.NewJsonObject
jsonEnvVars.EmitCompact = False
success = jsonEnvVars.UpdateString("LCS_PASSWORD","secret")
success = jsonEnvVars.UpdateString("MY_TEST_NAME","abc")

strEnvVars = jsonEnvVars.Emit()

Debug.Print strEnvVars

' Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
' prior to doing the upload or download.
scp.SendEnv = strEnvVars

' Do the upload..

remotePath = "starfish.jpg"

localPath = "qa_data/jpg/starfish.jpg"
success = scp.UploadFile(localPath,remotePath)
If (success <> True) Then
    Debug.Print scp.LastErrorText
    Exit Sub
End If

Debug.Print "SCP upload file success."

' Disconnect
ssh.Disconnect