blob: 86b4cf0caa64029bae3ce9fffac3cdb652bc6539 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
pxssh - control an SSH session
==============================
.. note::
*pxssh* is a screen-scraping wrapper around the SSH command on your system.
In many cases, you should consider using
`Paramiko <https://github.com/paramiko/paramiko>`_ or
`RedExpect <https://github.com/Red-M/RedExpect>`_ instead.
Paramiko is a Python module which speaks the SSH protocol directly, so it
doesn't have the extra complexity of running a local subprocess.
RedExpect is very similar to pxssh except that it reads and writes directly
into an SSH session all done via python with all the SSH protocol in C,
additionally it is written for communicating to SSH servers that are not just
Linux machines. Meaning that it is extremely fast in comparison to Paramiko
and already has the familiar expect API. In most cases RedExpect and pxssh
code should be fairly interchangable.
.. automodule:: pexpect.pxssh
.. autoclass:: ExceptionPxssh
pxssh class
-----------
.. autoclass:: pxssh
.. automethod:: __init__
.. attribute:: PROMPT
The regex pattern to search for to find the prompt. If you call :meth:`login`
with ``auto_prompt_reset=False``, you must set this attribute manually.
.. attribute:: force_password
If this is set to True, public key authentication is disabled, forcing the
server to ask for a password. Note that the sysadmin can disable password
logins, in which case this won't work.
.. attribute:: options
The dictionary of user specified SSH options, eg, ``options = dict(StrictHostKeyChecking="no", UserKnownHostsFile="/dev/null")``
.. automethod:: login
.. automethod:: logout
.. automethod:: prompt
.. automethod:: sync_original_prompt
.. automethod:: set_unique_prompt
|
