class documentation

A client side SSH implementation.

Method run_command Connect to an SSH server.
def run_command(self, host: str, command: bytes, username: str | None = None, port: int | None = None, password: str | None = None, key_filename: str | None = None, ssh_command: str | None = None, protocol_version: int | None = None) -> SubprocessWrapper: ΒΆ

Connect to an SSH server.

Run a command remotely and return a file-like object for interaction with the remote command.

Parameters
host:strHost name
command:bytesCommand to run (as argv array)
username:str | NoneOptional ame of user to log in as
port:int | NoneOptional SSH port to use
password:str | NoneOptional ssh password for login or private key
key_filename:str | NoneOptional path to private keyfile
ssh_command:str | NoneOptional SSH command
protocol_version:int | NoneDesired Git protocol version. By default the highest mutually supported protocol version will be used.
Returns
SubprocessWrapperUndocumented