CODEW - Codeword for administration lock in SWU

AMO CODEW can be used to read, check, display and regenerate the codeword delivered for a given Openscape switching unit. The set of purchased features and the list of sales units can both be displayed with it. In addition it is possible to let the purchased features examined against eventual violations. Such a check is also done automatically in regular time intervals, independently of AMO CODEW.

The examination serves as a software protection in order to prevent access to features not purchased. For this purpose a so-called hardware dongle(a hardware unit that has to be pluged into the Openscape switching unit) supplying a unique identifier (dongle-id) is used on the one hand and a software codeword on the other. In encrypted form the codeword contains the dongle-id as well as the expiration date and the settings of the feature packages that have been purchased by the customer. Each codeword is supplied in accordance with the delivered hardware dongle or SIM card.

If Openscape Platforms are connected into a network the codewords for the participating switching units are generated centrally by the OpenScape Manager LMT (License Management Tool) and then sent to the individual units. The centrally generated codewords are specially labelled and distinguished in their handling from the normal codewords.

A switching unit can be configured and installed only after the appropriate codeword has successfully been entered into the system through the command ADD-CODEW.

The following actions are provided by AMO CODEW:

ADD-CODEW: Feeding in of the codeword, checking potential violations and sending respective messages to the user. The command is rejected if the codeword is not valid, does not match the dongle or if the date is out of validity.

REGENERATE-CODEW: Reproducing the last valid codeword.

DISPLAY-CODEW: Showing all information encrypted in the codeword (the features purchased by the customer, the version of the software package, duration of validity, etc).

START-CODEW: Testing if the codeword is valid and feeding back the result to the user, as well as displaying the counts for the sales units present in the system. In case a contract violation(See Chapter "ADD-CODEW") is detected the user interface is locked so that no more SWU AMOs can be started.

CHANGE-CODEW: Trial mode administration.

OUTPUT-CODEW: Displaying an arbitrary text on the user interface as an advisory message of the SIT(Signalling Task). This action is intended mainly for the LMT for transmitting its messages in case of contract violation.

Interrelationships

(none)

Destination Processor: BP (Switching Unit)

Functions

ADD	Reading in and checking the codeword	password class 5
CHANGE	Activate or Deactivate Trial Mode	password class 5
DISPLAY	Displaying features and sales units	password class 3
OUTPUT	Showing a text string generated by the LMT and transmitted by the SIT	password class 5
REGENERATE	Putting out an ADD-CODEW command	password class 5
START	Checking codeword and showing sales units	password class 3

Procedure Overview

ADD-CODEW

ADD-CODEW

CODEW1=<string>, [CODEW2=<string>];

This action is used to read in the codeword and to enter it into the data base in case of success. The codeword and the data encrypted in it are always checked for intactness within the switching unit. This validity check reports a contract violation as soon as any of the following criteria are met:

codeword invalid
expiration date invalid
expiration date passed
variant and version of software package false
serial number false
dongle-ID false
contract violation by limit surpassing recognized: the count of sales units in use is in case of one or more feature packages greater than the count of purchased sales units.

In case of success the most important data of the previous and of the new codeword are displayed like in the header rows of DISPLAY-CODEW.

In case of failure the add command is rejected and the check results are shown within the scope of error message F01. If false codewords are being entered five times consecutively, further attempts will be allowed only after 5 minutes delay.

If the new codeword can not be added because of limit surpassing then the purchased and the used counts per feature package are displayed (like at DISPLAY-CODEW) but the coloumn "FREE" contains only exclamation marks (!!!!!).

Examples:

1. Rejection case

Input:

   ADD-CODEW:VNU4FVT9KDMV9XUNZK6FXHPUV73GEB6YSW73WC7GRDN8Y5TGHKXMX2A75TZM561M,FV72FLZ83CWPDF19X6L6E9SHBGRBJWZLSU2SFYECSMEPRRAGTXLMM4Y851;

Output (for example) :

   F01: CODEWORD NOT ALLOWED: WRONG-DONGLE-HARDWARE-ID

Further check results see in description of error message F01.

2. Acceptance case: a net codeword generated by LMT was entered

Input:

  ADD-CODEW:VNU4FVT9KDMV9XUNZK6FXHPUV73GEB6YSW73WC7GRDN8Y5TGHKXMX2A75TZM561M,FV72FLZ83CWPDF19X6L6E9SHBGRBJWZLSU2SFYECSMEPRRAGTXLMM4Y851;

Output :

   H01: THE NEW CODEWORD WAS ADDED.
   PREVIOUS CODEWORD:
   ------------------
   CODEWORD: JSPYP8ZELFTSUP3YZ6CY3FMTWZ625REMENUEDM1PHLBBUAADDJDN2N5S14EV63JY
             TR7YU84Y4CBU27392SG5RTY4SXTSV2NNW49B3F9B15P21H6SDJJTESXMPR
   SERIAL NUMBER: 1
   ENTRY DATE   : 27.11.2013

   NEW CODEWORD:
   -------------
   CODEWORD: EJ9SL32VSUNYSLMZHV6S8J334RCLVT57ECWV8AX2MXBTAUZ3FNY3FRYWM1H2TBBS
             1MARXPYRPZJ3NVC46EC4AC49Z3K8TXEBBRP5EJZNCK9DFF9WUWZSBMVEVX
   VERSION      : H300 (V11R0)
   SERIAL NUMBER: 1
   HARDWARE ID  : FEF45F39
   ENTRY DATE   : 06.01.2014
   VALID UNTIL  : 05.05.2014
   LMT-ID       : 07777

CHANGE-CODEW

CHANGE-CODEW

TRIAL=<param>;

Trial mode can be activated and deactivated with this action. During trial mode the license limits of specific features may be exceeded for a limited time (depending on code word seting, usually 30 days). Entities created in trial mode without sufficent licenses are marked and will be blocked in case of trial mode expiry without sufficient licenses.

Trial mode activation (TRIAL=YES) is not allowed is trial mode is already active. If the remainig duration of an active trial mode is not sufficient, another trial mode can be started with TRIAL=RESTART before the active trial mode expires. This trial mode is treated as a seperate trial mode regarding to duration and usage count, the remainig duration of the previously active trial mode is lost. As the trial mode expiration need not be awaited, an interim entity blocking can be avoided.

DISPLAY-CODEW

DISPLAY-CODEW

[TYPE=<param>];

In branch TYPE=COUNTS this action displays the codeword last entered and the informations contained in it, such as

the version of the software package,
the serial number,
the dongle-id of the attached hardware dongle,
the entry date of the codeword,
the expiration date of the codeword (optional),
the LMT-id in case of a net codeword (optional),
all feature packages purchased, as well as
the number of purchased sales units as well as the number of sales units currently in use.

In branch TYPE=SERVICE this action reproduces the codeword in encypted form suitable for machine input. This output is processed by LMT and it is not relevant for the user.

Note: Action DISPLAY-CODEW does not check contract violations with respect to the feature packages delivered.

Examples:

1. Displaying the counts of individual sales units

Input:

 DISP-CODEW;

 DISP-CODEW:COUNTS;

Output:

        SALES UNIT COUNTERS
        ===================

        CODEWORD: 2BEGGTDZBJ2ZNJP9TB24R8TL5P7NPFS5LZU7V3YXCXBHP7URK3DLYPNY26EFZWXJ
                  L5ETWZDJJ7HD6ULP7XSLJBA5MS16EY7TNH14TAXFEVPMSJTBPTDYYCJVD9
        VERSION      : H300 (V11R0)
        SERIAL NUMBER: 1
        HARDWARE ID  : E36FBE7B
        ENTRY DATE   : 16.12.2013
        VALID UNTIL  : 21.09.2014
        TRIAL MODE   : NOT ACTIVATED
        CONFIRMATION : 0
        DUPLEX LICENSE : YES
   +-----------------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS                    | TOTAL | USED  |  FREE |BLOCKED|
   +-----------------------------------------------------+-------+-------+-------+-------+
   |  FLEX                                               | 10000 |   468 |  9532 |       |
   |  STANDARD                                           |   500 |   100 |   400 |       |
   |  UNIFY PHONE                                        |    10 |     0 |    10 |       |
   +-----------------------------------------------------+-------+-------+-------+-------+
   AMO-CODEW-135       CODEWORD FOR ADMINISTRATION LOCK IN SWU
   DISPLAY COMPLETED;

Openscape 4000 Version V11R0 requires a code word with version identifier H300.

2. Displaying the counts of individual sales units in case of a net codeword generated by LMT

Input:

 DISP-CODEW;

Output :

        SALES UNIT COUNTERS
        ===================

        CODEWORD: EJ9SL32VSUNYSLMZHV6S8J334RCLVT57ECWV8AX2MXBTAUZ3FNY3FRYWM1H2TBBS
                  1MARXPYRPZJ3NVC46EC4AC49Z3K8TXEBBRP5EJZNCK9DFF9WUWZSBMVEVX
        VERSION      : H300 (V11R0)
        SERIAL NUMBER: 1
        HARDWARE ID  : E36FBE7B
        ENTRY DATE   : 16.12.2013
        VALID UNTIL  : 21.09.2014
        TRIAL MODE   : NOT ACTIVATED
        CONFIRMATION : 0
        DUPLEX LICENSE : YES
   +-----------------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS                    | TOTAL | USED  |  FREE |BLOCKED|
   +-----------------------------------------------------+-------+-------+-------+-------+
   |  FLEX                                               |       |   468 |       |       |
   |  STANDARD                                           |       |   100 |       |       |
   |  UNIFY PHONE                                        |       |     0 |       |       |
   +-----------------------------------------------------+-------+-------+-------+-------+
   AMO-CODEW-98       CODEWORD FOR ADMINISTRATION LOCK IN SWU
   DISPLAY COMPLETED;

3. Example License 10 Flex and 10 TDM, 11 TDM 0 IP configured:

Input:

 DISP-CODEW;

Output :

   +---------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS            | TOTAL | USED  |  FREE |BLOCKED|
   +---------------------------------------------+-------+-------+-------+-------+
   | FLEX                                        |    10 |    01 |     9 |       |
   | STANDRD                                     |    10 |    10 |     0 |       |
   | UNIFY PHONE                                 |    10 |     2 |     8 |       |
   +---------------------------------------------+-------+-------+-------+-------+
   H18: 1 TDM consumes FLEX licenses

4. Example License 10 Flex and 10 TDM, 11 TDM and 5 IP are configured:

Input:

 DISP-CODEW;

Output :

   +---------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS            | TOTAL | USED  |  FREE |BLOCKED|
   +---------------------------------------------+-------+-------+-------+-------+
   | FLEX                                        |    10 |     6 |     4 |       |
   | STANDARD                                    |    10 |    10 |     0 |       |
   | UNIFY PHONE                                 |    10 |     2 |     8 |       |
   +---------------------------------------------+-------+-------+-------+-------+
   H18: 1 TDM consumes FLEX licenses

5. Example License 10 Flex and 0 TDM, 1 TDM and 5 IP are configured:

Input:

 DISP-CODEW;

Output :

   +---------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS            | TOTAL | USED  |  FREE |BLOCKED|
   +---------------------------------------------+-------+-------+-------+-------+
   | FLEX                                        |    10 |     6 |     4 |       |
   | STANDARD                                    |     0 |     0 |     0 |       |
   | UNIFY PHONE                                 |    10 |     2 |     8 |       |
   +---------------------------------------------+-------+-------+-------+-------+
   H18: 1 TDM consumes FLEX licenses

6. Example License 10 Flex and 10 TDM, 5 TDM and 5 IP are configured:

Input:

 DISP-CODEW;

Output :

   +---------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS            | TOTAL | USED  |  FREE |BLOCKED|
   +---------------------------------------------+-------+-------+-------+-------+
   | FLEX                                        |    10 |     5 |     5 |       |
   | STANDARD                                    |    10 |     5 |     5 |       |
   | UNIFY PHONE                                 |    10 |     2 |     8 |       |
   +---------------------------------------------+-------+-------+-------+-------+
   H18: 0 TDM consumes FLEX licenses

OUTPUT-CODEW

OUTPUT-CODEW

MESSAGE=<string>;

This action lets an arbitrary text appear on the user interface as an advisory message from the SIT (Signalling Task). The messages generated by the LMT and transmitted to the switching unit can be displayed in this way. The message texts are shown without change but their length is limited to 80 characters.

Note: Action OUTPUT-CODEW does not check contract violations with respect to the feature packages delivered.

Example:

Input (e. g.):

 OUTPUT-CODEW:"HELLO WORLD!!!";

Output:

 H500:  AMO CODEW STARTED
 F2066 M4 N0051 NO ACT   BPA   AM       ADVISORY                99-02-05 18:01:30
       ALARM CLASS:CENTRAL:023
       FORMAT:33
       HELLO WORLD!!!
 AMO-CODEW-1         CODEWORD FOR ADMINISTRATION LOCK IN SWU
 OUTPUT COMPLETED;

REGENERATE-CODEW

REGENERATE-CODEW

;

The codeword installed for the last time is read in from the data base and displayed in form of an ADD-CODEW command.

Note: Action REGEN-CODEW does not check contract violations with respect to the feature packages delivered.

Example:

Input:

 REGENERATE-CODEW;

Output:

 ADD-CODEW:EJ9SL32VSUNYSLMZHV6S8J334RCLVT57ECWV8AX2MXBTAUZ3FNY3FRYWM1H2TBBS,1MARXPYRPZJ3NVC46EC4AC49Z3K8TXEBBRP5EJZNCK9DFF9WUWZSBMVEVX;

START-CODEW

START-CODEW

;

This action enables the user to force a validity check of the expiration date as well as of the sales units purchased and currently in use within all feature packages. In case a contract violation is detected the user interface is locked so that no more SWU AMOs can be started.

In case of success all feature packages are shown together with the counts of sales units purchased and sales units in use, just as by command DISPLAY-CODEW.

Examples:

1.Success case

Input:

 START-CODEW;

Output:

        SALES UNIT COUNTERS
        ===================

        CODEWORD: 2BEGGTDZBJ2ZNJP9TB24R8TL5P7NPFS5LZU7V3YXCXBHP7URK3DLYPNY26EFZWXJ
                  L5ETWZDJJ7HD6ULP7XSLJBA5MS16EY7TNH14TAXFEVPMSJTBPTDYYCJVD9
        VERSION      : H300 (V11R0)
        SERIAL NUMBER: 1
        HARDWARE ID  : E36FBE7B
        ENTRY DATE   : 16.12.2013
        VALID UNTIL  : 21.09.2014
        TRIAL MODE   : NOT ACTIVATED
        CONFIRMATION : 0
        DUPLEX LICENSE : YES
   +-----------------------------------------------------+-------+-------+-------+-------+
   |           V11 LICENSE COMPONENTS                    | TOTAL | USED  |  FREE |BLOCKED|
   +-----------------------------------------------------+-------+-------+-------+-------+
   |  FLEX                                               | 10000 |   468 |  9532 |       |
   |  STANDARD                                           |   500 |   100 |   400 |       |
   |  UNIFY PHONE                                        |    10 |     0 |    10 |       |
   +-----------------------------------------------------+-------+-------+-------+-------+
   AMO-CODEW-135       CODEWORD FOR ADMINISTRATION LOCK IN SWU
   START COMPLETED;

2. Error case: calling other AMOs after a contract violation has been recognized

Input (e. g.):

 ADD-SCSU:...;

Output:

 S48: START OF AMO SCSU NOT SUCCESSFUL
      CAUSE : AN INCONSISTENCY IN YOUR CONTRACTED SW HAS BEEN DETECTED
              PLEASE CONTACT YOUR SERVICE CENTER AND QUOTE THIS MESSAGE

After attempting to log on the following text appears:

 --------------------------------------------------------------------------------
 ADMINISTRATION OF SWU IS BLOCKED:
 AN INCONSISTENCY IN YOUR CONTRACTED SOFTWARE HAS BEEN DETECTED
 PLEASE CONTACT YOUR SERVICE CENTER AND QUOTE THIS MESSAGE
 ACTUAL CODEWORD EXPIRES AT 99-02-20
 --------------------------------------------------------------------------------

Parameter description

CODEW1	Codeword 1st part
	Type of Input:	single value, mandatory
	Possible Values:	text, up to 64 characters
CODEW2	Codeword 2nd part
	Type of Input:	single value, optional
	Possible Values:	text, up to 64 characters
MESSAGE	message to be sent by LMT
	Type of Input:	single value, mandatory
	Possible Values:	text, up to 80 characters
TRIAL	Trial mode
	Type of Input:	single value, mandatory
	Possible Values:	NO	stop
		RESTART	start again
		YES	start
TYPE	Type of display
	Type of Input:	single value, optional
	Possible Values:	COUNTS	Display of counters
	Possible Values:	SERVICE	Display of counters in encrypted form

Error Messages

F01	F01: CODEWORD not allowed: <reason>
F03	F03: Wrong codeword has been entered five times! Next attempt possible after <number> minutes, please wait
F05	F05: No CODEWORD available in DB. Add first by means of ADD-CODEW.
F06	F06: Licenses are not sufficient for normal mode. Trial mode can not be deactivated. Delete unused entities or order additional licenses. Use "DISPLAY-CODEW;" to display insufficient licenses.
F07	F07: No (more) trial mode available
F08	F08: Trial mode is not active. To activate the trial mode please enter: CHANGE-CODEW:TRIAL=YES;
F09	F09: Trial mode is already active for <N> days and <H> hours. To restart the trial mode please enter: CHANGE-CODEW:TRIAL=RESTART;

Advisory Messages

H01	H01: The new CODEWORD was added.
H02	H02: Codeword same as current - no action taken.
H03	H03: Unlicensed entities will be marked. Marked entities will be blocked at trial mode expiry, if sufficient licenses are missing. PLEASE CONFIRM TRIAL MODE ACTIVATION.
H04	H04: Trial mode has been activated for <n> day(s) and <H> hour(s). Use "DISPLAY-SDSU:LICMARK;" to show marked elements.
H05	H05: Blocked entities have been unblocked but stay marked as unlicensed.
H06	H06: Trial mode is active for <n> more day(s) and <H> hour(s). Use "DISPLAY-SDSU:LICMARK;" to show marked elements.
H07	H07: Trial mode is available <number> < (more) [time \| times]>.
H08	H08: Trial mode has been deactivated.
H09	H09: Trial mode is not active.
H10	H10: Trial mode would be active for <n> more day(s) and <H> hour(s). These days are lost. PLEASE CONFIRM TRIAL MODE DEACTIVATION.
H11	H11: Trial mode is active for <n> more day(s) and <H> hour(s). These days are lost. Trial mode restart is counted as additional trial mode usage. PLEASE CONFIRM TRIAL MODE RESTART.
H12	H12: Current codeword is a type 2 codeword.
H13	H13: The switch is in emergency mode. It will escalate in @@@@@ day(s) and about @@ hour(s).
H14	H14: The switch is in escalated emergency mode.
H15	H15: The system is currently running in CC-AP customer mode.
H15	H15: The system is currently running in CC-AP testlab mode.
H16	H16: Current codeword is a grace period codeword.
H17	H17: @@@@@ IP licenses: @@@@@ are used and @@@@@ are free.
H18	H18: @@@@@ TDM consumes FLEX licenses.
H19	H19: UNIFY PHONE LICENSE IS EXPIRED!