This file describes ssh-utilities API reference.
Warning
Beware, we are still in developement phase so API can change without warning, although most part are final and there are not expected any major changes.
Note
We often use throughout the documentation notation same as python typing. module to mark variable types as it is richer and preserves more information. e.g. List[str] obviously means list of strings. More on the matter can be read in the typing module documentation.
Note
This module should be ideally platform agnostic, but only connections from Windows and Linux(Debian, Ubuntu) to Linux(Debian, Ubuntu) have been tested so any other combinations are officially unsupported but should work.
ssh_utilities.connection
api/abstract api/local api/remote api/multi
ssh_utilities.utils
ssh_utilities.exceptions
ssh_utilities.constants
ssh_utilities.typeshed