ExecuteCommandSession Class

In This Topic

Class that represents the session with the SSH server that will execute a command on the server.

Object Model

Syntax

Visual Basic
C#

'Declaration
 
Public Class ExecuteCommandSession 
   Inherits InteractiveSession
   Implements System.IDisposable

'Usage
 
Dim instance As ExecuteCommandSession

public class ExecuteCommandSession : InteractiveSession, System.IDisposable

Example

Execute and wait
Fire and forget
Capturing command output
Sending text to standard input

Inheritance Hierarchy

System.Object
Xceed.SSH.Client.InteractiveSession
Xceed.SSH.Client.ExecuteCommandSession

Public Constructors

	Name	Description
	ExecuteCommandSession Constructor	Overloaded.

Top

Public Fields

	Name	Description
	DefaultTimeout
	MaximumStreamBufferSize
	MinimumStreamBufferSize

Top

Protected Fields

	Name	Description
	ChannelClosedEvent	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ChannelInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	CommandInternal
	ConnectionProtocolInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ErrorDataReceivedEventInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ErrorReceivedDataInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ErrorStreamInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	InputStreamInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowAdjustmentThresholdInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowInitialSizeInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowTargetSizeInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	MaximumReceivePacketSizeInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	OutputDataReceivedEventInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	OutputReceivedDataInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	OutputStreamInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	PacketIOManagerInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	SSHClientInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	TraceWriterInternal	(Inherited from Xceed.SSH.Client.InteractiveSession)

Top

Public Properties

	Name	Description
	Channel	(Inherited from Xceed.SSH.Client.InteractiveSession)
	Command
	Connected	TODODOC (Inherited from Xceed.SSH.Client.InteractiveSession)
	ExitSignal	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ExitStatus	(Inherited from Xceed.SSH.Client.InteractiveSession)
	IgnoreErrorData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	IgnoreOutputData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowAdjustmentThreshold	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowInitialSize	(Inherited from Xceed.SSH.Client.InteractiveSession)
	LocalWindowTargetSize	(Inherited from Xceed.SSH.Client.InteractiveSession)
	MaximumReceivePacketSize	(Inherited from Xceed.SSH.Client.InteractiveSession)
	SessionCompletedWaitHandle	(Inherited from Xceed.SSH.Client.InteractiveSession)
	SSHClient	(Inherited from Xceed.SSH.Client.InteractiveSession)
	Timeout	TODODOC Gets or sets a value, in milliseconds, indicating after what period of time an SSH operation should timeout.
	TimeoutSeconds	TODODOC Gets or sets a value, in seconds, indicating after what period of time an SSH operation should timeout.
	TraceWriter	Gets or sets the System.IO.TextWriter which will trace the communications between the client-side and the FTP server. (Inherited from Xceed.SSH.Client.InteractiveSession)

Top

Public Methods

	Name	Description
	ComputeStreamBufferSize	Overloaded.
	Connect	Overloaded. Connects.
	ConnectChannel	(Inherited from Xceed.SSH.Client.InteractiveSession)
	Disconnect
	Dispose	Overloaded. (Inherited from Xceed.SSH.Client.InteractiveSession)
	ExecuteCommand	Overloaded.
	ExecuteCommandAsync	Overloaded.
	GetErrorStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	GetInputStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	GetOutputStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	PassEnvironmentVariable	Overloaded. (Inherited from Xceed.SSH.Client.InteractiveSession)
	ValidateConnection	(Inherited from Xceed.SSH.Client.InteractiveSession)
	WriteData	(Inherited from Xceed.SSH.Client.InteractiveSession)

Top

Protected Methods

	Name	Description
	CheckIfDisposed	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ClearReceivedData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ConnectService	Overridden.
	ConnectSession	(Inherited from Xceed.SSH.Client.InteractiveSession)
	CreateErrorStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	CreateInputStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	CreateOutputStream	(Inherited from Xceed.SSH.Client.InteractiveSession)
	DisconnectService	Overridden.
	DisconnectSession	TODODOC (Inherited from Xceed.SSH.Client.InteractiveSession)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Xceed.SSH.Client.InteractiveSession)
	IsServiceConnected	Overridden.
	ObtainData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ObtainErrorData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	ObtainOutputData	(Inherited from Xceed.SSH.Client.InteractiveSession)
	OnChannelClosed	Overridden.
	OnChannelDataPacketReceived	(Inherited from Xceed.SSH.Client.InteractiveSession)
	OnChannelExtendedDataPacketReceived	(Inherited from Xceed.SSH.Client.InteractiveSession)

Top

Public Events

	Name	Description
	CommandCompleted

Top

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Standard: netstandard2.0, netstandard2.1

.NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

ExecuteCommandSession Members
Xceed.SSH.Client Namespace

Overview

Remote Command Execution

Send Feedback

Business Suite

Ultimate Suite

Reference

Overview