Delphi DLL

SSH Commands to a Cisco Switch

Demonstrates establishing an SSH session with a Cisco switch (or similar device) and sending commands in a device console session. Each command is sent, and its output is read up to the device's next prompt.

Note: QuickShell allocates a PTY, which is what a network device console expects. The device presents an interactive prompt, and each command's output is read up to the next prompt.

Background: Network devices differ from general-purpose servers in that they expose a menu- or prompt-driven console rather than a Unix shell, so exec requests are usually unavailable and driving the interactive console is the only option. That makes prompt matching the synchronization mechanism, and it is why a PTY is appropriate here despite the general advice to avoid one. Retrieving the received text between commands is essential: a prompt left in the buffer would make the next receive return immediately with the wrong output.

Chilkat Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
ssh: HCkSsh;
port: Integer;
password: PWideChar;
channelNum: Integer;
caseSensitive: Boolean;
cmdOutput: PWideChar;

begin
success := False;

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

//  Demonstrates establishing an SSH session with a Cisco switch (or similar device) and sending
//  commands in a device console session.
//  
//  Note: QuickShell allocates a PTY, which is what a network device console expects.  The device
//  presents an interactive prompt, and each command's output is read up to the next prompt.

ssh := CkSsh_Create();

port := 22;
success := CkSsh_Connect(ssh,'172.16.16.100',port);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    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 := CkSsh_AuthenticatePw(ssh,'mySshLogin',password);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Start a shell session.
channelNum := CkSsh_QuickShell(ssh);
if (channelNum < 0) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
//  which means no limit -- without it, this call waits forever if the received data never
//  contains a match.
CkSsh_putReadTimeoutMs(ssh,15000);

caseSensitive := True;

//  The switch presents a prompt ending in "#".  Reading up to it confirms the session is ready.
success := CkSsh_ChannelReceiveUntilMatch(ssh,channelNum,'#','utf-8',caseSensitive);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

//  Send a command and read its output up to the next prompt.
success := CkSsh_ChannelSendString(ssh,channelNum,'show clock' + #10,'utf-8');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

success := CkSsh_ChannelReceiveUntilMatch(ssh,channelNum,'#','utf-8',caseSensitive);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

//  Retrieving the text also clears the receive buffer, which matters: if the prompt were left
//  buffered, the next receive would match it immediately and return the wrong output.
cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

//  Additional commands follow the same send / read-to-prompt / retrieve pattern.
success := CkSsh_ChannelSendString(ssh,channelNum,'show version' + #10,'utf-8');
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

success := CkSsh_ChannelReceiveUntilMatch(ssh,channelNum,'#','utf-8',caseSensitive);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;

cmdOutput := CkSsh__getReceivedText(ssh,channelNum,'utf-8');
if (CkSsh_getLastMethodSuccess(ssh) = False) then
  begin
    Memo1.Lines.Add(CkSsh__lastErrorText(ssh));
    Exit;
  end;
Memo1.Lines.Add(cmdOutput);

CkSsh_Disconnect(ssh);

CkSsh_Dispose(ssh);