paramiko.client.SSHClient.invoke_shell

SSHClient.invoke_shell(term='vt100', width=80, height=24, width_pixels=0, height_pixels=0)

Start an interactive shell session on the SSH server. A new .Channel is opened and connected to a pseudo-terminal using the requested terminal type and size.

Parameters:

• term (str) – the terminal type to emulate (for example, "vt100")
• width (int) – the width (in characters) of the terminal window
• height (int) – the height (in characters) of the terminal window
• width_pixels (int) – the width (in pixels) of the terminal window
• height_pixels (int) – the height (in pixels) of the terminal window

Returns:

a new .Channel connected to the remote shell

Raises SSHException:  

if the server fails to invoke a shell