0% found this document useful (0 votes)
66 views35 pages

Ericsson RAN OSS ENM CLI Commands Guide

This document presents a guide on the use of CLI commands in the Ericsson RAN OSS ENM system, version 1.0, dated December 29, 2017. It covers various topics such as opening the CLI, creating collections for bulk actions, activating command files, as well as specific operations like deleting configuration versions and managing licenses. The document also includes detailed instructions for audit and maintenance tasks on eNodeB nodes.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
66 views35 pages

Ericsson RAN OSS ENM CLI Commands Guide

This document presents a guide on the use of CLI commands in the Ericsson RAN OSS ENM system, version 1.0, dated December 29, 2017. It covers various topics such as opening the CLI, creating collections for bulk actions, activating command files, as well as specific operations like deleting configuration versions and managing licenses. The document also includes detailed instructions for audit and maintenance tasks on eNodeB nodes.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

ERICSSON 2G 3G 4G Ericsson RAN Version: V1.

0
OSS ENM - CLI Commands Date: 29/12/2017

Ericsson RAN

OSS ENM - CLI Commands

History :
Version: v1.0 Document Creation

Date : 29/12/2017

Circulation level
Controlled
Internal
Free
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

Table of Contents

1. Introduceton
2. Prerequisites______________________________________________________________5
3. CLI Opening on ENM___________________________________________________6
4. Createton collectwe can do ac via CLItmassive waves________________6
5. Actgoton a CLI command file____________________________________8
6. Resynchronize a node - enable CM supervision______________________________9
7. SW: equivalent SHM via CLI______________________________________________10
A. Suppression of CV on 1 site (little interest) )____________________________________10
B. Suppression of upgrade package
C. Actgoton Emergency unlock___________________________________________________15
D. Createston CV massive startable_________________________________________________16
E. Restart of several sites planned on the previously created startable CV_____________17
F. Recoverton the state of the license for the list of sites____________________________________19
G. operaton restore on 1 enodeB via CLI_______________________________________20
8. CM: parameter setting audit______________________________________________20
A. Check one or more parameters on one or more sites_________________________________21
9. CM export____________________________________________________________23
A. Export all the configurationstat a node (without filter)__________________23
B. Make an export bytthe in utreading a filter____________________________________23
C. Verify the status of export progress___________________________________________23
D. Download the generated export___________________________________________________24
10. CM import the plan via CLI
A. Createtwe have a configurationton__________________________________________________24
B. Import of a plan into a configurationton non-Live________________________________24
C. Obtain the informationtabout the import of the plan______________________________________25
D. Actgotwe configure itton_________________________________________________25
E. Import of a plan in the configurationton Live (applicationtwe direct the changestons)_______25
F. Createton a rollback file following the appton a plan___________________25
11. Alarming audit alarms or state from CLI
A. List the DISABLED cards of all RNCs on an ENM_____________________________26
B. List dev non ENABLED on all RNC __________________________________ 26
C. Audit Alarm________________________________________________________________27
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

12. Actgoton/offtgoton a feature via CLI_______________________________30


A. List the features on the Enm___________________________________________________30
B. List the non-AC featurestseen on all the NE/Specific node____________________30
C. Actview a feature on an eNodeB
A. Disactsee a feature on an eNodeB
Lock/Unlock & Listng Site, cell & Hardware_______________________________32
A. List the status of a site/sites: _____________________________________________32
B. List the status of a cell:__________________________________________________32
C. Lister the Hardware and its status on a site:_______________________________________32
D. Lock/Unlock of all the cells of a site______________________________________33
E. Lock/Unlock from a specific cell_____________________________________________36
A. Lock/Unlock of a radio equipment_______________________________________________36
14. Help & Tips_________________________________________________________36
A. Help
B. Export the command and the result into a file_________________________________36
C. The functionton force_____________________________________________________________37

A. Check from the DU, Status MME__________________________________________________37


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

1. Introduction

The purpose of this instruction sheet is to describe actions that can be performed by CLI commands in
the areas Alarming, SW (SHM app), audit ...

The help on ENM is very well done.


[Link]

In the Command Set section, for example, you can see everything that can be done in CLI for
replace SHM
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

2. Prerequisites

Having ENM access

3. CLI opening on ENM


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

4. Collection creation via CLI to perform bulk actions

Create a file containing the list of enodeB to be added to the collection


Drag it onto the CLI screen
Then run the command
collection create testcli -f file:"[Link]"

Same operation if we have multiple sites in our collection (which generally happens)

Create a file collection_test.txt

Drag it on CLI

Then launch the command (if there are special characters in the collection name, it must be enclosed in " ")
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

If you want the collection to be public, you need to add –pu


deletion/creation

5. Activation of a CLI command file


You may have to run the same CLI commands multiple times or play a file.
with the orders already filled in this case proceed as below:

Drop your file into the ENM window to upload it to the workspace
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

Then type the batch command followed by the TAB key and click on validate syntax

The commands will be executed one after the other, you can follow the progress in the...
window and at the end a message will tell you if everything went well

6. Resynchronize a node – enable CM supervision

Following an attempt to act on an eNodeB, we have the error

In Topology Browser we see that the enodeB is unsynchronized.

We start with the tutorial for creating a node


[Link]

We then find how to activate the CM supervision to true to carry out actions.
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

[Link]
Enable CMSupervision

We then perform a resynchronization of the Node under the Topology browser.

And everything is OK

7. SW: equivalent SHM via CLI

A. Removal of CV from 1 site (little interest) )

To retrieve the FDN of ConfigurationVersion


cmedit get LACASSAGNE_LTE ConfigurationVersion
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

To retrieve the existing CVs


cmedit get
SubNetwork=ONRM_ROOTMO, MeContext=LACASSAGNE_LTE, ManagedElement=1, SwManagement
nt=1,ConfigurationVersion=1

To delete the desired CV


cmedit action
SubNetwork=ONRM_ROOTMO, MeContext=LACASSAGNE_LTE, ManagedElement=1, SwManagement
nt=1,ConfigurationVersion=1 delete.(configurationVersionName="Sauve_cv_SMO_Dec_22_2017")

B. Suppression of upgrade package

[Link]

Via cmedit is more tedious

It is necessary to list the upgrade packages and the CVs that are on top of them.
ERICSSON 2G 3G 4GEricsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

Then these CVs must be deleted.

cmedit action
SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1,SwManageme
nt=1, ConfigurationVersion=1 delete.(configurationVersionName="Save_cv_SMO_Nov_18_2017")

before deleting the upgrade package

cmedit delete
SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1,SwManagement
nt=1,UpgradePackage=Virtual_0_of_CXP102051/27_R21D52 --force

Via shm command

"shm deleteup -n LACASSAGNE_LTE --prodnum 'CXP102051/27' --prodrev 'R21D52' -drl --force"

The –drl option allows you to delete CVs from the rollback list.

If we set the option --force So the order is placed by itself without request for
confirmation
Once the order is placed, we have a Job name that can be seen via CLI (command
"shm status --jobname Shm_Cli_DELETE_UPGRADEPACKAGE_SOOP7376_28122017142312) or
via SHM

CLI Command
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

If the upgrade package needs to be removed from multiple LTE sites (before an upgrade), then it must be initiated
the order

shm deleteup -n BRAY_DUNES_LTE;BRAY_DUNES_GOEL_LTE --prodnum "CXP102051/23" --


prodrev "R27DC" -drl --force

or

Create a collection with the sites we want to act on, called delete_up
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

and launch the command (if we do not know the options, we can use TAB and it will suggest them,
example below

shm deleteup --collection delete_up --prodnum "CXP102051/23" --prodrev "R27DC" --delrolllist --


jobname del_up_281217

If we want to go to SHM to see the execution, we double-click on our job.


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

C. Activation Emergency unlock

to know if we have already used the emergency unlock

cmedit get SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE


[Link]

Retrieve the MO licensing FDN in order to use it to initiate the emergency unlock.
cmedit get SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE Licensing=1

FDN :
SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1,Sys
temFunctions=1,Licensing=1
Launch the Emergency Unlock

cmedit action SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE Licensing=1


setEmergencyState
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

D. Creation of a massive startable CV

May be useful before an upgrade

Create a collection via Network Explorer of sites to upgrade

Via CLI, launch if we want a CV called test_cv_cli that will be added to the rollback list and will be startable.
in case of restart

shm backup --collection testcv --backupname test_cv_cli --firstinrollback --startable


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

E. Restart of several scheduled sites on the startable CV


previously created

Créer une collection des sites a restarter (dans l’exemple on fait une collection d’un site
LACASSAGNE_LTE
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

shm restart --collection testcli --reason UNPLANNED_O_AND_M_ISSUE --rank RESTART_COLD --


jobname test_reboot_laca --begin 2017-12-28T15:40:00

We can clearly see in SHM that the reboot is planned.

Then once the hour is reached


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

the restart is successfully completed

F. License status recovery for site list

You can initiate the activation verification of a feature license on all declared nodes.
the ENM

Example:
CXC4011980 FAJ1214466 2017-09-26 No Limit Enabled Licensed4CC DL Carrier
Aggregation Extension

cmedit get * LicenseInventory,([Link]==CXC4011980) -t

G. restore operation on 1 enodeB via CLI

list of resumes on the node

cmedit get LACASSAGNE_LTE ConfigurationVersion


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

cmedit get SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE ConfigurationVersion.


(storedConfigurationVersions)

Retrieve the MO configuration version


cmedit get SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE ConfigurationVersion

Retrieve the startable CV


cmedit get
SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1,SwManagement
nt=1,ConfigurationVersion=1 [Link]

If needed, change the startable CV


cmedit action
SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1,SwManageme
nt=1,ConfigurationVersion=1 setStartable.
(configurationVersionName=Sauve_cv_SMO_Dec_27_2017)

restart
cmedit action SubNetwork=ONRM_ROOTMO,MeContext=LACASSAGNE_LTE,ManagedElement=1
manualRestart.(restartRank="RESTART_COLD",
restartReason="PLANNED_RECONFIGURATION",restartInfo="Restart for CV restore") –force

8. CM: parameterization audit

A. Check one or more parameters on one or more sites

It may be useful to check the settings on multiple nodes of a collection, a parameter


individual or several

We know that we want to audit the parameter on the enodeB

To retrieve the parameters (equivalent to the mom)


cmedit describe PowerDistribution*.(*LoadUndervoltageDisconnect*) -namespace
ERBS_NODE_MODEL

To retrieve the 2 desired parameters from a site


cmedit get BRAY_DUNES_LTE PowerDistribution.
(mainLoadUndervoltageDisconnect,priorityLoadUndervoltageDisconnect)

to produce the same output in table mode


cmedit get BRAY_DUNES_LTE PowerDistribution.
(mainLoadUndervoltageDisconnect,priorityLoadUndervoltageDisconnect) -t

To extract the 2 required parameters from multiple sites


cmedit get BRAY_DUNES_LTE; BRAY_DUNES_GOEL_LTE PowerDistribution.
(mainLoadUndervoltageDisconnect,priorityLoadUndervoltageDisconnect) –t
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

If we want to see these 2 parameters on all 3G and 4G sites.

cmedit get * PowerDistribution.


(mainLoadUndervoltageDisconnect, priorityLoadUndervoltageDisconnect) –t

If you want to see these parameters when they are declared on all 4G sites of the ENM
Note that if these MOs are not present on the enodeB, they do not appear in the table.

cmedit get * PowerDistribution.


(mainLoadUndervoltageDisconnect,priorityLoadUndervoltageDisconnect) -ns=ERBS_NODE_MODEL
-t
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

9. CM export
It is possible to retrieve part or the entire configuration of one or more sites.
Exports can be generated in two formats (3GPP or dynamic).

The 3GPP exports are in xml format and are similar to the files generated by BDREF for the
creation of MO/parameter configuration modification.

A. Perform an export of the entire configuration of a node (without filter)

cmedit export --ne LACASSAGNE_LTE --filetype dynamic

It is possible to perform the export in 3GPP format by replacing --filetype dynamic with --filetype.
3GPP.
It is possible to perform the export on all nodes by replacing --ne LACASSAGNE_LTE with --ne
*.
It is possible to perform the export on a collection by replacing--ne LACASSAGNE_LTE with--
collection my_collection.

B. Perform a partial export using a filter

Drop the [Link] file into the ENM window to load it into the workspace

[Link] added to workspace

cmedit export --ne LACASSAGNE_LTE --filetype dynamic -f file:[Link]


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

The file [Link] must contain a line like this:


MO [Link] name([Link])
<MO Class>.*(EUtranCellFDD.*)
<MO Class>.(<attr name1>,<attr name2>,...)(EUtranCellFDD.(tac,altitude,cellId))
You can export multiple MO by separating them with a ;
<MO Class1>.<attr name>;<MO Class2>.<attr name>;<MO Class3>.<attr name>;...

C. Check the status of the export

cmedit export --status --job 11984

You need to retrieve the job number (ID) following the command cmedit export –ne ...

D. Download the generated export

cmedit export --download --job 11984

10. CM import plan via CLI


Modification/creation/deletion plans for MO can be created in dynamic format or
3GPP. The easiest way to create a plan is to use an export file as inspiration and add the tags.
for deletion/modification/creation.

There are two documents in the help center for creating 3GPP import files or
Dynamic :
- Sample 3GPP import file
- Sample Dynamic Import file
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

It is possible to import the plan into the Live configuration (the modifications are applied.
directly on the live network) or in a non-Live configuration (to apply the changes
subsequently).

A. Creating a configuration
create my_config

B. Import of a plan in a non-Live configuration

Drop the file [Link] into the ENM window to load it into the workspace

cmedit import -f file:[Link] --filetype dynamic --target my_config

For a 3GPP plan (xml), replace --filetype dynamic with --filetype 3GPP.

C. Obtain the information on the import of the plan

cmedit import --status --job 232

You can use the --verbose option at the end of the command to get more information about the import.

D. Activation of the configuration

config activate --source my_config

E. Importing a plan into the Live configuration (direct application


modifications

Upload the file [Link] in the ENM window to load it into the workspace
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

cmedit import -f file:[Link] --filetype dynamic --target Live

F. Creation of a rollback file following the application of a


plan

You can create a rollback file for the import job:


config undo --importjob 233

One can also create a rollback file for the job of activating a configuration.
non_Live :

config undo --activationjob 348

You can then download the rollback file:

config undo --download --job 350

To apply the downloaded file, we reuse the commands from the paragraphs above (import
of a plan).

11. Alarming: audit alarms or status dev via CLI

A. List the DISABLED cards of all RNCs on an ENM

cmedit get * PlugInUnit.(operationalState!=ENABLED) -ns=RNC_NODE_MODEL -t

B. Lister development not ENABLED on all RNC

cmedit get * UtranCell.(operationalState!=ENABLED) -ns=RNC_NODE_MODEL –t


ERICSSON 2G 3G 4GEricsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

C. Alarm Audit

It can be useful to retrieve alarms from the sites of a collection (for example collection
previously created ex_collection

alarm get "ex_collection" -cri -maj -min -v

the file can also be exported to a CSV file that can be directly retrieved and opened with
excel
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

alarm get "ex_collection" -cri -maj -min -v –xp

Then
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

If we want all the nodes on ENM (includes 3G and 4G)

alarm get * -cri -maj -min


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

[Link]/deactivation of a feature via CLI

A. List the features on the Enm

Lcmadm list

B. List the features not activated on all NE/Specific Node

cmedit get * [Link]==DEACTIVATED OptionalFeatureLicense.* -t


NB1:the –t seal for display the result in tableau
NB2: press Ctrl+Enter to export the file directly (give a name + extension)
NB3: we can replace the * with the name of the node
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

C. Activate a feature on an eNodeB

cmedit set <node name> [Link]==<feature to be


activated> [Link]=ACTIVATED

Example:
cmedit set LACASSAGNE_LTE [Link]==HighSpeedUE
[Link]=ACTIVATED

A. Disable a feature on an eNodeB

cmedit set <node name> [Link]==<feature to be


activated> [Link]=DEACTIVATED

Example:
cmedit set LACASSAGNE_LTE [Link]==HighSpeedUE
[Link]=DEACTIVATED
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

13. Lock/Unlock & Listing Site, cell & Hardware

A. List the status of a Site/sites:


To list the status of a site:
cmedit get <Site_Name> eutrancellfdd.
(operationalstate,administrativestate,availabilitystatus,cellbarred) –t
ex for all sites: cmedit get * eutrancellfdd.
(operationalstate,administrativestate,availabilitystatus,cellbarred) –t

B. List the status of a cell:


cmedit get <SITE_NAME> eutrancellfdd.
(operationalstate,administrativestate==UNLOCKED,availabilitystatus,cellbarred) –t

C. List the hardware and its status on a site:


To list the radio equipment on all or all sites:
cmedit get <Site_Name> AuxPlugInUnit.
(unitType,operationalState,administrativeState,availabilityStatus) –t
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

To get information about:


productNumber,ProductionRevision,SerialNumber,ProductionDate,ProductionName)

just put a * after AuxPlugInUnit :


cmedit get <Site_Name> AuxPlugInUnit.* -t

D. Lock/Unlock all cells of a site


To Lock/Unlock all 4G cells of a site:
cmedit set <Site_Name> eutrancellfdd administrativestate=LOCKED
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

To check if the cells have been properly locked:


cmedit get <Site_Name> [Link]==LOCKED -t
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

To unlock all the cells of a site:

The –force function allows you not to have to validate the command.
ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM - CLI Commands Date: 29/12/2017

E. Lock/Unlock a specific cell


To lock a specific cell
cmedit set <Node Name> EUtranCellFDD.(EUtranCellFDDId==<Cell Name>
administrativestate=UNLOCKED)

To unlock a specific cell


cmedit set <Node Name> EUtranCellFDD.(EUtranCelleFDDId==<Cell Name>)
administrativeState=LOCKED)

A. Lock/Unlock of radio equipment

To lock radio equipment


cmedit set <Node Name [Link]==<AuxPlugInUnitId>
administrativeState=LOCKED

To unlock radio equipment


cmedit set <Node Name [Link]==<AuxPlugInUnitId>
administrativeState=UNLOCKED

[Link] & Tips

A. Help
At any time, we can use the help command to obtain more information about
any command and its syntax:
Help "command name"
example:
Help cmedit set

B. Export the command and the result to a file

To export a command and its result to a file:


press Ctrl+enter to directly export the file (give a name + extension)

C. The force function


ERICSSON 2G 3G 4G Ericsson RAN Version: V1.0
OSS ENM – CLI Commands Date: 29/12/2017

The - -force function allows bypassing the prompt to confirm the command when using the
set command or action

Description Help :
--force: Force the command execution. This option is not required when using scripting integration.
Batch scripts. It is assumed that all commands in a script should be executed without user intervention.

D. Check of the DU, Status MME, Link X2

To get the details of the DU


cmedit get <Node Name> PlugInUnit.-*

To check the status of the MME link


cmedit get * TermPointToMme.(operationalState, administrativeState, availabilityStatus) –t

To check the status of link X2

»cmedit get <Node_Name> TermPointToENB.(operationalState,administrativeState,availabilityStatus)


–t

You might also like