Introduction

SSHLibrary is a Robot Framework test library for testing SSH and SFTP. It is operating system independent and works both with Python and Jython.

The library has the following main usages:

• Executing commands on the remote machine, either with blocking or non-blocking behavior.

• Writing and reading in an interactive shell.

• Transferring files and directories over SFTP.

• Ensuring that files and directories exist on the remote machine.

SSHLibrary is open source software licensed under Apache License 2.0.

Installation

When installing SSHLibrary on UNIX-like machines with Python, the easiest approach is using pip:

pip install robotframework-sshlibrary

Alternatively you can download the source distribution from PyPI, extract it, and install it using one of the following depending are you using Python or Jython:

python setup.py install
jython setup.py install

A benefit of using pip is that it automatically installs paramiko and PyCrypto modules that SSHLibrary requires on Python. Using pip on Windows with Python works too, but you need to first install PyCrypto module manually.

On Jython SSHLibrary requires Trilead SSH JAR distribution.

For more detailed installation instructions see INSTALL.rst.

Documentation

Keyword documentation by version can be found from http://robotframework.org/SSHLibrary/.

For general information about using test libraries with Robot Framework, see Robot Framework User Guide.