diff --git a/docs/SSHLibrary-3.8.0rc1.rst b/docs/SSHLibrary-3.8.0rc1.rst
new file mode 100644
index 000000000..3f9c8366d
--- /dev/null
+++ b/docs/SSHLibrary-3.8.0rc1.rst
@@ -0,0 +1,73 @@
+===================
+SSHLibrary 3.8.0rc1
+===================
+
+
+.. default-role:: code
+
+
+SSHLibrary_ is a `Robot Framework`_ test library for SSH and SFTP.
+SSHLibrary 3.8.0rc1 is a new release with several enhancements and bug fixes.
+All issues targeted for SSHLibrary v3.8.0 can be found from
+the `issue tracker`_.
+
+If you have pip_ installed, just run
+
+::
+
+   pip install --pre --upgrade robotframework-sshlibrary
+
+to install the latest release or use
+
+::
+
+   pip install robotframework-sshlibrary==3.8.0rc1
+
+to install exactly this version. Alternatively you can download the source
+distribution from PyPI_ and install it manually.
+
+SSHLibrary 3.8.0rc1 was released on Friday November 5, 2021.
+
+.. _Robot Framework: http://robotframework.org
+.. _SSHLibrary: https://github.com/robotframework/SSHLibrary
+.. _pip: http://pip-installer.org
+.. _PyPI: https://pypi.python.org/pypi/robotframework-sshlibrary
+.. _issue tracker: https://github.com/robotframework/SSHLibrary/issues?q=milestone%3Av3.8.0
+
+
+.. contents::
+   :depth: 2
+   :local:
+
+Full list of fixes and enhancements
+===================================
+
+.. list-table::
+    :header-rows: 1
+
+    * - ID
+      - Type
+      - Priority
+      - Summary
+      - Added
+    * - `#388`_
+      - bug
+      - medium
+      - Get File scp=ALL depends on nonstandard utility
+      - rc 1
+    * - `#104`_
+      - enhancement
+      - medium
+      - File Should Exist not allowing GLOB
+      - rc 1
+    * - `#350`_
+      - enhancement
+      - low
+      - execute command with sudo has a potential password exposure
+      - rc 1
+
+Altogether 3 issues. View on the `issue tracker <https://github.com/robotframework/SSHLibrary/issues?q=milestone%3Av3.8.0>`__.
+
+.. _#388: https://github.com/robotframework/SSHLibrary/issues/388
+.. _#104: https://github.com/robotframework/SSHLibrary/issues/104
+.. _#350: https://github.com/robotframework/SSHLibrary/issues/350
diff --git a/docs/SSHLibrary.html b/docs/SSHLibrary.html
index 70808aa8f..f1b13aabc 100644
--- a/docs/SSHLibrary.html
+++ b/docs/SSHLibrary.html
@@ -1101,7 +1101,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"name": "SSHLibrary", "doc": "<p>SSHLibrary is a Robot Framework test library for SSH and SFTP.</p>\n<p>This document explains how to use keywords provided by SSHLibrary. For information about installation, support, and more please visit the <a href=\"https://github.com/robotframework/SSHLibrary\">project page</a>. For more information about Robot Framework, see <a href=\"http://robotframework.org\">http://robotframework.org</a>.</p>\n<p>The library has the following main usages:</p>\n<ul>\n<li>Executing commands on the remote machine, either with blocking or non-blocking behaviour (see <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> and <a href=\"#Start%20Command\" class=\"name\">Start Command</a>, respectively).</li>\n<li>Writing and reading in an interactive shell (e.g. <a href=\"#Read\" class=\"name\">Read</a> and <a href=\"#Write\" class=\"name\">Write</a>).</li>\n<li>Transferring files and directories over SFTP (e.g. <a href=\"#Get%20File\" class=\"name\">Get File</a> and <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a>).</li>\n<li>Ensuring that files or directories exist on the remote machine (e.g. <a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a> and <a href=\"#Directory%20Should%20Not%20Exist\" class=\"name\">Directory Should Not Exist</a>).</li>\n</ul>\n<p>This library works both with Python and Jython, but uses different SSH modules internally depending on the interpreter. See <a href=\"http://robotframework.org/SSHLibrary/#installation\">installation instructions</a> for more details about the dependencies. IronPython is unfortunately not supported. Python 3 is supported starting from SSHLibrary 3.0.0.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Connections%20and%20login\" class=\"name\">Connections and login</a></li>\n<li><a href=\"#Configuration\" class=\"name\">Configuration</a></li>\n<li><a href=\"#Executing%20commands\" class=\"name\">Executing commands</a></li>\n<li><a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a></li>\n<li><a href=\"#Pattern%20matching\" class=\"name\">Pattern matching</a></li>\n<li><a href=\"#Example\" class=\"name\">Example</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Time%20format\" class=\"name\">Time format</a></li>\n<li><a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a></li>\n<li><span class=\"name\">Shortcuts</span></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Connections and login\">Connections and login</h2>\n<p>SSHLibrary supports multiple connections to different hosts. New connections are opened with <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>.</p>\n<p>Login into the host is done either with username and password (<a href=\"#Login\" class=\"name\">Login</a>) or with public/private key pair (<a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public key</a>).</p>\n<p>Only one connection can be active at a time. This means that most of the keywords only affect the active connection. Active connection can be changed with <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a>.</p>\n<h2 id=\"Configuration\">Configuration</h2>\n<p>Default settings for all the upcoming connections can be configured on <a href=\"#Importing\" class=\"name\">library importing</a> or later with <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a>.</p>\n<p>Using <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a> does not affect the already open connections. Settings of the current connection can be configured with <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>. Settings of another, non-active connection, can be configured by first using <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> and then <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>.</p>\n<p>Most of the defaults can be overridden per connection by defining them as arguments to <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>. Otherwise the defaults are used.</p>\n<h3 id=\"Configurable per connection\">Configurable per connection</h3>\n<h4 id=\"Prompt\">Prompt</h4>\n<p>Argument <code>prompt</code> defines the character sequence used by <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and must be set before that keyword can be used.</p>\n<p>If you know the prompt on the remote machine, it is recommended to set it to ease reading output from the server after using <a href=\"#Write\" class=\"name\">Write</a>. In addition to that, <a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a> can read the server output more efficiently when the prompt is set.</p>\n<p>Prompt can be specified either as a normal string or as a regular expression. The latter is especially useful if the prompt changes as a result of the executed commands. Prompt can be set to be a regular expression by giving the prompt argument a value starting with <code>REGEXP:</code> followed by the actual regular expression like <code>prompt=REGEXP:[$#]</code>. See the <a href=\"#Regular%20expressions\" class=\"name\">Regular expressions</a> section for more details about the syntax.</p>\n<p>The support for regular expressions is new in SSHLibrary 3.0.0.</p>\n<h4 id=\"Encoding\">Encoding</h4>\n<p>Argument <code>encoding</code> defines the <a href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">character encoding</a> of input and output sequences. The default encoding is UTF-8.</p>\n<p>It is also possible to configure the error handler to use if encoding or decoding characters fails. Accepted values are the same that encode/decode functions in Python strings accept. In practice the following values are the most useful:</p>\n<ul>\n<li><code>ignore</code>: ignore characters that cannot be decoded</li>\n</ul>\n<ul>\n<li><code>strict</code>: fail if characters cannot be decoded</li>\n</ul>\n<ul>\n<li><code>replace</code>: replace characters that cannot be decoded with replacement character</li>\n</ul>\n<p>By default <code>encoding_errors</code> is set to <code>strict</code>. <code>encoding_errors</code> is new in SSHLibrary 3.7.0.</p>\n<h4 id=\"Path separator\">Path separator</h4>\n<p>Argument <code>path_separator</code> must be set to the one known by the operating system and the SSH server on the remote machine. The path separator is used by keywords <a href=\"#Get%20File\" class=\"name\">Get File</a>, <a href=\"#Put%20File\" class=\"name\">Put File</a>, <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a> and <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> for joining paths correctly on the remote host.</p>\n<p>The default path separator is forward slash <code>/</code> which works on Unix-like machines. On Windows the path separator to use depends on the SSH server. Some servers use forward slash and others backslash, and users need to configure the <code>path_separator</code> accordingly. Notice that using a backslash in Robot Framework test data requires doubling it like <code>\\\\</code>.</p>\n<p>The path separator can be configured on <a href=\"#Importing\" class=\"name\">library importing</a> or later, using <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a>, <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a> and <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>.</p>\n<h4 id=\"Timeout\">Timeout</h4>\n<p>Argument <code>timeout</code> is used by <a href=\"#Read%20Until\" class=\"name\">Read Until</a> variants. The default value is <code>3 seconds</code>. See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported timeout syntax.</p>\n<h4 id=\"Newline\">Newline</h4>\n<p>Argument <code>newline</code> is the line break sequence used by <a href=\"#Write\" class=\"name\">Write</a> keyword and must be set according to the operating system on the remote machine. The default value is <code>LF</code> (same as <code>\\n</code>) which is used on Unix-like operating systems. With Windows remote machines, you need to set this to <code>CRLF</code> (<code>\\r\\n</code>).</p>\n<h4 id=\"Terminal settings\">Terminal settings</h4>\n<p>Argument <code>term_type</code> defines the virtual terminal type, and arguments <code>width</code> and <code>height</code> can be used to control its  virtual size.</p>\n<h4 id=\"Escape ansi sequneces\">Escape ansi sequneces</h4>\n<p>Argument <code>escape_ansi</code> is a parameter used in order to escape ansi sequences that appear in the output when the remote machine has Windows as operating system.</p>\n<h3 id=\"Not configurable per connection\">Not configurable per connection</h3>\n<h4 id=\"Loglevel\">Loglevel</h4>\n<p>Argument <code>loglevel</code> sets the log level used to log the output read by <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>, <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a>, <a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a>. The default level is <code>INFO</code>.</p>\n<p><code>loglevel</code> is not configurable per connection but can be overridden by passing it as an argument to the most of the aforementioned keywords. Possible argument values are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code> and <code>NONE</code> (no logging).</p>\n<h2 id=\"Executing commands\">Executing commands</h2>\n<p>For executing commands on the remote machine, there are two possibilities:</p>\n<ul>\n<li><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> and <a href=\"#Start%20Command\" class=\"name\">Start Command</a>. The command is executed in a new shell on the remote machine, which means that possible changes to the environment (e.g. changing working directory, setting environment variables, etc.) are not visible to the subsequent keywords.</li>\n</ul>\n<ul>\n<li><a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a>. These keywords operate in an interactive shell, which means that changes to the environment are visible to the subsequent keywords.</li>\n</ul>\n<h2 id=\"Interactive shells\">Interactive shells</h2>\n<p><a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> can be used to interact with the server within the same shell.</p>\n<h3 id=\"Consumed output\">Consumed output</h3>\n<p>All of these keywords, except <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, consume the read or the written text from the server output before returning. In practice this means that the text is removed from the server output, i.e. subsequent calls to <a href=\"#Read\" class=\"name\">Read</a> keywords do not return text that was already read. This is illustrated by the example below.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>echo hello</td>\n<td></td>\n<td># Consumes written <code>echo hello</code></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>hello</td>\n<td># Consumes read <code>hello</code> and everything before it</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>hello</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td># Consumes everything available</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Not Contain</span></td>\n<td>${stdout}</td>\n<td>hello</td>\n<td># <code>hello</code> was already consumed earlier</td>\n</tr>\n</table>\n<p>The consumed text is logged by the keywords and their argument <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p><a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a> consume everything on the server output or if the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt.</p>\n<h3 id=\"Reading\">Reading</h3>\n<p><a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> can be used to read from the server. The read text is also consumed from the server output.</p>\n<p><a href=\"#Read\" class=\"name\">Read</a> reads everything available on the server output, thus clearing it.</p>\n<p><a href=\"#Read%20Until\" class=\"name\">Read Until</a> variants read output up until and <b>including</b> <code>expected</code> text. These keywords will fail if the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before <code>expected</code> is found.</p>\n<h3 id=\"Writing\">Writing</h3>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a> consume the written text from the server output while <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a> does not.</p>\n<p>These keywords do not return any output triggered by the written text. To get the output, one of the <a href=\"#Read\" class=\"name\">Read</a> keywords must be explicitly used.</p>\n<h2 id=\"Pattern matching\">Pattern matching</h2>\n<h3 id=\"Glob patterns\">Glob patterns</h3>\n<p>Some keywords allow their arguments to be specified as <i>glob patterns</i> where:</p>\n<table border=\"1\">\n<tr>\n<td>*</td>\n<td>matches anything, even an empty string</td>\n</tr>\n<tr>\n<td>?</td>\n<td>matches any single character</td>\n</tr>\n<tr>\n<td>[chars]</td>\n<td>matches any character inside square brackets (e.g. <code>[abc]</code> matches either <code>a</code>, <code>b</code> or <code>c</code>)</td>\n</tr>\n<tr>\n<td>[!chars]</td>\n<td>matches any character not inside square brackets</td>\n</tr>\n</table>\n<p>Pattern matching is case-sensitive regardless the local or remote operating system. Matching is implemented using Python's <a href=\"https://docs.python.org/3/library/fnmatch.html\">fnmatch module</a>.</p>\n<h3 id=\"Regular expressions\">Regular expressions</h3>\n<p>Some keywords support pattern matching using regular expressions, which are more powerful but also more complicated than <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>. This library uses Python's regular expressions, which are introduced in the <a href=\"https://docs.python.org/3/howto/regex.html\">Regular Expression HOWTO</a>.</p>\n<p>Remember that in Robot Framework data the backslash that is used a lot in regular expressions is an escape character and needs to be doubled to get a literal backslash. For example, <code>\\\\d\\\\d\\\\s</code> matches two digits followed by a whitespace character.</p>\n<p>Possible flags altering how the expression is parsed (e.g. <code>re.IGNORECASE</code>, <code>re.MULTILINE</code>) can be set by prefixing the pattern with the <code>(?iLmsux)</code> group. The available flags are <code>IGNORECASE</code>: <code>i</code>, <code>MULTILINE</code>: <code>m</code>, <code>DOTALL</code>: <code>s</code>, <code>VERBOSE</code>: <code>x</code>, <code>UNICODE</code>: <code>u</code>, and <code>LOCALE</code>: <code>L</code>. For example, <code>(?is)pat.ern</code> uses <code>IGNORECASE</code> and <code>DOTALL</code> flags.</p>\n<h2 id=\"Example\">Example</h2>\n<pre>\n<b>***</b> Settings <b>***</b>\nDocumentation          This example demonstrates executing commands on a remote machine\n...                    and getting their output and the return code.\n...\n...                    Notice how connections are handled as part of the suite setup and\n...                    teardown. This saves some time when executing several test cases.\n\nLibrary                <span class=\"name\">SSHLibrary</span>\nSuite Setup            <span class=\"name\">Open Connection And Log In</span>\nSuite Teardown         <a href=\"#Close%20All%20Connections\" class=\"name\">Close All Connections</a>\n\n<b>***</b> Variables <b>***</b>\n${HOST}                localhost\n${USERNAME}            test\n${PASSWORD}            test\n\n<b>***</b> Test Cases <b>***</b>\nExecute Command And Verify Output\n    [Documentation]    Execute Command can be used to ran commands on the remote machine.\n    ...                The keyword returns the standard output by default.\n    ${output}=         <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>  echo Hello SSHLibrary!\n    <span class=\"name\">Should Be Equal</span>    ${output}        Hello SSHLibrary!\n\nExecute Command And Verify Return Code\n    [Documentation]    Often getting the return code of the command is enough.\n    ...                This behaviour can be adjusted as Execute Command arguments.\n    ${rc}=             <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>  echo Success guaranteed.    return_stdout=False    return_rc=True\n    <span class=\"name\">Should Be Equal</span>    ${rc}            ${0}\n\nExecuting Commands In An Interactive Session\n    [Documentation]    Execute Command always executes the command in a new shell.\n    ...                This means that changes to the environment are not persisted\n    ...                between subsequent Execute Command keyword calls.\n    ...                Write and Read Until variants can be used to operate in the same shell.\n    <a href=\"#Write\" class=\"name\">Write</a>              cd ..\n    <a href=\"#Write\" class=\"name\">Write</a>              echo Hello from the parent directory!\n    ${output}=         <a href=\"#Read%20Until\" class=\"name\">Read Until</a>       directory!\n    <span class=\"name\">Should End With</span>    ${output}        Hello from the parent directory!\n\n<b>***</b> Keywords <b>***</b>\nOpen Connection And Log In\n   <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>     ${HOST}\n   <a href=\"#Login\" class=\"name\">Login</a>               ${USERNAME}        ${PASSWORD}\n</pre>\n<p>Save the content as file <code>executing_command.txt</code> and run:</p>\n<p><code>robot executing_commands.txt</code></p>\n<p>You may want to override the variables from commandline to try this out on your remote machine:</p>\n<p><code>robot -v HOST:my.server.com -v USERNAME:johndoe -v PASSWORD:secretpasswd executing_commands.txt</code></p>\n<h3 id=\"Time format\">Time format</h3>\n<p>All timeouts, delays or retry intervals can be given as numbers considered seconds (e.g. <code>0.5</code> or <code>42</code>) or in Robot Framework's time syntax (e.g. <code>1.5 seconds</code> or <code>1 min 30 s</code>). For more information about the time syntax see the <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework User Guide</a>.</p>\n<h2 id=\"Boolean arguments\">Boolean arguments</h2>\n<p>Some keywords accept arguments that are handled as Boolean values true or false. If such an argument is given as a string, it is considered false if it is either an empty string or case-insensitively equal to <code>false</code>, <code>none</code> or <code>no</code>. Other strings are considered true regardless their value, and other argument types are tested using the same <a href=\"http://docs.python.org/2/library/stdtypes.html#truth-value-testing\">rules as in Python</a>.</p>\n<p>True examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=True</td>\n<td># Strings are generally true.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=yes</td>\n<td># Same as the above.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${TRUE}</td>\n<td># Python <code>True</code> is true.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${42}</td>\n<td># Numbers other than 0 are true.</td>\n</tr>\n</table>\n<p>False examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=False</td>\n<td># String <code>false</code> is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=no</td>\n<td># Also string <code>no</code> is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${EMPTY}</td>\n<td># Empty string is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${FALSE}</td>\n<td># Python <code>False</code> is false.</td>\n</tr>\n</table>\n<p>Prior to SSHLibrary 3.1.0, all non-empty strings, including <code>no</code> and <code>none</code> were considered to be true. Considering <code>none</code> false is new in Robot Framework 3.0.3.</p>\n<h2 id=\"Transfer files with SCP\">Transfer files with SCP</h2>\n<p>Secure Copy Protocol (SCP) is a way of secure transfer of files between hosts. It is based on SSH protocol. The advantage it brings over SFTP is transfer speed. SFTP however can also be used for directory listings and even editing files while transferring. SCP can be enabled on keywords used for file transfer: <a href=\"#Get%20File\" class=\"name\">Get File</a>, <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a>, <a href=\"#Put%20File\" class=\"name\">Put File</a>, <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> by setting the <code>scp</code> value to <code>TRANSFER</code> or <code>ALL</code>.</p>\n<table border=\"1\">\n<tr>\n<td>OFF</td>\n<td>Transfer is done using SFTP only. This is the default value</td>\n</tr>\n<tr>\n<td>TRANSFER</td>\n<td>Directory listings (needed for logging) will be done using SFTP. Actual file transfer is done with SCP.</td>\n</tr>\n<tr>\n<td>ALL</td>\n<td>Only SCP is used for file transfer. No logging available.</td>\n</tr>\n</table>\n<p>There are some limitations to the current SCP implementation::</p>\n<ul>\n<li>When using SCP, files cannot be altered during transfer and <code>newline</code> argument does not work.</li>\n<li>If <code>scp=ALL</code> only <code>source</code> and <code>destination</code> arguments will work on the keywords. The directories are transferred recursively. Also, when running with Jython <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> and <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a> won't work due to current Trilead implementation.</li>\n<li>If running with Jython you can encounter some encoding issues when transferring files with non-ascii characters.</li>\n</ul>\n<p>SCP transfer was introduced in SSHLibrary 3.3.0.</p>\n<h3 id=\"Preserving original times\">Preserving original times</h3>\n<p>SCP allows some configuration when transferring files and directories. One of this configuration is whether to preserve the original modify time and access time of transferred files and directories. This is done using the <code>scp_preserve_times</code> argument. This argument works only when <code>scp</code> argument is set to <code>TRANSFER</code> or <code>ALL</code>. When moving directory with <code>scp</code> set to <code>TRANSFER</code> and <code>scp_preserve_times</code> is enabled only the files inside the director will keep their original timestamps. Also, when running with Jython <code>scp_preserve_times</code> won't work due to current current Trilead implementation.</p>\n<p><code>scp_preserve_times</code> was introduced in SSHLibrary 3.6.0.</p>\n<h2 id=\"Aliases\">Aliases</h2>\n<p>SSHLibrary allows the use of an alias when opening a new connection using the parameter <code>alias</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>alias=connection1</td>\n</tr>\n</table>\n<p>These aliases can later be used with other keywords like  <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a> or <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> in order to get information respectively to switch to a certain connection that has that alias.</p>\n<p>When a connection is closed, it is no longer possible to switch or get information about the other connections that have the same alias as the closed one. If the same <code>alias</code> is used for more connections, keywords <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> and <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a> will switch/get information only about the last opened connection with that <code>alias</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn2</td>\n</tr>\n<tr>\n<td>${conn_info}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>conn</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${conn_info.index}</td>\n<td>2</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n<td></td>\n</tr>\n<tr>\n<td>${current_conn}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>conn</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${current_conn.index}</td>\n<td>2</td>\n</tr>\n</table>\n<p>Note that if a connection that has the same alias as other connections is closed trying to switch or get information about the other connections that have the same alias is impossible.</p>\n<table border=\"1\">\n<tr>\n<td>'Open Connection`</td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n<td></td>\n</tr>\n<tr>\n<td>'Open Connection`</td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Close%20Connection\" class=\"name\">Close Connection</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Run Keyword And Expect Error</span></td>\n<td>Non-existing index or alias 'conn'.</td>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n</tr>\n</table>", "version": "3.7.0", "generated": "2021-07-05 17:13:30", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/__init__.py", "lineno": 37, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "3 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=3 seconds"}, {"name": "newline", "types": [], "defaultValue": "LF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=LF"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}, {"name": "term_type", "types": [], "defaultValue": "vt100", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=vt100"}, {"name": "width", "types": [], "defaultValue": "80", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=80"}, {"name": "height", "types": [], "defaultValue": "24", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=24"}, {"name": "path_separator", "types": [], "defaultValue": "/", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=/"}, {"name": "encoding", "types": [], "defaultValue": "UTF-8", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=UTF-8"}, {"name": "escape_ansi", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=False"}, {"name": "encoding_errors", "types": [], "defaultValue": "strict", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=strict"}], "doc": "<p>SSHLibrary allows some import time <a href=\"#Configuration\" class=\"name\">configuration</a>.</p>\n<p>If the library is imported without any arguments, the library defaults are used:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n</tr>\n</table>\n<p>Only arguments that are given are changed. In this example the <a href=\"#Timeout\" class=\"name\">timeout</a> is changed to <code>10 seconds</code> but  other settings are left to the library defaults:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>10 seconds</td>\n</tr>\n</table>\n<p>The <a href=\"#Prompt\" class=\"name\">prompt</a> does not have a default value and must be explicitly set to be able to use <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>. Since SSHLibrary 3.0.0, the prompt can also be a regular expression:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>prompt=REGEXP:[$#]</td>\n</tr>\n</table>\n<p>Multiple settings are also possible. In the example below, the library is brought into use with <a href=\"#Newline\" class=\"name\">newline</a> and <a href=\"#Path%20separator\" class=\"name\">path separator</a> known by Windows:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>newline=CRLF</td>\n<td>path_separator=\\\\</td>\n</tr>\n</table>", "shortdoc": "SSHLibrary allows some import time `configuration`.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 458}], "keywords": [{"name": "Close All Connections", "args": [], "doc": "<p>Closes all open connections.</p>\n<p>This keyword is ought to be used either in test or suite teardown to make sure all the connections are closed before the test execution finishes.</p>\n<p>After this keyword, the connection indices returned by <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a> are reset and start from <code>1</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n</tr>\n<tr>\n<td># Do something with the connections</td>\n<td></td>\n</tr>\n<tr>\n<td>[Teardown]</td>\n<td><a href=\"#Close%20All%20Connections\" class=\"name\">Close all connections</a></td>\n</tr>\n</table>", "shortdoc": "Closes all open connections.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 749}, {"name": "Close Connection", "args": [], "doc": "<p>Closes the current connection.</p>\n<p>No other connection is made active by this keyword. Manually use <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> to switch to another connection.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>results.txt</td>\n<td>/tmp</td>\n</tr>\n<tr>\n<td><a href=\"#Close%20Connection\" class=\"name\">Close Connection</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># Do something with /tmp/results.txt</td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Closes the current connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 732}, {"name": "Create Local Ssh Tunnel", "args": [{"name": "local_port", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "local_port"}, {"name": "remote_host", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_host"}, {"name": "remote_port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remote_port=22"}, {"name": "bind_address", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bind_address=None"}], "doc": "<p>The keyword uses the existing connection to set up local port forwarding (the openssh -L option) from a local port through a tunneled connection to a destination reachable from the SSH server machine.</p>\n<p>The example below illustrates the forwarding from the local machine, of the connection on port 80 of an inaccessible server (secure.server.com) by connecting to a remote SSH server (remote.server.com) that has access to the secure server, and makes it available locally, on the port 9191:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>remote.server.com</td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Local%20Ssh%20Tunnel\" class=\"name\">Create Local SSH Tunnel</a></td>\n<td>9191</td>\n<td>secure.server.com</td>\n<td>80</td>\n</tr>\n</table>\n<p>The tunnel is active as long as the connection is open.</p>\n<p>The default <code>remote_port</code> is 22.</p>\n<p>By default, anyone can connect on the specified port on the SSH client because the local machine listens on all interfaces. Access can be restricted by specifying a <code>bind_address</code>. Setting <code>bind_address</code> does not work with Jython.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Create%20Local%20Ssh%20Tunnel\" class=\"name\">Create Local SSH Tunnel</a></td>\n<td>9191</td>\n<td>secure.server.com</td>\n<td>80</td>\n<td>bind_address=127.0.0.1</td>\n</tr>\n</table>\n<p><code>bind_address</code> is new in SSHLibrary 3.3.0.</p>", "shortdoc": "The keyword uses the existing connection to set up local port forwarding (the openssh -L option) from a local port through a tunneled connection to a destination reachable from the SSH server machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1322}, {"name": "Directory Should Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> does not point to an existing directory.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Exist\" class=\"name\">Directory Should Exist</a></td>\n<td>/usr/share/man</td>\n</tr>\n</table>\n<p>Note that symlinks are followed:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Exist\" class=\"name\">Directory Should Exist</a></td>\n<td>/usr/local/man</td>\n<td># Points to /usr/share/man/</td>\n</tr>\n</table>", "shortdoc": "Fails if the given ``path`` does not point to an existing directory.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1857}, {"name": "Directory Should Not Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> points to an existing directory.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Not%20Exist\" class=\"name\">Directory Should Not Exist</a></td>\n<td>/non/existing</td>\n</tr>\n</table>\n<p>Note that this keyword follows symlinks. Thus the example fails if <code>/non/existing</code> is a link that points to an existing directory.</p>", "shortdoc": "Fails if the given ``path`` points to an existing directory.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1869}, {"name": "Enable Ssh Logging", "args": [{"name": "logfile", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "logfile"}], "doc": "<p>Enables logging of SSH protocol output to given <code>logfile</code>.</p>\n<p>All the existing and upcoming connections are logged onwards from the moment the keyword was called.</p>\n<p><code>logfile</code> is path to a file that is writable by the current local user. If the file already exists, it will be overwritten.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td># Not logged</td>\n</tr>\n<tr>\n<td><a href=\"#Enable%20Ssh%20Logging\" class=\"name\">Enable SSH Logging</a></td>\n<td>myserver.log</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n<td># Logged</td>\n</tr>\n<tr>\n<td># Do something with the connections</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># Check myserver.log for detailed debug information</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p><b>Note:</b> This keyword does not work when using Jython.</p>", "shortdoc": "Enables logging of SSH protocol output to given ``logfile``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 595}, {"name": "Execute Command", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "return_stdout", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stdout=True"}, {"name": "return_stderr", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stderr=False"}, {"name": "return_rc", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_rc=False"}, {"name": "sudo", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo=False"}, {"name": "sudo_password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo_password=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "output_during_execution", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "output_during_execution=False"}, {"name": "output_if_timeout", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "output_if_timeout=False"}, {"name": "invoke_subsystem", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invoke_subsystem=False"}, {"name": "forward_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "forward_agent=False"}], "doc": "<p>Executes <code>command</code> on the remote machine and returns its outputs.</p>\n<p>This keyword executes the <code>command</code> and returns after the execution has been finished. Use <a href=\"#Start%20Command\" class=\"name\">Start Command</a> if the command should be started in the background.</p>\n<p>By default, only the standard output is returned:</p>\n<table border=\"1\">\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>Arguments <code>return_stdout</code>, <code>return_stderr</code> and <code>return_rc</code> are used to specify, what is returned by this keyword. If several arguments evaluate to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), multiple values are returned.</p>\n<p>If errors are needed as well, set the respective argument value to true:</p>\n<table border=\"1\">\n<tr>\n<td>${stdout}</td>\n<td>${stderr}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n<td>return_stderr=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Empty</span></td>\n<td>${stderr}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Often checking the return code is enough:</p>\n<table border=\"1\">\n<tr>\n<td>${rc}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n<td>return_stdout=False</td>\n<td>return_rc=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${rc}</td>\n<td>0</td>\n<td># succeeded</td>\n<td></td>\n</tr>\n</table>\n<p>Arguments <code>sudo</code> and <code>sudo_password</code> are used for executing commands within a sudo session. Due to different permission elevation in Cygwin, these two arguments will not work when using it.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n<td>sudo=True</td>\n<td>sudo_password=test</td>\n</tr>\n</table>\n<p>The <code>command</code> is always executed in a new shell. Thus possible changes to the environment (e.g. changing working directory) are not visible to the later keywords:</p>\n<table border=\"1\">\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>cd /tmp</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n</table>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Read\" class=\"name\">Read</a> can be used for running multiple commands in the same shell. See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> section for more information.</p>\n<p>This keyword logs the executed command and its exit status with log level <code>INFO</code>.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the command is executed, this keyword fails.</p>\n<p><code>invoke_subsystem</code> will request a subsystem on the server, given by the <code>command</code> argument. If the server allows it, the channel will then be directly connected to the requested subsystem.</p>\n<p><code>forward_agent</code> determines whether to forward the local SSH Agent process to the process being executed. This assumes that there is an agent in use (i.e. <span class=\"name\">eval $(ssh-agent)</span>). Setting <code>forward_agent</code> does not work with Jython.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>ssh-add -L</td>\n<td>forward_agent=True</td>\n</tr>\n</table>\n<p><code>invoke_subsystem</code> and <code>forward_agent</code> are new in SSHLibrary 3.4.0.</p>\n<p><code>output_during_execution</code> enable logging the output of the command as it is generated, into the console.</p>\n<p><code>output_if_timeout</code> if the executed command doesn't end before reaching timeout, the parameter will log the output of the command at the moment of timeout.</p>\n<p><code>output_during_execution</code> and <code>output_if_timeout</code> are not working with Jython. New in SSHLibrary 3.5.0.</p>", "shortdoc": "Executes ``command`` on the remote machine and returns its outputs.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1127}, {"name": "File Should Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> does NOT point to an existing file.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a></td>\n<td>/boot/initrd.img</td>\n</tr>\n</table>\n<p>Note that symlinks are followed:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a></td>\n<td>/initrd.img</td>\n<td># Points to /boot/initrd.img</td>\n</tr>\n</table>", "shortdoc": "Fails if the given ``path`` does NOT point to an existing file.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1833}, {"name": "File Should Not Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> points to an existing file.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Not%20Exist\" class=\"name\">File Should Not Exist</a></td>\n<td>/non/existing</td>\n</tr>\n</table>\n<p>Note that this keyword follows symlinks. Thus the example fails if <code>/non/existing</code> is a link that points an existing file.</p>", "shortdoc": "Fails if the given ``path`` points to an existing file.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1845}, {"name": "Get Connection", "args": [{"name": "index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index_or_alias=None"}, {"name": "index", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index=False"}, {"name": "host", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=False"}, {"name": "alias", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=False"}, {"name": "port", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=False"}, {"name": "timeout", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=False"}, {"name": "newline", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=False"}, {"name": "prompt", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=False"}, {"name": "term_type", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=False"}, {"name": "width", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=False"}, {"name": "height", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=False"}, {"name": "encoding", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=False"}, {"name": "escape_ansi", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=False"}], "doc": "<p>Returns information about the connection.</p>\n<p>Connection is not changed by this keyword, use <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> to change the active connection.</p>\n<p>If <code>index_or_alias</code> is not given, the information of the current connection is returned. If there exists more connections with the same alias the keyword will return last opened connection that has that alias.</p>\n<p>This keyword returns an object that has the following attributes:</p>\n<table border=\"1\">\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Explanation</th>\n</tr>\n<tr>\n<td>index</td>\n<td>integer</td>\n<td>Number of the connection. Numbering starts from <code>1</code>.</td>\n</tr>\n<tr>\n<td>host</td>\n<td>string</td>\n<td>Destination hostname.</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>string</td>\n<td>An optional alias given when creating the connection.</td>\n</tr>\n<tr>\n<td>port</td>\n<td>integer</td>\n<td>Destination port.</td>\n</tr>\n<tr>\n<td>timeout</td>\n<td>string</td>\n<td><a href=\"#Timeout\" class=\"name\">Timeout</a> length in textual representation.</td>\n</tr>\n<tr>\n<td>newline</td>\n<td>string</td>\n<td>The line break sequence used by <a href=\"#Write\" class=\"name\">Write</a> keyword. See <a href=\"#Newline\" class=\"name\">newline</a>.</td>\n</tr>\n<tr>\n<td>prompt</td>\n<td>string</td>\n<td><a href=\"#Prompt\" class=\"name\">Prompt</a> character sequence for <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>.</td>\n</tr>\n<tr>\n<td>term_type</td>\n<td>string</td>\n<td>Type of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>width</td>\n<td>integer</td>\n<td>Width of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>height</td>\n<td>integer</td>\n<td>Height of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>path_separator</td>\n<td>string</td>\n<td>The <a href=\"#Path%20separator\" class=\"name\">path separator</a> used on the remote host.</td>\n</tr>\n<tr>\n<td>encoding</td>\n<td>string</td>\n<td>The <a href=\"#Encoding\" class=\"name\">encoding</a> used for inputs and outputs.</td>\n</tr>\n</table>\n<p>If there is no connection, an object having <code>index</code> and <code>host</code> as <code>None</code> is returned, rest of its attributes having their values as configuration defaults.</p>\n<p>If you want the information for all the open connections, use <a href=\"#Get%20Connections\" class=\"name\">Get Connections</a>.</p>\n<p>Getting connection information of the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td>prompt=&gt;&gt;</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${nearhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.host}</td>\n<td>near.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.index}</td>\n<td>2</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.prompt}</td>\n<td>&gt;&gt;</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.term_type}</td>\n<td>vt100</td>\n<td># From defaults</td>\n</tr>\n</table>\n<p>Getting connection information using an index:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>1</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.host}</td>\n<td>far.server.com</td>\n</tr>\n</table>\n<p>Getting connection information using an alias:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td>alias=far</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>far</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.host}</td>\n<td>far.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.alias}</td>\n<td>far</td>\n</tr>\n</table>\n<p>This keyword can also return plain connection attributes instead of the whole connection object. This can be adjusted using the boolean arguments <code>index</code>, <code>host</code>, <code>alias</code>, and so on, that correspond to the attribute names of the object. If such arguments are given, and they evaluate to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), only the respective connection attributes are returned. Note that attributes are always returned in the same order arguments are specified in the signature.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=example</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${host}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>host=True</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${host}</td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${host}</td>\n<td>${alias}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>host=yes</td>\n<td>alias=please</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${host}</td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${alias}</td>\n<td>example</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Getting only certain attributes is especially useful when using this library via the Remote library interface. This interface does not support returning custom objects, but individual attributes can be returned just fine.</p>\n<p>This keyword logs the connection information with log level <code>INFO</code>.</p>", "shortdoc": "Returns information about the connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 767}, {"name": "Get Connections", "args": [], "doc": "<p>Returns information about all the open connections.</p>\n<p>This keyword returns a list of objects that are identical to the ones returned by <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td>timeout=10s</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td>timeout=5s</td>\n</tr>\n<tr>\n<td>${nearhost}</td>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.host}</td>\n<td>near.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${nearhost.timeout}</td>\n<td>10</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${farhost.port}</td>\n<td>22</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${farhost.timeout}</td>\n<td>5</td>\n</tr>\n</table>\n<p>This keyword logs the information of connections with log level <code>INFO</code>.</p>", "shortdoc": "Returns information about all the open connections.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 916}, {"name": "Get Directory", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "recursive", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursive=False"}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Downloads a directory, including its content, from the remote machine to the local machine.</p>\n<p><code>source</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>destination</code> is the target path on the local machine.  Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>recursive</code> specifies whether to recursively download all subdirectories inside <code>source</code>. Subdirectories are downloaded if the argument value evaluates to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>).</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp/non/existing</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>recursive=True</td>\n</tr>\n</table>\n<p>The local <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing path on the local machine, <code>source</code> directory is downloaded into it.</p>\n<p>2. If <code>destination</code> does not exist on the local machine, it is created and the content of <code>source</code> directory is downloaded into it.</p>\n<p>3. If <code>destination</code> is not given, <code>source</code> directory is downloaded into the current working directory on the local &lt;machine. This is typically the directory where the test execution was started and thus accessible using the built-in <code>${EXECDIR}</code> variable.</p>\n<p>See also <a href=\"#Get%20File\" class=\"name\">Get File</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Downloads a directory, including its content, from the remote machine to the local machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1656}, {"name": "Get File", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Downloads file(s) from the remote machine to the local machine.</p>\n<p><code>source</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported. If the source contains wildcards explained in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, all files matching it are downloaded. In this case <code>destination</code> must always be a directory.</p>\n<p><code>destination</code> is the target path on the local machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/var/log/auth.log</td>\n<td>/tmp/</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/tmp/example.txt</td>\n<td>C:\\\\temp\\\\new_name.txt</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/path/to/*.txt</td>\n<td></td>\n</tr>\n</table>\n<p>The local <code>destination</code> is created using the rules explained below:</p>\n<p>1. If the <code>destination</code> is an existing file, the <code>source</code> file is downloaded over it.</p>\n<p>2. If the <code>destination</code> is an existing directory, the <code>source</code> file is downloaded into it. Possible file with the same name is overwritten.</p>\n<p>3. If the <code>destination</code> does not exist and it ends with the path separator of the local operating system, it is considered a directory. The directory is then created and the <code>source</code> file is downloaded into it. Possible missing intermediate directories are also created.</p>\n<p>4. If the <code>destination</code> does not exist and does not end with the local path separator, it is considered a file. The <code>source</code> file is downloaded and saved using that file name, and possible missing intermediate directories are also created.</p>\n<p>5. If <code>destination</code> is not given, the current working directory on the local machine is used as the destination. This is typically the directory where the test execution was started and thus accessible using built-in <code>${EXECDIR}</code> variable.</p>\n<p>See also <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Downloads file(s) from the remote machine to the local machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1600}, {"name": "Get Pre Login Banner", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=22"}], "doc": "<p>Returns the banner supplied by the server upon connect.</p>\n<p>There are 2 ways of getting banner information.</p>\n<p>1. Independent of any connection:</p>\n<table border=\"1\">\n<tr>\n<td>${banner} =</td>\n<td><a href=\"#Get%20Pre%20Login%20Banner\" class=\"name\">Get Pre Login Banner</a></td>\n<td>${HOST}</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${banner}</td>\n<td>Testing pre-login banner</td>\n</tr>\n</table>\n<p>The argument <code>host</code> is mandatory for getting banner key without an open connection.</p>\n<p>2. From the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>${HOST}</td>\n<td>prompt=${PROMPT}</td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>${USERNAME}</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td>${banner} =</td>\n<td><a href=\"#Get%20Pre%20Login%20Banner\" class=\"name\">Get Pre Login Banner</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${banner}</td>\n<td>Testing pre-login banner</td>\n</tr>\n</table>\n<p>New in SSHLibrary 3.0.0.</p>\n<p><b>Note:</b> This keyword does not work when using Jython.</p>", "shortdoc": "Returns the banner supplied by the server upon connect.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1095}, {"name": "List Directories In Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>A wrapper for <a href=\"#List%20Directory\" class=\"name\">List Directory</a> that returns only directories.</p>", "shortdoc": "A wrapper for `List Directory` that returns only directories.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1930}, {"name": "List Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>Returns and logs items in the remote <code>path</code>, optionally filtered with <code>pattern</code>.</p>\n<p><code>path</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported. If <code>path</code> is a symlink, it is followed.</p>\n<p>Item names are returned in case-sensitive alphabetical order, e.g. <code>['A Name', 'Second', 'a lower case name', 'one more']</code>. Implicit directories <code>.</code> and <code>..</code> are not returned. The returned items are automatically logged.</p>\n<p>By default, the item names are returned relative to the given remote path (e.g. <code>file.txt</code>). If you want them be returned in the absolute format (e.g. <code>/home/johndoe/file.txt</code>), set the <code>absolute</code> argument to any non-empty string.</p>\n<p>If <code>pattern</code> is given, only items matching it are returned. The pattern is a glob pattern and its syntax is explained in the <a href=\"#Pattern%20matching\" class=\"name\">Pattern matching</a> section.</p>\n<p>Examples (using also other <a href=\"#List%20Directory\" class=\"name\">List Directory</a> variants):</p>\n<table border=\"1\">\n<tr>\n<td>@{items}=</td>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>/home/johndoe</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>@{files}=</td>\n<td><a href=\"#List%20Files%20In%20Directory\" class=\"name\">List Files In Directory</a></td>\n<td>/tmp</td>\n<td>*.txt</td>\n<td>absolute=True</td>\n</tr>\n</table>\n<p>If you are only interested in directories or files, use <a href=\"#List%20Files%20In%20Directory\" class=\"name\">List Files In Directory</a> or <a href=\"#List%20Directories%20In%20Directory\" class=\"name\">List Directories In Directory</a>, respectively.</p>", "shortdoc": "Returns and logs items in the remote ``path``, optionally filtered with ``pattern``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1881}, {"name": "List Files In Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>A wrapper for <a href=\"#List%20Directory\" class=\"name\">List Directory</a> that returns only files.</p>", "shortdoc": "A wrapper for `List Directory` that returns only files.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1918}, {"name": "Login", "args": [{"name": "username", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username=None"}, {"name": "password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password=None"}, {"name": "allow_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "allow_agent=False"}, {"name": "look_for_keys", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "look_for_keys=False"}, {"name": "delay", "types": [], "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0.5 seconds"}, {"name": "proxy_cmd", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy_cmd=None"}, {"name": "read_config", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "read_config=False"}, {"name": "jumphost_index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jumphost_index_or_alias=None"}, {"name": "keep_alive_interval", "types": [], "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keep_alive_interval=0 seconds"}], "doc": "<p>Logs into the SSH server with the given <code>username</code> and <code>password</code>.</p>\n<p>Connection must be opened before using this keyword.</p>\n<p>This keyword reads, returns and logs the server output after logging in. If the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt is read. Otherwise the output is read using the <a href=\"#Read\" class=\"name\">Read</a> keyword with the given <code>delay</code>. The output is logged using the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p><code>proxy_cmd</code> is used to connect through a SSH proxy.</p>\n<p><code>jumphost_index_or_alias</code> is used to connect through an intermediary SSH connection that has been assigned an Index or Alias. Note that this requires a Connection that has been logged in prior to use.</p>\n<p><b>Note:</b> <code>proxy_cmd</code> and <code>jumphost_index_or_alias</code> are mutually exclusive SSH features. If you wish to use them both, create the jump-host's Connection using the proxy_cmd first, then use jump-host for secondary Connection.</p>\n<p><code>allow_agent</code> enables the connection to the SSH agent.</p>\n<p><code>look_for_keys</code> enables the searching for discoverable private key files in <code>~/.ssh/</code>.</p>\n<p><code>read_config</code> reads or ignores entries from <code>~/.ssh/config</code> file. This parameter will read the hostname, port number, username and proxy command.</p>\n<p><code>read_config</code> is new in SSHLibrary 3.7.0.</p>\n<p><code>keep_alive_interval</code> is used to specify after which idle interval of time a <code>keepalive</code> packet will be sent to remote host. By default <code>keep_alive_interval</code> is set to <code>0</code>, which means sending the <code>keepalive</code> packet is disabled.</p>\n<p><code>keep_alive_interval</code> is new in SSHLibrary 3.7.0.</p>\n<p><b>Note:</b> <code>allow_agent</code>, <code>look_for_keys</code>, <code>proxy_cmd</code>, <code>jumphost_index_or_alias</code>, <code>read_config</code> and <code>keep_alive_interval</code> do not work when using Jython.</p>\n<p>Example that logs in and returns the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Last login at</td>\n<td></td>\n</tr>\n</table>\n<p>Example that logs in and returns everything until the prompt:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>johndoe@linux:~$</td>\n<td></td>\n</tr>\n</table>\n<p>Example that logs in a remote server (linux.server.com) through a proxy server (proxy.server.com)</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td>proxy_cmd=ssh -l user -i keyfile -W linux.server.com:22 proxy.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Last login at</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example usage of SSH Agent: First, add the key to the authentication agent with: <code>ssh-add /path/to/keyfile</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>allow_agent=True</td>\n</tr>\n</table>", "shortdoc": "Logs into the SSH server with the given ``username`` and ``password``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 939}, {"name": "Login With Public Key", "args": [{"name": "username", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username=None"}, {"name": "keyfile", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keyfile=None"}, {"name": "password", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password="}, {"name": "allow_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "allow_agent=False"}, {"name": "look_for_keys", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "look_for_keys=False"}, {"name": "delay", "types": [], "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0.5 seconds"}, {"name": "proxy_cmd", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy_cmd=None"}, {"name": "jumphost_index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jumphost_index_or_alias=None"}, {"name": "read_config", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "read_config=False"}, {"name": "keep_alive_interval", "types": [], "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keep_alive_interval=0 seconds"}], "doc": "<p>Logs into the SSH server using key-based authentication.</p>\n<p>Connection must be opened before using this keyword.</p>\n<p><code>username</code> is the username on the remote machine.</p>\n<p><code>keyfile</code> is a path to a valid OpenSSH private key file on the local filesystem.</p>\n<p><code>password</code> is used to unlock the <code>keyfile</code> if needed. If the keyfile is invalid a username-password authentication will be attempted.</p>\n<p><code>proxy_cmd</code> is used to connect through a SSH proxy.</p>\n<p><code>jumphost_index_or_alias</code> is used to connect through an intermediary SSH connection that has been assigned an Index or Alias. Note that this requires a Connection that has been logged in prior to use.</p>\n<p><b>Note:</b> <code>proxy_cmd</code> and <code>jumphost_index_or_alias</code> are mutually exclusive SSH features. If you wish to use them both, create the jump-host's Connection using the proxy_cmd first, then use jump-host for secondary Connection.</p>\n<p>This keyword reads, returns and logs the server output after logging in. If the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt is read. Otherwise the output is read using the <a href=\"#Read\" class=\"name\">Read</a> keyword with the given <code>delay</code>. The output is logged using the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example that logs in using a private key and returns the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a></td>\n<td>johndoe</td>\n<td>/home/johndoe/.ssh/id_rsa</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${motd}</td>\n<td>Last login at</td>\n<td></td>\n</tr>\n</table>\n<p>With locked private keys, the keyring <code>password</code> is required:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a></td>\n<td>johndoe</td>\n<td>/home/johndoe/.ssh/id_dsa</td>\n<td>keyringpasswd</td>\n</tr>\n</table>\n<p><code>allow_agent</code> enables the connection to the SSH agent. <code>look_for_keys</code> enables the searching for discoverable private key files in <code>~/.ssh/</code>.</p>\n<p><code>read_config</code> reads or ignores entries from <code>~/.ssh/config</code> file. This parameter will read the hostname, port number, username, identity file and proxy command.</p>\n<p><code>read_config</code> is new in SSHLibrary 3.7.0.</p>\n<p><code>keep_alive_interval</code> is used to specify after which idle interval of time a <code>keepalive</code> packet will be sent to remote host. By default <code>keep_alive_interval</code> is set to <code>0</code>, which means sending the <code>keepalive</code> packet is disabled.</p>\n<p><code>keep_alive_interval</code> is new in SSHLibrary 3.7.0.</p>\n<p><b>Note:</b> <code>allow_agent</code>, <code>look_for_keys</code>, <code>proxy_cmd</code>, <code>jumphost_index_or_alias</code>, <code>read_config</code> and <code>keep_alive_interval</code> do not work when using Jython.</p>", "shortdoc": "Logs into the SSH server using key-based authentication.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1011}, {"name": "Open Connection", "args": [{"name": "host", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "host"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=22"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Opens a new SSH connection to the given <code>host</code> and <code>port</code>.</p>\n<p>The new connection is made active. Possible existing connections are left open in the background.</p>\n<p>Note that on Jython this keyword actually opens a connection and will fail immediately on unreachable hosts. On Python the actual connection attempt will not be done until <a href=\"#Login\" class=\"name\">Login</a> is called.</p>\n<p>This keyword returns the index of the new connection which can be used later to switch back to it. Indices start from <code>1</code> and are reset when <a href=\"#Close%20All%20Connections\" class=\"name\">Close All Connections</a> is used.</p>\n<p>Optional <code>alias</code> can be given for the connection and can be used for switching between connections, similarly as the index. Multiple connections with the same <code>alias</code> are allowed. See <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> for more details.</p>\n<p>Connection parameters, like <a href=\"#Timeout\" class=\"name\">timeout</a> and <a href=\"#Newline\" class=\"name\">newline</a> are documented in <a href=\"#Configuration\" class=\"name\">configuration</a>. If they are not defined as arguments, the library defaults are used for the connection.</p>\n<p>All the arguments, except <code>host</code>, <code>alias</code> and <code>port</code> can be later updated with <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>.</p>\n<p>Port <code>22</code> is assumed by default:</p>\n<table border=\"1\">\n<tr>\n<td>${index}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n</tr>\n</table>\n<p>Non-standard port may be given as an argument:</p>\n<table border=\"1\">\n<tr>\n<td>${index}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td>port=23</td>\n</tr>\n</table>\n<p>Aliases are handy, if you need to switch back to the connection later:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=myserver</td>\n<td></td>\n</tr>\n<tr>\n<td># Do something with my.server.com</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>myserver</td>\n<td></td>\n<td># Back to my.server.com</td>\n</tr>\n</table>\n<p>Settings can be overridden per connection, otherwise the ones set on <a href=\"#Importing\" class=\"name\">library importing</a> or with <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a> are used:</p>\n<table border=\"1\">\n<tr>\n<td>Open Connection</td>\n<td>192.168.1.1</td>\n<td>timeout=1 hour</td>\n<td>newline=CRLF</td>\n</tr>\n<tr>\n<td># Do something with the connection</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td># Default timeout</td>\n<td># Default line breaks</td>\n</tr>\n</table>\n<p>The <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a> are also configurable per connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td>term_type=ansi</td>\n<td>width=40</td>\n</tr>\n</table>\n<p>Starting with version 3.3.0, SSHLibrary understands <code>Host</code> entries from <code>~/.ssh/config</code>. For instance, if the config file contains:</p>\n<table border=\"1\">\n<tr>\n<td>Host</td>\n<td>my_custom_hostname</td>\n</tr>\n<tr>\n<td></td>\n<td>Hostname my.server.com</td>\n</tr>\n</table>\n<p>The connection to the server can also be made like this:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open connection</a></td>\n<td>my_custom_hostname</td>\n</tr>\n</table>\n<p><code>Host</code> entries are not read from config file when running with Jython.</p>", "shortdoc": "Opens a new SSH connection to the given ``host`` and ``port``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 618}, {"name": "Put Directory", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "mode", "types": [], "defaultValue": "0744", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode=0744"}, {"name": "newline", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline="}, {"name": "recursive", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursive=False"}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Uploads a directory, including its content, from the local machine to the remote machine.</p>\n<p><code>source</code> is the path on the local machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>destination</code> is the target path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>mode</code> can be used to set the target file permission. Numeric values are accepted. The default value is <code>0744</code> (<code>-rwxr--r--</code>).</p>\n<p><code>newline</code> can be used to force the line break characters that are written to the remote files. Valid values are <code>LF</code> and <code>CRLF</code>. Does not work if <code>scp</code> is enabled.</p>\n<p><code>recursive</code> specifies whether to recursively upload all subdirectories inside <code>source</code>. Subdirectories are uploaded if the argument value evaluates to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>).</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp/non/existing</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>recursive=True</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/home/groups/robot</td>\n<td>mode=0770</td>\n</tr>\n</table>\n<pre>\n<a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> | /var/logs | newline=CRLF       |Get File With SCP (transfer) And Preserve Time\n</pre>\n<p>The remote <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing path on the remote machine, <code>source</code> directory is uploaded into it.</p>\n<p>2. If <code>destination</code> does not exist on the remote machine, it is created and the content of <code>source</code> directory is uploaded into it.</p>\n<p>3. If <code>destination</code> is not given, <code>source</code> directory is typically uploaded to user's home directory on the remote machine.</p>\n<p>See also <a href=\"#Put%20File\" class=\"name\">Put File</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Uploads a directory, including its content, from the local machine to the remote machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1767}, {"name": "Put File", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "mode", "types": [], "defaultValue": "0744", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode=0744"}, {"name": "newline", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline="}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Uploads file(s) from the local machine to the remote machine.</p>\n<p><code>source</code> is the path on the local machine. Both absolute paths and paths relative to the current working directory are supported. If the source contains wildcards explained in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, all files matching it are uploaded. In this case <code>destination</code> must always be a directory.</p>\n<p><code>destination</code> is the target path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>mode</code> can be used to set the target file permission. Numeric values are accepted. The default value is <code>0744</code> (<code>-rwxr--r--</code>). If None value is provided, setting modes will be skipped.</p>\n<p><code>newline</code> can be used to force the line break characters that are written to the remote files. Valid values are <code>LF</code> and <code>CRLF</code>. Does not work if <code>scp</code> is enabled.</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>/home/groups/robot</td>\n<td>mode=0770</td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>/home/groups/robot</td>\n<td>mode=None</td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>newline=CRLF</td>\n<td></td>\n</tr>\n</table>\n<p>The remote <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing file, <code>source</code> file is uploaded over it.</p>\n<p>2. If <code>destination</code> is an existing directory, <code>source</code> file is uploaded into it. Possible file with same name is overwritten.</p>\n<p>3. If <code>destination</code> does not exist and it ends with the <a href=\"#Path%20separator\" class=\"name\">path separator</a>, it is considered a directory. The directory is then created and <code>source</code> file uploaded into it. Possibly missing intermediate directories are also created.</p>\n<p>4. If <code>destination</code> does not exist and it does not end with the <a href=\"#Path%20separator\" class=\"name\">path separator</a>, it is considered a file. If the path to the file does not exist, it is created.</p>\n<p>5. If <code>destination</code> is not given, the user's home directory on the remote machine is used as the destination.</p>\n<p>See also <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Uploads file(s) from the local machine to the remote machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1705}, {"name": "Read", "args": [{"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "delay", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=None"}], "doc": "<p>Consumes and returns everything available on the server output.</p>\n<p>If <code>delay</code> is given, this keyword waits that amount of time and reads output again. This wait-read cycle is repeated as long as further reads return more output or the default <a href=\"#Timeout\" class=\"name\">timeout</a> expires. <code>delay</code> must be given in Robot Framework's <a href=\"#Time%20format\" class=\"name\">time format</a>.</p>\n<p>This keyword is most useful for reading everything from the server output, thus clearing it.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td>delay=0.5s</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>secretpasswd</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td>loglevel=WARN</td>\n<td># Shown in the console due to loglevel</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>root@</td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> for more information about writing and reading in general.</p>", "shortdoc": "Consumes and returns everything available on the server output.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1458}, {"name": "Read Command Output", "args": [{"name": "return_stdout", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stdout=True"}, {"name": "return_stderr", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stderr=False"}, {"name": "return_rc", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_rc=False"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Returns outputs of the most recent started command.</p>\n<p>At least one command must have been started using <a href=\"#Start%20Command\" class=\"name\">Start Command</a> before this keyword can be used.</p>\n<p>By default, only the standard output of the started command is returned:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>Arguments <code>return_stdout</code>, <code>return_stderr</code> and <code>return_rc</code> are used to specify, what is returned by this keyword. If several arguments evaluate to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), multiple values are returned.</p>\n<p>If errors are needed as well, set the argument value to true:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}</td>\n<td>${stderr}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td>return_stderr=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Empty</span></td>\n<td>${stderr}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Often checking the return code is enough:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${rc}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td>return_stdout=False</td>\n<td>return_rc=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${rc}</td>\n<td>0</td>\n<td># succeeded</td>\n</tr>\n</table>\n<p>Using <a href=\"#Start%20Command\" class=\"name\">Start Command</a> and <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> follows LIFO (last in, first out) policy, meaning that <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> operates on the most recent started command, after which that command is discarded and its output cannot be read again.</p>\n<p>If several commands have been started, the output of the last started command is returned. After that, a subsequent call will return the output of the new last (originally the second last) command:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'HELLO'</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'SECOND'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>'SECOND'</td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>'HELLO'</td>\n</tr>\n</table>\n<p>This keyword logs the read command with log level <code>INFO</code>.</p>", "shortdoc": "Returns outputs of the most recent started command.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1264}, {"name": "Read Until", "args": [{"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Consumes and returns the server output until <code>expected</code> is encountered.</p>\n<p>Text up until and including the <code>expected</code> will be returned.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>:</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>@</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should End With</span></td>\n<td>${output}</td>\n<td>root@</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>", "shortdoc": "Consumes and returns the server output until ``expected`` is encountered.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1487}, {"name": "Read Until Prompt", "args": [{"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "strip_prompt", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "strip_prompt=False"}], "doc": "<p>Consumes and returns the server output until the prompt is found.</p>\n<p>Text up and until prompt is returned. The <a href=\"#Prompt\" class=\"name\">prompt</a> must be set before this keyword is used.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>This keyword is useful for reading output of a single command when output of previous command has been read and that command does not produce prompt characters in its output.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>prompt=$</td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=#</td>\n<td># For root, the prompt is #</td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should End With</span></td>\n<td>${output}</td>\n<td>root@myserver:~#</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until\" class=\"name\">Read Until</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>\n<p>If you want to exclude the prompt from the returned output, set <code>strip_prompt</code> to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>). If your prompt is a regular expression, make sure that the expression spans the whole prompt, because only the part of the output that matches the regular expression is stripped away.</p>\n<p><code>strip_prompt</code> argument is new in SSHLibrary 3.2.0.</p>", "shortdoc": "Consumes and returns the server output until the prompt is found.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1513}, {"name": "Read Until Regexp", "args": [{"name": "regexp", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "regexp"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Consumes and returns the server output until a match to <code>regexp</code> is found.</p>\n<p><code>regexp</code> can be a regular expression pattern or a compiled regular expression object. See the <a href=\"#Regular%20expressions\" class=\"name\">Regular expressions</a> section for more details about the syntax.</p>\n<p>Text up until and including the <code>regexp</code> will be returned.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a></td>\n<td>\\\\[.*\\\\].*:</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a></td>\n<td>.*@</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>root@</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until\" class=\"name\">Read Until</a> and <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>", "shortdoc": "Consumes and returns the server output until a match to ``regexp`` is found.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1550}, {"name": "Set Client Configuration", "args": [{"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Update the <a href=\"#Configuration\" class=\"name\">configuration</a> of the current connection.</p>\n<p>Only parameters whose value is other than <code>None</code> are updated.</p>\n<p>In the following example, <a href=\"#Prompt\" class=\"name\">prompt</a> is set for the current connection. Other settings are left intact:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection    </a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td>${myserver}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${myserver.prompt}</td>\n<td>$</td>\n</tr>\n</table>\n<p>Using keyword does not affect the other connections:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=$</td>\n<td></td>\n<td># Only linux.server.com affected</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection    </a></td>\n<td>windows.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=&gt;</td>\n<td></td>\n<td># Only windows.server.com affected</td>\n</tr>\n<tr>\n<td>${linux}</td>\n<td>${windows}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${linux.prompt}</td>\n<td>$</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${windows.prompt}</td>\n<td>&gt;</td>\n<td></td>\n</tr>\n</table>\n<p>Multiple settings are possible. This example updates the <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a> of the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>term_type=ansi</td>\n<td>width=40</td>\n</tr>\n</table>\n<p><b>Note:</b> Setting <code>width</code> and <code>height</code> does not work when using Jython.</p>", "shortdoc": "Update the `configuration` of the current connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 555}, {"name": "Set Default Configuration", "args": [{"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Update the default <a href=\"#Configuration\" class=\"name\">configuration</a>.</p>\n<p>Please note that using this keyword does not affect the already opened connections. Use <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a> to configure the active connection.</p>\n<p>Only parameters whose value is other than <code>None</code> are updated.</p>\n<p>This example sets <a href=\"#Prompt\" class=\"name\">prompt</a> to <code>$</code>:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>prompt=$</td>\n</tr>\n</table>\n<p>This example sets <a href=\"#Newline\" class=\"name\">newline</a> and <a href=\"#Path%20separator\" class=\"name\">path separator</a> to the ones known by Windows:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>newline=CRLF</td>\n<td>path_separator=\\\\</td>\n</tr>\n</table>\n<p>Sometimes you might want to use longer <a href=\"#Timeout\" class=\"name\">timeout</a> for all the subsequent connections without affecting the existing ones:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>timeout=5 seconds</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection       </a></td>\n<td>local.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>timeout=20 seconds</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>emea.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>apac.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${local}</td>\n<td>${emea}</td>\n<td>${apac}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${local.timeout}</td>\n<td>5</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${emea.timeout}</td>\n<td>20</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${apac.timeout}</td>\n<td>20</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Update the default `configuration`.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 516}, {"name": "Start Command", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "sudo", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo=False"}, {"name": "sudo_password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo_password=None"}, {"name": "invoke_subsystem", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invoke_subsystem=False"}, {"name": "forward_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "forward_agent=False"}], "doc": "<p>Starts execution of the <code>command</code> on the remote machine and returns immediately.</p>\n<p>This keyword returns nothing and does not wait for the <code>command</code> execution to be finished. If waiting for the output is required, use <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> instead.</p>\n<p>This keyword does not return any output generated by the started <code>command</code>. Use <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> to read the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>The <code>command</code> is always executed in a new shell, similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>. Thus possible changes to the environment (e.g. changing working directory) are not visible to the later keywords:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>cd /tmp</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n</table>\n<p>Arguments <code>sudo</code> and <code>sudo_password</code> are used for executing commands within a sudo session. Due to different permission elevation in Cygwin, these two arguments will not when using it.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td>sudo=True</td>\n<td>sudo_password=test</td>\n</tr>\n</table>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Read\" class=\"name\">Read</a> can be used for running multiple commands in the same shell. See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> section for more information.</p>\n<p>This keyword logs the started command with log level <code>INFO</code>.</p>\n<p><code>invoke_subsystem</code> argument behaves similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> keyword.</p>\n<p><code>forward_agent</code> argument behaves similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> keyword.</p>\n<p><code>invoke_subsystem</code> is new in SSHLibrary 3.4.0.</p>", "shortdoc": "Starts execution of the ``command`` on the remote machine and returns immediately.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1210}, {"name": "Switch Connection", "args": [{"name": "index_or_alias", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias"}], "doc": "<p>Switches the active connection by index or alias.</p>\n<p><code>index_or_alias</code> is either connection index (an integer) or alias (a string). Index is got as the return value of <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>. Alternatively, both index and alias can queried as attributes of the object returned by <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a>. If there exists more connections with the same alias the keyword will switch to the last opened connection that has that alias.</p>\n<p>This keyword returns the index of the previous active connection, which can be used to switch back to that connection later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${myserver}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n<td>alias=Build</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>jenkins</td>\n<td>jenkins</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>${myserver}</td>\n<td></td>\n<td># Switch using index</td>\n</tr>\n<tr>\n<td>${username}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>whoami</td>\n<td># Executed on my.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${username}</td>\n<td>johndoe</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>Build</td>\n<td></td>\n<td># Switch using alias</td>\n</tr>\n<tr>\n<td>${username}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>whoami</td>\n<td># Executed on build.local.net</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${username}</td>\n<td>jenkins</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches the active connection by index or alias.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 700}, {"name": "Write", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Writes the given <code>text</code> on the remote machine and appends a newline.</p>\n<p>Appended <a href=\"#Newline\" class=\"name\">newline</a> can be configured.</p>\n<p>This keyword returns and consumes the written <code>text</code> (including the appended newline) from the server output. See the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section for more information.</p>\n<p>The written <code>text</code> is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${written}=</td>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>su</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${written}</td>\n<td>su</td>\n<td># Returns the consumed output</td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Not Contain</span></td>\n<td>${output}</td>\n<td>${written}</td>\n<td># Was consumed from the output</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Password:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>invalidpasswd</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su: Authentication failure</td>\n<td></td>\n</tr>\n</table>\n<p>See also <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>.</p>", "shortdoc": "Writes the given ``text`` on the remote machine and appends a newline.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1378}, {"name": "Write Bare", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Writes the given <code>text</code> on the remote machine without appending a newline.</p>\n<p>Unlike <a href=\"#Write\" class=\"name\">Write</a>, this keyword returns and consumes nothing. See the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write%20Bare\" class=\"name\">Write Bare</a></td>\n<td>su\\n</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su</td>\n<td># Was not consumed from output</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Password:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write%20Bare\" class=\"name\">Write Bare</a></td>\n<td>invalidpasswd\\n</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su: Authentication failure</td>\n<td></td>\n</tr>\n</table>\n<p>See also <a href=\"#Write\" class=\"name\">Write</a>.</p>", "shortdoc": "Writes the given ``text`` on the remote machine without appending a newline.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1405}, {"name": "Write Until Expected Output", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "timeout", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "retry_interval", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "retry_interval"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Writes the given <code>text</code> repeatedly until <code>expected</code> appears in the server output.</p>\n<p>This keyword returns nothing.</p>\n<p><code>text</code> is written without appending a newline and is consumed from the server output before <code>expected</code> is read. See more information on the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>\n<p>If <code>expected</code> does not appear in output within <code>timeout</code>, this keyword fails. <code>retry_interval</code> defines the time before writing <code>text</code> again. Both <code>timeout</code> and <code>retry_interval</code> must be given in Robot Framework's <a href=\"#Time%20format\" class=\"name\">time format</a>.</p>\n<p>The written <code>text</code> is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>This example will write <code>lsof -c python27\\n</code> (list all files currently opened by Python 2.7), until <code>myscript.py</code> appears in the output. The command is written every 0.5 seconds. The keyword fails if <code>myscript.py</code> does not appear in the server output in 5 seconds:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a></td>\n<td>lsof -c python27\\n</td>\n<td>expected=myscript.py</td>\n<td>timeout=5s</td>\n<td>retry_interval=0.5s</td>\n</tr>\n</table>", "shortdoc": "Writes the given ``text`` repeatedly until ``expected`` appears in the server output.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1430}], "dataTypes": {"enums": [], "typedDicts": []}}
+libdoc = {"name": "SSHLibrary", "doc": "<p>SSHLibrary is a Robot Framework test library for SSH and SFTP.</p>\n<p>This document explains how to use keywords provided by SSHLibrary. For information about installation, support, and more please visit the <a href=\"https://github.com/robotframework/SSHLibrary\">project page</a>. For more information about Robot Framework, see <a href=\"http://robotframework.org\">http://robotframework.org</a>.</p>\n<p>The library has the following main usages:</p>\n<ul>\n<li>Executing commands on the remote machine, either with blocking or non-blocking behaviour (see <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> and <a href=\"#Start%20Command\" class=\"name\">Start Command</a>, respectively).</li>\n<li>Writing and reading in an interactive shell (e.g. <a href=\"#Read\" class=\"name\">Read</a> and <a href=\"#Write\" class=\"name\">Write</a>).</li>\n<li>Transferring files and directories over SFTP (e.g. <a href=\"#Get%20File\" class=\"name\">Get File</a> and <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a>).</li>\n<li>Ensuring that files or directories exist on the remote machine (e.g. <a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a> and <a href=\"#Directory%20Should%20Not%20Exist\" class=\"name\">Directory Should Not Exist</a>).</li>\n</ul>\n<p>This library works both with Python and Jython, but uses different SSH modules internally depending on the interpreter. See <a href=\"http://robotframework.org/SSHLibrary/#installation\">installation instructions</a> for more details about the dependencies. IronPython is unfortunately not supported. Python 3 is supported starting from SSHLibrary 3.0.0.</p>\n<h3 id=\"Table of contents\">Table of contents</h3>\n<ul>\n<li><a href=\"#Connections%20and%20login\" class=\"name\">Connections and login</a></li>\n<li><a href=\"#Configuration\" class=\"name\">Configuration</a></li>\n<li><a href=\"#Executing%20commands\" class=\"name\">Executing commands</a></li>\n<li><a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a></li>\n<li><a href=\"#Pattern%20matching\" class=\"name\">Pattern matching</a></li>\n<li><a href=\"#Example\" class=\"name\">Example</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Time%20format\" class=\"name\">Time format</a></li>\n<li><a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a></li>\n<li><span class=\"name\">Shortcuts</span></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Connections and login\">Connections and login</h2>\n<p>SSHLibrary supports multiple connections to different hosts. New connections are opened with <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>.</p>\n<p>Login into the host is done either with username and password (<a href=\"#Login\" class=\"name\">Login</a>) or with public/private key pair (<a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public key</a>).</p>\n<p>Only one connection can be active at a time. This means that most of the keywords only affect the active connection. Active connection can be changed with <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a>.</p>\n<h2 id=\"Configuration\">Configuration</h2>\n<p>Default settings for all the upcoming connections can be configured on <a href=\"#Importing\" class=\"name\">library importing</a> or later with <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a>.</p>\n<p>Using <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a> does not affect the already open connections. Settings of the current connection can be configured with <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>. Settings of another, non-active connection, can be configured by first using <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> and then <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>.</p>\n<p>Most of the defaults can be overridden per connection by defining them as arguments to <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>. Otherwise the defaults are used.</p>\n<h3 id=\"Configurable per connection\">Configurable per connection</h3>\n<h4 id=\"Prompt\">Prompt</h4>\n<p>Argument <code>prompt</code> defines the character sequence used by <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and must be set before that keyword can be used.</p>\n<p>If you know the prompt on the remote machine, it is recommended to set it to ease reading output from the server after using <a href=\"#Write\" class=\"name\">Write</a>. In addition to that, <a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a> can read the server output more efficiently when the prompt is set.</p>\n<p>Prompt can be specified either as a normal string or as a regular expression. The latter is especially useful if the prompt changes as a result of the executed commands. Prompt can be set to be a regular expression by giving the prompt argument a value starting with <code>REGEXP:</code> followed by the actual regular expression like <code>prompt=REGEXP:[$#]</code>. See the <a href=\"#Regular%20expressions\" class=\"name\">Regular expressions</a> section for more details about the syntax.</p>\n<p>The support for regular expressions is new in SSHLibrary 3.0.0.</p>\n<h4 id=\"Encoding\">Encoding</h4>\n<p>Argument <code>encoding</code> defines the <a href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">character encoding</a> of input and output sequences. The default encoding is UTF-8.</p>\n<p>It is also possible to configure the error handler to use if encoding or decoding characters fails. Accepted values are the same that encode/decode functions in Python strings accept. In practice the following values are the most useful:</p>\n<ul>\n<li><code>ignore</code>: ignore characters that cannot be decoded</li>\n</ul>\n<ul>\n<li><code>strict</code>: fail if characters cannot be decoded</li>\n</ul>\n<ul>\n<li><code>replace</code>: replace characters that cannot be decoded with replacement character</li>\n</ul>\n<p>By default <code>encoding_errors</code> is set to <code>strict</code>. <code>encoding_errors</code> is new in SSHLibrary 3.7.0.</p>\n<h4 id=\"Path separator\">Path separator</h4>\n<p>Argument <code>path_separator</code> must be set to the one known by the operating system and the SSH server on the remote machine. The path separator is used by keywords <a href=\"#Get%20File\" class=\"name\">Get File</a>, <a href=\"#Put%20File\" class=\"name\">Put File</a>, <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a> and <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> for joining paths correctly on the remote host.</p>\n<p>The default path separator is forward slash <code>/</code> which works on Unix-like machines. On Windows the path separator to use depends on the SSH server. Some servers use forward slash and others backslash, and users need to configure the <code>path_separator</code> accordingly. Notice that using a backslash in Robot Framework test data requires doubling it like <code>\\\\</code>.</p>\n<p>The path separator can be configured on <a href=\"#Importing\" class=\"name\">library importing</a> or later, using <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a>, <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a> and <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>.</p>\n<h4 id=\"Timeout\">Timeout</h4>\n<p>Argument <code>timeout</code> is used by <a href=\"#Read%20Until\" class=\"name\">Read Until</a> variants. The default value is <code>3 seconds</code>. See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported timeout syntax.</p>\n<h4 id=\"Newline\">Newline</h4>\n<p>Argument <code>newline</code> is the line break sequence used by <a href=\"#Write\" class=\"name\">Write</a> keyword and must be set according to the operating system on the remote machine. The default value is <code>LF</code> (same as <code>\\n</code>) which is used on Unix-like operating systems. With Windows remote machines, you need to set this to <code>CRLF</code> (<code>\\r\\n</code>).</p>\n<h4 id=\"Terminal settings\">Terminal settings</h4>\n<p>Argument <code>term_type</code> defines the virtual terminal type, and arguments <code>width</code> and <code>height</code> can be used to control its  virtual size.</p>\n<h4 id=\"Escape ansi sequneces\">Escape ansi sequneces</h4>\n<p>Argument <code>escape_ansi</code> is a parameter used in order to escape ansi sequences that appear in the output when the remote machine has Windows as operating system.</p>\n<h3 id=\"Not configurable per connection\">Not configurable per connection</h3>\n<h4 id=\"Loglevel\">Loglevel</h4>\n<p>Argument <code>loglevel</code> sets the log level used to log the output read by <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>, <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a>, <a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a>. The default level is <code>INFO</code>.</p>\n<p><code>loglevel</code> is not configurable per connection but can be overridden by passing it as an argument to the most of the aforementioned keywords. Possible argument values are <code>TRACE</code>, <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code> and <code>NONE</code> (no logging).</p>\n<h2 id=\"Executing commands\">Executing commands</h2>\n<p>For executing commands on the remote machine, there are two possibilities:</p>\n<ul>\n<li><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> and <a href=\"#Start%20Command\" class=\"name\">Start Command</a>. The command is executed in a new shell on the remote machine, which means that possible changes to the environment (e.g. changing working directory, setting environment variables, etc.) are not visible to the subsequent keywords.</li>\n</ul>\n<ul>\n<li><a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a>. These keywords operate in an interactive shell, which means that changes to the environment are visible to the subsequent keywords.</li>\n</ul>\n<h2 id=\"Interactive shells\">Interactive shells</h2>\n<p><a href=\"#Write\" class=\"name\">Write</a>, <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a>, <a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> can be used to interact with the server within the same shell.</p>\n<h3 id=\"Consumed output\">Consumed output</h3>\n<p>All of these keywords, except <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>, consume the read or the written text from the server output before returning. In practice this means that the text is removed from the server output, i.e. subsequent calls to <a href=\"#Read\" class=\"name\">Read</a> keywords do not return text that was already read. This is illustrated by the example below.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>echo hello</td>\n<td></td>\n<td># Consumes written <code>echo hello</code></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>hello</td>\n<td># Consumes read <code>hello</code> and everything before it</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>hello</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td># Consumes everything available</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Not Contain</span></td>\n<td>${stdout}</td>\n<td>hello</td>\n<td># <code>hello</code> was already consumed earlier</td>\n</tr>\n</table>\n<p>The consumed text is logged by the keywords and their argument <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p><a href=\"#Login\" class=\"name\">Login</a> and <a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a> consume everything on the server output or if the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt.</p>\n<h3 id=\"Reading\">Reading</h3>\n<p><a href=\"#Read\" class=\"name\">Read</a>, <a href=\"#Read%20Until\" class=\"name\">Read Until</a>, <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> can be used to read from the server. The read text is also consumed from the server output.</p>\n<p><a href=\"#Read\" class=\"name\">Read</a> reads everything available on the server output, thus clearing it.</p>\n<p><a href=\"#Read%20Until\" class=\"name\">Read Until</a> variants read output up until and <b>including</b> <code>expected</code> text. These keywords will fail if the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before <code>expected</code> is found.</p>\n<h3 id=\"Writing\">Writing</h3>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a> consume the written text from the server output while <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a> does not.</p>\n<p>These keywords do not return any output triggered by the written text. To get the output, one of the <a href=\"#Read\" class=\"name\">Read</a> keywords must be explicitly used.</p>\n<h2 id=\"Pattern matching\">Pattern matching</h2>\n<h3 id=\"Glob patterns\">Glob patterns</h3>\n<p>Some keywords allow their arguments to be specified as <i>glob patterns</i> where:</p>\n<table border=\"1\">\n<tr>\n<td>*</td>\n<td>matches anything, even an empty string</td>\n</tr>\n<tr>\n<td>?</td>\n<td>matches any single character</td>\n</tr>\n<tr>\n<td>[chars]</td>\n<td>matches any character inside square brackets (e.g. <code>[abc]</code> matches either <code>a</code>, <code>b</code> or <code>c</code>)</td>\n</tr>\n<tr>\n<td>[!chars]</td>\n<td>matches any character not inside square brackets</td>\n</tr>\n</table>\n<p>Pattern matching is case-sensitive regardless the local or remote operating system. Matching is implemented using Python's <a href=\"https://docs.python.org/3/library/fnmatch.html\">fnmatch module</a>.</p>\n<h3 id=\"Regular expressions\">Regular expressions</h3>\n<p>Some keywords support pattern matching using regular expressions, which are more powerful but also more complicated than <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>. This library uses Python's regular expressions, which are introduced in the <a href=\"https://docs.python.org/3/howto/regex.html\">Regular Expression HOWTO</a>.</p>\n<p>Remember that in Robot Framework data the backslash that is used a lot in regular expressions is an escape character and needs to be doubled to get a literal backslash. For example, <code>\\\\d\\\\d\\\\s</code> matches two digits followed by a whitespace character.</p>\n<p>Possible flags altering how the expression is parsed (e.g. <code>re.IGNORECASE</code>, <code>re.MULTILINE</code>) can be set by prefixing the pattern with the <code>(?iLmsux)</code> group. The available flags are <code>IGNORECASE</code>: <code>i</code>, <code>MULTILINE</code>: <code>m</code>, <code>DOTALL</code>: <code>s</code>, <code>VERBOSE</code>: <code>x</code>, <code>UNICODE</code>: <code>u</code>, and <code>LOCALE</code>: <code>L</code>. For example, <code>(?is)pat.ern</code> uses <code>IGNORECASE</code> and <code>DOTALL</code> flags.</p>\n<h2 id=\"Example\">Example</h2>\n<pre>\n<b>***</b> Settings <b>***</b>\nDocumentation          This example demonstrates executing commands on a remote machine\n...                    and getting their output and the return code.\n...\n...                    Notice how connections are handled as part of the suite setup and\n...                    teardown. This saves some time when executing several test cases.\n\nLibrary                <span class=\"name\">SSHLibrary</span>\nSuite Setup            <span class=\"name\">Open Connection And Log In</span>\nSuite Teardown         <a href=\"#Close%20All%20Connections\" class=\"name\">Close All Connections</a>\n\n<b>***</b> Variables <b>***</b>\n${HOST}                localhost\n${USERNAME}            test\n${PASSWORD}            test\n\n<b>***</b> Test Cases <b>***</b>\nExecute Command And Verify Output\n    [Documentation]    Execute Command can be used to ran commands on the remote machine.\n    ...                The keyword returns the standard output by default.\n    ${output}=         <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>  echo Hello SSHLibrary!\n    <span class=\"name\">Should Be Equal</span>    ${output}        Hello SSHLibrary!\n\nExecute Command And Verify Return Code\n    [Documentation]    Often getting the return code of the command is enough.\n    ...                This behaviour can be adjusted as Execute Command arguments.\n    ${rc}=             <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>  echo Success guaranteed.    return_stdout=False    return_rc=True\n    <span class=\"name\">Should Be Equal</span>    ${rc}            ${0}\n\nExecuting Commands In An Interactive Session\n    [Documentation]    Execute Command always executes the command in a new shell.\n    ...                This means that changes to the environment are not persisted\n    ...                between subsequent Execute Command keyword calls.\n    ...                Write and Read Until variants can be used to operate in the same shell.\n    <a href=\"#Write\" class=\"name\">Write</a>              cd ..\n    <a href=\"#Write\" class=\"name\">Write</a>              echo Hello from the parent directory!\n    ${output}=         <a href=\"#Read%20Until\" class=\"name\">Read Until</a>       directory!\n    <span class=\"name\">Should End With</span>    ${output}        Hello from the parent directory!\n\n<b>***</b> Keywords <b>***</b>\nOpen Connection And Log In\n   <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>     ${HOST}\n   <a href=\"#Login\" class=\"name\">Login</a>               ${USERNAME}        ${PASSWORD}\n</pre>\n<p>Save the content as file <code>executing_command.txt</code> and run:</p>\n<p><code>robot executing_commands.txt</code></p>\n<p>You may want to override the variables from commandline to try this out on your remote machine:</p>\n<p><code>robot -v HOST:my.server.com -v USERNAME:johndoe -v PASSWORD:secretpasswd executing_commands.txt</code></p>\n<h3 id=\"Time format\">Time format</h3>\n<p>All timeouts, delays or retry intervals can be given as numbers considered seconds (e.g. <code>0.5</code> or <code>42</code>) or in Robot Framework's time syntax (e.g. <code>1.5 seconds</code> or <code>1 min 30 s</code>). For more information about the time syntax see the <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework User Guide</a>.</p>\n<h2 id=\"Boolean arguments\">Boolean arguments</h2>\n<p>Some keywords accept arguments that are handled as Boolean values true or false. If such an argument is given as a string, it is considered false if it is either an empty string or case-insensitively equal to <code>false</code>, <code>none</code> or <code>no</code>. Other strings are considered true regardless their value, and other argument types are tested using the same <a href=\"http://docs.python.org/2/library/stdtypes.html#truth-value-testing\">rules as in Python</a>.</p>\n<p>True examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=True</td>\n<td># Strings are generally true.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=yes</td>\n<td># Same as the above.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${TRUE}</td>\n<td># Python <code>True</code> is true.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${42}</td>\n<td># Numbers other than 0 are true.</td>\n</tr>\n</table>\n<p>False examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=False</td>\n<td># String <code>false</code> is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=no</td>\n<td># Also string <code>no</code> is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${EMPTY}</td>\n<td># Empty string is false.</td>\n</tr>\n<tr>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>${path}</td>\n<td>recursive=${FALSE}</td>\n<td># Python <code>False</code> is false.</td>\n</tr>\n</table>\n<p>Prior to SSHLibrary 3.1.0, all non-empty strings, including <code>no</code> and <code>none</code> were considered to be true. Considering <code>none</code> false is new in Robot Framework 3.0.3.</p>\n<h2 id=\"Transfer files with SCP\">Transfer files with SCP</h2>\n<p>Secure Copy Protocol (SCP) is a way of secure transfer of files between hosts. It is based on SSH protocol. The advantage it brings over SFTP is transfer speed. SFTP however can also be used for directory listings and even editing files while transferring. SCP can be enabled on keywords used for file transfer: <a href=\"#Get%20File\" class=\"name\">Get File</a>, <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a>, <a href=\"#Put%20File\" class=\"name\">Put File</a>, <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> by setting the <code>scp</code> value to <code>TRANSFER</code> or <code>ALL</code>.</p>\n<table border=\"1\">\n<tr>\n<td>OFF</td>\n<td>Transfer is done using SFTP only. This is the default value</td>\n</tr>\n<tr>\n<td>TRANSFER</td>\n<td>Directory listings (needed for logging) will be done using SFTP. Actual file transfer is done with SCP.</td>\n</tr>\n<tr>\n<td>ALL</td>\n<td>Only SCP is used for file transfer. No logging available.</td>\n</tr>\n</table>\n<p>There are some limitations to the current SCP implementation::</p>\n<ul>\n<li>When using SCP, files cannot be altered during transfer and <code>newline</code> argument does not work.</li>\n<li>If <code>scp=ALL</code> only <code>source</code> and <code>destination</code> arguments will work on the keywords. The directories are transferred recursively. Also, when running with Jython <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> and <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a> won't work due to current Trilead implementation.</li>\n<li>If running with Jython you can encounter some encoding issues when transferring files with non-ascii characters.</li>\n</ul>\n<p>SCP transfer was introduced in SSHLibrary 3.3.0.</p>\n<h3 id=\"Preserving original times\">Preserving original times</h3>\n<p>SCP allows some configuration when transferring files and directories. One of this configuration is whether to preserve the original modify time and access time of transferred files and directories. This is done using the <code>scp_preserve_times</code> argument. This argument works only when <code>scp</code> argument is set to <code>TRANSFER</code> or <code>ALL</code>. When moving directory with <code>scp</code> set to <code>TRANSFER</code> and <code>scp_preserve_times</code> is enabled only the files inside the director will keep their original timestamps. Also, when running with Jython <code>scp_preserve_times</code> won't work due to current current Trilead implementation.</p>\n<p><code>scp_preserve_times</code> was introduced in SSHLibrary 3.6.0.</p>\n<h2 id=\"Aliases\">Aliases</h2>\n<p>SSHLibrary allows the use of an alias when opening a new connection using the parameter <code>alias</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>alias=connection1</td>\n</tr>\n</table>\n<p>These aliases can later be used with other keywords like  <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a> or <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> in order to get information respectively to switch to a certain connection that has that alias.</p>\n<p>When a connection is closed, it is no longer possible to switch or get information about the other connections that have the same alias as the closed one. If the same <code>alias</code> is used for more connections, keywords <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> and <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a> will switch/get information only about the last opened connection with that <code>alias</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=conn2</td>\n</tr>\n<tr>\n<td>${conn_info}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>conn</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${conn_info.index}</td>\n<td>2</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n<td></td>\n</tr>\n<tr>\n<td>${current_conn}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>conn</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${current_conn.index}</td>\n<td>2</td>\n</tr>\n</table>\n<p>Note that if a connection that has the same alias as other connections is closed trying to switch or get information about the other connections that have the same alias is impossible.</p>\n<table border=\"1\">\n<tr>\n<td>'Open Connection`</td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n<td></td>\n</tr>\n<tr>\n<td>'Open Connection`</td>\n<td>my.server.com</td>\n<td>alias=conn</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Close%20Connection\" class=\"name\">Close Connection</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Run Keyword And Expect Error</span></td>\n<td>Non-existing index or alias 'conn'.</td>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>conn</td>\n</tr>\n</table>", "version": "3.8.0rc1", "generated": "2021-11-05 14:26:40", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/__init__.py", "lineno": 37, "tags": [], "inits": [{"name": "Init", "args": [{"name": "timeout", "types": [], "defaultValue": "3 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=3 seconds"}, {"name": "newline", "types": [], "defaultValue": "LF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=LF"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "loglevel", "types": [], "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=INFO"}, {"name": "term_type", "types": [], "defaultValue": "vt100", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=vt100"}, {"name": "width", "types": [], "defaultValue": "80", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=80"}, {"name": "height", "types": [], "defaultValue": "24", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=24"}, {"name": "path_separator", "types": [], "defaultValue": "/", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=/"}, {"name": "encoding", "types": [], "defaultValue": "UTF-8", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=UTF-8"}, {"name": "escape_ansi", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=False"}, {"name": "encoding_errors", "types": [], "defaultValue": "strict", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=strict"}], "doc": "<p>SSHLibrary allows some import time <a href=\"#Configuration\" class=\"name\">configuration</a>.</p>\n<p>If the library is imported without any arguments, the library defaults are used:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n</tr>\n</table>\n<p>Only arguments that are given are changed. In this example the <a href=\"#Timeout\" class=\"name\">timeout</a> is changed to <code>10 seconds</code> but  other settings are left to the library defaults:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>10 seconds</td>\n</tr>\n</table>\n<p>The <a href=\"#Prompt\" class=\"name\">prompt</a> does not have a default value and must be explicitly set to be able to use <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>. Since SSHLibrary 3.0.0, the prompt can also be a regular expression:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>prompt=REGEXP:[$#]</td>\n</tr>\n</table>\n<p>Multiple settings are also possible. In the example below, the library is brought into use with <a href=\"#Newline\" class=\"name\">newline</a> and <a href=\"#Path%20separator\" class=\"name\">path separator</a> known by Windows:</p>\n<table border=\"1\">\n<tr>\n<td>Library</td>\n<td>SSHLibrary</td>\n<td>newline=CRLF</td>\n<td>path_separator=\\\\</td>\n</tr>\n</table>", "shortdoc": "SSHLibrary allows some import time `configuration`.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 458}], "keywords": [{"name": "Close All Connections", "args": [], "doc": "<p>Closes all open connections.</p>\n<p>This keyword is ought to be used either in test or suite teardown to make sure all the connections are closed before the test execution finishes.</p>\n<p>After this keyword, the connection indices returned by <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a> are reset and start from <code>1</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n</tr>\n<tr>\n<td># Do something with the connections</td>\n<td></td>\n</tr>\n<tr>\n<td>[Teardown]</td>\n<td><a href=\"#Close%20All%20Connections\" class=\"name\">Close all connections</a></td>\n</tr>\n</table>", "shortdoc": "Closes all open connections.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 749}, {"name": "Close Connection", "args": [], "doc": "<p>Closes the current connection.</p>\n<p>No other connection is made active by this keyword. Manually use <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> to switch to another connection.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>results.txt</td>\n<td>/tmp</td>\n</tr>\n<tr>\n<td><a href=\"#Close%20Connection\" class=\"name\">Close Connection</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># Do something with /tmp/results.txt</td>\n<td></td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Closes the current connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 732}, {"name": "Create Local Ssh Tunnel", "args": [{"name": "local_port", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "local_port"}, {"name": "remote_host", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "remote_host"}, {"name": "remote_port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remote_port=22"}, {"name": "bind_address", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "bind_address=None"}], "doc": "<p>The keyword uses the existing connection to set up local port forwarding (the openssh -L option) from a local port through a tunneled connection to a destination reachable from the SSH server machine.</p>\n<p>The example below illustrates the forwarding from the local machine, of the connection on port 80 of an inaccessible server (secure.server.com) by connecting to a remote SSH server (remote.server.com) that has access to the secure server, and makes it available locally, on the port 9191:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>remote.server.com</td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Local%20Ssh%20Tunnel\" class=\"name\">Create Local SSH Tunnel</a></td>\n<td>9191</td>\n<td>secure.server.com</td>\n<td>80</td>\n</tr>\n</table>\n<p>The tunnel is active as long as the connection is open.</p>\n<p>The default <code>remote_port</code> is 22.</p>\n<p>By default, anyone can connect on the specified port on the SSH client because the local machine listens on all interfaces. Access can be restricted by specifying a <code>bind_address</code>. Setting <code>bind_address</code> does not work with Jython.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Create%20Local%20Ssh%20Tunnel\" class=\"name\">Create Local SSH Tunnel</a></td>\n<td>9191</td>\n<td>secure.server.com</td>\n<td>80</td>\n<td>bind_address=127.0.0.1</td>\n</tr>\n</table>\n<p><code>bind_address</code> is new in SSHLibrary 3.3.0.</p>", "shortdoc": "The keyword uses the existing connection to set up local port forwarding (the openssh -L option) from a local port through a tunneled connection to a destination reachable from the SSH server machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1322}, {"name": "Directory Should Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> does not point to an existing directory.</p>\n<p>Supports wildcard expansions described in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, but only on the current directory.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Exist\" class=\"name\">Directory Should Exist</a></td>\n<td>/usr/share/man</td>\n</tr>\n<tr>\n<td><a href=\"#Directory%20Should%20Exist\" class=\"name\">Directory Should Exist</a></td>\n<td>/usr/share/*</td>\n</tr>\n</table>\n<p>Note that symlinks are followed:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Exist\" class=\"name\">Directory Should Exist</a></td>\n<td>/usr/local/man</td>\n<td># Points to /usr/share/man/</td>\n</tr>\n</table>", "shortdoc": "Fails if the given ``path`` does not point to an existing directory.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1863}, {"name": "Directory Should Not Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> points to an existing directory.</p>\n<p>Supports wildcard expansions described in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, but only on the current directory.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Directory%20Should%20Not%20Exist\" class=\"name\">Directory Should Not Exist</a></td>\n<td>/non/existing</td>\n</tr>\n<tr>\n<td><a href=\"#Directory%20Should%20Not%20Exist\" class=\"name\">Directory Should Not Exist</a></td>\n<td>/non/*</td>\n</tr>\n</table>\n<p>Note that this keyword follows symlinks. Thus the example fails if <code>/non/existing</code> is a link that points to an existing directory.</p>", "shortdoc": "Fails if the given ``path`` points to an existing directory.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1878}, {"name": "Enable Ssh Logging", "args": [{"name": "logfile", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "logfile"}], "doc": "<p>Enables logging of SSH protocol output to given <code>logfile</code>.</p>\n<p>All the existing and upcoming connections are logged onwards from the moment the keyword was called.</p>\n<p><code>logfile</code> is path to a file that is writable by the current local user. If the file already exists, it will be overwritten.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td># Not logged</td>\n</tr>\n<tr>\n<td><a href=\"#Enable%20Ssh%20Logging\" class=\"name\">Enable SSH Logging</a></td>\n<td>myserver.log</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n<td># Logged</td>\n</tr>\n<tr>\n<td># Do something with the connections</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td># Check myserver.log for detailed debug information</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p><b>Note:</b> This keyword does not work when using Jython.</p>", "shortdoc": "Enables logging of SSH protocol output to given ``logfile``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 595}, {"name": "Execute Command", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "return_stdout", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stdout=True"}, {"name": "return_stderr", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stderr=False"}, {"name": "return_rc", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_rc=False"}, {"name": "sudo", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo=False"}, {"name": "sudo_password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo_password=None"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "output_during_execution", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "output_during_execution=False"}, {"name": "output_if_timeout", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "output_if_timeout=False"}, {"name": "invoke_subsystem", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invoke_subsystem=False"}, {"name": "forward_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "forward_agent=False"}], "doc": "<p>Executes <code>command</code> on the remote machine and returns its outputs.</p>\n<p>This keyword executes the <code>command</code> and returns after the execution has been finished. Use <a href=\"#Start%20Command\" class=\"name\">Start Command</a> if the command should be started in the background.</p>\n<p>By default, only the standard output is returned:</p>\n<table border=\"1\">\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>Arguments <code>return_stdout</code>, <code>return_stderr</code> and <code>return_rc</code> are used to specify, what is returned by this keyword. If several arguments evaluate to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), multiple values are returned.</p>\n<p>If errors are needed as well, set the respective argument value to true:</p>\n<table border=\"1\">\n<tr>\n<td>${stdout}</td>\n<td>${stderr}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n<td>return_stderr=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Empty</span></td>\n<td>${stderr}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Often checking the return code is enough:</p>\n<table border=\"1\">\n<tr>\n<td>${rc}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>echo 'Hello John!'</td>\n<td>return_stdout=False</td>\n<td>return_rc=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${rc}</td>\n<td>0</td>\n<td># succeeded</td>\n<td></td>\n</tr>\n</table>\n<p>Arguments <code>sudo</code> and <code>sudo_password</code> are used for executing commands within a sudo session. Due to different permission elevation in Cygwin, these two arguments will not work when using it.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n<td>sudo=True</td>\n<td>sudo_password=test</td>\n</tr>\n</table>\n<p>The <code>command</code> is always executed in a new shell. Thus possible changes to the environment (e.g. changing working directory) are not visible to the later keywords:</p>\n<table border=\"1\">\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>cd /tmp</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>pwd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n</table>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Read\" class=\"name\">Read</a> can be used for running multiple commands in the same shell. See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> section for more information.</p>\n<p>This keyword logs the executed command and its exit status with log level <code>INFO</code>.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the command is executed, this keyword fails.</p>\n<p><code>invoke_subsystem</code> will request a subsystem on the server, given by the <code>command</code> argument. If the server allows it, the channel will then be directly connected to the requested subsystem.</p>\n<p><code>forward_agent</code> determines whether to forward the local SSH Agent process to the process being executed. This assumes that there is an agent in use (i.e. <span class=\"name\">eval $(ssh-agent)</span>). Setting <code>forward_agent</code> does not work with Jython.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>ssh-add -L</td>\n<td>forward_agent=True</td>\n</tr>\n</table>\n<p><code>invoke_subsystem</code> and <code>forward_agent</code> are new in SSHLibrary 3.4.0.</p>\n<p><code>output_during_execution</code> enable logging the output of the command as it is generated, into the console.</p>\n<p><code>output_if_timeout</code> if the executed command doesn't end before reaching timeout, the parameter will log the output of the command at the moment of timeout.</p>\n<p><code>output_during_execution</code> and <code>output_if_timeout</code> are not working with Jython. New in SSHLibrary 3.5.0.</p>", "shortdoc": "Executes ``command`` on the remote machine and returns its outputs.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1127}, {"name": "File Should Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> does NOT point to an existing file.</p>\n<p>Supports wildcard expansions described in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a></td>\n<td>/boot/initrd.img</td>\n</tr>\n<tr>\n<td><a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a></td>\n<td>/boot/*.img</td>\n</tr>\n</table>\n<p>Note that symlinks are followed:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Exist\" class=\"name\">File Should Exist</a></td>\n<td>/initrd.img</td>\n<td># Points to /boot/initrd.img</td>\n</tr>\n</table>", "shortdoc": "Fails if the given ``path`` does NOT point to an existing file.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1833}, {"name": "File Should Not Exist", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}], "doc": "<p>Fails if the given <code>path</code> points to an existing file.</p>\n<p>Supports wildcard expansions described in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#File%20Should%20Not%20Exist\" class=\"name\">File Should Not Exist</a></td>\n<td>/non/existing</td>\n</tr>\n<tr>\n<td><a href=\"#File%20Should%20Not%20Exist\" class=\"name\">File Should Not Exist</a></td>\n<td>/non/*</td>\n</tr>\n</table>\n<p>Note that this keyword follows symlinks. Thus the example fails if <code>/non/existing</code> is a link that points an existing file.</p>", "shortdoc": "Fails if the given ``path`` points to an existing file.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1848}, {"name": "Get Connection", "args": [{"name": "index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index_or_alias=None"}, {"name": "index", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "index=False"}, {"name": "host", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=False"}, {"name": "alias", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=False"}, {"name": "port", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=False"}, {"name": "timeout", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=False"}, {"name": "newline", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=False"}, {"name": "prompt", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=False"}, {"name": "term_type", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=False"}, {"name": "width", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=False"}, {"name": "height", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=False"}, {"name": "encoding", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=False"}, {"name": "escape_ansi", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=False"}], "doc": "<p>Returns information about the connection.</p>\n<p>Connection is not changed by this keyword, use <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> to change the active connection.</p>\n<p>If <code>index_or_alias</code> is not given, the information of the current connection is returned. If there exists more connections with the same alias the keyword will return last opened connection that has that alias.</p>\n<p>This keyword returns an object that has the following attributes:</p>\n<table border=\"1\">\n<tr>\n<th>Name</th>\n<th>Type</th>\n<th>Explanation</th>\n</tr>\n<tr>\n<td>index</td>\n<td>integer</td>\n<td>Number of the connection. Numbering starts from <code>1</code>.</td>\n</tr>\n<tr>\n<td>host</td>\n<td>string</td>\n<td>Destination hostname.</td>\n</tr>\n<tr>\n<td>alias</td>\n<td>string</td>\n<td>An optional alias given when creating the connection.</td>\n</tr>\n<tr>\n<td>port</td>\n<td>integer</td>\n<td>Destination port.</td>\n</tr>\n<tr>\n<td>timeout</td>\n<td>string</td>\n<td><a href=\"#Timeout\" class=\"name\">Timeout</a> length in textual representation.</td>\n</tr>\n<tr>\n<td>newline</td>\n<td>string</td>\n<td>The line break sequence used by <a href=\"#Write\" class=\"name\">Write</a> keyword. See <a href=\"#Newline\" class=\"name\">newline</a>.</td>\n</tr>\n<tr>\n<td>prompt</td>\n<td>string</td>\n<td><a href=\"#Prompt\" class=\"name\">Prompt</a> character sequence for <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a>.</td>\n</tr>\n<tr>\n<td>term_type</td>\n<td>string</td>\n<td>Type of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>width</td>\n<td>integer</td>\n<td>Width of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>height</td>\n<td>integer</td>\n<td>Height of the virtual terminal. See <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a>.</td>\n</tr>\n<tr>\n<td>path_separator</td>\n<td>string</td>\n<td>The <a href=\"#Path%20separator\" class=\"name\">path separator</a> used on the remote host.</td>\n</tr>\n<tr>\n<td>encoding</td>\n<td>string</td>\n<td>The <a href=\"#Encoding\" class=\"name\">encoding</a> used for inputs and outputs.</td>\n</tr>\n</table>\n<p>If there is no connection, an object having <code>index</code> and <code>host</code> as <code>None</code> is returned, rest of its attributes having their values as configuration defaults.</p>\n<p>If you want the information for all the open connections, use <a href=\"#Get%20Connections\" class=\"name\">Get Connections</a>.</p>\n<p>Getting connection information of the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td>prompt=&gt;&gt;</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${nearhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.host}</td>\n<td>near.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.index}</td>\n<td>2</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.prompt}</td>\n<td>&gt;&gt;</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.term_type}</td>\n<td>vt100</td>\n<td># From defaults</td>\n</tr>\n</table>\n<p>Getting connection information using an index:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>1</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.host}</td>\n<td>far.server.com</td>\n</tr>\n</table>\n<p>Getting connection information using an alias:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td>alias=far</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td># Current connection</td>\n</tr>\n<tr>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>far</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.host}</td>\n<td>far.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${farhost.alias}</td>\n<td>far</td>\n</tr>\n</table>\n<p>This keyword can also return plain connection attributes instead of the whole connection object. This can be adjusted using the boolean arguments <code>index</code>, <code>host</code>, <code>alias</code>, and so on, that correspond to the attribute names of the object. If such arguments are given, and they evaluate to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), only the respective connection attributes are returned. Note that attributes are always returned in the same order arguments are specified in the signature.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=example</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${host}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>host=True</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${host}</td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${host}</td>\n<td>${alias}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td>host=yes</td>\n<td>alias=please</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${host}</td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${alias}</td>\n<td>example</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Getting only certain attributes is especially useful when using this library via the Remote library interface. This interface does not support returning custom objects, but individual attributes can be returned just fine.</p>\n<p>This keyword logs the connection information with log level <code>INFO</code>.</p>", "shortdoc": "Returns information about the connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 767}, {"name": "Get Connections", "args": [], "doc": "<p>Returns information about all the open connections.</p>\n<p>This keyword returns a list of objects that are identical to the ones returned by <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>near.server.com</td>\n<td>timeout=10s</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>far.server.com</td>\n<td>timeout=5s</td>\n</tr>\n<tr>\n<td>${nearhost}</td>\n<td>${farhost}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${nearhost.host}</td>\n<td>near.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${nearhost.timeout}</td>\n<td>10</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${farhost.port}</td>\n<td>22</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${farhost.timeout}</td>\n<td>5</td>\n</tr>\n</table>\n<p>This keyword logs the information of connections with log level <code>INFO</code>.</p>", "shortdoc": "Returns information about all the open connections.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 916}, {"name": "Get Directory", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "recursive", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursive=False"}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Downloads a directory, including its content, from the remote machine to the local machine.</p>\n<p><code>source</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>destination</code> is the target path on the local machine.  Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>recursive</code> specifies whether to recursively download all subdirectories inside <code>source</code>. Subdirectories are downloaded if the argument value evaluates to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>).</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp/non/existing</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Get%20Directory\" class=\"name\">Get Directory</a></td>\n<td>/var/logs</td>\n<td>recursive=True</td>\n</tr>\n</table>\n<p>The local <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing path on the local machine, <code>source</code> directory is downloaded into it.</p>\n<p>2. If <code>destination</code> does not exist on the local machine, it is created and the content of <code>source</code> directory is downloaded into it.</p>\n<p>3. If <code>destination</code> is not given, <code>source</code> directory is downloaded into the current working directory on the local &lt;machine. This is typically the directory where the test execution was started and thus accessible using the built-in <code>${EXECDIR}</code> variable.</p>\n<p>See also <a href=\"#Get%20File\" class=\"name\">Get File</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Downloads a directory, including its content, from the remote machine to the local machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1656}, {"name": "Get File", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Downloads file(s) from the remote machine to the local machine.</p>\n<p><code>source</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported. If the source contains wildcards explained in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, all files matching it are downloaded. In this case <code>destination</code> must always be a directory.</p>\n<p><code>destination</code> is the target path on the local machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/var/log/auth.log</td>\n<td>/tmp/</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/tmp/example.txt</td>\n<td>C:\\\\temp\\\\new_name.txt</td>\n</tr>\n<tr>\n<td><a href=\"#Get%20File\" class=\"name\">Get File</a></td>\n<td>/path/to/*.txt</td>\n<td></td>\n</tr>\n</table>\n<p>The local <code>destination</code> is created using the rules explained below:</p>\n<p>1. If the <code>destination</code> is an existing file, the <code>source</code> file is downloaded over it.</p>\n<p>2. If the <code>destination</code> is an existing directory, the <code>source</code> file is downloaded into it. Possible file with the same name is overwritten.</p>\n<p>3. If the <code>destination</code> does not exist and it ends with the path separator of the local operating system, it is considered a directory. The directory is then created and the <code>source</code> file is downloaded into it. Possible missing intermediate directories are also created.</p>\n<p>4. If the <code>destination</code> does not exist and does not end with the local path separator, it is considered a file. The <code>source</code> file is downloaded and saved using that file name, and possible missing intermediate directories are also created.</p>\n<p>5. If <code>destination</code> is not given, the current working directory on the local machine is used as the destination. This is typically the directory where the test execution was started and thus accessible using built-in <code>${EXECDIR}</code> variable.</p>\n<p>See also <a href=\"#Get%20Directory\" class=\"name\">Get Directory</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Downloads file(s) from the remote machine to the local machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1600}, {"name": "Get Pre Login Banner", "args": [{"name": "host", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "host=None"}, {"name": "port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=22"}], "doc": "<p>Returns the banner supplied by the server upon connect.</p>\n<p>There are 2 ways of getting banner information.</p>\n<p>1. Independent of any connection:</p>\n<table border=\"1\">\n<tr>\n<td>${banner} =</td>\n<td><a href=\"#Get%20Pre%20Login%20Banner\" class=\"name\">Get Pre Login Banner</a></td>\n<td>${HOST}</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${banner}</td>\n<td>Testing pre-login banner</td>\n</tr>\n</table>\n<p>The argument <code>host</code> is mandatory for getting banner key without an open connection.</p>\n<p>2. From the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>${HOST}</td>\n<td>prompt=${PROMPT}</td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>${USERNAME}</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td>${banner} =</td>\n<td><a href=\"#Get%20Pre%20Login%20Banner\" class=\"name\">Get Pre Login Banner</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${banner}</td>\n<td>Testing pre-login banner</td>\n</tr>\n</table>\n<p>New in SSHLibrary 3.0.0.</p>\n<p><b>Note:</b> This keyword does not work when using Jython.</p>", "shortdoc": "Returns the banner supplied by the server upon connect.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1095}, {"name": "List Directories In Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>A wrapper for <a href=\"#List%20Directory\" class=\"name\">List Directory</a> that returns only directories.</p>", "shortdoc": "A wrapper for `List Directory` that returns only directories.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1942}, {"name": "List Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>Returns and logs items in the remote <code>path</code>, optionally filtered with <code>pattern</code>.</p>\n<p><code>path</code> is a path on the remote machine. Both absolute paths and paths relative to the current working directory are supported. If <code>path</code> is a symlink, it is followed.</p>\n<p>Item names are returned in case-sensitive alphabetical order, e.g. <code>['A Name', 'Second', 'a lower case name', 'one more']</code>. Implicit directories <code>.</code> and <code>..</code> are not returned. The returned items are automatically logged.</p>\n<p>By default, the item names are returned relative to the given remote path (e.g. <code>file.txt</code>). If you want them be returned in the absolute format (e.g. <code>/home/johndoe/file.txt</code>), set the <code>absolute</code> argument to any non-empty string.</p>\n<p>If <code>pattern</code> is given, only items matching it are returned. The pattern is a glob pattern and its syntax is explained in the <a href=\"#Pattern%20matching\" class=\"name\">Pattern matching</a> section.</p>\n<p>Examples (using also other <a href=\"#List%20Directory\" class=\"name\">List Directory</a> variants):</p>\n<table border=\"1\">\n<tr>\n<td>@{items}=</td>\n<td><a href=\"#List%20Directory\" class=\"name\">List Directory</a></td>\n<td>/home/johndoe</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>@{files}=</td>\n<td><a href=\"#List%20Files%20In%20Directory\" class=\"name\">List Files In Directory</a></td>\n<td>/tmp</td>\n<td>*.txt</td>\n<td>absolute=True</td>\n</tr>\n</table>\n<p>If you are only interested in directories or files, use <a href=\"#List%20Files%20In%20Directory\" class=\"name\">List Files In Directory</a> or <a href=\"#List%20Directories%20In%20Directory\" class=\"name\">List Directories In Directory</a>, respectively.</p>", "shortdoc": "Returns and logs items in the remote ``path``, optionally filtered with ``pattern``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1893}, {"name": "List Files In Directory", "args": [{"name": "path", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path"}, {"name": "pattern", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "pattern=None"}, {"name": "absolute", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "absolute=False"}], "doc": "<p>A wrapper for <a href=\"#List%20Directory\" class=\"name\">List Directory</a> that returns only files.</p>", "shortdoc": "A wrapper for `List Directory` that returns only files.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1930}, {"name": "Login", "args": [{"name": "username", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username=None"}, {"name": "password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password=None"}, {"name": "allow_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "allow_agent=False"}, {"name": "look_for_keys", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "look_for_keys=False"}, {"name": "delay", "types": [], "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0.5 seconds"}, {"name": "proxy_cmd", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy_cmd=None"}, {"name": "read_config", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "read_config=False"}, {"name": "jumphost_index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jumphost_index_or_alias=None"}, {"name": "keep_alive_interval", "types": [], "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keep_alive_interval=0 seconds"}], "doc": "<p>Logs into the SSH server with the given <code>username</code> and <code>password</code>.</p>\n<p>Connection must be opened before using this keyword.</p>\n<p>This keyword reads, returns and logs the server output after logging in. If the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt is read. Otherwise the output is read using the <a href=\"#Read\" class=\"name\">Read</a> keyword with the given <code>delay</code>. The output is logged using the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p><code>proxy_cmd</code> is used to connect through a SSH proxy.</p>\n<p><code>jumphost_index_or_alias</code> is used to connect through an intermediary SSH connection that has been assigned an Index or Alias. Note that this requires a Connection that has been logged in prior to use.</p>\n<p><b>Note:</b> <code>proxy_cmd</code> and <code>jumphost_index_or_alias</code> are mutually exclusive SSH features. If you wish to use them both, create the jump-host's Connection using the proxy_cmd first, then use jump-host for secondary Connection.</p>\n<p><code>allow_agent</code> enables the connection to the SSH agent.</p>\n<p><code>look_for_keys</code> enables the searching for discoverable private key files in <code>~/.ssh/</code>.</p>\n<p><code>read_config</code> reads or ignores entries from <code>~/.ssh/config</code> file. This parameter will read the hostname, port number, username and proxy command.</p>\n<p><code>read_config</code> is new in SSHLibrary 3.7.0.</p>\n<p><code>keep_alive_interval</code> is used to specify after which idle interval of time a <code>keepalive</code> packet will be sent to remote host. By default <code>keep_alive_interval</code> is set to <code>0</code>, which means sending the <code>keepalive</code> packet is disabled.</p>\n<p><code>keep_alive_interval</code> is new in SSHLibrary 3.7.0.</p>\n<p><b>Note:</b> <code>allow_agent</code>, <code>look_for_keys</code>, <code>proxy_cmd</code>, <code>jumphost_index_or_alias</code>, <code>read_config</code> and <code>keep_alive_interval</code> do not work when using Jython.</p>\n<p>Example that logs in and returns the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Last login at</td>\n<td></td>\n</tr>\n</table>\n<p>Example that logs in and returns everything until the prompt:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>johndoe@linux:~$</td>\n<td></td>\n</tr>\n</table>\n<p>Example that logs in a remote server (linux.server.com) through a proxy server (proxy.server.com)</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td>proxy_cmd=ssh -l user -i keyfile -W linux.server.com:22 proxy.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Last login at</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Example usage of SSH Agent: First, add the key to the authentication agent with: <code>ssh-add /path/to/keyfile</code>.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>allow_agent=True</td>\n</tr>\n</table>", "shortdoc": "Logs into the SSH server with the given ``username`` and ``password``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 939}, {"name": "Login With Public Key", "args": [{"name": "username", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username=None"}, {"name": "keyfile", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keyfile=None"}, {"name": "password", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password="}, {"name": "allow_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "allow_agent=False"}, {"name": "look_for_keys", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "look_for_keys=False"}, {"name": "delay", "types": [], "defaultValue": "0.5 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=0.5 seconds"}, {"name": "proxy_cmd", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxy_cmd=None"}, {"name": "jumphost_index_or_alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "jumphost_index_or_alias=None"}, {"name": "read_config", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "read_config=False"}, {"name": "keep_alive_interval", "types": [], "defaultValue": "0 seconds", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "keep_alive_interval=0 seconds"}], "doc": "<p>Logs into the SSH server using key-based authentication.</p>\n<p>Connection must be opened before using this keyword.</p>\n<p><code>username</code> is the username on the remote machine.</p>\n<p><code>keyfile</code> is a path to a valid OpenSSH private key file on the local filesystem.</p>\n<p><code>password</code> is used to unlock the <code>keyfile</code> if needed. If the keyfile is invalid a username-password authentication will be attempted.</p>\n<p><code>proxy_cmd</code> is used to connect through a SSH proxy.</p>\n<p><code>jumphost_index_or_alias</code> is used to connect through an intermediary SSH connection that has been assigned an Index or Alias. Note that this requires a Connection that has been logged in prior to use.</p>\n<p><b>Note:</b> <code>proxy_cmd</code> and <code>jumphost_index_or_alias</code> are mutually exclusive SSH features. If you wish to use them both, create the jump-host's Connection using the proxy_cmd first, then use jump-host for secondary Connection.</p>\n<p>This keyword reads, returns and logs the server output after logging in. If the <a href=\"#Prompt\" class=\"name\">prompt</a> is set, everything until the prompt is read. Otherwise the output is read using the <a href=\"#Read\" class=\"name\">Read</a> keyword with the given <code>delay</code>. The output is logged using the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example that logs in using a private key and returns the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a></td>\n<td>johndoe</td>\n<td>/home/johndoe/.ssh/id_rsa</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${motd}</td>\n<td>Last login at</td>\n<td></td>\n</tr>\n</table>\n<p>With locked private keys, the keyring <code>password</code> is required:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login%20With%20Public%20Key\" class=\"name\">Login With Public Key</a></td>\n<td>johndoe</td>\n<td>/home/johndoe/.ssh/id_dsa</td>\n<td>keyringpasswd</td>\n</tr>\n</table>\n<p><code>allow_agent</code> enables the connection to the SSH agent. <code>look_for_keys</code> enables the searching for discoverable private key files in <code>~/.ssh/</code>.</p>\n<p><code>read_config</code> reads or ignores entries from <code>~/.ssh/config</code> file. This parameter will read the hostname, port number, username, identity file and proxy command.</p>\n<p><code>read_config</code> is new in SSHLibrary 3.7.0.</p>\n<p><code>keep_alive_interval</code> is used to specify after which idle interval of time a <code>keepalive</code> packet will be sent to remote host. By default <code>keep_alive_interval</code> is set to <code>0</code>, which means sending the <code>keepalive</code> packet is disabled.</p>\n<p><code>keep_alive_interval</code> is new in SSHLibrary 3.7.0.</p>\n<p><b>Note:</b> <code>allow_agent</code>, <code>look_for_keys</code>, <code>proxy_cmd</code>, <code>jumphost_index_or_alias</code>, <code>read_config</code> and <code>keep_alive_interval</code> do not work when using Jython.</p>", "shortdoc": "Logs into the SSH server using key-based authentication.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1011}, {"name": "Open Connection", "args": [{"name": "host", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "host"}, {"name": "alias", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias=None"}, {"name": "port", "types": [], "defaultValue": "22", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "port=22"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Opens a new SSH connection to the given <code>host</code> and <code>port</code>.</p>\n<p>The new connection is made active. Possible existing connections are left open in the background.</p>\n<p>Note that on Jython this keyword actually opens a connection and will fail immediately on unreachable hosts. On Python the actual connection attempt will not be done until <a href=\"#Login\" class=\"name\">Login</a> is called.</p>\n<p>This keyword returns the index of the new connection which can be used later to switch back to it. Indices start from <code>1</code> and are reset when <a href=\"#Close%20All%20Connections\" class=\"name\">Close All Connections</a> is used.</p>\n<p>Optional <code>alias</code> can be given for the connection and can be used for switching between connections, similarly as the index. Multiple connections with the same <code>alias</code> are allowed. See <a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a> for more details.</p>\n<p>Connection parameters, like <a href=\"#Timeout\" class=\"name\">timeout</a> and <a href=\"#Newline\" class=\"name\">newline</a> are documented in <a href=\"#Configuration\" class=\"name\">configuration</a>. If they are not defined as arguments, the library defaults are used for the connection.</p>\n<p>All the arguments, except <code>host</code>, <code>alias</code> and <code>port</code> can be later updated with <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a>.</p>\n<p>Port <code>22</code> is assumed by default:</p>\n<table border=\"1\">\n<tr>\n<td>${index}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n</tr>\n</table>\n<p>Non-standard port may be given as an argument:</p>\n<table border=\"1\">\n<tr>\n<td>${index}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td>port=23</td>\n</tr>\n</table>\n<p>Aliases are handy, if you need to switch back to the connection later:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>alias=myserver</td>\n<td></td>\n</tr>\n<tr>\n<td># Do something with my.server.com</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>myserver</td>\n<td></td>\n<td># Back to my.server.com</td>\n</tr>\n</table>\n<p>Settings can be overridden per connection, otherwise the ones set on <a href=\"#Importing\" class=\"name\">library importing</a> or with <a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a> are used:</p>\n<table border=\"1\">\n<tr>\n<td>Open Connection</td>\n<td>192.168.1.1</td>\n<td>timeout=1 hour</td>\n<td>newline=CRLF</td>\n</tr>\n<tr>\n<td># Do something with the connection</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td># Default timeout</td>\n<td># Default line breaks</td>\n</tr>\n</table>\n<p>The <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a> are also configurable per connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td>term_type=ansi</td>\n<td>width=40</td>\n</tr>\n</table>\n<p>Starting with version 3.3.0, SSHLibrary understands <code>Host</code> entries from <code>~/.ssh/config</code>. For instance, if the config file contains:</p>\n<table border=\"1\">\n<tr>\n<td>Host</td>\n<td>my_custom_hostname</td>\n</tr>\n<tr>\n<td></td>\n<td>Hostname my.server.com</td>\n</tr>\n</table>\n<p>The connection to the server can also be made like this:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open connection</a></td>\n<td>my_custom_hostname</td>\n</tr>\n</table>\n<p><code>Host</code> entries are not read from config file when running with Jython.</p>", "shortdoc": "Opens a new SSH connection to the given ``host`` and ``port``.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 618}, {"name": "Put Directory", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "mode", "types": [], "defaultValue": "0744", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode=0744"}, {"name": "newline", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline="}, {"name": "recursive", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursive=False"}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Uploads a directory, including its content, from the local machine to the remote machine.</p>\n<p><code>source</code> is the path on the local machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>destination</code> is the target path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>mode</code> can be used to set the target file permission. Numeric values are accepted. The default value is <code>0744</code> (<code>-rwxr--r--</code>).</p>\n<p><code>newline</code> can be used to force the line break characters that are written to the remote files. Valid values are <code>LF</code> and <code>CRLF</code>. Does not work if <code>scp</code> is enabled.</p>\n<p><code>recursive</code> specifies whether to recursively upload all subdirectories inside <code>source</code>. Subdirectories are uploaded if the argument value evaluates to true (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>).</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/tmp/non/existing</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>recursive=True</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20Directory\" class=\"name\">Put Directory</a></td>\n<td>/var/logs</td>\n<td>/home/groups/robot</td>\n<td>mode=0770</td>\n</tr>\n</table>\n<pre>\n<a href=\"#Put%20Directory\" class=\"name\">Put Directory</a> | /var/logs | newline=CRLF       |Get File With SCP (transfer) And Preserve Time\n</pre>\n<p>The remote <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing path on the remote machine, <code>source</code> directory is uploaded into it.</p>\n<p>2. If <code>destination</code> does not exist on the remote machine, it is created and the content of <code>source</code> directory is uploaded into it.</p>\n<p>3. If <code>destination</code> is not given, <code>source</code> directory is typically uploaded to user's home directory on the remote machine.</p>\n<p>See also <a href=\"#Put%20File\" class=\"name\">Put File</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Uploads a directory, including its content, from the local machine to the remote machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1767}, {"name": "Put File", "args": [{"name": "source", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source"}, {"name": "destination", "types": [], "defaultValue": ".", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "destination=."}, {"name": "mode", "types": [], "defaultValue": "0744", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mode=0744"}, {"name": "newline", "types": [], "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline="}, {"name": "scp", "types": [], "defaultValue": "OFF", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp=OFF"}, {"name": "scp_preserve_times", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scp_preserve_times=False"}], "doc": "<p>Uploads file(s) from the local machine to the remote machine.</p>\n<p><code>source</code> is the path on the local machine. Both absolute paths and paths relative to the current working directory are supported. If the source contains wildcards explained in <a href=\"#Glob%20patterns\" class=\"name\">glob patterns</a>, all files matching it are uploaded. In this case <code>destination</code> must always be a directory.</p>\n<p><code>destination</code> is the target path on the remote machine. Both absolute paths and paths relative to the current working directory are supported.</p>\n<p><code>mode</code> can be used to set the target file permission. Numeric values are accepted. The default value is <code>0744</code> (<code>-rwxr--r--</code>). If None value is provided, setting modes will be skipped.</p>\n<p><code>newline</code> can be used to force the line break characters that are written to the remote files. Valid values are <code>LF</code> and <code>CRLF</code>. Does not work if <code>scp</code> is enabled.</p>\n<p><code>scp</code> enables the use of scp (secure copy protocol) for the file transfer. See <a href=\"#Transfer%20files%20with%20SCP\" class=\"name\">Transfer files with SCP</a> for more details.</p>\n<p><code>scp_preserve_times</code> preserve modification time and access time of transferred files and directories. It is ignored when running with Jython.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>/home/groups/robot</td>\n<td>mode=0770</td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>/home/groups/robot</td>\n<td>mode=None</td>\n</tr>\n<tr>\n<td><a href=\"#Put%20File\" class=\"name\">Put File</a></td>\n<td>/path/to/*.txt</td>\n<td>newline=CRLF</td>\n<td></td>\n</tr>\n</table>\n<p>The remote <code>destination</code> is created as following:</p>\n<p>1. If <code>destination</code> is an existing file, <code>source</code> file is uploaded over it.</p>\n<p>2. If <code>destination</code> is an existing directory, <code>source</code> file is uploaded into it. Possible file with same name is overwritten.</p>\n<p>3. If <code>destination</code> does not exist and it ends with the <a href=\"#Path%20separator\" class=\"name\">path separator</a>, it is considered a directory. The directory is then created and <code>source</code> file uploaded into it. Possibly missing intermediate directories are also created.</p>\n<p>4. If <code>destination</code> does not exist and it does not end with the <a href=\"#Path%20separator\" class=\"name\">path separator</a>, it is considered a file. If the path to the file does not exist, it is created.</p>\n<p>5. If <code>destination</code> is not given, the user's home directory on the remote machine is used as the destination.</p>\n<p>See also <a href=\"#Put%20Directory\" class=\"name\">Put Directory</a>.</p>\n<p><code>scp_preserve_times</code> is new in SSHLibrary 3.6.0.</p>", "shortdoc": "Uploads file(s) from the local machine to the remote machine.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1705}, {"name": "Read", "args": [{"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "delay", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delay=None"}], "doc": "<p>Consumes and returns everything available on the server output.</p>\n<p>If <code>delay</code> is given, this keyword waits that amount of time and reads output again. This wait-read cycle is repeated as long as further reads return more output or the default <a href=\"#Timeout\" class=\"name\">timeout</a> expires. <code>delay</code> must be given in Robot Framework's <a href=\"#Time%20format\" class=\"name\">time format</a>.</p>\n<p>This keyword is most useful for reading everything from the server output, thus clearing it.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td>delay=0.5s</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>secretpasswd</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td>loglevel=WARN</td>\n<td># Shown in the console due to loglevel</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>root@</td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> for more information about writing and reading in general.</p>", "shortdoc": "Consumes and returns everything available on the server output.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1458}, {"name": "Read Command Output", "args": [{"name": "return_stdout", "types": [], "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stdout=True"}, {"name": "return_stderr", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_stderr=False"}, {"name": "return_rc", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "return_rc=False"}, {"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}], "doc": "<p>Returns outputs of the most recent started command.</p>\n<p>At least one command must have been started using <a href=\"#Start%20Command\" class=\"name\">Start Command</a> before this keyword can be used.</p>\n<p>By default, only the standard output of the started command is returned:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>Arguments <code>return_stdout</code>, <code>return_stderr</code> and <code>return_rc</code> are used to specify, what is returned by this keyword. If several arguments evaluate to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>), multiple values are returned.</p>\n<p>If errors are needed as well, set the argument value to true:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}</td>\n<td>${stderr}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td>return_stderr=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Empty</span></td>\n<td>${stderr}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Often checking the return code is enough:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${rc}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td>return_stdout=False</td>\n<td>return_rc=True</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${rc}</td>\n<td>0</td>\n<td># succeeded</td>\n</tr>\n</table>\n<p>Using <a href=\"#Start%20Command\" class=\"name\">Start Command</a> and <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> follows LIFO (last in, first out) policy, meaning that <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> operates on the most recent started command, after which that command is discarded and its output cannot be read again.</p>\n<p>If several commands have been started, the output of the last started command is returned. After that, a subsequent call will return the output of the new last (originally the second last) command:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'HELLO'</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'SECOND'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>'SECOND'</td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>'HELLO'</td>\n</tr>\n</table>\n<p>This keyword logs the read command with log level <code>INFO</code>.</p>", "shortdoc": "Returns outputs of the most recent started command.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1264}, {"name": "Read Until", "args": [{"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Consumes and returns the server output until <code>expected</code> is encountered.</p>\n<p>Text up until and including the <code>expected</code> will be returned.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>:</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until\" class=\"name\">Read Until</a></td>\n<td>@</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should End With</span></td>\n<td>${output}</td>\n<td>root@</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>", "shortdoc": "Consumes and returns the server output until ``expected`` is encountered.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1487}, {"name": "Read Until Prompt", "args": [{"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "strip_prompt", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "strip_prompt=False"}], "doc": "<p>Consumes and returns the server output until the prompt is found.</p>\n<p>Text up and until prompt is returned. The <a href=\"#Prompt\" class=\"name\">prompt</a> must be set before this keyword is used.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>This keyword is useful for reading output of a single command when output of previous command has been read and that command does not produce prompt characters in its output.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td>prompt=$</td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=#</td>\n<td># For root, the prompt is #</td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should End With</span></td>\n<td>${output}</td>\n<td>root@myserver:~#</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until\" class=\"name\">Read Until</a> and <a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>\n<p>If you want to exclude the prompt from the returned output, set <code>strip_prompt</code> to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>). If your prompt is a regular expression, make sure that the expression spans the whole prompt, because only the part of the output that matches the regular expression is stripped away.</p>\n<p><code>strip_prompt</code> argument is new in SSHLibrary 3.2.0.</p>", "shortdoc": "Consumes and returns the server output until the prompt is found.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1513}, {"name": "Read Until Regexp", "args": [{"name": "regexp", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "regexp"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Consumes and returns the server output until a match to <code>regexp</code> is found.</p>\n<p><code>regexp</code> can be a regular expression pattern or a compiled regular expression object. See the <a href=\"#Regular%20expressions\" class=\"name\">Regular expressions</a> section for more details about the syntax.</p>\n<p>Text up until and including the <code>regexp</code> will be returned.</p>\n<p>If the <a href=\"#Timeout\" class=\"name\">timeout</a> expires before the match is found, this keyword fails.</p>\n<p>The read output is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>${PASSWORD}</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>sudo su -</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a></td>\n<td>\\\\[.*\\\\].*:</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>[sudo] password for johndoe:</td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>${PASSWORD}</td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read%20Until%20Regexp\" class=\"name\">Read Until Regexp</a></td>\n<td>.*@</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>root@</td>\n</tr>\n</table>\n<p>See also <a href=\"#Read%20Until\" class=\"name\">Read Until</a> and <a href=\"#Read%20Until%20Prompt\" class=\"name\">Read Until Prompt</a> keywords. For more details about reading and writing in general, see the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>", "shortdoc": "Consumes and returns the server output until a match to ``regexp`` is found.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1550}, {"name": "Set Client Configuration", "args": [{"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Update the <a href=\"#Configuration\" class=\"name\">configuration</a> of the current connection.</p>\n<p>Only parameters whose value is other than <code>None</code> are updated.</p>\n<p>In the following example, <a href=\"#Prompt\" class=\"name\">prompt</a> is set for the current connection. Other settings are left intact:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection    </a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=$</td>\n<td></td>\n</tr>\n<tr>\n<td>${myserver}=</td>\n<td><a href=\"#Get%20Connection\" class=\"name\">Get Connection</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${myserver.prompt}</td>\n<td>$</td>\n</tr>\n</table>\n<p>Using keyword does not affect the other connections:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>linux.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=$</td>\n<td></td>\n<td># Only linux.server.com affected</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection    </a></td>\n<td>windows.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>prompt=&gt;</td>\n<td></td>\n<td># Only windows.server.com affected</td>\n</tr>\n<tr>\n<td>${linux}</td>\n<td>${windows}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${linux.prompt}</td>\n<td>$</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${windows.prompt}</td>\n<td>&gt;</td>\n<td></td>\n</tr>\n</table>\n<p>Multiple settings are possible. This example updates the <a href=\"#Terminal%20settings\" class=\"name\">terminal settings</a> of the current connection:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>192.168.1.1</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a></td>\n<td>term_type=ansi</td>\n<td>width=40</td>\n</tr>\n</table>\n<p><b>Note:</b> Setting <code>width</code> and <code>height</code> does not work when using Jython.</p>", "shortdoc": "Update the `configuration` of the current connection.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 555}, {"name": "Set Default Configuration", "args": [{"name": "timeout", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=None"}, {"name": "newline", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "newline=None"}, {"name": "prompt", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "prompt=None"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}, {"name": "term_type", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "term_type=None"}, {"name": "width", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "width=None"}, {"name": "height", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "height=None"}, {"name": "path_separator", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path_separator=None"}, {"name": "encoding", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding=None"}, {"name": "escape_ansi", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escape_ansi=None"}, {"name": "encoding_errors", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding_errors=None"}], "doc": "<p>Update the default <a href=\"#Configuration\" class=\"name\">configuration</a>.</p>\n<p>Please note that using this keyword does not affect the already opened connections. Use <a href=\"#Set%20Client%20Configuration\" class=\"name\">Set Client Configuration</a> to configure the active connection.</p>\n<p>Only parameters whose value is other than <code>None</code> are updated.</p>\n<p>This example sets <a href=\"#Prompt\" class=\"name\">prompt</a> to <code>$</code>:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>prompt=$</td>\n</tr>\n</table>\n<p>This example sets <a href=\"#Newline\" class=\"name\">newline</a> and <a href=\"#Path%20separator\" class=\"name\">path separator</a> to the ones known by Windows:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>newline=CRLF</td>\n<td>path_separator=\\\\</td>\n</tr>\n</table>\n<p>Sometimes you might want to use longer <a href=\"#Timeout\" class=\"name\">timeout</a> for all the subsequent connections without affecting the existing ones:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>timeout=5 seconds</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection       </a></td>\n<td>local.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Default%20Configuration\" class=\"name\">Set Default Configuration</a></td>\n<td>timeout=20 seconds</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>emea.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>apac.server.com</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${local}</td>\n<td>${emea}</td>\n<td>${apac}=</td>\n<td><a href=\"#Get%20Connections\" class=\"name\">Get Connections</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${local.timeout}</td>\n<td>5</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${emea.timeout}</td>\n<td>20</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal As Integers</span></td>\n<td>${apac.timeout}</td>\n<td>20</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Update the default `configuration`.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 516}, {"name": "Start Command", "args": [{"name": "command", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "command"}, {"name": "sudo", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo=False"}, {"name": "sudo_password", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "sudo_password=None"}, {"name": "invoke_subsystem", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invoke_subsystem=False"}, {"name": "forward_agent", "types": [], "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "forward_agent=False"}], "doc": "<p>Starts execution of the <code>command</code> on the remote machine and returns immediately.</p>\n<p>This keyword returns nothing and does not wait for the <code>command</code> execution to be finished. If waiting for the output is required, use <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> instead.</p>\n<p>This keyword does not return any output generated by the started <code>command</code>. Use <a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a> to read the output:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>echo 'Hello John!'</td>\n<td></td>\n</tr>\n<tr>\n<td>${stdout}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${stdout}</td>\n<td>Hello John!</td>\n</tr>\n</table>\n<p>The <code>command</code> is always executed in a new shell, similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a>. Thus possible changes to the environment (e.g. changing working directory) are not visible to the later keywords:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>cd /tmp</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td></td>\n</tr>\n<tr>\n<td>${pwd}=</td>\n<td><a href=\"#Read%20Command%20Output\" class=\"name\">Read Command Output</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${pwd}</td>\n<td>/home/johndoe</td>\n</tr>\n</table>\n<p>Arguments <code>sudo</code> and <code>sudo_password</code> are used for executing commands within a sudo session. Due to different permission elevation in Cygwin, these two arguments will not when using it.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Command\" class=\"name\">Start Command</a></td>\n<td>pwd</td>\n<td>sudo=True</td>\n<td>sudo_password=test</td>\n</tr>\n</table>\n<p><a href=\"#Write\" class=\"name\">Write</a> and <a href=\"#Read\" class=\"name\">Read</a> can be used for running multiple commands in the same shell. See <a href=\"#Interactive%20shells\" class=\"name\">interactive shells</a> section for more information.</p>\n<p>This keyword logs the started command with log level <code>INFO</code>.</p>\n<p><code>invoke_subsystem</code> argument behaves similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> keyword.</p>\n<p><code>forward_agent</code> argument behaves similarly as with <a href=\"#Execute%20Command\" class=\"name\">Execute Command</a> keyword.</p>\n<p><code>invoke_subsystem</code> is new in SSHLibrary 3.4.0.</p>", "shortdoc": "Starts execution of the ``command`` on the remote machine and returns immediately.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1210}, {"name": "Switch Connection", "args": [{"name": "index_or_alias", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias"}], "doc": "<p>Switches the active connection by index or alias.</p>\n<p><code>index_or_alias</code> is either connection index (an integer) or alias (a string). Index is got as the return value of <a href=\"#Open%20Connection\" class=\"name\">Open Connection</a>. Alternatively, both index and alias can queried as attributes of the object returned by <a href=\"#Get%20Connection\" class=\"name\">Get Connection</a>. If there exists more connections with the same alias the keyword will switch to the last opened connection that has that alias.</p>\n<p>This keyword returns the index of the previous active connection, which can be used to switch back to that connection later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${myserver}=</td>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>my.server.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>johndoe</td>\n<td>secretpasswd</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Connection\" class=\"name\">Open Connection</a></td>\n<td>build.local.net</td>\n<td>alias=Build</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Login\" class=\"name\">Login</a></td>\n<td>jenkins</td>\n<td>jenkins</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>${myserver}</td>\n<td></td>\n<td># Switch using index</td>\n</tr>\n<tr>\n<td>${username}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>whoami</td>\n<td># Executed on my.server.com</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${username}</td>\n<td>johndoe</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Connection\" class=\"name\">Switch Connection</a></td>\n<td>Build</td>\n<td></td>\n<td># Switch using alias</td>\n</tr>\n<tr>\n<td>${username}=</td>\n<td><a href=\"#Execute%20Command\" class=\"name\">Execute Command</a></td>\n<td>whoami</td>\n<td># Executed on build.local.net</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${username}</td>\n<td>jenkins</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches the active connection by index or alias.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 700}, {"name": "Write", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Writes the given <code>text</code> on the remote machine and appends a newline.</p>\n<p>Appended <a href=\"#Newline\" class=\"name\">newline</a> can be configured.</p>\n<p>This keyword returns and consumes the written <code>text</code> (including the appended newline) from the server output. See the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section for more information.</p>\n<p>The written <code>text</code> is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${written}=</td>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>su</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${written}</td>\n<td>su</td>\n<td># Returns the consumed output</td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Not Contain</span></td>\n<td>${output}</td>\n<td>${written}</td>\n<td># Was consumed from the output</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Password:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write\" class=\"name\">Write</a></td>\n<td>invalidpasswd</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su: Authentication failure</td>\n<td></td>\n</tr>\n</table>\n<p>See also <a href=\"#Write%20Bare\" class=\"name\">Write Bare</a>.</p>", "shortdoc": "Writes the given ``text`` on the remote machine and appends a newline.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1378}, {"name": "Write Bare", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}], "doc": "<p>Writes the given <code>text</code> on the remote machine without appending a newline.</p>\n<p>Unlike <a href=\"#Write\" class=\"name\">Write</a>, this keyword returns and consumes nothing. See the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write%20Bare\" class=\"name\">Write Bare</a></td>\n<td>su\\n</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su</td>\n<td># Was not consumed from output</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>Password:</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Write%20Bare\" class=\"name\">Write Bare</a></td>\n<td>invalidpasswd\\n</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${output}=</td>\n<td><a href=\"#Read\" class=\"name\">Read</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Contain</span></td>\n<td>${output}</td>\n<td>su: Authentication failure</td>\n<td></td>\n</tr>\n</table>\n<p>See also <a href=\"#Write\" class=\"name\">Write</a>.</p>", "shortdoc": "Writes the given ``text`` on the remote machine without appending a newline.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1405}, {"name": "Write Until Expected Output", "args": [{"name": "text", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text"}, {"name": "expected", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected"}, {"name": "timeout", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "timeout"}, {"name": "retry_interval", "types": [], "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "retry_interval"}, {"name": "loglevel", "types": [], "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel=None"}], "doc": "<p>Writes the given <code>text</code> repeatedly until <code>expected</code> appears in the server output.</p>\n<p>This keyword returns nothing.</p>\n<p><code>text</code> is written without appending a newline and is consumed from the server output before <code>expected</code> is read. See more information on the <a href=\"#Interactive%20shells\" class=\"name\">Interactive shells</a> section.</p>\n<p>If <code>expected</code> does not appear in output within <code>timeout</code>, this keyword fails. <code>retry_interval</code> defines the time before writing <code>text</code> again. Both <code>timeout</code> and <code>retry_interval</code> must be given in Robot Framework's <a href=\"#Time%20format\" class=\"name\">time format</a>.</p>\n<p>The written <code>text</code> is logged. <code>loglevel</code> can be used to override the default <a href=\"#Loglevel\" class=\"name\">log level</a>.</p>\n<p>This example will write <code>lsof -c python27\\n</code> (list all files currently opened by Python 2.7), until <code>myscript.py</code> appears in the output. The command is written every 0.5 seconds. The keyword fails if <code>myscript.py</code> does not appear in the server output in 5 seconds:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Write%20Until%20Expected%20Output\" class=\"name\">Write Until Expected Output</a></td>\n<td>lsof -c python27\\n</td>\n<td>expected=myscript.py</td>\n<td>timeout=5s</td>\n<td>retry_interval=0.5s</td>\n</tr>\n</table>", "shortdoc": "Writes the given ``text`` repeatedly until ``expected`` appears in the server output.", "tags": [], "source": "/home/debbie/dev/mihaiparvu/sshlibrary/src/SSHLibrary/library.py", "lineno": 1430}], "dataTypes": {"enums": [], "typedDicts": []}}
 </script>
 <title></title>
 </head>
diff --git a/src/SSHLibrary/version.py b/src/SSHLibrary/version.py
index 789af9e1d..e4e9a0f00 100644
--- a/src/SSHLibrary/version.py
+++ b/src/SSHLibrary/version.py
@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-VERSION = '3.7.1.dev1'
+VERSION = '3.8.0rc1'