Revision: 16235
Author: baranowb
Date: Fri Jan 7 02:20:48 2011
Log: [No log message]
http://code.google.com/p/mobicents/source/detail?r=16235
Added:
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
Deleted:
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Linkset_Management.xml
Modified:
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Source_Build_Binary.xml
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/SS7_Stack_User_Guide.xml
=======================================
--- /dev/null
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Shell.xml
Fri Jan 7 02:20:48 2011
@@ -0,0 +1,499 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML
V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "SS7_Stack_User_Guide.ent">
+%BOOK_ENTITIES;
+]>
+
+<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>SCCP</literal>
+ or
+ <literal>Linksets</literal>
+ . <!-- TODO add XREF -->
+ </para>
+ </section>
+ <section
+ id="shell_start">
+ <title>Starting</title>
+ <para>
+ Shell client can be started with following command from
+ <filename>$JBOSS_HOME/bin</filename>
+ :
+ </para>
+ <programlisting>
+[$] ./ss7-run.sh
+ </programlisting>
+ <para>Once console starts, it will print following
information:</para>
+ <screen>
+=========================================================================
+
+Mobicents SS7: release.version=1.0.0-SNAPSHOT
+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
+=========================================================================
+
+mobicents>
+ </screen>
+
+ <para>
+ The
+ <literal>ss7-run</literal>
+ script supports following options
+ </para>
+
+ <screen><![CDATA[
+Usage: SS7 [OPTIONS]
+Valid Options
+-v Display version number and exit
+-h This help screen
+]]>
+ </screen>
+
+ <para>Shell needs to connect to managed instance. Command to connect has
following structure:</para>
+ <programlisting>
+ss7 connect <IP> <PORT> </programlisting>
+ <example>
+ <title>Connec to remote machine</title>
+ <screen>
+mobicents>ss7 connect 10.65.208.215 3435
+
+mobicents(10.65.208.215:3435)>
+ </screen>
+ </example>
+ <note>
+ <para>
+ Host IP and port are optional, if not specified, shell will try to
connect to
+ <literal>127.0.0.1:3435</literal>
+ </para>
+ </note>
+
+ <para>Command to disconnect has following structure:</para>
+ <programlisting>ss7 discconnect </programlisting>
+ <example>
+ <title>Disconnect</title>
+ <screen>
+mobicents(10.65.208.215:3435)>ss7 connect
+
+Bye
+mobicents>
+ </screen>
+ </example>
+ </section>
+
+ <section id="shell_linkset">
+ <title>Linkset Management</title>
+ <para>
+ Linksets are managed by
+ <literal>linkset</literal>
+ command. It allows to perform following:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>create linkset</para>
+ </listitem>
+ <listitem>
+ <para>delete linkset</para>
+ </listitem>
+ <listitem>
+ <para>activate linkset</para>
+ </listitem>
+ <listitem>
+ <para>deactivate linkset</para>
+ </listitem>
+ <listitem>
+ <para>create link</para>
+ </listitem>
+ <listitem>
+ <para>delete link</para>
+ </listitem>
+ <listitem>
+ <para>activate link</para>
+ </listitem>
+ <listitem>
+ <para>deactivate link</para>
+ </listitem>
+ <listitem>
+ <para>list state of linksets and present
links</para>
+ </listitem>
+ </itemizedlist>
+
+ <section
+ id="shell_linkset_create">
+ <title>Create Linkset</title>
+ <para>Linkset can be create by issuing command with following
structure:</para>
+ <programlisting>
+linkset create <linkset-type> opc <point-code> apc
<point-code> ni <network-id> <linkset-name>
</programlisting>
+ <para>or in case of dialogic:</para>
+ <programlisting>
+linkset create dialogic opc <point-code> apc <point-code> ni
<network-id> srcmod <src-mode> destmod <dest-mode>
<linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-type</term>
+ <listitem>
+ <para>
+ refers to type of
linkset to be created, ie.
+ <literal>dahdi</literal>
+ ,
+
<literal>dialogic</literal>
+ or
+ <literal>m3ua</literal>
+ . Correct values depend on which linkset factories have been
deployed. <!-- AMIT: add reference to linkset section/chapter -->
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>point-code</term>
+ <listitem>
+ <para>
+ is simply
+ <literal>MTP</literal>
+ point - either local(
+ <literal>opc</literal>
+ ) or remote(
+ <literal>dpc</literal>
+ )
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ni</term>
+ <listitem>
+ <para>is simply network identifier. It can have following
values:</para>
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+
<para>International network</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>1</term>
+ <listitem>
+ <para>Spare
(for international use only)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>2</term>
+ <listitem>
+
<para>National network</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>3</term>
+ <listitem>
+
<para>Reserved for national use</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>simple string name, which
identifies linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset creation</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset create dahdi opc 1 apc 2 ni 0
linkset1
+LinkSet successfully added
+mobicents(10.65.208.215:3435)>linkset create dialogic opc 3 apc 4 ni 3
srcmod 1 destmod 2 linkset2
+LinkSet successfully added
+ </screen>
+ </example>
+ </section>
+
+
+ <section
+ id="shell_linkset_delete">
+ <title>Remove Linkset</title>
+ <para>Linkset can be deleted by issuing command with following
structure:</para>
+ <programlisting>
+linkset delete <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Removal</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset delete linkset1
+LinkSet successfully deleted
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="shell_linkset_activate">
+ <title>Activate Linkset</title>
+ <para>Linkset can be activated by issuing command with following
structure:</para>
+ <programlisting>
+linkset activate <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Activation</title>
+ <screen>
+mobicents(10.65.208.215)>linkset activate linkset1
+LinkSet activated successfully
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="shell_linkset_deactivate">
+ <title>Deactivate Linkset</title>
+ <para>Linkset can be deactivated by issuing command with following
structure:</para>
+ <programlisting>
+linkset deactivate <linkset-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Linkset Deactivateion</title>
+ <screen>
+mobicents(10.65.208.215)>linkset deactivate linkset1
+LinkSet deactivated successfully
+ </screen>
+ </example>
+ </section>
+
+ <section
+ id="shell_linkset_link_create">
+ <title>Create Link</title>
+ <para>
+ <literal>Link</literal>
+ can be created in
+ <literal>Linkset</literal>
+ by issuing command with following structure:
+ </para>
+ <programlisting>
+linkset link create span <span-num> code <code-num> channel
<channel-num> <linkset-name> <link-name> </programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>span-num</term>
+ <listitem>
+ <para>integer number. It represents port number in card(indexed from
0).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>code-num</term>
+ <listitem>
+ <para>link code(sls assigned to this
link).</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>channel-num</term>
+ <listitem>
+ <para>integer number indicating time slot number(TDM time slot).
</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title></title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link create span 1 code 1 channel 1
linkset1 link1
+Link successfully added
+ </screen>
+ </example>
+ </section>
+ <section
+ id="shell_linkset_link_delete">
+ <title>Remove Link</title>
+ <para>
+ <literal>Link</literal>
+ can be removed from in
+ <literal>Linkset</literal>
+ by issuing command with following structure:
+ </para>
+ <programlisting>
+linkset link delete <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Removal</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link delete linkset1 link1
+Link successfully deleted
+ </screen>
+ </example>
+ </section>
+ <section
+ id="shell_linkset_link_activate">
+ <title>Activate Link</title>
+ <para>Link can be activated by issuing command with following
structure:</para>
+ <programlisting>
+linkset link activate <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Activation</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link activate linkset1 link1
+Link activated successfully
+ </screen>
+ </example>
+ </section>
+ <section
+ id="shell_linkset_link_deactivate">
+ <title>Deactivate Link</title>
+ <para>Link can be deactivated by issuing command with following
structure:</para>
+ <programlisting>
+linkset link deactivate <linkset-name> <link-name>
</programlisting>
+ <para>Where:</para>
+ <variablelist>
+ <varlistentry>
+ <term>linkset-name</term>
+ <listitem>
+ <para>is name set during link
creation</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>link-name</term>
+ <listitem>
+ <para>name which identifies link in
linkset</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ <example>
+ <title>Link Deactivateion</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset link deactivate linkset1 link1
+Link deactivated successfully
+ </screen>
+ </example>
+ </section>
+ <section
+ id="shell_linkset_show">
+ <title>Show status</title>
+ <para>Linkset and Link's status can be viewed by issuing command with
following structure:</para>
+ <programlisting>
+linkset show
+ </programlisting>
+
+ <example>
+ <title>Linkset Status</title>
+ <screen>
+mobicents(10.65.208.215:3435)>linkset show
+linkset1 dahdi opc=1 apc=2 ni=0
state=UNAVAILABLE
+ link1 span=1 channelId=1 code=1 state=UNAVAILABLE
+
+ </screen>
+ </example>
+
+ <para>The possible state of Linkset are </para>
+ <itemizedlist>
+ <listitem>
+ <para>UNAVAILABLE : Indicates the linkset does not have any
“available” links and cannot transport traffic</para>
+ </listitem>
+ <listitem>
+ <para>SHUTDOWN : Indicates the linkset has been shutdown in the
configuration</para>
+ </listitem>
+ <listitem>
+ <para>AVAILABLE : Indicates the linkset has at least one available
link and can carry traffic</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The possible state of Link are </para>
+ <itemizedlist>
+ <listitem>
+ <para>UNAVAILABLE : Indicates the link is not available to carry
traffic. This can occur if the link
+ is remotely or locally
inhibited by
+ a user. It can also be
unavailable if MTP2 has not been able to
+ successfully activate the link
connection.</para>
+ </listitem>
+ <listitem>
+ <para>SHUTDOWN : Indicates the link has been shutdown in the
configuration.</para>
+ </listitem>
+ <listitem>
+ <para>AVAILABLE : Indicates the link is active and able to transport
traffic</para>
+ </listitem>
+ <listitem>
+ <para>FAILED : A link is FAILED when the link is not shutdown but is
unavailable at layer2 for some reason.
+ For example Initial
+ Alignment failed or the link test messages sent by MTP3 are not
being acknowledged.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+ <section>
+ <title>SCCP Management</title>
+ <para>Currently <literal>Shell</literal> does not support
<literal>SCCP</literal> management.</para>
+ </section>
+</chapter>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Linkset_Management.xml
Thu Jan 6 23:53:40 2011
+++ /dev/null
@@ -1,470 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML
V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % BOOK_ENTITIES SYSTEM "SS7_Stack_User_Guide.ent">
-%BOOK_ENTITIES;
-]>
-
-<chapter
- id="linkset_management">
-
- <title>Linkset Management
- </title>
- <para>&THIS.PLATFORM; &THIS.APPLICATION; provides Shell client to manage
configuration. This chapter describes available commands.
- </para>
- <para>Shell client can be started with following command from
<filename>$JBOSS_HOME/bin</filename>:</para>
- <programlisting>
-[$] ./ss7-run.sh
- </programlisting>
- <para>Once console starts, it will print following information:</para>
- <screen>
-=========================================================================
-
-Mobicents SS7: release.version=1.0.0-SNAPSHOT
-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
-=========================================================================
-
-mobicents>
- </screen>
-
- <para>
- The <literal>ss7-run</literal> script supports following options
- </para>
-
-<screen><![CDATA[
-Usage: SS7 [OPTIONS]
-Valid Options
--v Display version number and exit
--h This help screen
-]]>
- </screen>
-
- <para>Shell needs to connect to managed instance. Command to connect has
following structure:</para>
- <programlisting>
-ss7 connect <IP> <PORT> </programlisting>
- <example>
- <title>Connec to remote machine</title>
- <screen>
-mobicents>ss7 connect 10.65.208.215 3435
-
-mobicents(10.65.208.215:3435)>
- </screen>
- </example>
- <note>
- <para>
- Host IP and port are optional, if not specified, shell will try to
connect to
- <literal>127.0.0.1:3435</literal>
- </para>
- </note>
-
- <para>Command to disconnect has following structure:</para>
- <programlisting>ss7 discconnect </programlisting>
- <example>
- <title>Disconnect</title>
- <screen>
-mobicents(10.65.208.215:3435)>ss7 connect
-
-Bye
-mobicents>
- </screen>
- </example>
-
- <para>
- Linksets are managed by
- <literal>linkset</literal>
- command. It allows to perform following:
- </para>
- <itemizedlist>
- <listitem>
- <para>create linkset</para>
- </listitem>
- <listitem>
- <para>delete linkset</para>
- </listitem>
- <listitem>
- <para>activate linkset</para>
- </listitem>
- <listitem>
- <para>deactivate linkset</para>
- </listitem>
- <listitem>
- <para>create link</para>
- </listitem>
- <listitem>
- <para>delete link</para>
- </listitem>
- <listitem>
- <para>activate link</para>
- </listitem>
- <listitem>
- <para>deactivate link</para>
- </listitem>
- <listitem>
- <para>list state of linksets and present links</para>
- </listitem>
- </itemizedlist>
-
- <section
- id="management_linkset_create">
- <title>Create Linkset</title>
- <para>Linkset can be create by issuing command with following
structure:</para>
- <programlisting>
-linkset create <linkset-type> opc <point-code> apc
<point-code> ni <network-id> <linkset-name>
</programlisting>
- <para>or in case of dialogic:</para>
- <programlisting>
-linkset create dialogic opc <point-code> apc <point-code> ni
<network-id> srcmod <src-mode> destmod <dest-mode>
<linkset-name> </programlisting>
- <para>Where:</para>
- <variablelist>
- <varlistentry>
- <term>linkset-type</term>
- <listitem>
- <para>
- refers to type of linkset to be
created, ie.
- <literal>dahdi</literal>
- ,
- <literal>dialogic</literal>
- or
- <literal>m3ua</literal>
- . Correct values depend on which linkset factories have been
deployed. <!-- AMIT: add reference to linkset section/chapter -->
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>point-code</term>
- <listitem>
- <para>
- is simply
- <literal>MTP</literal>
- point - either local(
- <literal>opc</literal>
- ) or remote(
- <literal>dpc</literal>
- )
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ni</term>
- <listitem>
- <para>is simply network identifier. It can have following
values:</para>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>International
network</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>1</term>
- <listitem>
- <para>Spare (for
international use only)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>2</term>
- <listitem>
- <para>National
network</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>3</term>
- <listitem>
- <para>Reserved for
national use</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>simple string name, which identifies
linkset</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Linkset creation</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset create dahdi opc 1 apc 2 ni 0
linkset1
-LinkSet successfully added
-mobicents(10.65.208.215:3435)>linkset create dialogic opc 3 apc 4 ni 3
srcmod 1 destmod 2 linkset2
-LinkSet successfully added
- </screen>
- </example>
- </section>
-
-
- <section
- id="management_linkset_delete">
- <title>Remove Linkset</title>
- <para>Linkset can be deleted by issuing command with following
structure:</para>
- <programlisting>
-linkset delete <linkset-name> </programlisting>
- <para>Where:</para>
- <variablelist>
-
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Linkset Removal</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset delete linkset1
-LinkSet successfully deleted
- </screen>
- </example>
- </section>
-
- <section
- id="management_linkset_activate">
- <title>Activate Linkset</title>
- <para>Linkset can be activated by issuing command with following
structure:</para>
- <programlisting>
-linkset activate <linkset-name> </programlisting>
- <para>Where:</para>
- <variablelist>
-
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Linkset Activation</title>
- <screen>
-mobicents(10.65.208.215)>linkset activate linkset1
-LinkSet activated successfully
- </screen>
- </example>
- </section>
-
- <section
- id="management_linkset_deactivate">
- <title>Deactivate Linkset</title>
- <para>Linkset can be deactivated by issuing command with following
structure:</para>
- <programlisting>
-linkset deactivate <linkset-name> </programlisting>
- <para>Where:</para>
- <variablelist>
-
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Linkset Deactivateion</title>
- <screen>
-mobicents(10.65.208.215)>linkset deactivate linkset1
-LinkSet deactivated successfully
- </screen>
- </example>
- </section>
-
- <section
- id="management_linkset_link_create">
- <title>Create Link</title>
- <para>
- <literal>Link</literal>
- can be created in
- <literal>Linkset</literal>
- by issuing command with following structure:
- </para>
- <programlisting>
-linkset link create span <span-num> code <code-num> channel
<channel-num> <linkset-name> <link-name> </programlisting>
- <para>Where:</para>
- <variablelist>
-
- <varlistentry>
- <term>span-num</term>
- <listitem>
- <para>integer number. It represents port number in card(indexed from
0).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>code-num</term>
- <listitem>
- <para>link code(sls assigned to this
link).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>channel-num</term>
- <listitem>
- <para>integer number indicating time slot number(TDM time slot).
</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>link-name</term>
- <listitem>
- <para>name which identifies link in
linkset.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title></title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset link create span 1 code 1 channel 1
linkset1 link1
-Link successfully added
- </screen>
- </example>
- </section>
- <section
- id="management_linkset_link_delete">
- <title>Remove Link</title>
- <para>
- <literal>Link</literal>
- can be removed from in
- <literal>Linkset</literal>
- by issuing command with following structure:
- </para>
- <programlisting>
-linkset link delete <linkset-name> <link-name>
</programlisting>
- <para>Where:</para>
- <variablelist>
-
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>link-name</term>
- <listitem>
- <para>name which identifies link in
linkset</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Link Removal</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset link delete linkset1 link1
-Link successfully deleted
- </screen>
- </example>
- </section>
- <section
- id="management_linkset_link_activate">
- <title>Activate Link</title>
- <para>Link can be activated by issuing command with following
structure:</para>
- <programlisting>
-linkset link activate <linkset-name> <link-name>
</programlisting>
- <para>Where:</para>
- <variablelist>
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>link-name</term>
- <listitem>
- <para>name which identifies link in
linkset</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Link Activation</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset link activate linkset1 link1
-Link activated successfully
- </screen>
- </example>
- </section>
- <section
- id="management_linkset_link_deactivate">
- <title>Deactivate Link</title>
- <para>Link can be deactivated by issuing command with following
structure:</para>
- <programlisting>
-linkset link deactivate <linkset-name> <link-name>
</programlisting>
- <para>Where:</para>
- <variablelist>
- <varlistentry>
- <term>linkset-name</term>
- <listitem>
- <para>is name set during link
creation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>link-name</term>
- <listitem>
- <para>name which identifies link in
linkset</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <example>
- <title>Link Deactivateion</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset link deactivate linkset1 link1
-Link deactivated successfully
- </screen>
- </example>
- </section>
- <section
- id="management_linkset_show">
- <title>Show status</title>
- <para>Linkset and Link's status can be viewed by issuing command with
following structure:</para>
- <programlisting>
-linkset show
- </programlisting>
-
- <example>
- <title>Linkset Status</title>
- <screen>
-mobicents(10.65.208.215:3435)>linkset show
-linkset1 dahdi opc=1 apc=2 ni=0
state=UNAVAILABLE
- link1 span=1 channelId=1 code=1 state=UNAVAILABLE
-
- </screen>
- </example>
-
- <para>The possible state of Linkset are </para>
- <itemizedlist>
- <listitem>
- <para>UNAVAILABLE : Indicates the linkset does not have any
“available” links and cannot transport traffic</para>
- </listitem>
- <listitem>
- <para>SHUTDOWN : Indicates the linkset has been shutdown in the
configuration</para>
- </listitem>
- <listitem>
- <para>AVAILABLE : Indicates the linkset has at least one available
link and can carry traffic</para>
- </listitem>
- </itemizedlist>
-
- <para>The possible state of Link are </para>
- <itemizedlist>
- <listitem>
- <para>UNAVAILABLE : Indicates the link is not available to carry
traffic. This can occur if the link
- is remotely or locally inhibited by a user. It can also be unavailable
if MTP2 has not been able to
- successfully activate the link
connection.</para>
- </listitem>
- <listitem>
- <para>SHUTDOWN : Indicates the link has been shutdown in the
configuration.</para>
- </listitem>
- <listitem>
- <para>AVAILABLE : Indicates the link is active and able to transport
traffic</para>
- </listitem>
- <listitem>
- <para>FAILED : A link is FAILED when the link is not shutdown but is
unavailable at layer2 for some reason.
- For example Initial Alignment failed or the link test messages sent by
MTP3 are not being acknowledged.</para>
- </listitem>
- </itemizedlist>
- </section>
-
-</chapter>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Thu Jan 6 23:53:40 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Design_Overview.xml
Fri Jan 7 02:20:48 2011
@@ -51,9 +51,7 @@
</listitem>
</itemizedlist>
<para>
- <literal>LinksetFactory</literal> creates instance of
<literal>Linkset</literal> on receiving instruction from
<literal>LinksetManager</literal>.
- Factories <literal>DahdiLinksetFactory</literal>,
<literal>DialogicLinksetFactory</literal> and
<literal>M3UALinksetFactory</literal> are
- defined for each type of linksets
explained above.
+ Each type of linkset has coresponding factory. Please refer to <xref
linkend="configuring_LinksetFactory"/> for list and guidelines how to
configure each factory.
</para>
<para>Configuration of linkset factories is exaplained in section
<xref linkend="configuring" /></para>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Source_Build_Binary.xml
Thu Jan 6 23:53:40 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/Chapter-Source_Build_Binary.xml
Fri Jan 7 02:20:48 2011
@@ -227,7 +227,7 @@
<section id="configuring_ShellExecutor">
<title>Configuring ShellExecutor</title>
<para>
- <literal>ShellExecutor</literal> is responsible for listening commands
from Shell Client Management and execute corresponding action.
+ <literal>ShellExecutor</literal> is responsible for listening to
incoming command. Received commands are executed on local resources to
perform actions like creation of <literal>SCCP</literal> routing rule.
</para>
<programlisting language="XML" role="XML"><![CDATA[ <bean
name="ShellExecutor" class="org.mobicents.ss7.ShellExecutor">
<property name="address">${jboss.bind.address}</property>
@@ -237,7 +237,7 @@
You may set the <literal>address</literal> property to any valid IP
address that your host is assigned.
The shell commands are exchanged over TCP/IP.</para>
<note><para>To understand JBoss bind options look at
- <ulink
url="http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html_single/index.html"></ulink>
</para> </note>
+ <ulink
url="http://docs.jboss.org/jbossas/docs/Installation_And_Getting_Started_Guide/5/html_single/index.html">Installation_And_Getting_Started_Guide</ulink>
</para> </note>
</section>
=======================================
---
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/SS7_Stack_User_Guide.xml
Thu Jan 6 23:53:40 2011
+++
/trunk/protocols/ss7/docs/sources/src/main/resources/en-US/SS7_Stack_User_Guide.xml
Fri Jan 7 02:20:48 2011
@@ -12,7 +12,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-Installation.xml" />
-->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-Setup_Hardware.xml" />
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-Linkset_Management.xml" />
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-Shell.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-SCCP.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-TCAP.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="Chapter-MAP.xml" />