XServices/doc/ExecuteServices/telnet.xml

83 lines
2.2 KiB
XML
Raw Permalink Normal View History

<?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>telnet</title>
<para>Runs a telnet session with an "expect shell" like behaviour.</para>
<section>
<title>&inp;
</title>
<para />
<table frame="all">
<title>telnet 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>prompt</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The prompt string to expect after login. This is used to recognize when
the session is open.</entry>
</row>
<row>
<entry>command</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The command to execute.</entry>
</row>
<row>
<entry>expect</entry>
<entry>String</entry>
<entry>No</entry>
<entry>The prompt to expect after the command has been executed successfully.</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:telnet>
<host>
<hostname>localhost</hostname>
<port>23</port>
<user>brosenberger</user>
<password></password>
</host>
<prompt>C:\Users\brosenberger&gt;</prompt>
<command>dir c:\temp</command>
<expect>enberger&gt;</expect>
<timeout>60000</timeout>
</ws:telnet>
]]></programlisting>
</section>
</section>