Revision: 3727af4aa5b9
Author: Vinu S Renish <[email protected]>
Date: Sun Aug 12 23:40:10 2012
Log: wrapping and neatness, removed m3ua and dialogic linkset details
http://code.google.com/p/jss7/source/detail?r=3727af4aa5b9
Added:
/hardware/cli/src/main/resources/help/linkset_show.txt
Deleted:
/hardware/cli/src/main/resources/help/linkset_link_show.txt
Modified:
/hardware/cli/src/main/resources/help/linkset.txt
/hardware/cli/src/main/resources/help/linkset_activate.txt
/hardware/cli/src/main/resources/help/linkset_create.txt
/hardware/cli/src/main/resources/help/linkset_deactivate.txt
/hardware/cli/src/main/resources/help/linkset_delete.txt
/hardware/cli/src/main/resources/help/linkset_link_activate.txt
/hardware/cli/src/main/resources/help/linkset_link_create.txt
/hardware/cli/src/main/resources/help/linkset_link_deactivate.txt
/hardware/cli/src/main/resources/help/linkset_link_delete.txt
/pom.xml
=======================================
--- /dev/null
+++ /hardware/cli/src/main/resources/help/linkset_show.txt Sun Aug 12
23:40:10 2012
@@ -0,0 +1,42 @@
+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.
+
=======================================
--- /hardware/cli/src/main/resources/help/linkset_link_show.txt Thu Aug 9
04:50:04 2012
+++ /dev/null
@@ -1,25 +0,0 @@
-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.
-
=======================================
--- /hardware/cli/src/main/resources/help/linkset.txt Thu Aug 9 04:50:04
2012
+++ /hardware/cli/src/main/resources/help/linkset.txt Sun Aug 12 23:40:10
2012
@@ -5,16 +5,21 @@
SYNOPSIS
linkset [create | remove | activate | deactivate | show] [options]
[parameters]
- linkset link [create | remove | activate | deactivate]
[parameters]
+ linkset link [create | remove | activate | deactivate] [parameters]
- options
+ 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.
+ 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 dahdi linksets 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.
+ linkset create, linkset delete, linkset activate, linkset deactivate,
+ linkset show, linkset link create, linkset link delete, linkset link
activate,
+ linkset link deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_activate.txt Thu Aug 9
04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_activate.txt Sun Aug 12
23:40:10 2012
@@ -4,17 +4,19 @@
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.
+PARAMETERS
+ <linkset-name> - Name of the Linkset to be activated.
+
EXAMPLE
-
linkset activate dahdilinkset1
- - The above command will activate the Linkset identified by the name
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.
+ linkset, linkset create, linkset delete, linkset deactivate, linkset
show,
+ linkset link create, linkset link delete, linkset link activate,
+ linkset link deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_create.txt Thu Aug 9
04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_create.txt Sun Aug 12
23:40:10 2012
@@ -2,56 +2,41 @@
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.
+ linkset create dahdi opc <point-code> apc <point-code> ni <network-id>
+ <linkset-name>
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>
+ This command is used to create a new Linkset of type Dahdi as explained
below. You
+ must ensure that appropriate linkset factories are deployed prior to
creating any
+ linkset.
PARAMETERS
+ opc <point-code> - MTP Point code of the originating
+ signalling point. Takes an
Integer Value.
- Standard Parameters
+ apc <point-code> - MTP Point code of the adjacent
signalling
+ point. Takes an Integer Value.
- 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
+ ni <network-id> - Network Identifier and should be one
of
+ the following values
0 - International
Network
- 1 - Spare (for
International use only)
+ 1 - Spare (for
International use)
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> - ??
+ <linkset-name> - Name of the Linkset to be
created. This
+ will be used to identify the
linkset.
+ Takes a String value.
- destmod <dest-mode> - ??
+EXAMPLES
+ linkset create dahdi opc 3 apc 4 ni 0 dahdilinkset1
-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.
+ 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.
SEE ALSO
- linkset, linkset delete, linkset activate, linkset deactivate, linkset
show, linkset link create, linkset link delete, linkset link activate,
linkset link deactivate.
+ linkset, linkset delete, linkset activate, linkset deactivate, linkset
show,
+ linkset link create, linkset link delete, linkset link activate,
+ linkset link deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_deactivate.txt Thu Aug 9
04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_deactivate.txt Sun Aug 12
23:40:10 2012
@@ -4,17 +4,19 @@
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.
+PARAMETERS
+ <linkset-name> - Name of the Linkset to be deactivated.
+
EXAMPLE
-
linkset deactivate dahdilinkset1
- - The above command will deactivate the Linkset identified by the name
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.
+ linkset, linkset create, linkset delete, linkset activate, linkset show,
+ linkset link create, linkset link delete, linkset link activate,
+ linkset link deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_delete.txt Thu Aug 9
04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_delete.txt Sun Aug 12
23:40:10 2012
@@ -4,17 +4,19 @@
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.
+PARAMETERS
+ <linkset-name> - Name of the Linkset to be deleted.
+
EXAMPLE
-
- linkset delete m3ualinkset1
- - The above command will delete the Linkset identified by the name
m3ualinkset1.
+ linkset delete dahdilinkset1
+
+ The above command will delete the Linkset identified by the name
dahdilinkset1.
SEE ALSO
- linkset, linkset create, linkset activate, linkset deactivate, linkset
show, linkset link create, linkset link delete, linkset link activate,
linkset link deactivate.
+ linkset, linkset create, linkset activate, linkset deactivate, linkset
show,
+ linkset link create, linkset link delete, linkset link activate,
+ linkset link deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_link_activate.txt Thu
Aug 9 04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_link_activate.txt Sun Aug
12 23:40:10 2012
@@ -4,20 +4,21 @@
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.
+PARAMETERS
+ <link-name> - Name of the Link to be activated.
+
+ <linkset-name> - Name of the Linkset within which the
Link resides.
+
EXAMPLE
-
linkset link activate linkset1 link1
- - The above command will activate the Link identified by the name Link1
within the Linkset linkset1..
+
+ 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.
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate,
+ linkset show, linkset link create, linkset link delete, linkset link
deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_link_create.txt Thu Aug
9 04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_link_create.txt Sun Aug
12 23:40:10 2012
@@ -2,28 +2,37 @@
linkset link create
SYNOPSIS
- linkset link create span <span-num> code <code-num> channel <channel-num>
<linkset-name> <link-name>
+ 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.
+ 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.
+ 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.
+ 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.
+ 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.
+ <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.
-
+ <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.
+
+ 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.
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate,
+ linkset show, linkset link delete, linkset link activate, linkset link
deactivate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_link_deactivate.txt Thu
Aug 9 04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_link_deactivate.txt Sun
Aug 12 23:40:10 2012
@@ -4,19 +4,20 @@
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
+PARAMETERS
+ <link-name> - Name of the Link to be deactivated.
+ <linkset-name> - Name of the Linkset within which the
Link resides.
+
+EXAMPLE
linkset link deactivate linkset1 link1
- - The above command will deactivate the Link identified by the name Link1
within the Linkset linkset1..
+
+ 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.
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate,
+ linkset show, linkset link create, linkset link delete, linkset link
activate.
=======================================
--- /hardware/cli/src/main/resources/help/linkset_link_delete.txt Thu Aug
9 04:50:04 2012
+++ /hardware/cli/src/main/resources/help/linkset_link_delete.txt Sun Aug
12 23:40:10 2012
@@ -4,19 +4,20 @@
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.
+PARAMETERS
+ <link-name> - Name of the Link to be deleted.
+
+ <linkset-name> - Name of the Linkset within which the
Link resides.
+
EXAMPLE
-
linkset link delete linkset1 link1
- - The above command will delete the Link identified by the name Link1
within the Linkset linkset1..
+
+ 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.
+ linkset, linkset create, linkset delete, linkset activate, linkset
deactivate,
+ linkset show, linkset link create, linkset link activate, linkset link
deactivate.