Chilkat2-Python

Get the Exit Status of a Remote SSH Command

Demonstrates the Chilkat Ssh.GetChannelExitStatus method, which returns the remote process exit status for a channel. The only argument is the channel number. Call it only after ChannelReceivedExitStatus returns true.

Background: The exit status is how you learn whether a remote command actually succeeded — recall that a successful exec request only means the request was accepted. By Unix convention 0 means success and any nonzero value indicates a failure. Retrieve it promptly after the receive operation and before calling unrelated SSH methods or releasing the channel, since the completed channel record can be discarded.

Chilkat Chilkat2-Python Downloads

Download Chilkat for Chilkat2-Python

Chilkat2-Python

import sys
import chilkat2

success = False

# Demonstrates the Ssh.GetChannelExitStatus method, which returns the remote process exit
# status for a channel.  The only argument is the channel number.  Call it only after
# ChannelReceivedExitStatus returns True.

ssh = chilkat2.Ssh()

sshPort = 22
success = ssh.Connect("ssh.example.com",sshPort)
if (success == False):
    print(ssh.LastErrorText)
    sys.exit()

# 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 = ssh.AuthenticatePw("mySshLogin",password)
if (success == False):
    print(ssh.LastErrorText)
    sys.exit()

channelNum = ssh.OpenSessionChannel()
if (channelNum < 0):
    print(ssh.LastErrorText)
    sys.exit()

success = ssh.SendReqExec(channelNum,"grep -q root /etc/passwd")
if (success == False):
    print(ssh.LastErrorText)
    sys.exit()

# IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
# it, this call waits forever if the server never sends channel close.
ssh.ReadTimeoutMs = 15000

success = ssh.ChannelReceiveToClose(channelNum)
if (success == False):
    print(ssh.LastErrorText)
    sys.exit()

# Retrieve the exit status immediately, before calling unrelated SSH methods or releasing the
# channel, because the completed channel record can be discarded.
if (ssh.ChannelReceivedExitStatus(channelNum)):
    exitStatus = ssh.GetChannelExitStatus(channelNum)
    print("Exit status: " + str(exitStatus))

    # By convention, 0 means the remote command succeeded.
    if (exitStatus == 0):
        print("The remote command succeeded.")
    else:
        print("The remote command reported a failure.")

ssh.Disconnect()