Class ExecuteOptions

Namespace

Tmds.Ssh

Assembly

Tmds.Ssh.dll

Options for executing commands.

public sealed class ExecuteOptions

Inheritance

object

ExecuteOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AllocateTerminal

Gets or sets whether to allocate a pseudo-terminal.

public bool AllocateTerminal { get; set; }

Property Value

bool

Remarks

Defaults to false.

EnvironmentVariables

Gets or sets environment variables for the remote process.

public Dictionary<string, string> EnvironmentVariables { get; set; }

Property Value

Dictionary<string, string>

Remarks

Often SSH servers don't accept environment variables (for security).

When AllocateTerminal is set to true, 'TERM' is ignored when its value does not match TerminalType.

StandardErrorEncoding

Gets or sets the Encoding for standard error.

public Encoding StandardErrorEncoding { get; set; }

Property Value

Encoding

StandardInputEncoding

Gets or sets the Encoding for standard input.

public Encoding StandardInputEncoding { get; set; }

Property Value

Encoding

StandardOutputEncoding

Gets or sets the Encoding for standard output.

public Encoding StandardOutputEncoding { get; set; }

Property Value

Encoding

TerminalHeight

Gets or sets the terminal height in characters.

public int TerminalHeight { get; set; }

Property Value

int

Remarks

Defaults to 24.

TerminalSettings

Configure additional terminal settings.

public TerminalSettings TerminalSettings { get; }

Property Value

TerminalSettings

TerminalType

Gets or sets the terminal type.

public string TerminalType { get; set; }

Property Value

string

Remarks

Defaults to "xterm-256color".

TerminalWidth

Gets or sets the terminal width in characters.

public int TerminalWidth { get; set; }

Property Value

int

Remarks

Defaults to 80.