<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE section [
<!ENTITY % myent SYSTEM "../entities.ent">
%myent;
]>
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
	xmlns:xi="http://www.w3.org/2001/XInclude">
	<title>runCommandWithSSH</title>
	<para>Executes a command through a SSH session.</para>
	<section>
		<title>&inp;
		</title>
		<para />
		<table frame="all">
			<title>runCommandWithSSH input parameters</title>
			<tgroup cols="4">
				<colspec colnum="1" colname="parameter" />
				<colspec colnum="2" colname="type" />
				<colspec colnum="3" colname="required" />
				<colspec colnum="4" colname="description" />
				<thead>
					<row>
						<entry>parameter</entry>
						<entry>type</entry>
						<entry>required</entry>
						<entry>description</entry>
					</row>
				</thead>
				<tbody>
					<row>
						<entry>host</entry>
						<entry>HostConnection</entry>
						<entry>Yes</entry>
						<entry>
							Host to connect to (see:
							<link linkend="hostconnection">tns:HostConnection</link>
							)
						</entry>
					</row>
					<row>
						<entry>command</entry>
						<entry>String</entry>
						<entry>No</entry>
						<entry>The command to execute.</entry>
					</row>
          &param-timeout;
				</tbody>
			</tgroup>
		</table>
		<para />
	</section>
	<section>
		<title>&outp;
		</title>
		<xi:include href="../types/ReturnCode.xml" />
	</section>
	<section>
		<title>Sample Request:</title>
		<programlisting language="xml">
	<![CDATA[
      <ws:runCommandWithSSH>
         <host>
            <hostname>ssh.brutex.net</hostname>
            <port>22</port>
            <user>roger</user>
            <password>xxx</password>
         </host>
         <command>ls /etc/</command>
         <timeout>30000</timeout>
      </ws:runCommandWithSSH>
	]]></programlisting>
	</section>
</section>