summaryrefslogtreecommitdiff
path: root/doc/api/pxssh.rst
blob: c3388f0cdfeb38b71f056966450b59134d2ed8bb (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
pxssh - control an SSH session
==============================

.. automodule:: pexpect.pxssh

.. autoclass:: ExceptionPxssh

pxssh class
-----------

.. autoclass:: pxssh

   .. automethod:: __init__

   .. attribute:: auto_prompt_reset

      Set this to False to prevent :meth:`login` from setting a unique prompt
      which can easily be located.

   .. attribute:: PROMPT

      The regex pattern to search for to find the prompt. If
      :attr:`auto_prompt_reset` is False, you must set this attribute manually.

   .. automethod:: login
   .. automethod:: logout
   .. automethod:: prompt
   .. automethod:: sync_original_prompt
   .. automethod:: set_unique_prompt