4 new revisions:
Revision: a991684f5726
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:38:53 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=a991684f5726
Revision: 3ed64e9df368
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:39:16 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=3ed64e9df368
Revision: a20510f79a95
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:43:58 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=a20510f79a95
Revision: 9d7c607ac5b8
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:46:55 2012
Log: Merge branch 'master' of https://code.google.com/p/jss7
http://code.google.com/p/jss7/source/detail?r=9d7c607ac5b8
==============================================================================
Revision: a991684f5726
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:38:53 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=a991684f5726
Added:
/m3ua/cli/sctp/src/main/resources/help/sctp.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_create.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_destroy.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_association_show.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_create
/m3ua/cli/sctp/src/main/resources/help/sctp_server_create.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_destroy.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_show.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_start.txt
/m3ua/cli/sctp/src/main/resources/help/sctp_server_stop.txt
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp.txt Thu Aug 2 21:38:53 2012
@@ -0,0 +1,18 @@
+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
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_create.txt Thu
Aug 2 21:38:53 2012
@@ -0,0 +1,42 @@
+Name
+ sctp association create
+
+SYNOPSIS
+ sctp association create <assoc-name> <CLIENT | SERVER> <server-name>
<peer-ip> <peer-port> <host- ip> <host-port> <socket-type>
+
+DESCRIPTION
+ This command is used to create a new SCTP (Client side or Server side)
association.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <assoc-name> - Name of the new Association created. This must be unique
and takes any String value.
+
+ <CLIENT | SERVER> - Specify if this association is client side or server
side. If it is client side, it will initiate the connection to peer. If it
is server side, it will wait for peer to initiate the connection. The
connection request will be accepted from peer-ip: peer:port.
+
+ <peer-ip> -
+
+ <peer-port> -
+
+ <host-ip> - In a client side association, the host IP address to which
the Association will bind to. For SCTP multi-home support, you can pass
multiple IP addresses as comma separated values. The Association will bind
to the primary IP address and when it becomes unavailable, it will
automatically fall back to secondary address. If the socket-type is TCP,
these comma separated values will be ignored and the Assocation will always
bind to the primary IP address (the first value in the comma separated
list). This is required only for a client side Association. For a server
side association, even if you specify these values it will be ignored.
+
+ <host-port> - In a client side association, the host port to which the
Association will bind to. This is required only for a client side
Association. For a server side association, even if you specify these
values it will be ignored.
+
+ <server-name> - In a server-side association, the server-name must be
passed to associate with the Server identified by that name. You must
ensure that the Server identified by server-name has already been created
using the sctp server create command. In a client-side association, this is
not required and you should not pass this parameter.
+
+ Optional Parameters
+
+ <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP. If it is a SERVER SCTP Association, the
socket-type must match with the one specified while creating the Server.
+
+EXAMPLES
+ sctp association create Assoc1 CLIENT 192.168.56.101 2905
192.168.56.1,192.168.56.1 2905
+ - The above command will create a new CLIENT SCTP Association identified
as Assoc1. The client side will initiate the connection. It will bind the
host-ip 192.168.56.1 and host-port 2905 to peer-ip 192.168.56.101 and
peer-port 2905.
+
+ sctp association create Assoc2 SERVER TestServer 192.168.56.1 2905
+ - The above command will create a new SERVER SCTP association with the
Server identified as TestServer and accept connections from peer whose IP
address is 192.168.56.1 and port 2905.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association destroy, sctp association
show
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_destroy.txt Thu
Aug 2 21:38:53 2012
@@ -0,0 +1,22 @@
+Name
+ sctp association destroy
+
+SYNOPSIS
+ sctp association destroy <assoc-name>
+
+DESCRIPTION
+ This command is used to delete an existing SCTP Association identified by
the name assoc-name.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <assoc-name> - Name of the Association to be deleted.
+
+EXAMPLES
+ sctp association destroy Assoc1
+ - The above command will destroy the Association identified by the name
Assoc1.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association create, sctp association
show
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_association_show.txt Thu
Aug 2 21:38:53 2012
@@ -0,0 +1,14 @@
+Name
+ sctp association show
+
+SYNOPSIS
+ sctp association show
+
+DESCRIPTION
+ This command is used to view the details of all SCTP Associations
created. The information displayed will include the Association type
(SERVER or CLIENT), name of the Association, state (whether started=false
or true). For a CLIENT Association it will also display the host-ip,
host-port and peer-ip, peer-port values. For multi-home SCTP, it will
display all the IP addresses that are configured. For a SERVER Association,
it will display the configured peer-ip and peer-port values.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp server show, sctp association create, sctp association
destroy
+
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_create Thu Aug 2
21:38:53 2012
@@ -0,0 +1,36 @@
+Name
+ sctp server create
+
+SYNOPSIS
+ sctp server create <sever-name> <host-ip> <host-port> <socket-type>
+
+DESCRIPTION
+ This command is used to create a new SCTP Server (or TCP Server)
instance.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <server-name> - Name of the new Server created. This must be unique and
takes any String value.
+
+ <host-ip> - The host IP address to which the SCTP Server socket will
bind to. For SCTP multi-home support, you can pass multiple IP addresses as
comma separated values. The Server socket will bind to the primary IP
address and when it becomes unavailable, it will automatically fall back to
secondary address. If the socket-type is TCP, these comma separated values
will be ignored and the Server socket will always bind to the primary IP
address (the first value in the comma separated list).
+
+ <host-port> - The host port to which the underlying SCTP Server socket
will bind to.
+
+ Optional Parameters
+
+ <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP.
+
+EXAMPLES
+ sctp server create TestServer 127.0.0.1 2905
+ - The above command will create a new SCTP Server identified as
TestServer and bind the Server socket to the IP address 127.0.0.1 and port
2905.
+
+ sctp server create TestServerMulti 10.2.50.145,10.2.50.146 2905
+ - The above command will create a new SCTP Server identified as
TestServerMulti and bind the Server socket to the IP address 10.2.50.145
and port 2905. If 10.2.50.145 is unavailable, the Server will automatically
fall back to 10.2.50.146.
+
+ sctp server create TestServerTCP 127.0.0.1 2906 TCP
+ - The above command will create a new TCP Server identified as
TestServerTCP and bind the socket to the IP address 127.0.0.1 and port 2906.
+
+SEE ALSO
+ sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_create.txt Thu Aug
2 21:38:53 2012
@@ -0,0 +1,36 @@
+Name
+ sctp server create
+
+SYNOPSIS
+ sctp server create <sever-name> <host-ip> <host-port> <socket-type>
+
+DESCRIPTION
+ This command is used to create a new SCTP Server (or TCP Server)
instance.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <server-name> - Name of the new Server created. This must be unique and
takes any String value.
+
+ <host-ip> - The host IP address to which the SCTP Server socket will
bind to. For SCTP multi-home support, you can pass multiple IP addresses as
comma separated values. The Server socket will bind to the primary IP
address and when it becomes unavailable, it will automatically fall back to
secondary address. If the socket-type is TCP, these comma separated values
will be ignored and the Server socket will always bind to the primary IP
address (the first value in the comma separated list).
+
+ <host-port> - The host port to which the underlying SCTP Server socket
will bind to.
+
+ Optional Parameters
+
+ <socket-type> - If you do not specify the socket-type as "TCP", by
default it will be SCTP.
+
+EXAMPLES
+ sctp server create TestServer 127.0.0.1 2905
+ - The above command will create a new SCTP Server identified as
TestServer and bind the Server socket to the IP address 127.0.0.1 and port
2905.
+
+ sctp server create TestServerMulti 10.2.50.145,10.2.50.146 2905
+ - The above command will create a new SCTP Server identified as
TestServerMulti and bind the Server socket to the IP address 10.2.50.145
and port 2905. If 10.2.50.145 is unavailable, the Server will automatically
fall back to 10.2.50.146.
+
+ sctp server create TestServerTCP 127.0.0.1 2906 TCP
+ - The above command will create a new TCP Server identified as
TestServerTCP and bind the socket to the IP address 127.0.0.1 and port 2906.
+
+SEE ALSO
+ sctp, sctp server destroy, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_destroy.txt Thu Aug
2 21:38:53 2012
@@ -0,0 +1,23 @@
+Name
+ sctp server destroy
+
+SYNOPSIS
+ sctp server destroy <sever-name>
+
+DESCRIPTION
+ This command is used to delete an existing SCTP Server instance. You must
ensure that the Server is stopped prior to deletion.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <server-name> - Name of the Server instance to be
deleted.
+
+EXAMPLES
+ sctp server destroy TestServer
+ - The above command will destroy the Server identified by the name
TestServer.
+
+SEE ALSO
+ sctp, sctp server create, sctp server start, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_show.txt Thu Aug 2
21:38:53 2012
@@ -0,0 +1,12 @@
+Name
+ sctp server show
+
+SYNOPSIS
+ sctp server show
+
+DESCRIPTION
+ This command is used to view the details of all SCTP Server instances
created. The information displayed will include the socket type (SCTP or
TCP), name of the Server, state (whether started=false or true), the IP
address and port that the Server is bound to. For multi-home SCTP Servers
it will display all the IP addresses that are configured.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server start, sctp
server stop, sctp association create, sctp association destroy, sctp
association show
+
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_start.txt Thu Aug 2
21:38:53 2012
@@ -0,0 +1,21 @@
+Name
+ sctp server start
+
+SYNOPSIS
+ sctp server start <sever-name>
+
+DESCRIPTION
+ This command is used to start an existing SCTP Server instance. Upon
executing this command, the underlying SCTP server socket is bound to the
IP: Port configured for this Server instance at the time of creation using
the "sctp server create" command.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <server-name> - Name of the Server instance to be
started.
+
+EXAMPLES
+ sctp server start TestServer
+ - The above command will start the previously created Server instance
identified by the name TestServer and bind the underlying socket to the IP
address and port configured for TestServer at the time of creation.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server stop, sctp
server show, sctp association create, sctp association destroy, sctp
association show
=======================================
--- /dev/null
+++ /m3ua/cli/sctp/src/main/resources/help/sctp_server_stop.txt Thu Aug 2
21:38:53 2012
@@ -0,0 +1,22 @@
+Name
+ sctp server stop
+
+SYNOPSIS
+ sctp server stop <sever-name>
+
+DESCRIPTION
+ This command is used to stop an existing SCTP Server instance. Upon
executing this command, the underlying SCTP server socket is closed and all
resources are released.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <server-name> - Name of the Server instance to be
stopped.
+
+EXAMPLES
+ sctp server stop TestServer
+ - The above command will stop the currently running Server instance
identified by the name TestServer, close the underlying socket and release
all resources.
+
+SEE ALSO
+ sctp, sctp server create, sctp server destroy, sctp server start, sctp
server show, sctp association create, sctp association destroy, sctp
association show
+
==============================================================================
Revision: 3ed64e9df368
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:39:16 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=3ed64e9df368
Added:
/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
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua.txt Thu Aug 2 21:39:16 2012
@@ -0,0 +1,21 @@
+Name
+ m3ua
+ Manage M3UA - AS, ASP and Route
+
+SYNOPSIS
+ m3ua as [create | destroy | show | add | remove] [parameters]
+
+ m3ua asp [create | destroy | show | start | stop] [parameters]
+
+ m3ua route [add | remove | show] [parameters]
+
+ parameters
+ 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.
+
+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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_add.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,26 @@
+Name
+ m3ua as add
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <as-name> - Name of the AS to which this ASP is being
assigned.
+
+ <asp-name> - Name of the ASP that is being
assigned to the AS.
+
+EXAMPLES
+ m3ua as add AS1 ASP1
+ - 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_create.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,39 @@
+Name
+ 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>
+
+DESCRIPTION
+ This command is used to create a new Application Server.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <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.
+
+ <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.
+
+ 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.
+
+ <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.
+
+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'.
+
+ 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.
+
+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.
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_destroy.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,23 @@
+Name
+ m3ua as destroy
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <as-name> - Name of the AS instance to be deleted.
+
+EXAMPLES
+ m3ua as destroy 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_remove.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,26 @@
+Name
+ m3ua as remove
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <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.
+
+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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_as_show.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,13 @@
+Name
+ m3ua as show
+
+SYNOPSIS
+ 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.
+
+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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_create.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,23 @@
+Name
+ m3ua asp create
+
+SYNOPSIS
+ m3ua asp create <asp-name> <sctp-association>
+
+DESCRIPTION
+ This command is used to create a new Application Server Process.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <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.
+
+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.
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_destroy.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,23 @@
+Name
+ m3ua asp destroy
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <asp-name> - Name of the ASP to be deleted.
+
+EXAMPLES
+ m3ua asp destroy 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_show.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,13 @@
+Name
+ m3ua asp show
+
+SYNOPSIS
+ 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.
+
+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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_start.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,23 @@
+Name
+ m3ua asp start
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <asp-name> - Name of the ASP to be started.
+
+EXAMPLES
+ m3ua asp start 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_asp_stop.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,23 @@
+Name
+ m3ua asp stop
+
+SYNOPSIS
+ m3ua asp stop <asp-name>
+
+DESCRIPTION
+ This command is used to stop a currently running ASP.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <asp-name> - Name of the ASP to be stopped.
+
+EXAMPLES
+ m3ua asp stop 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_add.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,28 @@
+Name
+ m3ua route add
+
+SYNOPSIS
+ 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.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <as-name> - Name of the AS assigned to route message for
this dpc.
+
+ <dpc> - Destination Point Code.
+
+ <opc> - Originating Point Code.
+
+ <si> - Service Indicator.
+
+EXAMPLES
+ 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_remove.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,28 @@
+Name
+ m3ua route remove
+
+SYNOPSIS
+ m3ua route remove <as-name> <dpc> <opc> <si>
+
+DESCRIPTION
+ This command is used to remove a previously configured route.
+
+PARAMETERS
+
+ Standard Parameters
+
+ <as-name> - Name of the AS assigned to route message for
this dpc.
+
+ <dpc> - Destination Point Code.
+
+ <opc> - Originating Point Code.
+
+ <si> - Service Indicator.
+
+EXAMPLES
+ 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.
+
+
=======================================
--- /dev/null
+++ /m3ua/cli/m3ua/src/main/resources/help/m3ua_route_show.txt Thu Aug 2
21:39:16 2012
@@ -0,0 +1,13 @@
+Name
+ m3ua route show
+
+SYNOPSIS
+ m3ua route show
+
+DESCRIPTION
+ 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.
+
+
==============================================================================
Revision: a20510f79a95
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:43:58 2012
Log: help files
http://code.google.com/p/jss7/source/detail?r=a20510f79a95
Added:
/management/linkset/src/main/resources/help/linkset.txt
/management/linkset/src/main/resources/help/linkset_activate.txt
/management/linkset/src/main/resources/help/linkset_create.txt
/management/linkset/src/main/resources/help/linkset_deactivate.txt
/management/linkset/src/main/resources/help/linkset_delete.txt
/management/linkset/src/main/resources/help/linkset_link_activate.txt
/management/linkset/src/main/resources/help/linkset_link_create.txt
/management/linkset/src/main/resources/help/linkset_link_deactivate.txt
/management/linkset/src/main/resources/help/linkset_link_delete.txt
/management/linkset/src/main/resources/help/linkset_link_show.txt
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset.txt Thu Aug 2
21:43:58 2012
@@ -0,0 +1,20 @@
+Name
+ linkset
+ Manage links and linksets
+
+SYNOPSIS
+ linkset [create | remove | activate | deactivate | show] [options]
[parameters]
+
+ linkset link [create | remove | activate | deactivate]
[parameters]
+
+ options
+ Command Line options.
+ parameters
+ Command Line parameters.
+
+DESCRIPTION
+ This command is used to manage linksets and links within a linkset. You
can create, remove, activate, deactivate and view the status of linksets
and links using this command. You can manage three types of links (M3UA or
dialogic or dahdi) using the linkset command by using appropriate values
for the parameters passed.
+
+SEE ALSO
+ linkset create, linkset delete, linkset activate, linkset deactivate,
linkset show, linkset link create, linkset link delete, linkset link
activate, linkset link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_activate.txt Thu
Aug 2 21:43:58 2012
@@ -0,0 +1,20 @@
+Name
+ linkset activate
+
+SYNOPSIS
+ linkset activate <linkset-name>
+
+ <linkset-name>
+ is the name of the Linkset to be activated.
+
+DESCRIPTION
+ This command is used to activate an existing Linkset.
+
+EXAMPLE
+
+ linkset activate dahdilinkset1
+ - The above command will activate the Linkset identified by the name
dahdilinkset1.
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset deactivate, linkset
show, linkset link create, linkset link delete, linkset link activate,
linkset link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_create.txt Thu Aug
2 21:43:58 2012
@@ -0,0 +1,57 @@
+Name
+ linkset create
+
+SYNOPSIS
+ linkset create [m3ua | dialogic | dahdi] [parameters] <linkset-name>
+
+ parameters
+ Command Line parameters to specify appropriate values for the linkset
based on the type of linkset created.
+
+DESCRIPTION
+ This command is used to create a new Linkset of type M3UA or Dialogic or
Dahdi as explained below. You must ensure that appropriate linkset
factories are deployed prior to creating any linkset.
+
+USAGE
+ linkset create m3ua opc <point-code> apc <point-code> ni <network-id> as
<as-name> <linkset-name>
+
+ linkset create dialogic opc <point-code> apc <point-code> ni <network-id>
srcmod <src-mode> destmod <dest-mode> <linkset-name>
+
+ linkset create dahdi opc <point-code> apc <point-code> ni <network-id>
<linkset-name>
+
+PARAMETERS
+
+ Standard Parameters
+
+ opc <point-code> - MTP Point code of the originating signalling point.
Takes an Integer Value.
+
+ apc <point-code> - MTP Point code of the adjacent signalling point.
Takes an Integer Value.
+
+ ni <network-id> - Network Identifier and should be one of the following
values
+ 0 - International
Network
+ 1 - Spare (for
International use only)
+ 2 - National Network
+ 3 - Reserved for
National use
+
+ <linkset-name> - Name of the Linkset to be created. This will be used
to identify the linkset. Takes a String value.
+
+ Specific Parameters
+
+ as <as-name> - Name of the Application Server that is wrapped by the
newly created Linkset. This parameter is mandatory and applicable only for
M3UA linksets. You must ensure that the Application Server is already
created before using it in the command here. Refer to 'm3ua as create' for
more help on creating an Application Server.
+
+ srcmod <src-mode> - ??
+
+ destmod <dest-mode> - ??
+
+EXAMPLES
+
+ linkset create m3ua opc 1 apc 2 ni 2 as AS1 m3ualinkset1
+ - The above command will create a new linkset of type M3UA and name
m3ualinkset1 that wraps around the Application Server AS1. The originating
point code value is 1 and the adjacent point code value is 2 and the
network is a national network.
+
+ linkset create dahdi opc 3 apc 4 ni 0 dahdilinkset1
+ - The above command will create a new linkset of type Dahdi and name
dahdilinkset1. The originating point code value is 3 and the adjacent point
code value is 4 and the network is an international network.
+
+ linkset create dialogic opc 5 apc 6 ni 2 srcmod 1 destmod 2
dialogiclinkset1
+ - The above command will create a new linkset of type Dialogic and name
dialogiclinkset. The originating point code value is 5 and the adjacent
point code value is 6 and the network is a national network.
+
+SEE ALSO
+ linkset, linkset delete, linkset activate, linkset deactivate, linkset
show, linkset link create, linkset link delete, linkset link activate,
linkset link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_deactivate.txt Thu
Aug 2 21:43:58 2012
@@ -0,0 +1,20 @@
+Name
+ linkset deactivate
+
+SYNOPSIS
+ linkset deactivate <linkset-name>
+
+ <linkset-name>
+ is the name of the Linkset to be deactivated.
+
+DESCRIPTION
+ This command is used to deactivate an existing Linkset.
+
+EXAMPLE
+
+ linkset deactivate dahdilinkset1
+ - The above command will deactivate the Linkset identified by the name
dahdilinkset1.
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset show,
linkset link create, linkset link delete, linkset link activate, linkset
link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_delete.txt Thu Aug
2 21:43:58 2012
@@ -0,0 +1,20 @@
+Name
+ linkset delete
+
+SYNOPSIS
+ linkset delete <linkset-name>
+
+ <linkset-name>
+ is the name of the Linkset to be deleted.
+
+DESCRIPTION
+ This command is used to delete an existing Linkset.
+
+EXAMPLE
+
+ linkset delete m3ualinkset1
+ - The above command will delete the Linkset identified by the name
m3ualinkset1.
+
+SEE ALSO
+ linkset, linkset create, linkset activate, linkset deactivate, linkset
show, linkset link create, linkset link delete, linkset link activate,
linkset link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_link_activate.txt
Thu Aug 2 21:43:58 2012
@@ -0,0 +1,23 @@
+Name
+ linkset link activate
+
+SYNOPSIS
+ linkset link activate <linkset-name> <link-name>
+
+ <link-name>
+ is the name of the Link to be activated.
+
+ <linkset-name>
+ is the name of the Linkset in which the Link resides.
+
+DESCRIPTION
+ This command is used to activate an existing Link within a Linkset.
+
+EXAMPLE
+
+ linkset link activate linkset1 link1
+ - The above command will activate the Link identified by the name Link1
within the Linkset linkset1..
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate, linkset show, linkset link create, linkset link delete, linkset
link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_link_create.txt Thu
Aug 2 21:43:58 2012
@@ -0,0 +1,29 @@
+Name
+ linkset link create
+
+SYNOPSIS
+ linkset link create span <span-num> code <code-num> channel <channel-num>
<linkset-name> <link-name>
+
+DESCRIPTION
+ This command is used to create a new Link within a Linkset. The Linkset
must be created prior to executing this command.
+
+PARAMETERS
+ span <span-num> - Port number in the Card (indexed from 0). Takes an
Integer Value.
+
+ code <code-num> - Signaling Link code - SLS (Signaling link selection)
assigned to this Link. Takes an Integer Value.
+
+ channel <channel-num> - Time Slot number (TDM time slot). Takes an
Integer Value.
+
+ <linkset-name> - Name of the Linkset within which the new Link is being
created.
+
+ <link-name> - Name of the Link to be created. This will be used to
identify the Link. Takes a String value.
+
+
+EXAMPLES
+
+ linkset link create span 1 code 1 channel 1 linkset1 link1
+ - The above command will create a new Link identified as link1 within an
existing Linkset identified as linkset1.
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate, linkset show, linkset link delete, linkset link activate,
linkset link deactivate.
+
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_link_deactivate.txt
Thu Aug 2 21:43:58 2012
@@ -0,0 +1,22 @@
+Name
+ linkset link deactivate
+
+SYNOPSIS
+ linkset link deactivate <linkset-name> <link-name>
+
+ <link-name>
+ is the name of the Link to be deactivated.
+
+ <linkset-name>
+ is the name of the Linkset in which the Link resides.
+
+DESCRIPTION
+ This command is used to deactivate an existing Link within a Linkset.
+
+EXAMPLE
+
+ linkset link deactivate linkset1 link1
+ - The above command will deactivate the Link identified by the name Link1
within the Linkset linkset1..
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate, linkset show, linkset link create, linkset link delete, linkset
link activate.
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_link_delete.txt Thu
Aug 2 21:43:58 2012
@@ -0,0 +1,22 @@
+Name
+ linkset link delete
+
+SYNOPSIS
+ linkset link delete <linkset-name> <link-name>
+
+ <link-name>
+ is the name of the Link to be deleted.
+
+ <linkset-name>
+ is the name of the Linkset in which the Link resides.
+
+DESCRIPTION
+ This command is used to delete an existing Link within a Linkset.
+
+EXAMPLE
+
+ linkset link delete linkset1 link1
+ - The above command will delete the Link identified by the name Link1
within the Linkset linkset1..
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate, linkset show, linkset link create, linkset link activate,
linkset link deactivate.
=======================================
--- /dev/null
+++ /management/linkset/src/main/resources/help/linkset_link_show.txt Thu
Aug 2 21:43:58 2012
@@ -0,0 +1,25 @@
+Name
+ linkset show
+
+SYNOPSIS
+ linkset show
+
+DESCRIPTION
+ This command is used to view all Links and Linksets and their states.
+
+ The possible states of a Linkset are:
+
+ - UNAVAILABLE : Indicates that the Linkset does not have any 'available'
links and cannot transport traffic.
+ - SHUTDOWN : Indicates that Linkset has been shutdown.
+ - AVAILABLE : Indicates that the Linkset has atleast one 'available' link
and can transport traffic.
+
+ The possible states of a Link are:
+
+ - UNAVAILABLE : Indicates that the Link is not 'available' to transport
traffic. A Link is 'unavailable' 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.
+ - SHUTDOWN : Indicates the Link has been shutdown in the configuration.
+ - AVAILABLE : Indicates the Link is active and 'available' to transport
traffic.
+ - FAILED : Indicates that the Link is not 'shutdown' but is 'unavailable'
at Layer 2 for some reason. For example, the Initial Alignment may fail, or
the link test messages sent by MTP 3 are not being acknowledged.
+
+SEE ALSO
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate, linkset link create, linkset link delete, linkset link
activate, linkset link deactivate.
+
==============================================================================
Revision: 9d7c607ac5b8
Author: Vinu S Renish <[email protected]>
Date: Thu Aug 2 21:46:55 2012
Log: Merge branch 'master' of https://code.google.com/p/jss7
http://code.google.com/p/jss7/source/detail?r=9d7c607ac5b8