=======
Manage persistent pool of SSH channels accessible via RESTful API and command line utility

Install
-------
To install sshpool, simply:
$ pip install sshpool
This will add two executable scripts `sshpoold` and `sshpoolctl` inside your python environment bin folder.
sshpoold
--------
`sshpoold` manages SSH channels and allow communication via RESTful API
$ sshpoold -h
usage: sshpoold [-h] [--channel CHANNEL] [--host HOST] [--port PORT]
optional arguments:
-h, --help show this help message and exit
--channel CHANNEL alias://user:pass@host:port
--host HOST SSHPool interface (default: 127.0.0.1)
--port PORT SSHPool listening port (default: 8877)
Start `sshpoold` daemon:
$ sshpoold
[2013-07-16 22:12:46,291] * Running on http://127.0.0.1:8877/
Optionally, `sshpoold` daemon can also be started with one or more SSH channel DSN:
$ sshpoold --channel=localhost://localhost
[2013-07-16 22:14:31,325] connecting to localhost://abhinavsingh:None@localhost:22
[2013-07-16 22:14:31,331] * Running on http://127.0.0.1:8877/
[2013-07-16 22:14:31,815] connected to localhost://abhinavsingh:None@localhost:22
Channel DSN
-----------
[DSN](http://en.wikipedia.org/wiki/Data_source_name) string describes a connection to SSH server. Format `alias://user:pass@host:port`:
Attribute | Description
--- | ---
alias | *(required)* An alias to use with `sshpoolctl` and RESTful API's
user | Defaults to current system user
pass | If not provided `sshpoold` will attempt to use public keys for authentication
host | *(required)* IP Address or FQDN
port | Defaults to 22
REST API
--------
Resource | Method | Parameters | Response | Description
--- | --- | --- | --- | ---
/channels | GET | - | JSON dict | Retrieve meta info for all SSH channels
/channels/<alias> | GET | - | JSON dict | Retrieve meta info for a specific SSH channel
/channels | POST | DSN | "OK" | Start a new SSH channel
/channels/<alias> | POST | command | JSON dict | Execute arbitrary command over a SSH channel
/channels/<alias> | DELETE | - | "OK" | Terminate a SSH channel
Channel meta info dictionary consists of following attributes:
Attribute | Description
--- | ---
user | username used for SSH channel
pass | None or string
host | IP Address or FQDN
port | SSH server port used for connection
is_alive | boolean
start_time | epoch timestamp of when SSH channel was started
Command output dictionary consists of following attributes:
Attribute | Description
--- | ---
stdout | stdout stream
stderr | stderr stream
exit_code | exit code of executed command
exception | available if command execution failed internally
sshpoolctl
----------
`sshpoolctl` provides an interactive shell to communicate with `sshpoold` daemon
$ sshpoolctl -h
usage: sshpoolctl [-h] [--host HOST] [--port PORT]
optional arguments:
-h, --help show this help message and exit
--host HOST SSHPool interface (default: 127.0.0.1)
--port PORT SSHPool listening port (default: 8877)
Start sshpoolctl utility:
$ sshpoolctl
==> Press Ctrl-C to exit <==
sshpool> help
Documented commands (type help <topic>):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
exit help quit run start status stop
Run arbitrary shell commands:
sshpool> help run
run <alias> <cmd> Run arbitrary commands over a channel
sshpool> run localhost echo hello world
hello world
sshpool> run localhost pwd
/Users/abhinavsingh
Start a new SSH channel:
sshpool> help start
start <dsn> Add a new channel
sshpool> start local://localhost
OK
View status of all SSH channels:
sshpool> help status
status View status of started channels
sshpool> status
local abhinavsingh:None@localhost:22 running 53
localhost abhinavsingh:None@localhost:22 running 449
Stop a SSH channel:
sshpool> help stop
stop <alias> Stop an existing channel
sshpool> stop localhost
OK
sshpool> status
local abhinavsingh:None@localhost:22 running 154
Metadata
Release files for sshpool 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sshpool-0.1.2.tar.gz | 12.0 kB | Without provenance | Details for sshpool-0.1.2.tar.gz |
Release files / sshpool-0.1.2.tar.gz
| Download URL | sshpool-0.1.2.tar.gz |
|---|---|
| Size | 12.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
38e4d9696796ef8b7006ec91464f19107657915460c19cf9b404a8e874cba2fb
|
|
BLAKE2b-256 checksum How to use checksums |
2668c49c0f796dc44f66b2b4d6b526faafd1af16c5bfead4a939750e828bc237
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sshpool 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.