|
| def | get_banner (self) |
| |
| def | create_local_ssh_tunnel (self, local_port, remote_host, remote_port, bind_address) |
| |
| def | close (self) |
| | Closes the connection. More...
|
| |
| def | __init__ (self, host, alias=None, port=22, timeout=3, newline='LF', prompt=None, term_type='vt100', width=80, height=24, path_separator='/', encoding='utf8', escape_ansi=False, encoding_errors='strict') |
| |
| def | login (self, username=None, password=None, allow_agent=False, look_for_keys=False, delay=None, proxy_cmd=None, read_config=False, jumphost_connection=None, keep_alive_interval='0 seconds') |
| | Logs into the remote host using password authentication. More...
|
| |
| def | login_with_public_key (self, username, keyfile, password, allow_agent=False, look_for_keys=False, delay=None, proxy_cmd=None, jumphost_connection=None, read_config=False, keep_alive_interval='0 seconds') |
| | Logs into the remote host using the public key authentication. More...
|
| |
| def | execute_command (self, command, sudo=False, sudo_password=None, timeout=None, output_during_execution=False, output_if_timeout=False, invoke_subsystem=False, forward_agent=False) |
| | Executes the command on the remote host. More...
|
| |
| def | start_command (self, command, sudo=False, sudo_password=None, invoke_subsystem=False, forward_agent=False) |
| | Starts the execution of the command on the remote host. More...
|
| |
| def | read_command_output (self, timeout=None, output_during_execution=False, output_if_timeout=False) |
| | Reads the output of the previous started command. More...
|
| |
| def | write (self, text, add_newline=False) |
| | Writes text in the current shell. More...
|
| |
| def | read (self, delay=None) |
| | Reads all output available in the current shell. More...
|
| |
| def | read_char (self) |
| | Reads a single Unicode character from the current shell. More...
|
| |
| def | read_until (self, expected) |
| | Reads output from the current shell until the expected text is encountered or the timeout expires. More...
|
| |
| def | read_until_newline (self) |
| | Reads output from the current shell until a newline character is encountered or the timeout expires. More...
|
| |
| def | read_until_prompt (self, strip_prompt=False) |
| | Reads output from the current shell until the prompt is encountered or the timeout expires. More...
|
| |
| def | read_until_regexp (self, regexp) |
| | Reads output from the current shell until the regexp matches or the timeout expires. More...
|
| |
| def | read_until_regexp_with_prefix (self, regexp, prefix) |
| | Read and return from output until regexp matches prefix + output. More...
|
| |
| def | write_until_expected (self, text, expected, timeout, interval) |
| | Writes text repeatedly in the current shell until the expected appears in the output or the timeout expires. More...
|
| |
| def | put_file (self, source, destination='.', mode='0o744', newline='', scp='OFF', scp_preserve_times=False) |
| | Calls :py:meth:AbstractSFTPClient.put_file` with the given arguments. More...
|
| |
| def | put_directory (self, source, destination='.', mode='0o744', newline='', recursive=False, scp='OFF', scp_preserve_times=False) |
| | Calls :py:meth:AbstractSFTPClient.put_directory with the given arguments and the connection specific path separator. More...
|
| |
| def | get_file (self, source, destination='.', scp='OFF', scp_preserve_times=False) |
| | Calls :py:meth:AbstractSFTPClient.get_file with the given arguments. More...
|
| |
| def | get_directory (self, source, destination='.', recursive=False, scp='OFF', scp_preserve_times=False) |
| | Calls :py:meth:AbstractSFTPClient.get_directory with the given arguments and the connection specific path separator. More...
|
| |
| def | list_dir (self, path, pattern=None, absolute=False) |
| | Calls :py:meth:.AbstractSFTPClient.list_dir with the given arguments. More...
|
| |
| def | list_files_in_dir (self, path, pattern=None, absolute=False) |
| | Calls :py:meth:AbstractSFTPClient.list_files_in_dir with the given arguments. More...
|
| |
| def | list_dirs_in_dir (self, path, pattern=None, absolute=False) |
| | Calls :py:meth:AbstractSFTPClient.list_dirs_in_dir with the given arguments. More...
|
| |
| def | is_dir (self, path) |
| | Calls :py:meth:AbstractSFTPClient.is_dir with the given path. More...
|
| |
| def | is_file (self, path) |
| | Calls :py:meth:AbstractSFTPClient.is_file with the given path. More...
|
| |
|
| def | _get_client (self) |
| |
| def | _get_jumphost_tunnel (self, jumphost_connection) |
| |
| def | _login (self, username, password, allow_agent=False, look_for_keys=False, proxy_cmd=None, read_config=False, jumphost_connection=None, keep_alive_interval=None) |
| |
| def | _login_with_public_key (self, username, key_file, password, allow_agent, look_for_keys, proxy_cmd=None, jumphost_connection=None, read_config=False, keep_alive_interval=None) |
| |
| def | _start_command (self, command, sudo=False, sudo_password=None, invoke_subsystem=False, forward_agent=False) |
| |
| def | _create_sftp_client (self) |
| |
| def | _create_scp_transfer_client (self) |
| |
| def | _create_scp_all_client (self) |
| |
| def | _create_shell (self) |
| |
| def | _create_local_port_forwarder (self, local_port, remote_host, remote_port, bind_address) |
| |
Definition at line 68 of file pythonclient.py.