SIE Command Line Interface Principles

7/27/2019 SIE Command Line Interface Principles

1/47

SIE: Command Line Interface Principles & Tools

Document number: PE/OMP/DD/0048Document issue: 05.01 / ENDocument status: StandardDate: 22/Sep/2008

External document

Copyright 2008 Nortel Networks, All Rights Reserved

Printed in France

NORTEL CONFIDENTIAL

The information contained in this document is the property of Nortel Networks. Except as specifically authorized in

writing by Nortel Networks, the holder of this document shall keep the information contained herein confidential

and shall protect same in whole or in part from disclosure and dissemination to third parties and use same for

evaluation, operation and maintenance purposes only.

The content of this document is provided for information purposes only and is subject to modification. It does not

constitute any representation or warranty from Nortel Networks as to the content or accuracy of the information

contained herein, including but not limited to the suitability and performances of the product or its intended

application.

This is the Way. This is Nortel, Nortel, the Nortel logo, and the Globemark are trademarks of Nortel Networks. All

other trademarks are the property of their owners.


2/47


Nortel Networks confidential

PE/OMP/DD/0048 05.01 / EN Standard 22/Sep/2008 Page 2/47

PUBLICATION HISTORY

22/Sep/2008

Issue 05.01 / EN, Standard

Updated for v18.0 release of OMC-R

05/Apr/2007



14/Jun/2006



08/Jun/2005


Updated scope of the document

22/Feb/2005



01/Oct/2003


Update for v15 release of OMC-R

07/Apr/2003


Update for v14 release of OMC-R

02/Mar/2000


Update after review: PE/OMP/GES/32


3/47




23/Nov/1999

Issue 01.01 / EN, Draft

Creation


4/47




CONTENTS

1. INTRODUCTION ............................................................................................................................ 51.1. OBJECT.................................................................................................................................... 51.2. SCOPE OF THIS DOCUMENT .......................................................................................................51.3. AUDIENCE FOR THIS DOCUMENT ................................................................................................5

2. RELATED DOCUMENTS .............................................................................................................. 52.1. APPLICABLE DOCUMENTS ..........................................................................................................52.2. REFERENCE DOCUMENTS ..........................................................................................................5

3. COMMAND LINE INTERFACE .....................................................................................................53.1. PRINCIPLES .............................................................................................................................. 53.2. EXAMPLES................................................................................................................................ 9

4. COMMAND FILES ......................................................................................................................... 95. INTERCONNECTION BETWEEN A NMC AND AN OMC THOUGH THE LINE INTERFACE .. 11

5.1. PRINCIPLES OF THE NMC-OMC INTERFACE.............................................................................115.1.1 Connection between NMC and OMC ............................................................................115.1.2 Establishing a session between NMC and OMC ..........................................................135.1.3 Sending commands from NMC to OMC .......................................................................155.1.4 Subscription to services ................................................................................................15

5.2. COMMAND FORMAT.................................................................................................................175.3. OUTPUT FORMAT ....................................................................................................................18

5.3.1 Command response format ...........................................................................................185.3.2 Observation report format .............................................................................................205.3.3 Notification and alarm format ........................................................................................245.3.4 Configuration of External Alarm and User System Alarms descriptions ....................... 41

6. APPENDIX A (OBJECT TREE) ...................................................................................................437. ABBREVIATIONS AND DEFINITIONS .......................................................................................46

7.1. ABBREVIATIONS ......................................................................................................................467.2. DEFINITIONS ...........................................................................................................................47


5/47




1. INTRODUCTION

1.1. OBJECT

The purpose of this document is to describe the command line interface. It contains

also the necessary information that may be used by management software in a

Network Management Centre (NMC) in order to access a V18.0 and higher OMC. This

interface is build upon the manager part of the OMC-R and doesnt deal with the Q3

normalization.

1.2. SCOPE OF THIS DOCUMENT

This document is applicable to v18.0 and higher releases of OMC-R.

1.3. AUDIENCE FOR THIS DOCUMENT

Designers.

2. RELATED DOCUMENTS

2.1. APPLICABLE DOCUMENTS

[A1] PE/OMP/DD/0043 SFS MMI User Facilities

[A2] PE/OMC/DD/0005 SFS Security Management

[A3] PE/MD/DD/0006 SIE Q3 OMC-R Observation Counter List

[A4] PE/OMC/DD/0073 STO OMC-R: Technical Specification of the

Radio Objectives

2.2. REFERENCE DOCUMENTS

None

3. COMMAND LINE INTERFACE

3.1. PRINCIPLES

The command line interface is based on the ITU-T Z 300 Series Recommendations. It

actually implements a subset of these recommendations, since some of them are not

relevant to the OMC-R MMI. Also, some separators have been modified to take into

account specific aspects of the OMC-R MMI.

The syntax of a command line is the following:


6/47




verb - obj ect Cl ass : par amet erName = val ue; paramet erName =

val ue. . .

verb is the verb of the command itself,

obj ect Cl ass is the class of the object concerned by the command1,

par amet er Name is the name of a valid parameter for this command,

val ue is the value of the corresponding parameter (if applicable).

The various separators used are:

the dash ('- ') to separate the verb from the object of the command;

the colon (': ') to separate the command name from the parameters;

the semi-colon ('; ') to separate the various parameters;

the equal sign ('='), to separate the name of a parameter from its value;

The couple (verb, objectClass) uniquely identifies a command. A command may have

any finite number of parameters. For each command, there is a list of acceptable

parameters, as well as a set of constraints that must be satisfied by the parameters.

These constraints include test for presence as well as operators (and, or, xor, same,

nand). Parameters may be of several basic types: integer, decimal number, character

string, enumerated list, date, time, date & time, object identifier, scope and filter.

Composed parameters may also be built from these basic types in two ways: lists and

groups. A parameter of type list will feature a list of values of the same type, whereas

a parameter of type group will feature a vector of values with predefined types (see

examples below). For each type of parameter, the obvious syntax checks are

performed (a date must be valid, etc.). Moreover, for each type of parameter, severalother checks may be performed.

These checks are summarized in the following table:

1 The object class deals with the BSS objects but also with all the OMC objects such as log, calendar, relay.

The whole object are described in appendix A


7/47




parameter type optional checks

integer minimum and maximum values, step

decimal number minimum and maximum values

character string minimum and maximum length, regular expression pattern

SMS-CB minimum and maximum length, authorized characters

enumerated allowed values

date

time

date & time

object identifier authorized classes, use of wild cards

scope allowed values

filter authorized parameters

list of values minimum and maximum number of elements

checks relevant to the elementary valuesgroup of values checks relevant to the elementary values

The following separators are used inside parameter values:

the comma (', '), to separate the date from the time in a date & time;

the ampersand ('&'), to separate nodes in an object identifier;

the equal sign ('='), to separate a class from its instance in a node of an object

identifier;

the ampersand ('&'), to separate elements in a list;

the tilda ('~'), to separate elements in a group.

Moreover, in parameters of type "filter", the equality test is represented by the equal

sign ('='), the greater or equal test is represented by '>', the lesser or equal test is

represented by '


8/47




"m - 10" stands for '10 minutes ago';

"d - 1, h" stands for 'yesterday at the same time';

"d +1, h +10" stands for 'tomorrow, ten hours later than now';

"d - 2, m +30" stands for 'the day before yesterday, but thirty minutes later'.

Relative dates and times are instantiated (i.e. turned to absolute dates and times)

when the command is actually run. In other words, commands stored for later use (be

it in a job or a command file) keep their dates and times relative until the command is

actually run. For instance, a command that would be recorded as taking place

"tomorrow" will actually be recorded as taking place "the next day".

All commands and parameters may be versioned according to the following

discriminators:

BSC version,

BSC architecture,

mibVersion,

transcoder architecture,

command origin (i.e. graphic interface, command file or ROT).

Moreover, some features as ASCI or HSCSD may be enabled or not using off-line

configuration2. This influences the command and parameter models.

Syntax analysis is both case and diacritical sign insensitive, but it follows the country's

habits in terms of formatting (for instance, a dot is used to separate the integer part

from the decimal part of a decimal number in several countries, whereas a comma isused at the same place in other countries). Spaces are not relevant. If separators or

spaces are needed for a value, double quotes must surround them. If double quotes

are needed, they must be prefixed by a backslash. If backslash is needed, it must be

prefixed by another backslash.

Commands that apply to an object (most commands do) must have at least one

parameter (of type "object identifier"), which gives the object on which the command is

applied.

Please note that for creation commands, the actual instance of the object to be

created may or must be omitted for certain classes of objects. Also, when entering an

object id, the bsc number may be replaced by the bsc name; the bsc andbtsSiteManager numbers may be replaced by the btsSiteManager name, and the bts

number may be replaced by the bts name.

Some commands do not apply to any particular object. In that case, the verb is

immediately followed by ':' and, obviously, the parameter usually used to input the

object may not be used.

Some commands apply to several objects thanks to the "scope and filter" mechanism.

In that case, the verb is followed by a '-' and a specific keyword indicating that this

command applies to several objects. The parameter usually used to input the object

must be used to give the base object of the command. A parameter of type "scope"

2 This concerns also the PCM type.


9/47




must be used. A parameter of type "filter" may be used. Other parameters may be

used just like in a normal command. There is only one little difference between "scope

and filter" commands and normal commands: when displaying several objects with a

"scope and filter" command, the user may input a list of parameters he wishes to see,

to avoid displaying all parameters of all objects concerned.

3.2. EXAMPLES

This section gives several examples of command lines. Please note that they do not

correspond to any real command, but only try to illustrate the various general rules

given above. An actual command would depend on the current language of the

application.

The following command line is a fictitious line that features all basic types of

parameters, as well as an example of a list and an example of a group:

Cr eat e - obj ect Cl ass: obj ect = ( bsc = 3 & bt sSi t eManager = 2) ;i nt egerParam = 4; deci mal Par am = 3. 4; st r i ngPar am = "bsc name";

enumPar am = out Of Ser vi ce; dat ePar am = 25/ 12/ 02; t i mePar am =

13: 42: 00; dat eAndTi mePar am = 04/ 07/ 02, 08: 30: 00; l i st of I nt Par am

= 4 & 5 & 7; groupPar am = 5. 6 ~ "val ue"

The following example illustrates a command that does not apply to a particular object:

Sl eep: dur at i on = 12

The following example illustrates a command that applies to several objects:

Set - sever al : obj ect = net wor k; scope = whol e subt r ee; f i l t er

= ( obj ect Cl ass = bt s & admi ni st r at i veSt at e = l ocked) ;

admi ni st r at i veSt ate = unl ocked

When an object instance must be input (either as the object instance being acted upon

by the command or in a parameter), the actual tree model to be used to list the various

nodes in the right order are available in Appendix A.

4. COMMAND FILES

A command file is a list of command lines. There are several ways to create a

command file:

create an empty command file with the command file manager and edit it with

the command file editor;

record a command file (see below the description of the two operating modes

of the OMC-R);

import a command file via UNIX.

The OMC-R MMI may operate in two different modes:

in the normal mode, all commands requested by the user are checked by MMI

(see [A1] for more information on these checks) and actually sent on to theOMC-R applications and run;


10/47




in the command file recording mode, all command requested by the user are

checked by MMI (see [A1] for more information on these checks) and stored

in a command file; they are not sent on to the OMC-R applications.

To change modes, the user must use the appropriate action available from the

command file manager menu. When entering the command file recording mode, the

user is prompted to enter the new command file name just before the actual recording

starts.

Once created or imported, command files may be managed and edited thanks to the

command file manager and editor.

While a command file is being run, one of the commands it triggers may be refused,

either because it failed one of the checks (syntax, semantic, etc.) or because the

current user does not have proper authorization to run it.

A command file may be run in four different modes (these modes can be combined in

the same command):

error sensitive: in this case, if a command is refused, the command file stops

running;

error insensitive: in this case, if a command is refused, the command file

moves on to the next command.

retry on error: in this case, if a command is refused, the command is rerun,

the delay value between two retries and the maximum number of retries for a

command is off-line configured. If this mode is combined with the mode error

sensitive, this mode is priority on the mode error sensitive, i.e. the retry is

executed before the test to stop the command file. The list of errors giving thepossibility to have a retry is configured off-line.

no retry on error: in this case, no retry is executed.

The previous algorithm applies only to errors returned by the OMC-R applications.

Errors detected by MMI (see [A1] for more information on the checks performed by

MMI) will always stop the command file.

Running a command file starts at the first line, except if the appropriate parameter is

used to indicate another line to begin with.

When the command file stops running because of an error, the error message given to

the user contains the actual line number where it stopped.

It is possible to interrupt a command file currently running if it was started interactively

(in other words, if the command that runs a command file was used interactively, it can

be aborted).

While command files include commands that follow the normal syntax, it is possible to

replace any token of a command line by a keyword (beginning by '$'). If this is the

case, the user will have to provide a value for this keyword each time the command

file is checked or run. Keyword substitution is performed at this time. This allows the

user to parametrize command files to make them more generic.

Several commands are of special interest in command files (though they are available

interactively also):


11/47




sleep, which allows the user to momentarily suspend the command file for a

given amount time passed as a parameter;

echo, which allows the user to print any character string in the logs at that

point.

Comments may also be used in command files. These comments will simply be

ignored when the command file is being checked or run.

Since one of the commands available with the OMC-R MMI allows running a

command file (possibly with keyword substitution), it is possible to call a command file

from another command file. To avoid loops, the level of nesting is limited to a

maximum value that may be configured off-line.

There are three ways to run a command file:

interactively, from any window allowing it;

from another command file;

at a given time, thanks to the command scheduler functionality;

by the command Run-commandFile directly on the line tools(see [A1]).

5. INTERCONNECTION BETWEEN A NMC AND ANOMC THOUGH THE LINE INTERFACE

5.1. PRINCIPLES OF THE NMC-OMC INTERFACE

The NMC uses the line interface in order to access the OMC

In this section all messages are underlined for the English version (for example

"yes").

5.1.1 CONNECTION BETWEEN NMC AND OMC

Depending on the location of the OMC, the NMC may be connected to OMCs on the

same Ethernet link (local OMC LAN).

The NMC connects the part of the MMI function on an OMC workstation. This part of

the MMI function is a sub-function called "Command Line Input Management" and is

described in [A1].

The interface offered by this sub-function of MMI, is called "line interface" in the

following.

For the whole OMC system (including all the OMC workstations), there may be a

maximum of N simultaneous connections on the line interface (N is configured off-line,

see [A4]). Each NMC active session uses one connection and therefore decrements

the number of available connections for the Remote Operation Terminals (PCs).

Although it interfaces with MMI, the non-Q3 interface is intended to be used as a pure

machine-machine interface. So, for the convenience of the machine-machine


12/47




interface, some of the output formats may be configured in the MMI function of the

OMC workstation in a way that is not satisfactory for a man-machine interface.

For example, the format of the General Permanent Observation reports could be

configured for the MMI of the workstation so that it will be compatible with Metrica tool

for statistical analysis. This format would be convenient for the non Q3 machine-

machine interface but not for the user interface of the workstation.

For this reason, the NMC should connect if possible to one dedicated OMC local

workstation.

Security considerations:

In order to prevent unallowed access to OMC servers or OMC workstations, no other

machines should be allowed to connect to the network shown in the scheme below.

As a result, it is recommended that:

no other networks are connected to the OMC LANs.

no other machines are on the OMC LANs (this is suitable for performance

reasons too).

Note that the NMC may have to connect to other networks (in order to manage other

OMCs for instance). Care must be taken to prevent unallowed access from these

networks.


13/47




5.1.2 ESTABLISHING A SESSION BETWEEN NMC AND OMC

The NMC has to perform a simple remote login (via telnet for instance) to an OMC

workstation.

If it is required, a 'nmc' unix user can be created on the OMC workstation:

"nmc: x: : : NMC: / OMC/ di agnost i c: / OMC/ exe/ Mmi Li neI nput . x"

When the NMC is successfully logged on the OMC workstation (UNIX login), the OMC

application is run. It sends a welcome message followed by the login prompt, for

applicative login:

"Username:

The NMC must send back a valid OMC user name.

The NMC is then requested to send the password, as the password prompt is sent:


14/47




"Password: "

The password is sent encrypted, according to a scrambling algorithm.

If the couple (OMC user name, password) is not correct, access is denied and the

following message appears:

"name or password is incorrect"

If the maximum allowed number of successful login attempts is reached, the following

message appears:

"Too many login errors occurred; exiting..."

Then the MmiLineInput.x task terminates and the remote login connection is closed.

If the user attempts to log in outside his work timetable, access is denied too and the

following message appears:

"you are not authorized to login at this time"J ust after login, the NMC may receive the following messages, concerning password

expiration:

"WARNING: your password expires in days"

No specific action is expected from the NMC.

"> Your password has expired, please change it."

This message is followed by a message prompting for a new password:

"New password: "

Then the NMC is prompted to confirm the password that it has entered:

"New password (confirmation): "

After successful login, the OMC application sends the command line input prompt:

">"

It is ready to receive commands from the NMC.

The NMC must close the OMC session that it does not use any longer, by sending the

logout command "Logout ".

Warning:

Only the initial OMC login is taken into account. This means that a login cannot be

performed during the session.

Note on the interactive mode:

In this case, the MmiLineInput.x application has to be launched with the number

assigned to the MmiKernel.x task, which is statically configured on the OMC.

The command can be launched either manually from the UNIX shell or automatically

after login to a UNIX user account (let us say 'nmc') declared as follows in the

/etc/password file:

"nmc: x: : : NMC: / OMC/ di agnost i c: / OMC/ exe/ Mmi Li neI nputNMC. sh"


15/47




with MmiLineInputNMC.sh containing just one line :

Mmi Li neI nput . x - T

This is called the interactive mode of the command line interface.

5.1.3 SENDING COMMANDS FROM NMC TO OMC

The principles of the syntax of the command line interface are described in the chapter

COMMAND LINE INTERFACE.

The message "SENT" indicates that the command has been successfully forwarded

inside the manager part of the OMC.

The message "local communication error" indicates that the forwarding of the

command failed. In such a case, the NMC should close the session with the OMC.

The NMC must wait for the complete result of the command.

Possible intermediate partial results contain the following strings:

either the string "SUCCEEDED (other answers follow)"

or the string "FAILED (other answers follow)"

The full result or the last partial result contains:

either the string "SUCCEEDED (completed)"

or the string "FAILED (completed)"

After having received the complete result, the NMC has to wait for the command line

input prompt before sending the next command. Otherwise, the NMC command islikely to be ignored.

Note:

If the result of the command involves a large amount of data (10 kbytes or more, this

value is configured off-line) to be sent to the NMC (e.g. command to display

notification log contents), the following message appears, asking for a confirmation by

the NMC:

"Displaying the answer will take approximatively seconds at 2400

bpsorseconds at 9600 bps. Do you really want to

display it? (yes/no) "

the durations given in this message are meaningless here. They are typical:

they are the time that the response data would use to be transmitted from the

OMC workstation to a remote computer via a telephone network, with two

possible bandwidths.

Then the system waits for "yes" or "no". Therefore, although the information given by

the message is not interesting for an NMC, the NMC should be able to detect and

process these confirmation requests.

5.1.4 SUBSCRIPTION TO SERVICES

The following information may be spontaneously sent to the NMC using the line

interface:


16/47




notifications;

user alarms (generated according configurable criteria);

user mail concerning the OMC user that the NMC is logged as;

instrument panel observation reports.

It is automatically performed for the user mail after OMC user login. It is possible to

unsubscribe this subscription and to subscribe to this one.

The commands for subscribing to this information are respectively:

"Subscribe notifications"

"Subscribe alarms"

"Subscribe mail"

"Subscribe performance monitor"

They are not related to any object.

The parameters for these commands allow the filtering of the information.

For example, the following command could be used to get all the notifications of

severity 'critical' concerning both all the objects under the mediation part of the OMC

and all the sites under the BSC 6:

"Subscribe notifications: Object Filter List = ((bsc = 6 & btsSiteManager = all)

~ Object Instance) & ((md) ~ Whole Subtree); perceived severity =

critical"

After subscribing commands have been sent, other commands can be sent normally,as before.

The OMC software guarantees that spontaneously sent information and command

results are not merged (i.e. the whole text of the information spontaneously sent is

treated as an atomically entity).

To remove the subscription mechanism the following commands have to be used:

"Unsubscribe notifications"

"Unsubscribe alarms"

"Unsubscribe mail"

"Unsubscribe performance monitor"

They are not related to any object

It is not possible to command a second subscription for the same kind of information

on the same session unless the first one has been removed: in other words, two

subscriptions for the same kind of information cannot coexist on the same session.

When a switchover is performed on the OMC server or when the server reboots: the

opened subscriptions (including the user mail) are no longer active. In this case,

subscription has to be re-opened. In this case, the following message is displayed:

"All subscriptions are lost. You have to send new subscription requests".


17/47




5.2. COMMAND FORMAT

The format of the commands is described in the chapter command line interface.

Note on the use of the wildcard keyword 'all' in the parameters of the commands:

This keyword may replace the identifier value at the last level(s) in the hierarchical

name of the object instances:

For instance (bsc =106 & btsSiteManager =all & bts =all) means "all the bts under

any btsSiteManager that pertains to bsc number 106".

For commands related to an object, the value of the 'object' parameter must not

contain the wildcard.

Rules for the hierarchical names of the object instances:

For mono-instantiated object classes, the name of the object instance does not

contain any equality at the last level, but only the name of the object class. Forinstance: '(md)'

The level corresponding to such an object instance does not appear inside the

hierarchical name of an object instance (it only appears if it is at the last level). For

instance, the omc does not appear in the name of the notification log object.

Some examples of commands are provided hereafter:

Example number 1:

Di spl ay r aw r epor t : mdObj ect Li st = ( bsc = 106) ; mdScanner Type =

" f ast St at i st i c"; r epor t Obj Level = ( bsc = 106 & bt sSi t eManager

= al l & bt s = al l ) ; begi nSearchTi me = 01/ 07/ 02, 12: 45: 00;endSear chTi me = 01/ 07/ 02, 13: 15: 00;

Gets the report that displays the counters of the fast statistic observation generated by

the BSC number 106 and that exclusively concerns all the cells, for the 1st J uly 2002

at 1:15 PM or immediately before, but after 12:45 PM.

Example number 2:

Set admi ni st r at i veSt at e- bt s: obj ect = ( bsc = 106 &

btsSi t eManager = 24 & bts = 2) ; admi ni st r at i veState = " l ocked";

Put out of service (or locks) the cell represented by the bts object 2 under the

btsSiteManager 24 and bsc 106.

Example number 3:

Di spl ay - bt s : obj ect = ( bsc = 106 & btsSi t eManager = 24 & bts

= 2)

Queries the non-dynamic characteristics for a cell, ie the non-dynamic attributes of the

object representing the cell under the btsSiteManager 24 and bsc 106.

Example number 4:

Set - sever al : obj ect = ( bsc = 106) ; scope = subl evel 2; f i l t er =

obj ect Cl ass = "bt s" & admi ni st r at i veSt at e = " l ocked";admi ni st r at i veSt at e = "unl ocked" ;


18/47




Modify the administrativeState of all cells where the administrativeState is locked to

unlocked.

Example number 5:

Di spl ay cont ent s- not i f i cat i on l og: obj ect = ( not i f i cat i on l og) ;mi ni mum event t i me = 08/ 01/ 02, 15: 54: 00; maxi mum event t i me =

08/ 01/ 02, 15: 56: 00; maxi mum r ecept i on t i me = 08/ 01/ 02,

23: 59: 00;

Provides the NMC with the event-reports issued by the BSSs and the OMC between

3:54 PM and 3:56 PM on the 1st of August 2002 and received by the OMC on this

day.

5.3. OUTPUT FORMAT

All responses to a command have the same format (described in the section

COMMAND RESPONSE FORMAT). A special configuration (based on configuration

files) is provided to format the observation reports (described in the section

OBSERVATION REPORT FORMAT), the notifications and the alarms (described in

the section NOTIFICATION AND ALARM FORMAT). The corresponding line mode

and graphical displays are both defined by this configuration.

5.3.1 COMMAND RESPONSE FORMAT

In this section all messages are underlinedfor the English version.

COMMAND RESPONSE HEADER

Each response is identified by the following information:

The time of the response, with the format hh:mm:ss where hh is the hour on

two digits, mm is the minutes on two digits, ss is the seconds on two digits.

The command number, on nine digits.

The user name which executed the command.

The name of the machine which executed the command.

The status of the response to the command.

Each field is separated by a space.

When a command is refused by Man Machine Interface (Syntactical error, or

communication error), the following message is displayed by Man Machine Interface.

HH:MM:SS userName machineName FAILED (completed)

following by the appropriate error message.

When a command is accepted by Man Machine Interface, and sent to the application

the following message is displayed by Man Machine Interface:

HH:MM:SS commandNumber userName machineName SENT

following by the text of the command line executed.


19/47




When a response with a status succeeded is received by Man Machine Interface, the

following message is sent.

HH:MM:SS commandNumber userName machineName SUCCEEDED

(completed)

or if not the last response

HH:MM:SS commandNumber userName machineName SUCCEEDED

(other answers follow)

following by the text of the response

When a response with a status failed is received by Man Machine Interface, the

following message is sent.

HH:MM:SS commandNumber userName machineName FAILED

(completed)

or if not the last response

HH:MM:SS commandNumber userName machineName FAILED (other

answers follow)

following by the error message and if necessary the parameters in error.

A command is completed when the status received is FAILED (completed) or

SUCCEEDED (completed).

RESPONSE FAILED

The text displayed after the header line is the following:

The object instance in error if necessary, by example:

object bsc = 1 (PARIS)

The error message, by example:

The object must be unlocked

The parameters in error if necessary, one parameter by line.

RESPONSE SUCCEEDED

This section is not relevant for the response to an observation report, and for allresponse related to notifications and alarms.

If the response to a command has no supplementary information for example the

response to a command "set" or a command "create", only the header line is

displayed.

If the response to a command contains supplementary information for example the

response to a command "display", all parameters received by the Man Machine

Interface are displayed. The name of the parameter is always in the column zero (0) of

the line, and the value of the parameter is displayed in column twenty-four (24). If the

name of the parameter is greater that 24 characters, the value of the parameter is

displayed after the name of the parameter separated by a space. If the value of a

parameter is formatted on several lines the following output is provided.


20/47




column 0 column 24

parameterOne value parameterOne

parameterTwo value 1 parameterTwo

value 2 parameterTwo

value 3 parameterTwo

parameterThree value parameterThree

veryLongParameterName value parameter

5.3.2 OBSERVATION REPORT FORMAT

Each observation report is configurable, and this configuration can be changed with a

standard text editor. Inside a report file, there are possibilities to display or not some

counters, according to the version of the BSC. Each modification in one the

configuration files is taken into account immediatly.

CONFIGURATION FILE NAME

Each observation report is described in a file stored in the current language directory

(/OMC/config/locale//). The version stands for the bsc version

involves for the report. The selection of the appropriate report file depends on:

the monitored object,

the mdScannerType,

the bscCounterList type.

The report type will modify the header of each report. The following file name are

used:

form_hdr_bdm.cfg (busiest day of the month report)

form_hdr_day.cfg (daily report)

form_hdr_raw.cfg (raw report)

form_hdr_usr.cfg (custom report)

For a mdScannerType "permanent general MD", the file name is form_GPO_mdr.cfg

For an mdScannerType "temporary interface", the file name is

form_TOInterference.cfg

For an mdScannerType "temporary signallingLink", the file name is

form_TOSignallingLink.cfg

For an mdScannerType "temporary Abis interface bts", the file name is

form_TOAbisInterface.cfg .

For a manager permanent general observation, the file names is form_GPO_mgr.cfg

For a bscCounterList type "Diagnostic" (ODIAG), the following file names are used:

For an adjacent cell report: form_ODIAG_adjC.cfg

For a bsc report: form_ODIAG_bsc.cfg


21/47




For a bts report: form_ODIAG_bts.cfg

For a transceiverZone report: form_ODIAG_trZone.cfg

For a bscCounterList type "Fast statistic" (OFS), the following file names are used:

For an adjacent cell report: form_OFS_adjC.cfg

For a bsc report: form_OFS_bsc.cfg

For a bts report: form_OFS_bts.cfg

For a transceiverZone report: form_OFS_trZone.cfg

For a bscCounterList type "general statistic" (OGS), the following file names are used:

For an adjacent cell report: form_OGS_adjC.cfg

For a bsc report: form_OGS_bsc.cfg

For a bts report: form_OGS_bts.cfg

For a transceiverZone report:form_OGS_trZone.cfg

For a bscCounterList type "real time" (ORT), the following file names are used:

For a bsc report: form_ORT_bsc.cfg

For a bts report: form_ORT_bts.cfg

DESCRIPTION OF THE CONFIGURATION FILE FORMAT

Each configuration file is an ASCII file, and can be edited by a standard text editor.

The main principle is that the position of information displayed in a report is specified

by a column number (in character units) and a line number.

The character separator between two fields is the space or the tabulation.

The comment sign is '#': all characters on the same line after the sign '#' are ignored

(excepted if the sign '#' is between "and", in this case the sign '#' is not interpreted and

can be displayed as a label).

The blank lines are permitted in the file.

Each significant line (i.e. not comments) in the file must have the following format:

Line Column

All keywords used in a report file are "key sensitive". In this section all keyword are

written in italic.

keywords list:

activationObject: used to display the instance of the activation object.

initiationTime: used to display the collect counter time at the BSS level (date

and time).

omcReceptionTime: used to display the instant when the manager function of

the OMC receives the observation message.

granularityPeriod: used to display (in seconds) the granularity period of theassociated mdScanner object.


22/47




observationDuration : used to display the duration (in seconds) of the

observation.

firstScanInitTime: used to display the collect time of the first found message

satisfying the user request.

lastScanInitTime: used to display the collect time of the last found message

satisfying the user request.

refValidityDate: used to display the day (date and time) which defines the

beginning of the period used for the busiest day of the month elaboration.

refStartPeriod: used to display the time which defines the beginning of the

reference period (the reference period is the time interval in the day used to

compute the value of reference counter).

refEndPeriod: used to display the time which defines the end of the reference

period (the reference period is the time interval in the day used to compute the

value of reference counter).

refCntrName: used to display the name of the counter to sum to decide which

is the busiest day of the month.

refCntrValue : used to display the value of reference counter with the

format "format" (for the definition of the format see "man printf"), calculated by

summing all the values of the counter refCntrName, during the reference

period.

mdStorageDuration: used to display the storage duration of the observation

message files onto the MD-R disks.

label : used to display a label, it is possible to have multiple label in a

line.

title: used to set a title

counter : used to display the value of a counter

which has the name "nameOfCounter" with the format "format" (for the

definition of the format see "man printf"), for the list of counter names see

[A3].

idObservedObject []: This keyword is used:

o to display a complete instance of the observed object or a part of the

instance of the observed object. List of observateObjectClass

possible:

bsc

pcmCircuit

btsSiteManager

bts

adjacentCellHandOverV8 (match for adjacentCellHandOver

class)


23/47




channel

signallingLink

md

transceiverEqpt

omc

machine

transceiverZone

o To display the last node of an observed object use "lastNode".

o To display the complete instance of an observed object with the

location name (if available) use "allNodes"

o To display a node or a list of nodes, all nodes name and the format to

use should be precised. Warning only the nodes with a numeric value

are accepted. The name of the node to use is the name used for

observedObjectClass.

Examples for an observateObjectClass bts (bsc =1, btsSiteManager =1,

bts =3):

idObservedObject bts allNodes

result: bsc 1 ( PARI S) btsSi t eManager 2 ( BERCY) bts

3 ( BERCY 1)

idObservedObject bts lastNode

result: bts 3

idObservedObject bts "bsc %d btsSiteManager %d

bts %d"

result: 123

idObservedObject bts "bsc %d btsSiteManager / %d

bts / %d"

result: 1/ 2/ 3

idObservedObjectbts "bsc %dbts /%d"

result: 1/ 3

idObservedObject bts "bsc %03d btsSiteManager

/ %03d bts / %03d"

result: 001/ 002/ 003

idObservedObject bts "bsc %03d btsSiteManager \ "

%03d\ " bts \ " %03d\ ""

result: 001 002 003

idObservedObject bts "bsc \ "bsc = %03d\ "

btsSiteManager \ " SI TE = 03d\ " bts \ " CELL =

%03d\ " "


24/47




result: bsc = 001 SI TE = 002 CELL = 003

If lengthMax is omitted the displayed instance is not truncated, else the

instance displayed is truncated to lengthMax characters.

beginBlock : to display counters for the list ofinstances to one location (Note: only the lineNumber is significant)

endBlock: end of the block for the previous beginBlock (Note: only the

lineNumber is significant)

A block can be multi lines, the lineNumber of the beginBlock must be equal to the

lineNumber of the first text displayed in the report, and the lineNumber of the endBlock

must be greater than or equal to the lineNumber of the last text displayed in the report.

A block cannot be included in another block.

BSC version management:

Three special keywords are defined to manage the bsc version. These keywords aredefaultBscVersion, ifBscVersion and endifBscVersion.

defaultBscVersion : This keyword is used to define the

bscVersion, if the version of the bsc (for the current report) is unknown. This

keyword must be set in the report form before a keyword ifBscVersion.

ifBscVersion : If the version of the bsc (for the current report) is

equal to the specified version the following lines in the report form are taken

into account.

endifBscVersion: Define the end of the special processing for a bsc version.

NOTE: The values authorized for are V16, V17 and V18 or other forhigher versions of OMC.

5.3.3 NOTIFICATION AND ALARM FORMAT

This section describes the format of configuration files used to define how a

notification or a user alarm (cleared or not) is displayed to the user.

CONFIGURATION FILE NAME

There are several configuration files, located in the /OMC/config/locale//

directory, organized following this scheme:

for the notifications:


25/47




for the alarms:

for the cleared alarms:


26/47


27/47




DESCRIPTION OF THE CONFIGURATION FILE FORMAT

The principle is that the content of the file reflects what the user will see. Every

character of the file will be displayed, except the keywords. Keywords are delimited by

two % characters. %rep%, %codano% are keywords. A keyword can contain a token,or a variable. If a keyword contains a variable, this variable will be replaced by its

value during display. If a keyword contains a token, this string will modify some

characteristics of the file.

The comment sign is '#': all characters on the same line after the sign '#' are ignored.

Sample of configuration file:

- - - - Code: %not i f Al ar mI nf o. codano% - - -

sour ce: %commonNot i f i cat i onI nf o. obj ect I d%

The result to the final user will be this:

- - - - Code : 1032 - - -

source: bsc = 4 & bt sSi t eManager = 1 & bt s = 3

codano and objectId are variables.

A variable will be replaced by its value when the report is displayed to the user.

A format string can be added after the variable name. The format string has the same

definition as the part of the format string used by printf.

Example: to display the codano left justified, you specify this:

%codano, - 10%

Some of the variables are common to the different kinds of notifications, and some

can be used only in a specific kind of notifications.

One variable can contain several fields ( like a C structure). Its the case with the

variable addInfo (described later). If you choose to display the whole variable addInfo,

each field contained in this variable will be printed. But you can also choose to access

individually to each field. Example post Mor t em:

%addI nf o. commonAddI nf o. post Mor t em% will display the postMortem field,

element ofcommonAddInfo, included in addInfo.

TOKENS

A token is a reserved keyword, used to define a specific action.

The defined tokens are:

%cond%

%endcond%

%if %

%else%

%endif%

%ifdef%


28/47




%endifdef%

%length%

%inpar%

%outpar%

%align%

%endalign%

%begin%

Tokens %cond% / %endcond% means that each line of the rapport will only be

displayed if there is no undefined variable in a line. Example:

%cond%

Var1: %val ueVar1%

%endcond%

The line Var1: %val ueVar1%will only be displayed if the variable valueVar1 is

defined

%endcond% indicates the end of the condition state (%cond%). Every line following

the %endcond% keyword will be displayed, even if some variables are undefined in a

line (in this case the variable will be replaced by the string 'undefined').

More than one line can be written between the %cond% / %endcond% tokens.

Tokens %if % / %else% / %endif% means that the following lines will be

displayed only if the condition is true, until the next %endif% or%else% token.

The condition can take several forms:

Variable ( in that case, the condition is: the variable has to be defined )

Variable EQ value ( verification of equality )

Variable NEQ Value ( verification of inequality )

Condition1 AND Condition2 AND Condition3 ( where Condition_i can take

one of the three previous forms )

Condition1 OR Condition2 OR Condition3

In the two last cases, the condition can be composed either of AND or of OR, butAND and OR cannot be mixed in the same condition.

Example:

%i f bt sModel EQ bt sModel S2000i nDoor%

Thi s came f r om a BTS S2000 i n door number %bt sI d%

%endi f %

A special defined variable is origin which can take the value

commandSchedulerOrigin, lineInputOrigin, graphicOrigin, rotOrigin or

commandFileOrigin. So you can defined several kinds of report according to thecommand origin.


29/47




Example:

%i f or i gi n EQ gr aphi cOr i gi n%

I am on Mmi Gr aphi c

%endi f %

%i f or i gi n EQ r ot Or i gi n%

I ' m on l i ne i nput .

%endi f %

The mechanism of the three %if% / %else% / %endif% keywords is similar to the

classical mechanism ofif/ else / endif, in C-language, for instance.

%if condition% %endif%

the lines between the two keywords are displayed only if the condition is true.

%if condition% %else% %endif%

if the condition is true, the lines between %if % and %else% are displayed,

otherwise the lines between %else% and %endif%.

Tokens %ifdef % / %endifdef%

This particular type of condition only applies on variables passed to the file that parses

these configuration files.

The lines between %ifdef % and %endifdef% are displayed only if

is passed to the construction of this parsing file.

Tokens %length variable number%

This keyword is replaced by (number the length ofvariable) stars.

For Example:

%length notifAlarmInfo.perceivedSeverity 23%

If the severity of the alarm is major, the keyword will be replaced by 23-5=18 *

characters.

Tokens %inpar% / %outpar%

Some information theobjectId variable, for instance have the following form:

text1 (text1) text2 (text2) %outpar% only displays the parts of the string that are not between parenthesis while

%inpar% displays the texts that are between parenthesis. What is more, this

information is presented like in a table; let us take an example:

If the variable commonNotificationInfo.objectIdcontains the following strings

bsc 3 ( France) bt sSi t eManager 0 ( Par i s ( XVe) ) ,

I nst ance: %out par commonNot i f i cat i onI nf o. obj ect I d%

Descri pt i on: %i npar commonNot i f i cat i onI nf o. obj ect I d%

Then it gives:


30/47




I nst ance: bsc 3 | bt sSi t eManager 0

Descri pt i on: France | Par i s ( XVe)

Tokens %align% / %endalign%

%align% means that for each line displayed after this keyword, the information are

preceded exactly by one tabulation.

%endalign% indicates the end this alignment: for each line lying after this keyword, the

information are displayed from the beginning of the line.

Thi s t ext i s not al i gned

%al i gn%

Thi s t ext i s al i gned

Thi s one t oo

%endal i gn%

gives:

Thi s t ext i s not al i gned

Thi s t ext i s al i gned

Thi s one t oo

Tokens %begin value%

If the variable is defined, and if it contains the string value at a particularindex, it will be displayed from this index to the end.

For instance, if the variable addInfo.commonAddInfo.bscLocation equals

equi pement : bsc chai nA,

then %begin addInfo.commonAddInfo.bscLocation chain% gives chai nA.

OVERVIEW OF VARIABLES

Several set of variables exist. Some concern the notifications, others the alarms and

finally the cleared alarm.

In the alarm display configuration file, variables which are specific to the alarm may be

displayed as well as the variables which are relevant for the notification. By the same

way, in the cleared alarm display configuration file, variables which are specific to the

cleared alarm may be displayed as well as the variables which are relevant for the

alarm. As the notification variables are a subset of the alarm variable, they are usable

for the cleared alarm display.

According to the configuration file where the variables are used, it is necessary to add

a prefix to identify them. In the alarm display configuration file, notification variables

must be preceded by the "notificationDescription" prefix. In the cleared alarm

display configuration files, notification variables must be preceded by

"alarmDescription.notificationDescription" and the alarm variable by the

"alarmDescription" prefix.


31/47




Each variable may be present (displayed) or not according to the event.

The following sections give the sets of variables which are accessible to the user.

NOTIFICATION VARIABLES

Here is the list of the notification variables.

When these variables are used in the notification display configuration file no prefix is

required.

When these variables are used in the alarm display configuration file, they must be

preceded by the "notificationDescription." prefix.

When these variables are used in the cleared alarm display configuration files,

notification variables must be preceded by

"alarmDescription.notificationDescription." prefix

commonNotificationInfo

commonNotificationInfo.notifType

commonNotificationInfo.objectId

commonMgrNotificationInfo

commonMgrNotificationInfo.omcNotifId

commonMgrNotificationInfo.omcTime

commonMgrNotificationInfo.optionalMgrInfocommonMgrNotificationInfo.optionalMgrInfo.omcId

commonMgrNotificationInfo.optionalMgrInfo.taskId

commonMgrNotificationInfo.optionalMgrInfo.machineId

commonMgrNotificationInfo.optionalMgrInfo.machineName

commonMdNotificationInfo

commonMdNotificationInfo.mdNotifId

commonMdNotificationInfo.eventTime

commonMdNotificationInfo.optionalMdInfo

commonMdNotificationInfo.optionalMdInfo.mdId

commonMdNotificationInfo.optionalMdInfo.bssId

notifAlarmInfo

notifAlarmInfo.perceivedSeverity

notifAlarmInfo.probableCause

notifAlarmInfo.codano


32/47




notifAlarmInfo.cause

sourceIndicator

usageState

stateChange

stateChange.administrativeStateWithShuttingDown

stateChange.operationalState

stateChange.availabilityStatus

tSCBNumbersignallingLinkResState

accessibilityState

remoteSsuState

supportingTransceiverEquipment

specificAction

sigChannel

sigChannel.pcmCircuitRef

Here is information on the main variables corresponding to notification data.

Main variables description:

commonMgr Not i f i cat i onI nf o. omcNot i f I d : OMC-R user notification

number (serial identifier of the user-notification in the OMC-R).

commonMdNot i f i cat i onI nf o. mdNot i f I d : MD-R user notification

identity if the event is coming from an MD-R application or from a BSS via theMD-R.

commonNoti f i cat i onI nf o. not i f Type : similar to the Q3 notification

type.

commonMdNot i f i cat i onI nf o. opt i onal MdI nf o. mdI d : related MD-R

identity if the event is coming from an MD-R application or from a BSS via the

MD-R.

commonMgr Not i f i cat i onI nf o. opt i onal Mgr I nf o. machi neI d : related

machine identity if the event is coming from a manager application.

commonMgr Not i f i cat i onI nf o. opt i onal Mgr I nf o. t askI d : relatedtask identity if the event is coming from a manager application.


33/47




commonNot i f i cat i onI nf o. obj ect I d : Object class and instance

commonMdNot i f i cat i onI nf o. event Ti me : The date and time of the

event creation by the BSS ( if the event if coming from the BSS) or by the MD-

R (if the event is coming from the MD-R).

commonMgrNot i f i cat i onI nf o. omcTi me : Date and time of the event

reception by the manager.

The following list given the variables which correspond to the additional information

data.

addI nf o

addI nf o. addi t i onal Text

addI nf o. bscI d

addI nf o. bdaSt ate

addI nf o. commonAddI nf o

addI nf o. commonAddI nf o. mdTi me

addI nf o. commonAddI nf o. post Mor t em

addI nf o. commonAddI nf o. bt sLocat i on

addI nf o. commonAddI nf o. btsLocat i on. btsEqptName

addI nf o. commonAddI nf o. btsLocat i on. eqptProcNum

addI nf o. commonAddI nf o. btsLocat i on. btsModel

addI nf o. commonAddI nf o. bt sLocat i on. bt sEqpt Locat i on

addI nf o. commonAddI nf o. bt sLocat i on. bt sEqpt Locat i on. bt sCabi netLoc

at i on


at i on. bt sCabi net


at i on. btsCabi net Ext ensi onNumber

addI nf o. commonAddI nf o. bt sLocati on. bt sEqpt Locat i on. r ackBt s

addI nf o. commonAddI nf o. bt sLocati on. bt sEqpt Locat i on. eqpt Di st i ngui

shName

addI nf o. commonAddI nf o. bscLocat i on

addI nf o. commonAddI nf o. bscLocat i on. bscEqptName

addI nf o. commonAddI nf o. bscLocat i on. eqptProcNum

addI nf o. commonAddI nf o. bscLocat i on. bscModel

addI nf o. commonAddI nf o. bscLocat i on. bscChai nI dent i f i er

addI nf o. commonAddI nf o. bscLocat i on. bscEqpt Locat i on

addI nf o. commonAddI nf o. bscLocat i on. bscEqpt Locat i on. bscCabi netLoc

at i on


34/47




addI nf o. commonAddI nf o. bscLocat i on. bscEqpt Locat i on. bscRackName

addI nf o. commonAddI nf o. bscLocat i on. bscEqpt Locat i on. t e

addI nf o. commonAddI nf o. NmsCompI d

addI nf o. manuf act ur er I nf o

addI nf o. bt sAbi sNak

addI nf o. bt sAbi sNak. bt sAbi sNakGsmFunct i on

addI nf o. bt sAbi sNak. bt sABi sNakReport

addI nf o. bt sAbi sNak. t ei

addI nf o. bt sEr r or

addI nf o. bt sEr r or . bt sEr r or I mpactFl ag

addI nf o. bt sEr r or . sendTEI

addI nf o. bt sEr r or . bt sPcm

addI nf o. bt sEr r or. pcmEr r Sec

addI nf o. bt sErr or . pcmEr r Sec. nbSecNos

addI nf o. bt sEr r or. pcmEr r Sec. nbSecSi a

addI nf o. bt sEr r or. pcmEr r Sec. nbSecRr a

addI nf o. bt sEr r or. pcmEr r Sec. nbSecLos

addI nf o. bt sEr r or. pcmEr r Sec. nbSecFec

addI nf o. bt sEr r or. pcmEr r Sec. nbSecCr c

addI nf o. bt sErr or . pcmEr r Sec. nbSecS1s2

addI nf o. sendTEI

addI nf o. i nt er nal PCMFai l ur e

addI nf o. dl oadFai l ur e

addI nf o. dl oadFai l ur e. t ei

addI nf o. dl oadFai l ur e. manI d

addI nf o. dl oadFai l ur e. hwRef

addI nf o. dl oadFai l ur e. swRef

addI nf o. dl oadFai l ur e. cf gRef

addI nf o. dl oadFai l ur e. f Set Ref

addI nf o. r esTDMA

addI nf o. r esTDMA. t r anscei ver Equi pment I d

addI nf o. r esTDMA. t dmaMask

addI nf o. t r xSync

addI nf o. crGl ob


35/47




addI nf o. dLoadTCUFai l

addI nf o. t cbSync

addI nf o. t cbEXT

addI nf o. t cb2Sync

addI nf o. t cb2EXT

addI nf o. chnDegr

addI nf o. chnDegr . chnDegr Swi t chCap

addI nf o. chnDegr . chnDegr TCUCanal Av

addI nf o. chnDegr. chnDegr I nt PcmSwm16

addI nf o. chnDegr . chnDegr SLSAvai l abl e

addI nf o. chnDegr . t otal nbr ECI

addI nf o. chnDegr . eci Avai l abl eNbr

addI nf o. chnDegr . t otal Nbr SI CX

addI nf o. chnDegr . si cxAvai l abl eNbr

addI nf o. chnDegr . t otal Nbr SI CD

addI nf o. chnDegr . si cdAvai l abl eNbr

addI nf o. chnDegr . t otal Nbr CS7

addI nf o. chnDegr . cs7Avai l abl eNbr

addI nf o. chnDegr . t ot al Nbr Si cdPor t s

addI nf o. chnDegr . f aul t ySi cdPor t sNbr

addI nf o. chnDegr . t otal Nbr Cs7Por t s

addI nf o. chnDegr . f aul t yCs7Por t sNbr

addI nf o. chnDegr . t otal Nbr Cs7Por t s

addI nf o. chnDegr . f aul t yChai nHardDi skSt ate

addI nf o. t r anscei ver Equi pment I d

addI nf o. t r anscei ver I d

addI nf o. conf i gType

addI nf o. r adAnoChl n

addI nf o. part i t i onName

addI nf o. chai nRest ar t I nPr ogr ess

addI nf o. ci rcul arF i l eI dent i f i er

addI nf o. newPcmChoosenAsI nternal Cl ockRef erence

addI nf o. newPcmChoosenAsI nt ernal Cl ockRef erence. cl ockRef Ol dPcm

addI nf o. newPcmChoosenAsI nternal Cl ockRef erence. cl ockRef NewPcm


36/47




addI nf o. abi sEr r MesTEI Number

addI nf o. hoppLaw

addI nf o. hoppLaw. hoppLawI ni t Conf

addI nf o. hoppLaw. t sHoppLaw

addI nf o. t scbTei Unknown

addI nf o. r adUnknownCel l

addI nf o. t r cNack

addI nf o. t r cNack. t r cNackTypeMessage

addI nf o. t r cNack. ci c

addI nf o. mscTraf f i cSt ateChange

addI nf o. r adObsEndWarni ng

addI nf o. def enceThr eshol dCr ossed

addI nf o. def enceThr eshol dCr ossed. def Act i on

addI nf o. def enceThr eshol dCr ossed. maxSum

addI nf o. def enceThr eshol dCr ossed. sumPer i od

addI nf o. def enceSpecAnomal y

addI nf o. def enceSpecAnomal y. def Act i on

addI nf o. def enceSpecAnomal y. suspTask

addI nf o. def enceSpecAnomal y. suspSt at i onI d

addI nf o. def enceSpecAnomal y. suspStat i onName

addI nf o. ear MdWarni ngThr eshol dCr ossi ng

addI nf o. ear MdWarni ngThreshol dCr ossi ng. mdWarni ngI d

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. r efPer i od

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. pr ocI dent i t y

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. pr ocI dent i t y. bscEqpt Name

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. pr ocI dent i t y. eqpt ProcNum

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. eqpt I dent i t y

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. eqpt I dent i t y. bt sEqpt Name

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. eqpt I dent i t y. eqpt ProcNum

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. moni t oredSpeci f i cProbl ems


. codano


. cause

addI nf o. ear MdWarni ngThr eshol dCr ossi ng. count erVal ue


37/47




addI nf o. ear MdWarni ngThr eshol dCr ossi ng. st art Al armThr eshol ds

addI nf o. ear MdWarni ngThreshol dCr ossi ng. endAl armThr eshol ds

addI nf o. orcMdWarni ngThr eshol dCr ossi ng

addI nf o. orcMdWarni ngThreshol dCr ossi ng. mdWarni ngI d

addI nf o. orcMdWarni ngThr eshol dCr ossi ng. count er I d

addI nf o. orcMdWarni ngThr eshol dCr ossi ng. col l ect Ti me

addI nf o. orcMdWarni ngThr eshol dCr ossi ng. t hr eshol dType

addI nf o. orcMdWarni ngThr eshol dCr ossi ng. count erVal ue

addI nf o. orcMdWarni ngThr eshol dCr ossi ng. st art Al armThr eshol ds

addI nf o. orcMdWarni ngThreshol dCr ossi ng. endAl armThr eshol ds

addI nf o. maxAccept edBscMdCl ockDr i f t

addI nf o. mdServi cesHangUp

addI nf o. mdShut down

addI nf o. mdShut down. host NameMdServer

addI nf o. mdShut down. host NameBkpSer ver

addI nf o. mdShut down. mdShut DownMdAr chi t ect ure

addI nf o. mdShut down. mdShut downStopCause

addI nf o. assocI d

addI nf o. sof t wareBSCAnomal y

addI nf o. sof t wareBSCAnomal y. bdeVal ue

addI nf o. sof t wareBSCAnomal y. bdaVal ue

addI nf o. par t i t i onFul l

addI nf o. par t i t i onFul l . par t i t i onName

addI nf o. par t i t i onFul l . dest r oyLogDat e

addI nf o. x25l apbDown

addI nf o. pmOsAnomal y

addI nf o. pmOsAnomal y. l owThr eshol dVal ue

addI nf o. pmOsAnomal y. hi ghThr eshol dVal ue

addI nf o. pmOsAnomal y. count erVal ue

addI nf o. pmOsAnomal y. mdScannerType

addI nf o. pmOsAnomal y. counter I d

addI nf o. pmOsAnomal y. mdGr anul ar i t yPer i od

addI nf o. pmOsAnomal y. mdScanI ni t i at i onTi me

addI nf o. dt i me_MdMgr


38/47




addI nf o. dt i me_MdMgr. dtMdTi me

addI nf o. dt i me_MdMgr. dtMgrTi me

addI nf o. dt i me_MdMgr . dt Di f f Thr eshol d

addI nf o. r adSysI nf o

addI nf o. r adSysI nf o. t r anscei ver I d

addI nf o. r adSysI nf o. channel I d

addI nf o. r adSysI nf o. channel TypeFM

addI nf o. r adSysI nf o. subChanI d

addI nf o. sever al UnsuccessFul Logi nAno

addI nf o. several UnsuccessFul Logi nAno. l ogi nAt t emptNumber

addI nf o. sever al UnsuccessFul Logi nAno. host Name

addI nf o. omcAccessFai l ur eAno

addI nf o. omcAccessFai l ureAno. omcAccessFai l AccessMode

addI nf o. omcAccessFai l ureAno. omcAccessFai l Degr Level

addI nf o. al ar mFi l eRepai r

addI nf o. al ar mFi l eRepai r . suspTask

addI nf o. al ar mFi l eRepai r . suspSt at i onI d

addI nf o. al armFi l eRepai r . suspSt ati onName

addI nf o. al ar mFi l eRepai r . al ar mFi l eRepai r St at us

addI nf o. bscOver Load

addI nf o. pcuAnomal yI nf o

addI nf o. pcuAnomal yI nf o. ser vi ceAvai l abi l i t yTr end

addI nf o. pcuAnomal yI nf o. cel l GPRSAvai l abi l i t yChangeI nf o

addI nf o. pcuAnomal yI nf o. cel l GPRSAvai l abi l i t yChangeI nf o. cel l GRPSN

ewAvai l abi l i t y

addI nf o. pcuAnomal yI nf o. cel l GPRSAvai l abi l i t yChangeI nf o. i mpact edC

el l Li st

addI nf o. wr ongAbi sMessageI nf o

addI nf o. wr ongAbi sMessageI nf o. wr ongAbi sMessageNbMsg

addI nf o. wr ongAbi sMessageI nf o. wr ongAbi sMessageCauseLi st

addI nf o. wr ongAi r Message

addI nf o. wr ongAi r Message. wr ongAi r MessageNbMsgUnrecongni sed

addI nf o. wr ongAi r Message. wr ongAi r MessageNbMsgRecongni sed

addI nf o. wr ongAi r Message. wr ongAi r MessageLi st

addI nf o. wr ongAMessage


39/47




addI nf o. wr ongAMessage. wr ongAMessageNbMsg

addI nf o. wr ongAMessage. wr ongAMessageLi st

addI nf o. unknownCI CAt BSC

addI nf o. unknownCI CAt BSC. unknownCI CAt BSCLi st

addI nf o. unknownCI CAt MSC

addI nf o. unknownCI CAt MSC. unknownCI CAt MSCLi st

addI nf o. Radi oAccessAt t empt Whi l eCel l NotReady

addI nf o. Radi oAccessAt t emptWhi l eCel l Not Ready. Radi oAccessAt t emptW

hi l eCel l Not ReadyNbMsg

addI nf o. Radi oAccessAt t emptWhi l eCel l Not Ready. Radi oAccessAt t emptW

hi l eCel l Not ReadyLi st

addI nf o. HOAtt empt ToUnkownBCCHbSI C

addI nf o. HOAt t empt ToUnkownBCCHbSI C. At t empt ToUnkownBCCHnbMsg

addI nf o. HOAtt empt ToUnkownBCCHbSI C. Att empt ToUnkownBCCHLi st

addI nf o. Feat ur eAvai l abi l i t y

addI nf o. Feat ur eAvai l abi l i t y. Feat ur eAvai l abi l i t ySt at us

addI nf o. Feat ur eAvai l abi l i t y. Feat ur eAvai l abi l i t yLi st

addI nf o. NmsAl armI nf o

addI nf o. NmsAl ar mI nf o. NmsAl ar mCommentDat a

addI nf o. NmsAl armI nf o. NmsAl armOper at orDat a

addI nf o. NmsAl armI nf o. NmsAl armCompCr i t i cal i t y

addI nf o. NmsAl armI nf o. NmsAl armCust omer I d

addI nf o. NmsAl armI nf o. NmsAl armRel at edComponents

addI nf o. NmsMessageI nf o

addI nf o. NmsMessageI nf o. percei vedSever i t y

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o. NmsAl armCommentDat

a

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o. NmsAl armOper at orDa

t a

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o. NmsAl armCompCr i t i c

al i t y

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o. NmsAl armCust omer I d

addI nf o. NmsMessageI nf o. NmsMessageGeneral I nf o. NmsAl armRel at edCom

ponents

addI nf o. NmsRawStat eI nf o


40/47




addI nf o. NmsRawStat eI nf o. NmsRawStat eCompCr i t i cal i t y

addI nf o. NmsRawStat eI nf o. NmsRawStat e

addI nf o. Gpr sCel l Audi t I nf o

addI nf o. Gpr sCel l Audi t I nf o. Gpr sCel l Audi t I nf oLi st

ALARM VARIABLES

Here is the list of the alarm variables.

When these variables are used in the alarm display configuration file no prefix is

required.

When these variables are used in the cleared alarm display configuration files,

notification variables must be preceded by "alarmDescription." prefix

commonAl ar mI nf o

commonAl armI nf o. al armI d

commonAl armI nf o. al armSeveri t y

commonAl armI nf o. al armStat e

ackAl armI nf o

ackAl armI nf o. ackTi me

ackAl armI nf o. ackUser

Variable signification:

commonAl armI nf o. al armI d: The alarm number.

commonAl armI nf o. al armSever i t y: The severity of the alarm urgent, no

urgent, without intervention.

commonAl armI nf o. al armStat e: The state of the alarm acknowledged or

unacknowledged.

ackAl armI nf o. ackTi me: The date and time when the alarm has been

acknowledged.

ackAl armI nf o. ackUser : The user name which acknowledged the alarm.

CLEARED ALARM VARIABLES

Here is the list of the cleared alarm variables.

al ar mHi stori cI nf o

al ar mHi st or i cI nf o. cessat i onTi me

al ar mHi st or i cI nf o. cessat i onType

al ar mHi st or i cI nf o. cessat i onUser


41/47




Variable signification:

al ar mHi st or i cI nf o. cessat i onTi me: The date and time when the alarm

has ceased.

al ar mHi st or i cI nf o. cessat i onType: The type of the cessationautomatic or user.

al ar mHi st or i cI nf o. cessat i onUser : The user name which ceased the

alarm.

5.3.4 CONFIGURATION OF EXTERNAL ALARM AND USER SYSTEMALARMS DESCRIPTIONS

The message displayed when an external alarm is raised can be (and should be)

defined by the customer. There is a configuration file which contain description of each

alarm for a given bts Type, and a configuration file for the user system alarm. Thesefiles are located in the /OMC/config/locale// directory. The names of the files

are:

MmiExternalAlarmDesc.cfg: for external alarms

MmiUserSysDesc.cfg: for user system alarms.

The content of the MmiExternalAlarmDesc.cfg will be described here, but the

MmiUserSysDesc.cfg follows exactly the same rules.

Each line of this configuration file is made of two part: first, a number constructed from

a number describing the bts type added to the alarm number (see examples), and an

ASCII description of the alarm.

Comments can be added, using the #character.

Examples:

0x00C80001 Fi re al ar m # BTS2000 i n door , al arm number 1

0x00C80002 I nt r us i on # BTS2000 i n door , al arm number 2

0x03200010 Fi re Al ar m # BTS8000 out door , al arm 16

Note than in this example, hexadecimal notation was used, but you can also use

decimal notation.Here is the base number for each type of BTS:


42/47




Bts Type Hexa Base Value Decimal Base Value

S2000inDoor 0X00C80000 13107200

S2000EinDoor 0X00C90000 13172736S2000EoutDoor 0X00CA0000 13238272

S2000DlowPower 0X00CB0000 13303808

S2000DhighPower 0X00CC0000 13369344S4000inDoor 0X01900000 26214400S4000CinDoor 0X01910000 26279936S4000outDoor 0X01920000 26345472S4000smart 0X01930000 26411008S8000inDoor 0X03200000 52428800

S8000outDoor 0X03210000 52494336S8000inDoorCBCF 0X032A0000 53084160S8000outDoorCBCF 0X032B0000 53149696S2000LP_O1 0X00D20000 13762560S2000LP_O2 0X00D30000 13828096S2000LP_S11 0X00D40000 13893632

S2000HP_O1 0X00DC0000 14417920

S2000HP_O2 0X00DD0000 14483456S2000HP_S11 0X00DE0000 14548992e-CELL 0X00E60000 15073280

So, the find which number is associed with an alarm description, take the base value

of the Bts model, and add the external alarm number. Example, number 48 for a

S12000HP_O1 is: 14417920( Base number) +48 =14417968

So, you can put the following description in the configuration file:

14417968 Al arm 48 f or S12000HP_O1

or if you prefer to use hexadecimal notation:

S1200smar t =0X00DC0000+0X30 ( =48 deci mal ) - > 0X00DC0040

So the line in the configuration file will be:

0X00DC0040 "Al ar m 48 f or S12000HP_O1 "

You can also configure if the number at the left (i.e. 0X00DC0040) will be displayed or

not in the notification or alarms. To do this, you have to modify the line containing the

description of the parameter ExternalAlarmDesc in the file MmiParamModels.cfg:

ext ernal Al armDesc Label f ormat_hex Mmi Ext ernal Al armDesc. cf g

This line said that the parameter externalAlarmDesc is of type Label, is displayed

using the format format_hex and use label file MmiExternalAlarmDesc.cfg.

In this line, you can modify the format parameter. Here is the possible value of format

and the different result in a report:

Format string Result

format_none Alarm 48 for S12000 smartformat_dec(or no format specified) (14417968) Alarm 48 for S12000HP_O1format_hex (0X00DC0040) Alarm 48 for S12000HP_O1

You can also use this formatting option with the user SysDesc parameter.


43/47




6. APPENDIX A (OBJECT TREE)

This chapter gives the object tree used by MMI. All object instances will be identifiedaccording to this tree.

When the object name is followed by a star (*) the object has a sub-tree that is not

represented.

md (*)

network (*)

root

omc (*)

internalMdRoot

internalRoot

defaultSubNetwork

subNetwork

bscMdIntPerDefaultSubNet

bscMdIntPerSubNet

AAterIntPerDefaultSubNet

AAterIntPerSubNet

AIntPerDefaultSubNet

AIntPerSubNet

AterIntPerDefaultSubNet

AterIntPerSubNet

bssRadiosPerDefaultSubNet

bssRadiosPerSubNet

AGprsIntPerSubNet

AGprsIntPerDefaultSubNet

obect mana er

object Q3

summary object manager


44/47




omc

userProfile

terminalProfile

commandFile shortMessageuserMessage

sessionLog

object manager

object Q3


ob

obResult

clearedAlarmLog currentAlarmListnotificationLogrelay

directory

mdScanner efd logmdWarning bscMdInterface

md

alarmRecord

stateChangeRecord

mdScanReportRecord

observationFileReadyRecord

traceContro l cal lPathTrace

traceReference traceReference

traceRecord

alarmCriteria

machine

attributeValueChangeRecord

objectCreationRecord

objectDeletionRecord

executableSoftware


45/47




network

bsc

signallingPoint

pcmCircuit

(Abis, Ater,AGprs)

xtp

btsSiteManager (*)

transcoder

lapdlink(Abis,AGprs)

software

signallingLinkSet(A, Lb)

signallingLink(A, Lb)

AbisIntPerRadioSitesGroup

radioSiteSum

AbisIntPerMultipleSite

pcmCircuit

transcoderBoard

btsSMSum

software

object manager

object Q3


multipleSite

tcusPerBsc AIntPerBsc

tAbisIntPerBsc bscSuminternalBscCrossRef

AterIntPerBsc

unrefLapdPerBsc

unrefPcmPerBsc

radioSitesPerBsc

bssRadio

AbisIntPerRadioSite

radioSitesGroup

AintPerPcm

internalTcuCrossRef tcuSum AintPerTcutcbsPerTcu

PCUSn

AGprsIntPerBsc

pcu pcuSum

G3transcoderEqp G3transcoderEqpSum

cem

cemPerG3TranscoderEqp

lsaRc iem

lsaRcPerG3TranscoderEqp

trm

trmPerG3TranscoderEqp

G3bscEqp (*) G3bscEqpSum

software

G2transcoderEqp

tdti

G2bscEqp

bscLog


46/47




G3bscEqp

iem

cc

object manager

object Q3


interfaceNode interfaceNodeSum

lsaRcPerInterfaceNode sw8kRmPerInterfaceNode

controlNodeSum

atmRmPerInterfaceNode

sw8kRm

ccPerControlNode

cem

cemPerInterfaceNode

lsaRc atmRm

controlNode

mms tmu

tmuPerControlNode omuPerControlNode

omu

hsaRc

hsaRcPerInterfaceNode

iom

btssoftware

transceiver powerControl

frequencyHoppingSystem

channel

object manager

object Q3


btsSiteManager

adjacentCellHandOver

adjacentCellReselection

handOverControl

transceiverEquipment

software

BtsSum adjCellHOPerBts

transceiverZone

transcvZonePerBts

transceiverEqtSumadjacentCellUTRAN

7. ABBREVIATIONS AND DEFINITIONS

7.1. ABBREVIATIONS

EDB : Error Database

H/W : Hardware

I/F : Interface


47/47


LAN : Local Area Network

MMI : Man-Machine Interface function of the OMC-R

NE : Network Element

NMC : Network Management Centre

N/W : Network

PSTN : Public Switched Telephone Network

ROT: Remote Operation Terminal

S/W : Software

XLAN : eXtended Local Area Network - Set of LANs connected to the same X25

network, through routers that make the X25 LAN transparent for communication from

one LAN to another one.

7.2. DEFINITIONS

: configured current language. For example: takes the value "en" for

the English version and the value.

failed command : A command within a command file, which has become

syntactically incorrect and has not, passed the

SIE Command Line Interface Principles

Documents

Transcript of SIE Command Line Interface Principles