3 new revisions:
Revision: 5d98e17acef7
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:41:58 2012
Log: CLI
http://code.google.com/p/jss7/source/detail?r=5d98e17acef7
Revision: 8cabe6989127
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:42:37 2012
Log: minor changes
http://code.google.com/p/jss7/source/detail?r=8cabe6989127
Revision: c440ca761058
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:44:34 2012
Log: Merge branch 'master' of https://code.google.com/p/jss7
http://code.google.com/p/jss7/source/detail?r=c440ca761058
==============================================================================
Revision: 5d98e17acef7
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:41:58 2012
Log: CLI
http://code.google.com/p/jss7/source/detail?r=5d98e17acef7
Modified:
/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
/docs/sources/src/main/resources/en-US/Section-Shell_Linkset.xml
/docs/sources/src/main/resources/en-US/Section-Shell_M3UA.xml
=======================================
--- /docs/sources/src/main/resources/en-US/Chapter-Shell.xml Wed Aug 8
20:59:48 2012
+++ /docs/sources/src/main/resources/en-US/Chapter-Shell.xml Tue Aug 28
23:41:58 2012
@@ -8,42 +8,45 @@
<chapter
id="shell">
<title>Shell Command Line</title>
- <section>
- <title>Introduction</title>
- <para>&THIS.PLATFORM; &THIS.APPLICATION;
- provides Shell client to manage configuration of &THIS.APPLICATION;
Services. This chapter describes how to install and start client. Also it
describes available
- commands and provides examples.
- To see examples of specific flow, to perform certain tasks, please
refer to sections in chapter devoted to
- <literal>Linksets</literal>, <literal>SCCP</literal> or
<literal>M3UA</literal>
-
- . <!-- TODO add XREF -->
- </para>
- </section>
- <section
+
+<para>
+ <literal>Shell</literal> is a Command Line Interface (CLI) tool that
will allow you to manage different aspects of &THIS.PLATFORM;
&THIS.APPLICATION; in an interactive manner.
+ It connects to different instances of &THIS.PLATFORM;
&THIS.APPLICATION; which manages <literal>Linksets</literal>,
+ <literal>SCCP</literal> resource, routing and
<literal>M3UA</literal>.
+ Usually <literal>Shell</literal> will be invoked from a remote
machine(remote to <literal>Linksets</literal> and application protocols).
+
+ </para>
+
+ <section id="running_shell">
+ <title>Running the Shell</title>
+<section
id="shell_start">
- <title>Starting</title>
+ <title>Start the Shell Client</title>
<para>
Shell client can be started with following command from
<filename>$JBOSS_HOME/bin</filename>
:
</para>
- <programlisting>[$]./ss7-cli.sh</programlisting>
+ <programlisting>[$] ./ss7-cli.sh</programlisting>
<para>Once console starts, it will print following
information:</para>
<screen>
=========================================================================
-Mobicents SS7: release.version=1.0.0-SNAPSHOT
+telscale SS7: release.version=2.0.0
This is free software, with components licensed under the GNU General
Public License
-version 2 and other licenses. For further details visit
http://mobicents.org
+version 2 and other licenses. For further details visit http://telscale.org
=========================================================================
-mobicents>
+telscale>
</screen>
+
+
+
<para>
The
<literal>ss7-cli</literal>
- script supports following options
+ script supports the following options
</para>
<screen><![CDATA[
@@ -53,16 +56,18 @@
-h This help screen
]]>
</screen>
-
- <para>Shell needs to connect to managed instance. Command to connect has
following structure:</para>
+</section>
+<section id="connect_shell">
+ <title>Connect to Managed Instance</title>
+ <para>Shell needs to connect to a managed instance. The command to
connect has following structure:</para>
<programlisting>
connect <IP> <PORT> </programlisting>
<example>
- <title>Connec to remote machine</title>
+ <title>Connect to remote machine</title>
<screen>
-mobicents>connect 10.65.208.215 3435
+telscale>connect 10.65.208.215 3435
-mobicents(10.65.208.215:3435)>
+telscale(10.65.208.215:3435)>
</screen>
</example>
<note>
@@ -71,20 +76,85 @@
<literal>127.0.0.1:3435</literal>
</para>
</note>
-
+ </section>
+ <section id="disconnect_shell">
+ <title>Disconnect</title>
<para>Command to disconnect has following structure:</para>
- <programlisting>disconnect </programlisting>
+ <programlisting>ss7 discconnect </programlisting>
<example>
<title>Disconnect</title>
<screen>
-mobicents(10.65.208.215:3435)>disconnect
+telscale(10.65.208.215:3435)>ss7 disconnect
Bye
-mobicents>
+telscale>
</screen>
</example>
</section>
+
+
+ </section>
+ <section id="commands_help">
+ <title>Command-line Completion</title>
+ <para>
+ &THIS.PLATFORM; &THIS.APPLICATION; Shell supports Command-line
completion (Tab Completion) allowing you to type the first (or first few)
character(s) of the comand and press tab to fill in the rest of the
command. As soon as you enter the CLI (by executing the
<filename>ss7-cli.sh</filename> script) you can make use of this feature to
view all possible commands.
+ </para>
+ <para>
+When you first enter CLI and press the "tab" key, CLI will display all
operations permitted in that context. Once you connect to a managed
instance and while staying connected if you press the "tab" key it will
display all other commands allowed.
+ </para>
+<programlisting>
+telscale> [tab key press]
+history connect exit
+telscale>connect 10.65.208.215 3435
+telscale(10.65.208.215:3435)> [tab key press]
+sctp linkset m3ua sccp history disconnect
+</programlisting>
+ <para>
+If you enter the first few characters of a command and press "tab", CLI
will automatically fill in the rest of the command or display all possible
commands if there is more than one command beginning with the characters
entered by you.
+ </para>
+<programlisting>
+telscale(10.65.208.215:3435)>sctp [tab key press]
+server association --help
+telscale(10.65.208.215:3435)>sctp
+</programlisting>
+ <para>
+In addition, help files are also available for every command using the
--help option. The help files provide details of the command including
possible parameters and examples of usage if applicable.
+ </para>
+<programlisting>
+telscale(10.65.208.215:3435)>sctp --help
+Name
+ sctp
+ Manage M3UA - SCTP
+
+SYNOPSIS
+ sctp server [create | destroy | start | stop | show] [parameters]
+
+ sctp association [create | destroy | show] [parameters]
+
+ parameters
+ Command Line parameters.
+
+DESCRIPTION
+ This command is used to manage M3UA - SCTP. You can create, destroy,
start and
+ stop a SCTP Server and view the Server configuration using the sctp
server
+ command. You can create, destroy and view SCTP Associations using the
+ sctp association command.
+
+SEE ALSO
+ sctp server create, sctp server destroy, sctp server start, sctp server
stop,
+ sctp server show, sctp association create, sctp association destroy,
+ sctp association show
+
+telscale(10.65.208.215:3435)>
+</programlisting>
+ </section>
+<para> The sections below describe the available Shell
+ commands and provide examples of usage.
+ To see examples of specific flow or to perform certain tasks, please
refer to corresponding sections devoted to
+ <literal>Linksets</literal>, <literal>SCCP</literal> or
<literal>M3UA</literal>
+
+ </para>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Section-Shell_Linkset.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Section-Shell_Sccp.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Section-Shell_M3UA.xml" />
=======================================
--- /docs/sources/src/main/resources/en-US/Section-Shell_Linkset.xml Sun
Mar 6 22:09:31 2011
+++ /docs/sources/src/main/resources/en-US/Section-Shell_Linkset.xml Tue
Aug 28 23:41:58 2012
@@ -6,9 +6,9 @@
<section id="shell_linkset">
<title>Linkset Management</title>
<para>
- Linksets are managed by
+ You can manage Linksets using the
<literal>linkset</literal>
- command. It allows to perform following:
+ command. It allows you to perform the following
operations:
</para>
<itemizedlist>
<listitem>
=======================================
--- /docs/sources/src/main/resources/en-US/Section-Shell_M3UA.xml Wed Aug
8 22:12:24 2012
+++ /docs/sources/src/main/resources/en-US/Section-Shell_M3UA.xml Tue Aug
28 23:41:58 2012
@@ -500,7 +500,7 @@
id="shell_m3ua_asp_side_create">
<title>Create ASP</title>
<para>Application Server Process (ASP) can be
created by issuing command with following structure:</para>
- <programlisting>m3ua asp create <asp-name>
<sctp-association></programlisting>
+ <programlisting>m3ua asp create <asp-name>
<sctp-association> aspid <aspid></programlisting>
<para>Where:</para>
<variablelist>
<varlistentry>
@@ -513,6 +513,13 @@
<term>sctp-association</term>
<listitem>
<para>name of SCTP
Association</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>aspid</term>
+ <listitem>
+ <para>Identifier for this
newly created Application Server Process. If this is not passed, next
available aspid will be used.
+</para>
</listitem>
</varlistentry>
</variablelist>
==============================================================================
Revision: 8cabe6989127
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:42:37 2012
Log: minor changes
http://code.google.com/p/jss7/source/detail?r=8cabe6989127
Modified:
/docs/sources/src/main/resources/en-US/Chapter-Introduction.xml
=======================================
--- /docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Wed
Aug 8 22:12:24 2012
+++ /docs/sources/src/main/resources/en-US/Chapter-Introduction.xml Tue Aug
28 23:42:37 2012
@@ -18,6 +18,11 @@
<para>
Since &THIS.PLATFORM; jSS7 is Java based, it is cross-platform and can be
installed and used on any Operating System that supports Java. The Open
Source Software gives you the flexibility to understand the readily
available source code and customise the product for your Enterprise needs.
</para>
+
+
+ <important>
+ <para>Spaces were introduced in some tables and code listings to
ensure proper page render.</para>
+ </important>
</section>
@@ -25,11 +30,6 @@
<title>Introduction
to SS7
</title>
- <!-- TODO this should be placed elsewhere -->
-
- <important>
- <para>Spaces were introduced in some tables and code listings to
ensure proper page render.</para>
- </important>
<section id="ss7_overview">
<title>SS7 Overview</title>
@@ -90,7 +90,7 @@
</mediaobject>
</section>
- <section id="tdm">
+ <!--<section id="tdm">
<title>Time Division Multiplexing</title>
<para>
In circuit switched networks such as the Public
Switched Telephone
@@ -116,7 +116,7 @@
immediate lower order are combined, creating
multiplexes with a
bandwidth of n x 64 kbit/s, where n = 120, 480, 1920,
etc.
</para>
- </section>
+ </section>-->
</section> <!-- End of Introduction to SS7 section -->
</chapter>
==============================================================================
Revision: c440ca761058
Author: Vinu S Renish <[email protected]>
Date: Tue Aug 28 23:44:34 2012
Log: Merge branch 'master' of https://code.google.com/p/jss7
http://code.google.com/p/jss7/source/detail?r=c440ca761058
