Skip to content

ssh

ssh documentation

toolroom._stubs.ssh.Ssh

Bases: Tool[_R]

__call__

__call__(
    *args: str | PathLike[str],
    A: Flag = ...,
    B: Value = ...,
    C: Flag = ...,
    D: Value = ...,
    E: Value = ...,
    F: Value = ...,
    G: Flag = ...,
    I: Value = ...,
    J: Value = ...,
    K: Flag = ...,
    L: Value = ...,
    M: Flag = ...,
    N: Flag = ...,
    O: Value = ...,
    P: Value = ...,
    Q: Value = ...,
    R: Value = ...,
    S: Value = ...,
    T: Flag = ...,
    V: Flag = ...,
    W: Value = ...,
    X: Flag = ...,
    Y: Flag = ...,
    Z: Flag = ...,
    a: Flag = ...,
    b: Value = ...,
    c: Value = ...,
    e: Value = ...,
    f: Flag = ...,
    g: Flag = ...,
    i: Value = ...,
    k: Flag = ...,
    l: Value = ...,
    m: Value = ...,
    n: Flag = ...,
    o: Value = ...,
    p: Value = ...,
    q: Flag = ...,
    s: Flag = ...,
    t: Flag = ...,
    v: Flag = ...,
    w: Value = ...,
    x: Flag = ...,
    y: Flag = ...,
    **flags: Any,
) -> _R

OpenSSH remote login client

Parameters:

Name Type Description Default
A Flag

Enables forwarding of connections from an authentication agent such as ssh-agent(1).

...
B Value

Bind to the address of bind_interface before attempting to connect to the destination host. Added in 7.7p1.

...
C Flag

Requests compression of all data (including stdin, stdout, stderr, and data for forwarded X11, TCP and UNIX-domain connections).

...
D Value

Specifies a local "dynamic" application-level port forwarding. May be repeated: a list emits the flag once per item. Added in 3.0p1.

...
E Value

Append debug logs to log_file instead of standard error. Added in 6.3p1.

...
F Value

Specifies an alternative per-user configuration file. Added in 3.0p1.

...
G Flag

Causes ssh to print its configuration after evaluating Host and Match blocks and exit. Added in 6.8p1.

...
I Value

Specify the PKCS#11 shared library ssh should use to communicate with a PKCS#11 token providing keys for user authentication. Added in 3.0p1.

...
J Value

Connect to the target host by first making an ssh connection to the jump host described by destination and then establishing a TCP forwarding to the ultimate destination from there. May be repeated: a list emits the flag once per item. Added in 7.3p1.

...
K Flag

Enables GSSAPI-based authentication and forwarding (delegation) of GSSAPI credentials to the server. Added in 4.7p1.

...
L Value

Specifies that connections to the given TCP port or Unix socket on the local (client) host are to be forwarded to the given host and port, or Unix socket, on the remote side.

...
M Flag

Places the ssh client into "master" mode for connection sharing. Added in 3.9p1.

...
N Flag

Do not execute a remote command.

...
O Value

Control an active connection multiplexing master process. Added in 4.0p1.

...
P Value

Specify a tag name that may be used to select configuration in ssh_config(5). May be repeated: a list emits the flag once per item.

...
Q Value

Queries for the algorithms supported by one of the following features: cipher (supported symmetric ciphers), cipher-auth (supported symmetric ciphers that support authenticated encryption), help (supported query terms for use with the -Q flag), mac (supported message integrity codes), kex (key exchange algorithms), key (key types), key-ca-sign (valid CA signature algorithms for certificates), key-cert (certificate key types), key-plain (non-certificate key types), key-sig (all key types and signature algorithms), protocol-version (supported SSH protocol versions), and sig (supported signature algorithms). May be repeated: a list emits the flag once per item. Added in 6.3p1.

...
R Value

Specifies that connections to the given TCP port or Unix socket on the remote (server) host are to be forwarded to the local side.

...
S Value

Specifies the location of a control socket for connection sharing, or the string "none" to disable connection sharing. Added in 3.9p1.

...
T Flag

Disable pseudo-terminal allocation.

...
V Flag

Display the version number and exit. Added in 3.7p1.

...
W Value

Requests that standard input and output on the client be forwarded to host on port over the secure channel. Added in 5.4p1.

...
X Flag

Enables X11 forwarding.

...
Y Flag

Enables trusted X11 forwarding. Added in 3.8p1.

...
Z Flag

List the public keys that would be attempted for authentication to the specified destination in preferred order and exit. Added in 10.5p1.

...
a Flag

Disables forwarding of the authentication agent connection.

...
b Value

Use bind_address on the local machine as the source address of the connection. Added in 3.0p1.

...
c Value

Selects the cipher specification for encrypting the session.

...
e Value

Sets the escape character for sessions with a pty . Defaults to ~.

...
f Flag

Requests ssh to go to background just before command execution.

...
g Flag

Allows remote hosts to connect to local forwarded ports.

...
i Value

Selects a file from which the identity (private key) for public key authentication is read.

...
k Flag

Disables forwarding (delegation) of GSSAPI credentials to the server.

...
l Value

Specifies the user to log in as on the remote machine. May be repeated: a list emits the flag once per item.

...
m Value

A comma-separated list of MAC (message authentication code) algorithms, specified in order of preference.

...
n Flag

Redirects stdin from /dev/null (actually, prevents reading from stdin).

...
o Value

Can be used to give options in the format used in the configuration file. May be repeated: a list emits the flag once per item.

...
p Value

Port to connect to on the remote host. May be repeated: a list emits the flag once per item.

...
q Flag

Quiet mode.

...
s Flag

May be used to request invocation of a subsystem on the remote system.

...
t Flag

Force pseudo-terminal allocation.

...
v Flag

Verbose mode.

...
w Value

Requests tunnel device forwarding with the specified tun(4) devices between the client (local_tun) and the server (remote_tun). May be repeated: a list emits the flag once per item. Added in 4.3p1.

...
x Flag

Disables X11 forwarding.

...
y Flag

Send log information using the syslog(3) system module. Added in 5.2p1.

...