Subversion Repositories XServices

Rev

Rev 59 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
59 brianR 1 
<?xml version='1.0' encoding='utf-8'?>
2 
<!DOCTYPE section [
3 
<!ENTITY % myent SYSTEM "../entities.ent">
4 
%myent;
5 
]>
6 
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
7 
	xmlns:xi="http://www.w3.org/2001/XInclude">
8 
	<title>runCommandWithSSH</title>
9 
	<para>Executes a command through a SSH session.</para>
10 
	<section>
11 
		<title>&inp;
12 
		</title>
13 
		<para />
14 
		<table frame="all">
15 
			<title>runCommandWithSSH input parameters</title>
16 
			<tgroup cols="4">
17 
				<colspec colnum="1" colname="parameter" />
18 
				<colspec colnum="2" colname="type" />
19 
				<colspec colnum="3" colname="required" />
20 
				<colspec colnum="4" colname="description" />
21 
				<thead>
22 
					<row>
23 
						<entry>parameter</entry>
24 
						<entry>type</entry>
25 
						<entry>required</entry>
26 
						<entry>description</entry>
27 
					</row>
28 
				</thead>
29 
				<tbody>
30 
					<row>
31 
						<entry>host</entry>
32 
						<entry>HostConnection</entry>
33 
						<entry>Yes</entry>
34 
						<entry>
35 
							Host to connect to (see:
36 
							<link linkend="hostconnection">tns:HostConnection</link>
37 
							)
38 
						</entry>
39 
					</row>
40 
					<row>
41 
						<entry>command</entry>
42 
						<entry>String</entry>
43 
						<entry>No</entry>
44 
						<entry>The command to execute.</entry>
45 
					</row>
46 
          &param-timeout;
47 
				</tbody>
48 
			</tgroup>
49 
		</table>
50 
		<para />
51 
	</section>
52 
	<section>
53 
		<title>&outp;
54 
		</title>
55 
		<xi:include href="../types/ReturnCode.xml" />
56 
	</section>
57 
	<section>
58 
		<title>Sample Request:</title>
59 
		<programlisting language="xml">
60 
	<![CDATA[
61 
      <ws:runCommandWithSSH>
62 
         <host>
63 
            <hostname>ssh.brutex.net</hostname>
64 
            <port>22</port>
65 
            <user>roger</user>
66 
            <password>xxx</password>
67 
         </host>
68 
         <command>ls /etc/</command>
69 
         <timeout>30000</timeout>
70 
      </ws:runCommandWithSSH>
71 
	]]></programlisting>
72 
	</section>
73 
</section>