cmedit Syntax

Yiannis Agrogiannis [email protected]

cmedit subcommands
Get: List data for MOIs

Set: Modify data (attributes) for MOIs

Action: Perform an action on MOI

Describe: Describe an MO Class, an MOI, or MOI attributes

Create: Create a MOI

Delete: Delete a MOI

Export: Bulk-export CM data to a file

Import: Bulk-import CM data from a file

ENM CLI Page 1
cmedit subcommands
Get: List data for MOIs

Set: Modify data (attributes) for MOIs

Action: Perform an action on MOI

Describe: Describe an MO Class, an MOI, or MOI attributes

Create: Create a MOI

Delete: Delete a MOI

Export: Bulk-export CM data to a file

Import: Bulk-import CM data from a file

ENM CLI Page 2
cmedit General Syntax

commandset subcommand <node(s)> <MOC>

Target Node(s) Target MOC

ENM CLI Page 3

cmedit General Syntax

commandset subcommand <node(s)> <MOC>

Case Sensitive Non case-sensitive

ENM CLI Page 4

 get subcommand

ENM CLI Page 5

 cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,..)

ENM CLI Page 6

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1,attribute2,..)

ENM CLI Page 7

cmedit get – Example 1

› Print all instances for MO=eutrancellfdd for a specific node

cmedit get ERBS1 EUtranCellFDD

› Print all instances for MO=eutrancellfdd for multiple nodes

cmedit get ERBS1;ERBS2 EUtranCellFDD

› Print all instances for MO=eutrancellfdd in whole network

cmedit get * EUtranCellFDD

(* indicates all nodes)

ENM CLI Page 8

cmedit get – Example 2
Wildcards for node(s) name(s)
› Print all instances for MO=eutrancellfdd

cmedit get ERB* EUtranCellFDD

cmedit get *01 EUtranCellFDD

cmedit get *RB* EUtranCellFDD

ENM CLI Page 9

cmedit get – Example 2
Wildcards for MOC=No support
› cmedit get ERBS1 EUtranCell*

› Error 4004 : Command syntax error, unexpected input '*' while

processing get command (object specifications).

› Suggested Solution :
Refer to usage instructions for the cmedit get command

ENM CLI Page 10

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC> -t

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,..)

ENM CLI Page 11

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,..)

ENM CLI Page 12

cmedit get – Example 3
› Print all cell attributes for a specific node
cmedit get ERBS1 EUtranCellFDD.*

› Print all cell attributes for a multiple nodes

cmedit get ERBS1;ERBS2 EUtranCellFDD.*

› Print all cell attributes in network

cmedit get * EUtranCellFDD.*

ENM CLI Page 13

cmedit get – Example 4

› Use wildcard to identify a node and print All attributes for

MO=eutrancellfdd

cmedit get ERB* EUtranCellFDD.*

cmedit get *005 EUtranCellFDD.*

cmedit get *BS00* EUtranCellFDD.*

ENM CLI Page 14

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.* -t

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,..)

ENM CLI Page 15

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,…)

ENM CLI Page 16

cmedit get – Example 5
› Print for All cells in a Node the operationalState attributes
cmedit get ERBS1 EUtranCellFDD.operationalState

› Print for All cells in multiple Nodes the operationalState attribute

cmedit get ERBS1;ERBS2
EUtranCellFDD.operationalState

› Print for All cells in network both the operationalState attributes

cmedit get * EUtranCellFDD.operationalState
ENM CLI Page 17
cmedit get – Example 6

› Use wildcard to identify a node and print All attributes for

MO=eutrancellfdd

cmedit get ERB* EUtranCellFDD. operationalState

cmedit get *005 EUtranCellFDD. operationalState

cmedit get *BS00* EUtranCellFDD. operationalState

ENM CLI Page 18

cmedit get – Specific Cell

› Print for a specific cell in a node the operationalState attribute

cmedit getLTE01ERBS00001
EUtranCellFDD.(EUtranCellFDDId==LTE01ERBS00001-1 ,
operationalState)

ENM CLI Page 19

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.attribute -t

cmedit get <node(s)> <MOC>.(attribute1, attribute2,…)

ENM CLI Page 20

cmedit get - syntax

cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,..)

ENM CLI Page 21

cmedit get – Example 7
› Print for all cells in a Node both the operationalState and
administrativestate attributes
cmedit get ERBS1 EUtranCellFDD.(operationalState,
administrativestate)

› Print for all cells in network both the operationalState and

administrativestate attributes
cmedit get * EUtranCellFDD.(operationalState,
administrativestate)

ENM CLI Page 22

cmedit get – Example 8
› Use wildcard to identify a node and print both the
operationalState and administrativestate attributes
MO=eutrancellfdd
cmedit get ERB* EUtranCellFDD.(operationalState,
administrativestate)

cmedit get *005 EUtranCellFDD. (operationalState,

administrativestate)

cmedit get *BS00* EUtranCellFDD. (operationalState,

administrativestate)

ENM CLI Page 23

Question - cmedit get

› What is the command to list ALL attributes for a

specific cell in a node ??

ENM CLI Page 24

Question - cmedit get

Correct or Wrong ??

cmedit get ERBS1

EUtranCellFDD.(EUtranCellFDDId==cell-1, * )

ENM CLI Page 25

Answer - cmedit get

Wrong

cmedit get ERBS1

EUtranCellFDD.(EUtranCellFDDId==cell-1, * )

ENM CLI Page 26

Answer - cmedit get

Correct

cmedit get FDN

ENM CLI Page 27

cmedit get – Example 9

› Print all cell attributes for a specific cell (FDN)

cmedit get
ManagedElement=ERBS1,ENodeBFunction=1,EUtranCellFDD=ERBS-1

cmedit get
SubNetwork=RadioNode, ManagedElement=ERBS1, ENodeBFunction=1,
EUtranCellFDD=ERBS-1

(when a node belongs to a subnetwork)

ENM CLI Page 28

cmedit get – Syntax Summary
cmedit get <node(s)> <MOC>

cmedit get FDN

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1,

attribute2,…)

ENM CLI Page 29

cmedit get – Syntax Summary
cmedit get <node(s)> <MOC>

cmedit get <node(s)> <MOC>.*

cmedit get <node(s)> <MOC>.attribute

cmedit get <node(s)> <MOC>.(attribute1, attribute2,…)

Single nodes : Node1

Multiple Nodes : Node1;Node2
Collection : Collection name

ENM CLI
Saved Search : Search Page
name30
Hint 1
cmedit get

› Print all children MOs for a specific parent MO

cmedit get <node(s)> <MO>,*

Parent MO comma (not dot)

ENM CLI Page 32

 set subcommand

ENM CLI Page 33

cmedit set - syntax

› Modify an attribute for all MOIs for a node(s)

cmedit set <node(s)> <MOC> attribute=new_value

› Modify an attribute for a specific MOI for a node

cmedit set <node> <MOC>.(MOid==id)
attribute=new_value

ENM CLI Page 34

 cmedit set – Example 10

› Set an attribute value for All cells in a node

cmedit set ERBS1 EUtranCellFDD administrativeState=LOCKED

› Set an attribute value for a specific cell in a node

cmedit set ERBS1 eutrancellfdd. eutrancellfddid==1

administrativestate=UNLOCKED

ENM CLI Page 35

cmedit set - syntax

› Modify an attribute for all MOIs for a node(s)

cmedit set <node(s)> <MOC> attribute=new_value

› Modify an attribute for a specific MOI for a node

cmedit set <node> <MOC>.(MOid==id)
attribute=new_value
Single nodes : Node1
Multiple Nodes : Node1;Node2
Collection : Collection name
Saved Search : Search name
ENM CLI Page 36
 describe subcommand

ENM CLI Page 37

cmedit describe - syntax

(The command doesn’t accept the Node name)

cmedit describe <MOC>

cmedit describe <MOC>.*

cmedit describe <MOC>.attribute1

cmedit describe <MOC>.(attribute1,attribute2)

ENM CLI Page 38

cmedit describe – Example 11

› cmedit describe EUtranCellFDD.*

› cmedit describe EUtranCellFDD.* -t

› cmedit describe EUtranCellFDD.operationalState

› cmedit describe EUtranCellFDD.(operationalState,

administrativeState, availabilityStatus, cellBarred)

ENM CLI Page 39

 action subcommand

ENM CLI Page 40

cmedit action - syntax
› Initiate a modeled action by Query
cmedit action <Node> criteria action [options]

› Initiate a modeled action by FDN

cmedit action <FDN> action

› Initiate a modeled action by FDN

cmedit action <FDN> criteria action [options]

ENM CLI Page 41

 cmedit action – Example 12
Initiate Node Manual Restart
› Modeled action by Query
cmedit action ERBS1 ManagedElement
manualRestart.(restartRank=RESTART_WARM;
restartReason=PLANNED_RECONFIGURATION; restartInfo=someinfo)

› Modeled action by FDN

cmedit action MeContext=ERBS1,ManagedElement=1
manualRestart.(restartrank=RESTART_WARM,
restartreason=PLANNED_RECONFIGURATION,restartinfo=someInfo)
ENM CLI Page 42
cmedit action – Example 13

Initiate AuxPlugInUnit Manual Restart

› Modeled action by Query (Node name)

cmedit action ERBS1

AuxPlugInUnit.(AuxPlugInUnitId==RRU-1) restartUnit

cmedit action ERBS1 ManagedElement startHealthCheck

cmedit action * ManagedElement startHealthCheck

ENM CLI Page 43

cmedit action – Example 14
› Create a Node CV (ERBS node type)
cmedit action ERBS1 configurationversion
create.(configurationVersionName=..., identity=…, operatorName=…,
comment=…)

ENM CLI Page 44

cmedit action – Example 15

› Create a Node BrmBackup (RadioNode node type)

cmedit action Node1 brmbackupmanager createBackup

ENM CLI Page 45

cmedit action – Example 16
› Delete a Node CV (ERBS node type)
cmedit action ERBS1 configurationversion
delete.configurationVersionName=...

ENM CLI Page 46

 Hint

ENM CLI Page 47

cmedit action – Example 17

› Find what actions are supported for an MOC

(list all supported actions for an MOI by using any keyword as a
trigger)

cmedit action <Node> <MOC> keyword

ENM CLI Page 48

cmedit action – Example 18
› Find the supported action types for MOC=ManagedElement

cmedit action Node1 managedelement test

› Error 1016 : An incorrect action name (coffee) has been encountered for
the type ManagedElement possible value(s) are [manualRestart,
startHealthCheck]

› Suggested Solution : Provide a value from this list:

[manualRestart , startHealthCheck]

ENM CLI Page 49

cmedit action – Example 19
› Find the mandatory attributes for a specific action type

cmedit action Node1 managedelement manualrestart

› Error 1005 : manualRestart requires the following mandatory

attribute(s): (restartRank, restartReason, restartInfo)

› Suggested Solution : Provide the mandatory attribute(s):

(restartRank, restartReason, restartInfo)

ENM CLI Page 50

cmedit action – Example 20
cmedit action eNB4-304 eutrancellfdd hello

Error 1016 : An incorrect action name (hello) has been encountered for
the type EUtranCellFDD possible value(s) are [changeFrequency,
startAilg, stopAilg]

Suggested Solution :
Provide a value from this list: [changeFrequency, startAilg, stopAilg]

ENM CLI Page 51

cmedit action – Example 21
cmedit action eNB4-304 enodebfunction bye

Error 1016 : An incorrect action name (icecream) has been encountered

for the type ENodeBFunction possible value(s) are
[updateMMEConnection, collectDynamicCellStatus]

Suggested Solution : Provide a value from this list:

[updateMMEConnection , collectDynamicCellStatus]

ENM CLI Page 52

 create subcommand

ENM CLI Page 53

cmedit create - syntax
› Create a Managed Object Instance by FDN
cmedit create <FDN> attributes [options]

ENM CLI Page 54

cmedit create – Example 22

› Create an ENodeBFunction
cmedit create
MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1
ENodeBFunctionId=1; userLabel=”New"; eNodeBPlmnId=(mcc=272,
mnc=7,mncLength=2)

ENM CLI Page 55

cmedit create – Example 23

› Create an ENodeBFunction

cmedit create

MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

ENodeBFunctionId=1; userLabel=”New"; eNodeBPlmnId=(mcc=272,

mnc=7,mncLength=2)

ENM CLI Page 56

cmedit create – Example 24
› Create an EUtranCellFDD

› cmedit create
MeContext=ERBS1,ManagedElement=1,ENodeBFunction=1,
EUtranCellFDD=2 physicalLayerSubCellId=2, earfcnul=20900,
cellId=2, physicalLayerCellIdGroup=67, eUtranCellFDDId=2,
tac=100, earfcndl=2900

ENM CLI Page 57

 delete subcommand

ENM CLI Page 58

cmedit delete - syntax
› Delete an MOI by specifying the FDN
cmedit delete <FDN> [-ALL]

› Delete an object by specifying the FDN

cmedit delete <FDN> criteria [-ALL] [options]

› Delete an object by query

cmedit delete <node> criteria [filter] [-ALL] [options]

ENM CLI Page 59

cmedit delete – Example 25
› Delete an MOI (by FDN)
cmedit delete
MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

-ALL

› Delete an MOI (by query)

cmedit delete * EUtranCellFDD.(EUtranCellFDDId==3, cellId==1)

ENM CLI Page 60

Additional
 Alternative 1
Identify MOI directly by MOid
Alternative 1
› <MO Class>=<MO_Id> <attr name>

› <MO Class>=<MO_Id> <attr name1>, <attr name2>,….

ENM CLI Page 63

Example  find MOid
» cmedit get LTE05ERBS00010 eutrancellfdd
FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-1

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-2

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-3

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-4

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-5

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-6
6 instance(s)
ENM CLI Page 64
 Alternative 1 Example 1/3
› Print MO instance for MO=eutrancellfdd
cmedit get ERBS1 eutrancellfdd=cell-2
Instead of

› cmedit get ERBS1 eutrancellfdd.(EUtranCellFDDId== cell-2)

› Print attr values for MO=eutrancellfdd

cmedit get ERBS1 eutrancellfdd=cell-2 tac,cellbarred

Instead of
› cmedit get ERBS1 eutrancellfdd.(EUtranCellFDDId== cell-2,
tac,cellbarred)
ENM CLI Page 65
Wildcards for MOid

› <MO Class>=<Partial MO_Id>*

*<Partial MO_Id>

*<Partial MO_Id>*

ENM CLI Page 66

 Alternative 1 Example 2/3
› cmedit get ERBS1 eutrancellfdd=LTE05* tac,cellbarred

› cmedit get ERBS1 eutrancellfdd=*-2 tac,cellbarred

› cmedit get ERBS1 eutrancellfdd=*ERBS* tac,cellbarred

ENM CLI Page 67

 Alternative 1 Example 3/3

› Print MOI data based on specific attribute value

cmedit get * eutrancellfdd=LTE05*

administrativestate==UNLOCKED , operationalstate

ENM CLI Page 68

 Alternative 2
Identify MOI by FDN
Example  find FDN
» cmedit get LTE05ERBS00010 eutrancellfdd
FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-1

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedEleme
nt=1,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-2

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-3

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-4

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-5

FDN :
SubNetwork=ONRM_ROOT_MO,SubNetwork=Dublin,MeContext=LTE05ERBS00010,ManagedElement=1
,ENodeBFunction=1,EUtranCellFDD=LTE05ERBS00010-6
6 instance(s)
ENM CLI Page 70
 Alternative 2 Example 1/1
› cmedit get FDN -attr cellbarred
Instead of

› cmedit get ERBS1 eutrancellfdd.(eutrancellfdd=cell-2 ,cellbarred )

› cmedit get FDN -attr cellbarred,tac

Instead of

› cmedit get ERBS1 eutrancellfdd.(eutrancellfdd=cell-2 ,cellbarred,tac)

ENM CLI Page 71

 Hint 2
Criteria for get subcommand
Criteria 1
› Print all CM attributes of the specified MO Class
<MO Class>.<cm>
› Print all PM attributes of the specified MO Class
› Note: Only supported on CPP platform types where node types support reading
of PM counters as MO attributes.
<MO Class>.<pm>
› Print all Persistent attributes of the specified MO Class
<MO Class>.<p>
› Print all Writable Persistent attributes of the specified MO Class
› <MO Class>.<w>
› Print all Mandatory Persistent attributes of the specified MOC
<MO Class>.<m>
ENM CLI Page 73
Criteria 2
› Use a semi-colon to separate multiple MO Classes when
searching for all instances of *either* MOC1 or MOC2
<MO Class1>;<MO Class2>

› Use a comma to separate multiple MO Classes when

searching for all instances of MOC1 which have a child MOC
instance of MOC2
<MO Class1>,<MO Class2>

ENM CLI Page 74

Hint 3
get cmd – Example 1
› Report netype and synch status of particular node
cmedit get <Node(s)> --detailnode

Example
cmedit get eNB4-304 --detailnode
FDN : MeContext=eNB4-304
neType : ERBS
syncStatus : SYNCHRONIZED

1 instance(s)

ENM CLI Page 76

get cmd – Example 2

› cmedit get eNB* --detailnode

› cmedit get *04 --detailnode

› cmedit get *B4* --detailnode

› cmedit get node1;node2;node3 --detailnode

ENM CLI Page 77

Hint 4
action subcommand
› Any action performed by activating a non-live configuration
cannot be undone
› Reason:
action subcommand affects the non-persistent attributes

› All other functions performed by set, create, delete

subcommands can be undone

ENM CLI Page 79

Hint 5
Print multiple MOCs
› Search for all instances of *either* MOC1 or MOC2 or
MOC3

cmedit get <node(s)> MOC1;MOC2;MOC3

Note : Use a semi-colon as separator

ENM CLI Page 81

Hint 6
Print multiple MOCs
› Search for all instances of MO Class1 which have a child
MO Class instance of MO Class2

cmedit get <node(s)> MOC1,MOC2

Note : Use a comma as separator

ENM CLI Page 83