Revision: 49db30a4c484
Author: Vinu S Renish <[email protected]>
Date: Mon Aug 13 02:30:26 2012
Log: neatness and wrap
http://code.google.com/p/jss7/source/detail?r=49db30a4c484
Modified:
/m3ua/cli/m3ua/src/main/resources/help/m3ua.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_as_add.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_as_create.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_as_destroy.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_as_remove.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_as_show.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_create.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_destroy.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_show.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_start.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_stop.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_route_add.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_route_remove.txt
/m3ua/cli/m3ua/src/main/resources/help/m3ua_route_show.txt
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua.txt Thu Aug 2 21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua.txt Mon Aug 13 02:30:26 2012
@@ -13,9 +13,14 @@
Command Line parameters.
DESCRIPTION
- This command is used to manage M3UA - AS (Application Server), ASP
(Application Server Process) and Route. You can create and destroy an AS
using the m3ua as command. You can create, destroy, start and stop an ASP
using the m3ua asp command. You can manage route configuration using the
m3ua route command.
+ This command is used to manage M3UA - AS (Application Server),
+ ASP (Application Server Process) and Route. You can create and destroy an
AS using
+ the m3ua as command. You can create, destroy, start and stop an ASP using
the
+ m3ua asp command. You can manage route configuration using the m3ua route
command.
SEE ALSO
- m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create, m3ua asp
destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create, m3ua asp
destroy,
+ m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_add.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_add.txt Mon Aug 13
02:30:26 2012
@@ -5,7 +5,12 @@
m3ua as add <as-name> <asp-name>
DESCRIPTION
- This command is used to assign an Application Server Process to an
Application Server. The AS and ASP must both be created prior to executing
this command. You can configure an ASP to process signaling traffic related
to more than one AS, over a single SCTP Association. However you must
ensure that all the Application Servers that share the ASP are configured
with a valid Routing Context value.
+ This command is used to assign an Application Server Process to an
Application
+ Server. The AS and ASP must both be created prior to executing this
command.
+
+ You can configure an ASP to process signaling traffic related to more
than one AS,
+ over a single SCTP Association. However you must ensure that all the
Application
+ Servers that share the ASP are configured with a valid Routing Context
value.
PARAMETERS
@@ -20,7 +25,8 @@
- The above command will assign ASP1 to AS1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
-remove, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_create.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_create.txt Mon Aug 13
02:30:26 2012
@@ -2,7 +2,9 @@
m3ua as create
SYNOPSIS
- m3ua as create <as-name> <AS | SGW | IPSP> mode <SE | DE> ipspType
<client | server> rc <routing- context> traffic-mode <traffic mode>
<network-appearance>
+ m3ua as create <as-name> <AS | SGW | IPSP> mode <SE | DE>
+ ipspType <client | server> rc <routing- context> traffic-mode <traffic
mode>
+ <network-appearance>
DESCRIPTION
This command is used to create a new Application Server.
@@ -11,29 +13,76 @@
Standard Parameters
- <as-name> - Name of the new Server created. This must be unique and
takes any String value.
+ <as-name> - Name of the new Server created. This must be
+ unique and takes any String value.
- <AS | SGW | IPSP> - The type of the new Server is specified using this
parameter. The three possible values are AS (Application Server), SGW
(Signaling Gateway) and IPSP.
+ <AS | SGW | IPSP> - The type of the new Server is specified using
this
+ parameter. The three possible values are
+ AS (Application Server), SGW (Signaling
Gateway)
+ and IPSP.
- <SE | DE> - You must specify if Single Exchange or Double Exchange of
ASPSM (ASP State Maintenance) and ASPTM (ASP Traffic Maintenance) messages
should be performed.
+ <SE | DE> - You must specify if Single Exchange or
+ Double Exchange of ASPSM (ASP State
Maintenance)
+ and ASPTM (ASP Traffic Maintenance)
messages
+ should be performed.
- <client | server> - This is required if the newly created AS is of type
IPSP. You must specify is if it is of type Client or Server.
+ <client | server> - This is required if the newly created AS is of
+ type IPSP. You must specify is if it is
of type
+ Client or Server.
Optional Parameters
- <routing-context> - This refers to the Routing Context configured for
M3UA Stack on SGW. This parameter is optional. However for an ASP
(Application Server Process) assigned to this AS to be configured to
process signaling traffic related to more than one AS over a single SCTP
Association, it is mandatory to specify a routing-context for the AS. If an
ASP is configured to always process signaling traffic from one AS,
irrespective of whether the received messages have routing context set or
not, it will always be delivered to AS for further processing.
-However if an ASP is configured to process signaling traffic related to
more than one AS over a single SCTP Association and if a signaling message
is received without RC, then the ASP will drop the message and send back an
Error message. A respective log4j error will also be logged.
+ <routing-context> - This refers to the Routing Context configured
for
+ M3UA Stack on SGW. This parameter is
optional.
- <traffic-mode> - You may choose to specify the traffic mode for ASPs.
At the moment jSS7 M3UA supports only 2 modes: loadshare and override.
Broadcast mode is not supported. This is an optional parameter and if not
specified the default mode is 'loadshare'.
+ However for an ASP (Application Server
Process)
+ assigned to this AS to be configured to
process
+ signaling traffic related to more than
one AS over
+ a single SCTP Association, it is
mandatory to
+ specify a routing-context for the AS.
If an ASP is
+ configured to always process signaling
traffic
+ from one AS, irrespective of whether
the received
+ messages have routing context set or
not, it will
+ always be delivered to AS for further
processing.
+
+ However if an ASP is configured to
process
+ signaling traffic related to more than
one AS over
+ a single SCTP Association and if a
signaling
+ message is received without RC, then
the ASP will
+ drop the message and send back an Error
message.
+ A respective log4j error will also be
logged.
+
+ <traffic-mode> - You may choose to specify the traffic
mode for
+ ASPs. At the moment jSS7 M3UA supports
only
+ 2 modes: loadshare and override.
Broadcast mode is
+ not supported.
+
+ This is an optional parameter and if
not specified
+ the default mode is 'loadshare'.
- <network-appearance> - This is a M3UA local reference (typically an
integer) shared by SG and AS. This value together with a Signaling Point
Code, uniquely identifies a SS7 node by indicating the specific SS7 network
to which it belongs. It can be used to distinguish between signalling
traffic, associated with different networks, being sent between the SG and
the ASP over a common SCTP association.
+ <network-appearance> - This is a M3UA local reference
(typically an
+ integer) shared by SG and AS. This
value together
+ with a Signaling Point Code, uniquely
identifies a
+ SS7 node by indicating the specific SS7
network to
+ which it belongs. It can be used to
distinguish
+ between signalling traffic, associated
with
+ different networks, being sent between
the SG and
+ the ASP over a common SCTP association.
EXAMPLES
m3ua as create AS1 IPSP mode DE ipspType server rc 1 traffic-mode
loadshare
- - The above command will create a new M3UA Application Server identified
as AS1, of type IPSP (Server), Double Exchange mode. The Routing Context is
1 and traffic-mode is 'loadshare'.
+
+ The above command will create a new M3UA Application Server identified as
AS1,
+ of type IPSP (Server), Double Exchange mode. The Routing Context is 1
and
+ traffic-mode is 'loadshare'.
m3ua as create AS2 AS mode SE rc 100 traffic-mode loadshare
network-appearance 12
- - The above command will create a new M3UA Application Server identified
as AS2, of type AS, Single Exchange mode. The Routing Context is 100,
traffic-mode is 'loadshare' and the network-appearance value is 12.
+
+ The above command will create a new M3UA Application Server identified as
AS2,
+ of type AS, Single Exchange mode. The Routing Context is 100,
+ traffic-mode is 'loadshare' and the network-appearance value is 12.
SEE ALSO
- m3ua as destroy, m3ua as show, m3ua asp create, m3ua asp destroy, m3ua
asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove, m3ua
route add, m3ua route remove, m3ua route show.
+ m3ua as destroy, m3ua as show, m3ua asp create, m3ua asp destroy, m3ua
asp show,
+ m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove, m3ua route
add,
+ m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_destroy.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_destroy.txt Mon Aug 13
02:30:26 2012
@@ -5,7 +5,9 @@
m3ua as destroy <as-name>
DESCRIPTION
- This command is used to delete an existing M3UA Application Server
instance identified by the name 'as-name'. You must ensure that all ASPs
are unassigned and the AS state is 'INACTIVE' prior to destroying the AS.
+ This command is used to delete an existing M3UA Application Server
instance
+ identified by the name 'as-name'. You must ensure that all ASPs are
unassigned and
+ the AS state is 'INACTIVE' prior to destroying the AS.
PARAMETERS
@@ -15,9 +17,12 @@
EXAMPLES
m3ua as destroy AS1
- - The above command will destroy the AS identified by the name AS1.
+
+ The above command will destroy the AS identified by the name AS1.
SEE ALSO
- m3ua, m3ua as create, m3ua as show, m3ua asp create, m3ua asp destroy,
m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove,
m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as show, m3ua asp create, m3ua asp destroy,
+ m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_remove.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_remove.txt Mon Aug 13
02:30:26 2012
@@ -5,22 +5,26 @@
m3ua as remove <as-name> <asp-name>
DESCRIPTION
- This command is used to un-assign an Application Server Process from an
Application Server that it was previously assigned to.
+ This command is used to un-assign an Application Server Process from an
+ Application Server that it was previously assigned to.
PARAMETERS
Standard Parameters
- <as-name> - Name of the AS from which this ASP is being
un-
-assigned.
+ <as-name> - Name of the AS from which this ASP is being
+ un-assigned.
<asp-name> - Name of the ASP to be un-assigned.
EXAMPLES
m3ua as remove AS1 ASP1
- - The above command will remove ASP1 from AS1.
+
+ The above command will remove ASP1 from AS1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_show.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_show.txt Mon Aug 13
02:30:26 2012
@@ -5,9 +5,14 @@
m3ua as show
DESCRIPTION
- This command is used to view the details of all configured Application
Servers. The information displayed will include the configured
functionality (AS or IPSP or SGW), mode (SE or DE), IPSP type (if
applicable), routing context, traffic mode and network appearance values.
+ This command is used to view the details of all configured Application
Servers.
+ The information displayed will include the configured
+ functionality (AS or IPSP or SGW), mode (SE or DE), IPSP type (if
applicable),
+ routing context, traffic mode and network appearance values.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua asp create, m3ua asp destroy,
m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove,
m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua asp create, m3ua asp
destroy,
+ m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_create.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_create.txt Mon Aug 13
02:30:26 2012
@@ -11,13 +11,19 @@
Standard Parameters
- <asp-name> - Name of the new Application Server Process created. This
must be unique and takes any String value.
+ <asp-name> - Name of the new Application
Server Process
+ created. This must be unique
and takes any
+ String value.
<sctp-association> - Name of the SCTP Association
EXAMPLES
m3ua asp create ASP1 Assoc1
- - The above command will create a new M3UA Application Server Process
identified as ASP1.
+
+ The above command will create a new M3UA Application Server Process
identified
+ as ASP1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp destroy,
m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove,
m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp destroy,
+ m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_destroy.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_destroy.txt Mon Aug 13
02:30:26 2012
@@ -5,7 +5,9 @@
m3ua asp destroy <asp-name>
DESCRIPTION
- This command is used to delete an existing M3UA Application Server
Process identified by the name 'asp-name'. You must ensure that the ASP is
stopped prior to issuing the command.
+ This command is used to delete an existing M3UA Application Server
Process
+ identified by the name 'asp-name'. You must ensure that the ASP is
stopped prior
+ to issuing the command.
PARAMETERS
@@ -15,9 +17,12 @@
EXAMPLES
m3ua asp destroy ASP1
- - The above command will destroy the ASP identified by the name ASP1.
+
+ The above command will destroy the ASP identified by the name ASP1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as remove,
m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_show.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_show.txt Mon Aug 13
02:30:26 2012
@@ -5,9 +5,13 @@
m3ua asp show
DESCRIPTION
- This command is used to view the details of all configured Application
Server Processes. The information displayed will include the name, the SCTP
Association name and if it is started or stopped.
+ This command is used to view the details of all configured Application
Server
+ Processes. The information displayed will include the name, the SCTP
Association
+ name and if it is started or stopped.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp start, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_start.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_start.txt Mon Aug 13
02:30:26 2012
@@ -5,7 +5,8 @@
m3ua asp start <asp-name>
DESCRIPTION
- This command is used to start an existing ASP. You must ensure that the
ASP is assigned to at least one AS prior to starting it.
+ This command is used to start an existing ASP. You must ensure that the
ASP is
+ assigned to at least one AS prior to starting it.
PARAMETERS
@@ -15,9 +16,12 @@
EXAMPLES
m3ua asp start ASP1
- - The above command will start the ASP identified by the name ASP1.
+
+ The above command will start the ASP identified by the name ASP1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp stop, m3ua as add, m3ua as
remove, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp stop, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_stop.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_stop.txt Mon Aug 13
02:30:26 2012
@@ -15,9 +15,12 @@
EXAMPLES
m3ua asp stop ASP1
- - The above command will stop the ASP identified by the name ASP1.
+
+ The above command will stop the ASP identified by the name ASP1.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua as add, m3ua as
remove, m3ua route add, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua as add, m3ua as
remove,
+ m3ua route add, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_add.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_add.txt Mon Aug 13
02:30:26 2012
@@ -5,13 +5,16 @@
m3ua route add <as-name> <dpc> <opc> <si>
DESCRIPTION
- This command is used to configure an AS to route message, i.e. configure
the destination point code that the message will be routed to. You must
ensure that the AS is created prior to executing this command.
+ This command is used to configure an AS to route message, i.e. configure
the
+ destination point code that the message will be routed to. You must
ensure that
+ the AS is created prior to executing this command.
PARAMETERS
Standard Parameters
- <as-name> - Name of the AS assigned to route message for
this dpc.
+ <as-name> - Name of the AS assigned to route message for
+ this dpc.
<dpc> - Destination Point Code.
@@ -23,6 +26,8 @@
m3ua route add AS1 2 -1 -1
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add, m3ua as remove, m3ua route remove, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add,
+ m3ua as remove, m3ua route remove, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_remove.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_remove.txt Mon Aug 13
02:30:26 2012
@@ -11,7 +11,8 @@
Standard Parameters
- <as-name> - Name of the AS assigned to route message for
this dpc.
+ <as-name> - Name of the AS assigned to route message for
+ this dpc.
<dpc> - Destination Point Code.
@@ -23,6 +24,8 @@
m3ua route remove AS1 2 -1 -1
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add, m3ua as remove, m3ua route add, m3ua route show.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add,
+ m3ua as remove, m3ua route add, m3ua route show.
=======================================
--- /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_show.txt Thu Aug 2
21:39:16 2012
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_show.txt Mon Aug 13
02:30:26 2012
@@ -8,6 +8,8 @@
This command is used to display all configured routes.
SEE ALSO
- m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add, m3ua as remove, m3ua route add, m3ua route remove.
+ m3ua, m3ua as create, m3ua as destroy, m3ua as show, m3ua asp create,
+ m3ua asp destroy, m3ua asp show, m3ua asp start, m3ua asp stop, m3ua as
add,
+ m3ua as remove, m3ua route add, m3ua route remove.