ssh-utilities
stable
Contents:
API reference
Connection usage
SSHPath usage
MultiConnection usage
Porting from ssh_utilities <=0.4.x to >0.5.x
ssh-utilities class inheritance diagrams
ssh-utilities UML classes graph
ssh-utilities
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
_
_2str (ssh_utilities.remote.path.SSHPath attribute)
_add_multi() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
_add_one() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
_CALLBACK (in module ssh_utilities.typeshed)
_CMD (in module ssh_utilities.typeshed)
_DIRECTION (in module ssh_utilities.typeshed)
_ENV (in module ssh_utilities.typeshed)
_EXCTYPE (in module ssh_utilities.typeshed)
_FILE (in module ssh_utilities.typeshed)
_flavour() (ssh_utilities.remote.path.SSHPath method)
_get_connection() (ssh_utilities.remote._connection_wrapper.check_connections static method)
_GLOBPAT (in module ssh_utilities.typeshed)
_negotiate() (ssh_utilities.remote._connection_wrapper.check_connections method)
_ONERROR (in module ssh_utilities.typeshed)
_parse_persistence_dict() (ssh_utilities.multi_connection._persistence.Pesistence static method)
_PATH (in module ssh_utilities.typeshed)
_path2str() (ssh_utilities.abstract._connection.ConnectionABC static method)
(ssh_utilities.abstract.ConnectionABC static method)
(ssh_utilities.local.LocalConnection method)
_SPATH (in module ssh_utilities.typeshed)
_to_str() (ssh_utilities.abstract._connection.ConnectionABC method)
(ssh_utilities.abstract.ConnectionABC method)
_WALK (in module ssh_utilities.typeshed)
A
absolute() (ssh_utilities.remote.path.SSHPath method)
add_hosts() (ssh_utilities.connection.Connection class method)
(ssh_utilities.multi_connection.MultiConnection class method)
B
Builtins (class in ssh_utilities.local)
(class in ssh_utilities.local._builtins)
(class in ssh_utilities.remote)
(class in ssh_utilities.remote._builtins)
builtins (ssh_utilities.local.LocalConnection attribute)
(ssh_utilities.multi_connection.MultiConnection attribute)
(ssh_utilities.remote.SSHConnection attribute)
BuiltinsABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._builtins)
bytes_2_human_readable() (in module ssh_utilities.utils)
C
C (in module ssh_utilities.constants)
CalledProcessError
chdir() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
check_connections (class in ssh_utilities.remote._connection_wrapper)
check_returncode() (ssh_utilities.utils.CompletedProcess method)
chmod() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
clear() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
close() (ssh_utilities.local.LocalConnection static method)
(ssh_utilities.remote.SSHConnection method)
CompletedProcess (class in ssh_utilities.utils)
config_parser() (in module ssh_utilities.utils)
CONFIG_PATH (in module ssh_utilities.constants)
Connection (class in ssh_utilities.connection)
connection (ssh_utilities.remote.path.SSHPath attribute)
ConnectionABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._connection)
ConnectionError
context_timeit() (in module ssh_utilities.utils)
copy() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.multi_connection._dict_interface.DictInterface method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
copy2() (ssh_utilities.remote._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
copyfile() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
copyfileobj() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil static method)
(ssh_utilities.local._shutil.Shutil static method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
cwd() (ssh_utilities.remote.path.SSHPath method)
D
DictInterface (class in ssh_utilities.multi_connection._dict_interface)
DirEntryABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._os)
download_tree() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
E
exists() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
expanduser() (ssh_utilities.remote.path.SSHPath method)
F
file_filter (class in ssh_utilities.utils)
for_all_methods() (in module ssh_utilities.utils)
from_dict() (ssh_utilities.connection.Connection class method)
(ssh_utilities.multi_connection._persistence.Pesistence class method)
from_str() (ssh_utilities.connection.Connection class method)
(ssh_utilities.multi_connection._persistence.Pesistence class method)
G
G (in module ssh_utilities.constants)
GET (in module ssh_utilities.constants)
get() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
get_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
get_available_hosts() (ssh_utilities.connection.Connection class method)
(ssh_utilities.multi_connection.MultiConnection class method)
getsize() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
group() (ssh_utilities.remote.path.SSHPath method)
H
home() (ssh_utilities.remote.path.SSHPath method)
I
ignore_patterns() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
Inner() (in module ssh_utilities.multi_connection._delegated)
inode() (ssh_utilities.abstract._os.DirEntryABC method)
(ssh_utilities.abstract.DirEntryABC method)
is_dir() (ssh_utilities.abstract._os.DirEntryABC method)
(ssh_utilities.abstract.DirEntryABC method)
is_file() (ssh_utilities.abstract._os.DirEntryABC method)
(ssh_utilities.abstract.DirEntryABC method)
is_symlink() (ssh_utilities.abstract._os.DirEntryABC method)
(ssh_utilities.abstract.DirEntryABC method)
isdir() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
isfile() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
islink() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
items() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
items_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
J
join() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
K
keys() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
keys_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
L
lchmod() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
LG (in module ssh_utilities.constants)
listdir() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
LocalConnection (class in ssh_utilities.local)
lprint (class in ssh_utilities.utils)
lstat() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
M
makedirs() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
mkdir() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
MultiConnection (class in ssh_utilities.multi_connection)
N
name (ssh_utilities.abstract._os.OsABC attribute)
(ssh_utilities.abstract.OsABC attribute)
(ssh_utilities.local.Os attribute)
(ssh_utilities.local._os.Os attribute)
(ssh_utilities.remote.Os attribute)
(ssh_utilities.remote._os.Os attribute)
NullContext (class in ssh_utilities.utils)
O
open() (ssh_utilities.abstract._builtins.BuiltinsABC method)
(ssh_utilities.abstract.BuiltinsABC method)
(ssh_utilities.connection.Connection static method)
(ssh_utilities.local.Builtins method)
(ssh_utilities.local._builtins.Builtins method)
(ssh_utilities.remote.Builtins method)
(ssh_utilities.remote._builtins.Builtins method)
(ssh_utilities.remote.path.SSHPath method)
Os (class in ssh_utilities.local)
(class in ssh_utilities.local._os)
(class in ssh_utilities.remote)
(class in ssh_utilities.remote._os)
os (ssh_utilities.local.LocalConnection attribute)
(ssh_utilities.multi_connection.MultiConnection attribute)
(ssh_utilities.remote.SSHConnection attribute)
OsABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._os)
OsPath (class in ssh_utilities.local)
(class in ssh_utilities.remote)
OsPathABC (class in ssh_utilities.abstract)
owner() (ssh_utilities.remote.path.SSHPath method)
P
Path() (ssh_utilities.abstract._pathlib.PathlibABC method)
(ssh_utilities.abstract.PathlibABC method)
(ssh_utilities.local.Pathlib method)
(ssh_utilities.local._pathlib.Pathlib method)
(ssh_utilities.remote.Pathlib method)
(ssh_utilities.remote._pathlib.Pathlib method)
Pathlib (class in ssh_utilities.local)
(class in ssh_utilities.local._pathlib)
(class in ssh_utilities.remote)
(class in ssh_utilities.remote._pathlib)
pathlib (ssh_utilities.local.LocalConnection attribute)
(ssh_utilities.multi_connection.MultiConnection attribute)
(ssh_utilities.remote.SSHConnection attribute)
PathlibABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._pathlib)
Pesistence (class in ssh_utilities.multi_connection._persistence)
pop() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
pop_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
popitem() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
popitem_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
ProgressBar() (in module ssh_utilities.utils)
PUT (in module ssh_utilities.constants)
R
R (in module ssh_utilities.constants)
readlink() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
realpath() (ssh_utilities.abstract.OsPathABC method)
(ssh_utilities.local.OsPath method)
(ssh_utilities.remote.OsPath method)
RED (in module ssh_utilities.constants)
remove() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
rename() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
replace() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
rmdir() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
rmtree() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
run() (ssh_utilities.abstract._subprocess.SubprocessABC method)
(ssh_utilities.abstract.SubprocessABC method)
(ssh_utilities.local.Subprocess method)
(ssh_utilities.remote.Subprocess method)
(ssh_utilities.remote._subprocess.Subprocess method)
S
samefile() (ssh_utilities.remote.path.SSHPath method)
scandir() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
sftp (ssh_utilities.remote.SSHConnection attribute)
SFTPOpenError
Shutil (class in ssh_utilities.local)
(class in ssh_utilities.local._shutil)
(class in ssh_utilities.remote)
(class in ssh_utilities.remote._shutil)
shutil (ssh_utilities.local.LocalConnection attribute)
(ssh_utilities.multi_connection.MultiConnection attribute)
(ssh_utilities.remote.SSHConnection attribute)
ShutilABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._shutil)
ssh_utilities.abstract (module)
ssh_utilities.abstract._builtins (module)
ssh_utilities.abstract._connection (module)
ssh_utilities.abstract._os (module)
ssh_utilities.abstract._pathlib (module)
ssh_utilities.abstract._shutil (module)
ssh_utilities.abstract._subprocess (module)
ssh_utilities.connection (module)
ssh_utilities.constants (module)
ssh_utilities.exceptions (module)
ssh_utilities.local (module)
ssh_utilities.local._builtins (module)
ssh_utilities.local._os (module)
ssh_utilities.local._pathlib (module)
ssh_utilities.local._shutil (module)
ssh_utilities.local._subprocess (module)
ssh_utilities.multi_connection (module)
ssh_utilities.multi_connection._delegated (module)
ssh_utilities.multi_connection._dict_interface (module)
ssh_utilities.multi_connection._persistence (module)
ssh_utilities.remote (module)
ssh_utilities.remote._builtins (module)
ssh_utilities.remote._connection_wrapper (module)
ssh_utilities.remote._os (module)
ssh_utilities.remote._pathlib (module)
ssh_utilities.remote._shutil (module)
ssh_utilities.remote._subprocess (module)
ssh_utilities.remote.path (module)
ssh_utilities.typeshed (module)
ssh_utilities.utils (module)
SSHConnection (class in ssh_utilities.remote)
SSHPath (class in ssh_utilities.remote.path)
stat() (ssh_utilities.abstract._os.DirEntryABC method)
(ssh_utilities.abstract.DirEntryABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
stdout (ssh_utilities.exceptions.CalledProcessError attribute)
Subprocess (class in ssh_utilities.local)
(class in ssh_utilities.remote)
(class in ssh_utilities.remote._subprocess)
subprocess (ssh_utilities.local.LocalConnection attribute)
(ssh_utilities.multi_connection.MultiConnection attribute)
(ssh_utilities.remote.SSHConnection attribute)
SubprocessABC (class in ssh_utilities.abstract)
(class in ssh_utilities.abstract._subprocess)
supports_dir_fd() (ssh_utilities.abstract._os.OsABC static method)
(ssh_utilities.abstract.OsABC static method)
(ssh_utilities.local.Os static method)
(ssh_utilities.local._os.Os static method)
(ssh_utilities.remote.Os static method)
(ssh_utilities.remote._os.Os static method)
supports_fd() (ssh_utilities.abstract._os.OsABC static method)
(ssh_utilities.abstract.OsABC static method)
(ssh_utilities.local.Os static method)
(ssh_utilities.local._os.Os static method)
(ssh_utilities.remote.Os static method)
(ssh_utilities.remote._os.Os static method)
symlink() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
T
TimeoutExpired
to_dict() (ssh_utilities.multi_connection._persistence.Pesistence method)
(ssh_utilities.multi_connection.MultiConnection method)
touch() (ssh_utilities.remote.path.SSHPath method)
U
unlink() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
update() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
upload_tree() (ssh_utilities.abstract._shutil.ShutilABC method)
(ssh_utilities.abstract.ShutilABC method)
(ssh_utilities.local.Shutil method)
(ssh_utilities.local._shutil.Shutil method)
(ssh_utilities.remote.Shutil method)
(ssh_utilities.remote._shutil.Shutil method)
V
values() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
values_all() (ssh_utilities.multi_connection._dict_interface.DictInterface method)
(ssh_utilities.multi_connection._persistence.Pesistence method)
W
walk() (ssh_utilities.abstract._os.OsABC method)
(ssh_utilities.abstract.OsABC method)
(ssh_utilities.local.Os method)
(ssh_utilities.local._os.Os method)
(ssh_utilities.remote.Os method)
(ssh_utilities.remote._os.Os method)
Y
Y (in module ssh_utilities.constants)
Read the Docs
v: stable
Versions
latest
stable
v0.15.1
v0.15.0
v0.14.0
v0.13.0
v0.11.0
v0.10.0
v0.9.0
v0.8.10
v0.8.9
v0.8.8
v0.8.7
v0.8.6
v0.8.5
v0.8.4
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.2
v0.7.1
v0.7.0
v0.6.1
v0.6.0
Downloads
On Read the Docs
Project Home
Builds