SH Request.vi

SH Request.vi connector pane

Description

Request a new shell channel from the remote SSH server.

Inputs

LabSSH Session

Required

Yes

SSH session refnum.

PTY Emulation

Required

No

Default

vanilla

Determines which terminal emulation to request when allocating the pseudo-terminal (PTY).

New in version 2.5.

Warning

Not all values make sense for your host, and this may be ignored without an error. Consult your server’s available terminal emulation settings to choose a correct value.

Note

Prior to v2.5, this value was hard-coded to vanilla. This is now the default value to preserve backward-compatibility.

Examples

• vt100

• xterm

• ansi

• dumb

error in

Required

No

Default

No Error

Incoming error from previous VI call. Is passed through to error out.

Warning

LabVIEW will not execute Call Library Function Node if there is an error present on the wire. Ensure that there is no error prior to calling this VI – unexpected behavior will occur.

Timeout msec

Required

No

Default

5000

Amount of time in milliseconds to wait for a response from remote host before a timeout error occurs.

Outputs

LabSSH Session Out

Duplicate SSH session refnum.

error out

Error (if any) resulting from this VI call.