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>telnet</title>
9 
	<para>Runs a telnet session with an "expect shell" like behaviour.</para>
10 
	<section>
11 
		<title>&inp;
12 
		</title>
13 
		<para />
14 
		<table frame="all">
15 
			<title>telnet 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>Host to connect to (see: <link linkend="hostconnection">tns:HostConnection</link>)</entry>
35 
					</row>
36 
					<row>
37 
						<entry>prompt</entry>
38 
						<entry>String</entry>
39 
						<entry>No</entry>
40 
						<entry>The prompt string to expect after login. This is used to recognize when
41 
						 the session is open.</entry>
42 
					</row>
43 
					<row>
44 
						<entry>command</entry>
45 
						<entry>String</entry>
46 
						<entry>No</entry>
47 
						<entry>The command to execute.</entry>
48 
					</row>
49 
					<row>
50 
						<entry>expect</entry>
51 
						<entry>String</entry>
52 
						<entry>No</entry>
53 
						<entry>The prompt to expect after the command has been executed successfully.</entry>
54 
					</row>
55 
          &param-timeout;
56 
				</tbody>
57 
			</tgroup>
58 
		</table>
59 
		<para />
60 
	</section>
61 
	<section>
62 
		<title>&outp;</title>
63 
		<xi:include href="../types/ReturnCode.xml" />
64 
	</section>
65 
	<section>
66 
	<title>Sample Request:</title>
67 
	<programlisting language="xml">
68 
	<![CDATA[
69 
	 <ws:telnet>
70 
         <host>
71 
            <hostname>localhost</hostname>
72 
            <port>23</port>
73 
            <user>brosenberger</user>
74 
            <password></password>
75 
         </host>
76 
         <prompt>C:\Users\brosenberger&gt;</prompt>
77 
         <command>dir c:\temp</command>
78 
         <expect>enberger&gt;</expect>
79 
         <timeout>60000</timeout>
80 
      </ws:telnet>
81 
	]]></programlisting>
82 
	</section>
83 
</section>