Session.ExecuteCommand Method

CommandExecutionResult with command output. See also Capturing results of operations.

With SFTP and SCP protocols, executes arbitrary remote shell command. With FTP protocol, executes a protocol command.

With SFTP protocol, that does not allow execution of arbitrary remote command, separate shell session will be automatically opened.

Not supported with WebDAV and S3 protocols.

The command must not require user input.

using System;
using WinSCP;
 
class Example
{
 public static int Main()
 {
 try
 {
 // Setup session options
 SessionOptions sessionOptions = new SessionOptions
 {
 Protocol = Protocol.Sftp,
 HostName = "example.com",
 UserName = "user",
 Password = "mypassword",
 SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..."
 };
 
 using (Session session = new Session ())
 {
 // Connect
 session.Open(sessionOptions);
 
 // Execute mysqldump on the server to dump all MySQL databases and
 // compress the results
 const string dbUsername = "USERNAME";
 const string dbPassword = "PASSWORD";
 const string tempFilePath = "/tmp/all_databases.gz";
 
 string dumpCommand =
 string.Format(
 "mysqldump --opt -u {0} --password={1} --all-databases | gzip > {2}",
 dbUsername, dbPassword, tempFilePath);
 session.ExecuteCommand(dumpCommand).Check();
 
 // Download the database dump
 session.GetFiles(tempFilePath, @"D:\dbbackup\").Check();
 }
 
 return 0;
 }
 catch (Exception e)
 {
 Console.WriteLine("Error: {0}", e);
 return 1;
 }
 }
}

Imports WinSCP
 
Friend Class Example
 
 Public Shared Function Main() As Integer
 
 Try 
 ' Setup session options
 Dim sessionOptions As New SessionOptions
 With sessionOptions 
 .Protocol = Protocol.Sftp
 .HostName = "example.com"
 .UserName = "user"
 .Password = "mypassword"
 .SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..."
 End With
 
 Using session As New Session
 ' Connect
 session.Open(sessionOptions)
 
 ' Execute mysqldump on the server to dump all MySQL databases and
 ' compress the results
 Const dbUsername As String = "USERNAME"
 Const dbPassword As String = "PASSWORD"
 Const tempFilePath As String = "/tmp/all_databases.gz"
 
 Dim dumpCommand As String =
 String.Format(
 "mysqldump --opt -u {0} --password={1} --all-databases | gzip > {2}",
 dbUsername, dbPassword, tempFilePath)
 session.ExecuteCommand(dumpCommand).Check()
 
 ' Download the database dump
 session.GetFiles(tempFilePath, "D:\dbbackup\").Check()
 End Using
 
 Return 0
 Catch e As Exception
 Console.WriteLine("Error: {0}", e)
 Return 1
 End Try
 
 End Function
 
End Class

Learn more about using WinSCP .NET assembly from PowerShell.

try
{
 # Load WinSCP .NET assembly
 Add-Type -Path "WinSCPnet.dll"
 
 # Setup session options
 $sessionOptions = New-Object WinSCP.SessionOptions -Property @{
 Protocol = [WinSCP.Protocol]::Sftp
 HostName = "example.com"
 UserName = "user"
 Password = "mypassword"
 SshHostKeyFingerprint = "ssh-rsa 2048 xxxxxxxxxxx..."
 }
 
 $session = New-Object WinSCP.Session
 
 try
 {
 # Connect
 $session.Open($sessionOptions)
 
 # Execute mysqldump on the server to dump all MySQL databases and compress the results
 $dbUsername = "USERNAME"
 $dbPassword = "PASSWORD"
 $tempFilePath = "/tmp/all_databases.gz"
 
 $dumpCommand =
 "mysqldump --opt -u $dbUsername --password=$dbPassword --all-databases | " +
 "gzip > $tempFilePath"
 $session.ExecuteCommand($dumpCommand).Check()
 
 # Download the database dump
 $session.GetFiles($tempFilePath, "D:\dbbackup\").Check()
 
 finally
 {
 # Disconnect, clean up
 $session.Dispose()
 }
 
 exit 0
}
catch
{
 Write-Host "Error: $($_.Exception.Message)"
 exit 1
}