ENM CLI documentation with syntax examples

ENM CLI h�ps://mhsenm02.celcom.com.my/#help/app/cliapp/concept/synta...
cmedit get
< Back To Cmedit
Syntax
Syntax to get an Object by Specifying the FDN
cmedit get <FDN> [get by fdn options]
cmedit get <FDN> criteria [filter] [options]
Syntax to get an object by query
cmedit get [scope type] scope [scope filter] criteria [filter] [options]
Syntax to get by node name or view contents of a collection
cmedit get [scope type] scope [scope filter] [node details options]
Syntax to get an object by name
cmedit get [scope type] scope [scope filter] criteria_for_MO_by_Id [options]
Scope type
Use Scope Type option to restrict the scope to:
• collection [ -co | --collection ]
• nodenames [ -n | --node ] (*)
• saved search [ -sa | --savedSearch ] (**).
(*) in this case node names are case insensitive.
(**) not supported for get by node name.
Scope
Use the scope to specify node names or collections to search on.
<Node Name>
One or many node names can be defined as scope. Multiple node names should be separated with a semi-colon,
i.e. - ERBS01;ERBS02;ERBS03.
<Partial Node Name>*

Starts with the specified partial node name, i.e. - ERBS0*.
*<Partial Node Name>

Ends with the specified partial node name, i.e. - *001.
1 of 24 3/11/2022, 4:25 PM
*<Partial Node Name>*

Contains the specified partial node name, i.e. *RBS0*.
*
References all nodes in the network.
<Collection Name>
One or many Collections can be defined as scope. Multiple Collection names should be separated with a semi-
colon, i.e. - Collection01;Collection02
Partial collection names are not supported and the name should be entered in a case sensitive manner.
ENM CLI supports querying of MOs in a Collection that are stored in a flat structure only, i.e. MOs all of the same
type.
Collections maybe queried that have MOs stored in a parent / child (Topology) type structure. However, duplicate
MOs will be returned if the parent MO in the Collection is not the MO being queried.
<SavedSearch Name>
One or many SavedSearch can be defined as scope. Multiple SavedSearch names should be separated with a
semi-colon, i.e. - savedsearch01;savedsearch02
Partial SavedSearch names are not supported and the name should be entered in a case sensitive manner.
Saved Search as scope can be issued only with the criteria to specify Managed Object (MO) Classes names and
attribute values to search on.
Note:
<NodeName> and wildcard search with <Partial Node Name> is not supported for MO having the same level as
NetworkElement and for PO (i.e. LicenseData, OpenAlarm,...).
Scope Filter
Use the scope filter to add conditions to reduce the initial set of nodes specified in the scope.
--scopefilter (<MO Class>.<attribute name><operator><value> [AND <MO Class>.<attribute

name><operator><value>])
The usage of MO Class with cardinality of 1:1 towards the node is recommended.
In case of MO Class with a cardinality of 1:x, the node will be included in the command scope if at least one instance
of MO Class matches the specified restriction.
See the examples for more details about cardinality behavior.
Criteria
Use the criteria to specify Managed Object (MO) Classes names and attribute values to search on. Multiple MO
Classes can be used to specify parent child relationships.
<MO Class>
Search for all instances of the specified MO Class and display the Full Distinguished Name (FDN) of those
instances.
<MO Class>.*
Search for all instances of the specified MO Class and display the FDN of those instances including all of their
persistent attributes.
<MO Class>.<cm>
Use the special identifier <cm> to select all Configuration Management (CM) attributes of the specified MO Class.
2 of 24 3/11/2022, 4:25 PM
<MO Class>.<pm>
Use the special identifier <pm> to select all Performance Management (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>.
Use the special identifier to select all persistent attributes of the specified MO Class.
<MO Class>.<w>
Use the special identifier <w> to select all writable persistent attributes of the specified MO Class.
<MO Class>.<m>
Use the special identifier <m> to select all mandatory persistent attributes of the specified MO Class.
<MO Class1>;<MO Class2>

Use a semi-colon to separate multiple MO Classes when searching for all instances of *either* MO Class1 or MO
Class2.
<MO Class1>,<MO Class2>

Use a comma to separate multiple MO Classes when searching for all instances of MO Class1 which have a child
MO Class instance of MO Class2.
Note: Currently not supported for YANG locally scoped MOs.
<MO Class>.<attr name>

Search for all instances of the specified MO Class which contains the specified attribute and display the attribute
value for each MO instance found.
<MO Class>.<struct attr name>.{<struct member name>}

Search for all instances of the specified MO Class which contains the specified struct attribute and member and
display the member value for each MO instance found.
Note:
Only use this syntax with attributes of type struct whose members are not complex types (list or struct).
Use round or curly brackets, comma to separate multiple members of the specified struct attribute.
<MO Class>.<list of structs attr name>.[{<struct member name>, ..}]

Search for all instances of the specified MO Class which contains the specified list of structs attribute containing the
specified struct members.
Use to identify MO class(es) and output only the structs of the list of structs attribute containing the specified
members.
Besides no other members except those specified will be shown in the output.
Note:
Only use this syntax with attributes of type list of structs whose members in the structs are not complex types (list or
struct).
Use square brackets, comma to separate multiple members of the struct in the specified list of structs.
<MO Class>.<list attr name>~~[<simple data type elements>]

Search for all instances of the specified MO Class which contains the specified attribute whose current value
satisfies the 'contains' operator and specified value.
The ~~ (List Contains) operator searches on a list type attribute of simple data types (for example: integer, string,
enumerated) and displays the complete list if the members in the <simple data type elements> are contained in the
list attribute.
When used on a list of simple data types (for example: integer, string, enumerated) the <list member names> must
be in one of the following formats:
• [ "any" ]
3 of 24 3/11/2022, 4:25 PM
• [ "any" && "any" && ... && "any" ]
• [ "any" || "any" || ... || "any" ]
Note: The <value> must not contain a combination of && and ||.
<MO Class>.<attr name><operator><value>

satisfies the specified operator and specified value.
Note:
Search on operator == is supported for simple (integer, string, enumerated), struct and list attribute types.
Search on operator != is supported on integer, enumerated and full string text only (for example: partial string, struct
and list matching using the != operator is not supported).
Search on operators <, >, !<, !>, <=, >= is supported for integer data attribute types only.
<MO Class>.<struct attr name>.{<struct member name><operator><value>}

Search for all instances of the specified MO Class which contains the specified struct attribute and member whose
current value satisfies the specified operator and specified value.
Note:
Search on operator == is supported for simple (integer, string, enumerated) data member attribute types only.
Search on operator != is supported on integer, enumerated and full string text only (for example: partial string
matching using the != operator is not supported).
Search on operators <, >, !<, !>, <=, >= is supported for integer data member attribute types only.
<MO Class>.<list of structs attr name>~~[ { <struct member name><operator><value>, .. } ]

The ~~ (List Contains) operator searches if at least one of the structs in the list has the member whose current value
satisfies the specified criteria.
If the criteria is satisfied the complete list is displayed.
Note:
struct).
Search on operator ==, != is supported on integer, enumerated and full string text only (for example: partial string
<MO Class>.<list of structs attr name>~&[{<struct member name><operator><value>}]

The ~& (List Contains and Filter) operator searches if at least one of the structs in the list has the member whose
current value satisfies the specified criteria.
Only the structs that satisfy the criteria are displayed.
Note:
struct).
Use square brackets, comma to separate multiple members of the struct in the specified list of structs .
<MO Class>.<list of structs attr name>.[{<struct member name><operator><value>}]

Searches if at least one of the structs in the list has the member whose current value satisfies the specified criteria.
Only the struct members in the list that satisfy the criteria are displayed.
Note:
4 of 24 3/11/2022, 4:25 PM
struct).
<MO Class>.(<attr name1>,<attr name2><operator><value>)

Use round brackets to group multiple attributes for the same MO Class.
Criteria for MO by Id
<MO Class>=<MO_Id>
Use to identify MO class(es).
<MO Class>=<MO_Id> <special identifier>

Use to identify MO class(es) and apply special identifier as an output filter. Examples of special identifiers are <cm>,
<pm>, etc.
<MO Class>=<Partial MO_Id>*

Starts with the specified partial MO_Id, i.e. - cell*.
<MO Class>=*<Partial MO_Id>

Ends with the specified partial MO_Id, i.e. - *001.
<MO Class>=*<Partial MO_Id>*

Contains the specified partial MO_Id, i.e. *cell00*.
<MO Class>=<MO_Id> <attr name>

Use to identify MO class(es) and output attribute name(s). Multiple attributes should be comma separated.
<MO Class>=<MO_Id> <struct attr name>.{<struct member name>}

Use to identify MO class(es) and output only the specified member(s) of the struct attribute.
Note:
<MO Class>=<MO_Id> <list of structs attr name>.[{<struct member name>, ..}]

Search for all instances of the specified MO Class which contains the specified list of structs attribute containing the
specified struct members.
Use to identify MO class(es) and output only the structs of the list of structs attribute containing the specified
members.
Besides no other members except those specified will be shown in the output.
Note:
struct).
<MO Class>=<MO_Id> <list attr name> ~~[<simple data type elements>]

satisfies the 'contains' operator and specified value.
The ~~ (List Contains) operator searches on a list type attribute of simple data types (for example: integer, string,
enumerated) and displays the complete list if the members in the <simple data type elements> are contained in the
5 of 24 3/11/2022, 4:25 PM
list attribute.
When used on a list of simple data types (for example: integer, string, enumerated) the <list member names> must
be in one of the following formats:
• [ "any" ]
• [ "any" && "any" && ... && "any" ]
• [ "any" || "any" || ... || "any" ]
Note: The <value> must not contain a combination of && and ||.
<MO Class>=<MO_Id> <attr name><operator><value>

Note:
Search on operator == is supported for simple (integer, string, enumerated), struct and list attribute types.
Search on operator != is supported on integer, enumerated and full string text only (for example: partial string, struct
and list matching using the != operator is not supported).
<MO Class>=<MO_Id> <struct attr name>.{<struct member name><operator><value>}

Use to identify MO class(es) and output only the specified member(s) of the struct attribute whose current value
Note:
<MO Class>=<MO_Id> <list of structs attr name>~~[ { <struct member name><operator><value>, .. } ]

The ~~ (List Contains) operator searches if at least one of the structs in the list has the member whose current value
satisfies the specified criteria.
If the criteria is satisfied the complete list is displayed.
Note:
struct).
Search on operator ==, != is supported on integer, enumerated and full string text only (for example: partial string
<MO Class>=<MO_Id> <list of structs attr name>~&[{<struct member name><operator><value>}]

The ~& (List Contains and Filter) operator searches if at least one of the structs in the list has the member whose
current value satisfies the specified criteria.
Only the structs that satisfy the criteria are displayed.
Note:
struct).
6 of 24 3/11/2022, 4:25 PM
<MO Class>=<MO_Id> <list of structs attr name>.[{<struct member name><operator><value>}]

Search for all instances of the specified MO Class which contains the specified list of structs attribute and struct
member whose current value satisfies the specified operator and specified value.
Use to identify MO class(es) and output only the specified structs of the list of structs attribute whose current value
Note:
struct).
Note:
The <MO_Id> supports alphanumeric characters (A-Z, a-z and 0-9) and certain supported "special" characters.
The supported "special" characters are:
. - _
If the <MO_Id> includes any other special character, then it must be contained in quotes.
Filters
Use the filter to limit the output of the get command by specifying the MO Classes names and attribute names to
show. If not specified, all instances and values for the MO Classes and attributes given in the criteria are shown.
<MO Class>
Only show instances of the specified MO Class.
<MO Class>.<attr name>

Only show instances of the specified MO Class and values for the specified attribute.
<MO Class>.<struct attr name>.(<struct member name>)

Only show instances of the specified MO Class and values for the specified struct attribute and member.
<MO Class>.*
Only show instances of the specified MO Class including persistent attributes
<MO Class>.<cm>
Use the special identifier <cm> to select all Configuration Management (CM) attributes of the specified MO Class.
<MO Class>.<pm>
Use the special identifier <pm> to select all Performance Management (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>.
Use the special identifier to select all persistent attributes of the specified MO Class.
<MO Class>.<w>
Use the special identifier <w> to select all writable persistent attributes of the specified MO Class.
<MO Class>.<m>
7 of 24 3/11/2022, 4:25 PM
Use the special identifier <m> to select all mandatory persistent attributes of the specified MO Class.
<MO Class>.(<attr name1>,<attr name2>)

Use round brackets to group multiple attributes for the same MO Class.
<MO Class1>;<MO Class2>

Use a semi-colon to separate multiple MO Classes to display all instances of *either* MO Class1 or MO Class2
(regardless of whether MO Class1 is a parent or child of MO Class2).
Options
Use the options to further restrict the output specification.
-ns or --namespace
Specify a particular namespace.
-v or --version
Specify a particular version.
-ne or --netype
Specify a particular netype.
-cn or --count
Report the number of instances.
-t or --table
Response displayed in table format.
Note: When copy and pasting a table of data from the CLI to another application the data in the clipboard needs to
be copied as text only to prevent formatting issue.
-l or --list
Response displayed in list format.
-d or --dynamic
Output displayed in Ericsson Dynamic File Format.
-s or --syncstatus
Report the sync status of the node which the returned MOs belong to.
--output <Output Type> <Output Name>

Create <Output Type> with specified <Output Name> using the MO(s) returned from get command output.
<Output Type>
priColl: Create a private collection.
pubColl: Create a public collection.
<Output Name>
Name of the Output created.
Options for Get by FDN

Use the options to further restrict the output specification.
-t or --table
Response displayed in table format.
be copied as text only to prevent formatting issue.
8 of 24 3/11/2022, 4:25 PM
-l or --list
Response displayed in list format.
-attr or --attribute
Response displays only the attributes specified. One or many attributes can be defined. Use a comma to separate
multiple attributes.
-s or --syncstatus

<Output Type>
<Output Name>
Node Details Option

Use the option to add more information the output specification.
-dn or --detailnode
Report a netype and synchronization status of particular node.
-ne or --netype
Specify a particular netype.
-cn or --count
Report the number of instances.
-t or --table
Present the response in table format.
be copied as text only to prevent issues with formatting.
-l or --list
Present the response in list format.
-s or --syncstatus

<Output Type>
<Output Name>
Description
cmedit get is used to query Node data from the Network.
If a node is un-synced, the data returned to the ENM CLI will differ from actual data on the node, if node data has
changed since the node was last synced with ENM
9 of 24 3/11/2022, 4:25 PM
The command output provides the additional "syncStatus" attribute for list and table layout. The output is controlled
by PIB (Platform Integration Bridge) boolean parameter syncStatusInfoEnabled, default setting is false. If
syncStatusInfoEnabled is set to false, one may also get the "syncStatus" attribute using the --syncstatus option.
Details of Case Sensitivity for cmedit commands.
Details of Special Characters for cmedit commands.
Collection and SavedSearch names as scope support alphanumeric characters (A-Z, a-z and 0-9) and certain
supported "special" characters.
The supported "special" characters are:
. - _ <space>
If Collection/SavedSearch name includes <space>, then it must be contained in quotes.
CM Edit commands have an overload protection mechanism to limit GET command searches on certain MO types
which have a large number of instances in the network. For more information see the CM Edit Command Set for
Overload Protection page.
Command Consequences
• Without --output option there is no consequences in the Get command.
• With --output option, the Get command result is the creation of the <Output Type> specified.
Examples
Get a ManagedElement by FDN
cmedit get MeContext=ERBS001,ManagedElement=1
Response
This command returns all the attributes values of the specified MO instance for the provided FDN. The attribute
names are shown in alphabetic order, while struct attributes (i.e. mimInfo : {mimVersion=1, mimRelease=320,
mimName=ERBS_NODE_MODEL_H}) does not have an assured order for its members. The following are the
attributes that are shown for MO instance:
FDN : MeContext=ERBS001,ManagedElement=1
ManagedElementId : 1
applicationConfiguration : []
healthCheckResult : {startTime=, message=, healthCheckResultCode=INITIAL_VALUE}
healthCheckSchedule : []
logicalName :
mimInfo : {mimVersion=1, mimRelease=320, mimName=ERBS_NODE_MODEL_H}
neType : ERBS
platformType : null
productName :
productNumber :
productRevision :
productType : Node
site :
userLabel : Region5
1 instance(s)
Get one attribute of ManagedElement by FDN
10 of 24 3/11/2022, 4:25 PM
cmedit get MeContext=ERBS001,ManagedElement=1 --attribute userLabel
Response
This command returns the "userLabel" attribute value of the specified MO instance for the provided FDN. The
following is the attribute that is shown for MO instance:
userLabel : Region5
1 instance(s)
Get a list of attributes of ManagedElement by a list of FDNs
cmedit get MeContext=ERBS001,ManagedElement=1;MeContext=ERBS002,ManagedElement=1 -

attr neType,userLabel
Response
This command returns the "neType" and "userLabel" attributes values of the specified MO instance for the provided
list of FDNs. The following are the attributes that are shown for MO instances:
neType : ERBS
userLabel : Region5
neType : ERBS
userLabel : Region5
2 instance(s)
Get a list of struct attributes of ManagedElement by a list of FDNs
cmedit get MeContext=ERBS001,ManagedElement=1;MeContext=ERBS002,ManagedElement=1 -

attr mimInfo.(mimRelease,mimVersion)
Response
This command returns the values of "mimRelease" and "mimVersion" members of "mimInfo" struct attribute of the
specified MO instance for the provided list of FDNs. The following are the attributes that are shown for MO
instances:
mimInfo : {mimRelease=160,mimVersion=1}
mimInfo : {mimRelease=160,mimVersion=1}
2 instance(s)
Get a list of attributes of ManagedElement by a list of FDNs with additional syncStatus attribute
cmedit get MeContext=LTE03ERBS00001,ManagedElement=1;MeContext=LTE08ERBS00002,Mana

gedElement=1 -attr neType,userLabel --syncstatus
Response (Setting PIB parameter syncStatusInfoEnabled to true one may always get the "syncStatus"
attribute, without specifying --syncstatus option)
This command returns all the attributes values of the specified MO instance for the provided FDN and the syncStaus
attribute too. The following are the attributes that are shown for MO instance:
11 of 24 3/11/2022, 4:25 PM
FDN : MeContext=LTE03ERBS00001,ManagedElement=1
syncStatus : SYNCHRONIZED
neType : ERBS
userLabel : Region5
FDN : MeContext=LTE08ERBS00002,ManagedElement=1
neType : ERBS
userLabel : Region5
2 instance(s)
Get One Attribute of a Single MO Class
cmedit get LTE32ERBS00001 networkelement.netype
Response
FDN : NetworkElement=LTE32ERBS00001
neType : ERBS
1 instance(s)
Get One Struct Attribute of a Single MO Class
cmedit get LTE32ERBS00001 ENodeBFunction.eNodeBPlmnId
Response
FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1
eNodeBPlmnId : {mncLength=2, mcc=271, mnc=7}
1 instance(s)
Get One Struct Member inside Struct Attribute of a Single MO Class
cmedit get LTE32ERBS00001 ENodeBFunction.eNodeBPlmnId.(mcc)
Response
eNodeBPlmnId : {mcc=271}
1 instance(s)
Get One Struct Member inside Struct Attribute of a Single MO Class whose current value satisfies the
specified operators and specified values
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc>=271)
Response
3 instance(s)
12 of 24 3/11/2022, 4:25 PM
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc==271) ENodeBFunction.eN

odeBPlmnId.(mnc)
Response
eNodeBPlmnId : {mnc=27}
3 instance(s)
Get all Structs inside List of Structs Attribute of a Single MO Class whose current value satisfies the
cmedit get * EUtranCellFDD.activePlmnList.[{mcc==353}]
Response
FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1,EUtranCellFDD=LTE32
ERBS00001-1
activePlmnList : [{mcc=353, mnc=57, mncLength=2}, {mcc=353, mnc=58, mncLength=2}]
ERBS00002-1
activePlmnList : [{mcc=353, mnc=58, mncLength=2}]
ERBS00004-4
3 instance(s)
Get One Struct Attribute of a Single MO Class whose current value satisfies the specified operator and
specified value
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId=={mcc=271,mnc=27,mncLength=

2}
Response
eNodeBPlmnId : {mcc=271, mnc=27, mncLength=2}
1 instance(s)
Get Two Struct Attributes of a Single MO Class
cmedit get netsim_LTE08ERBS00010 AuxPlugInUnit.(productData,positionCoordinates)
Response
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE08ERBS00010,ManagedElement=1,Equip
ment=1,AuxPlugInUnit=1
positionCoordinates : {altitude=0, geoDatum=WGS84, latitude=0, longitude=0}
productData : {productionDate=, serialNumber=, productNumber=, productRevision=2B, pr
oductName=IRU}
1 instance(s)
Get Struct Members inside Struct Attributes of a Single MO Class
13 of 24 3/11/2022, 4:25 PM
cmedit get netsim_LTE08ERBS00010 AuxPlugInUnit.(productData.(productName, productR

evision),positionCoordinates.(geoDatum))
Response
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE08ERBS00010,ManagedElement=1,Equip
ment=1,AuxPlugInUnit=1
positionCoordinates : {geoDatum=WGS84}
productData : {productRevision=2B, productName=IRU}
1 instance(s)
Get All Persistent Attributes of a Single MO Class, displaying the output in Ericsson Dynamic File
Format
cmedit get LTE32ERBS00001 networkelement.* -d
Response
This command returns all persistent attribute values for the specified MO instance. The following is the list of the
persistent attribute values for the instance:
FDN : "NetworkElement=LTE32ERBS00001"
neProductVersion : [{revision="F1107", identity="CXPL15BCP1"}]
networkElementId : "LTE32ERBS00001"
neType : ERBS
nodeModelIdentity : "17A-H.1.160"
ossModelIdentity : "17A-H.1.160"
ossPrefix : "MeContext=LTE32ERBS00001"
platformType : CPP
release : "H.1.160"
technologyDomain : [EPS]
utcOffset : <empty>
1 instance(s)
Get Managed Object Instances Filtered by One Attribute Value
cmedit get * networkelement.netype=="ERBS"
Response
This command returns all the MO instances with the specified attribute value. Each instance is repeated on as a
new row in the table or a new element in the list. The following is one instance with the specified attribute:
neType: ERBS
1 instance(s)
Get Managed Object Instances Filtered by More Than One Attribute Value
cmedit get * networkelement.(netype=="ERBS",platformtype=="CPP")
Response
This command returns all the MO instances with the specified attribute values. Each instance is repeated on as a
new row in the table or a new element in the list. The following is one instance with the specified attributes:
neType : ERBS
platformType : CPP
14 of 24 3/11/2022, 4:25 PM
1 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has One
Value
cmedit get * networkelement.radioAccessTechnology~~["3G"]
Response
This command returns all NetworkElement MOs where the radioAccessTechnology list contains entry "3G"
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has Two
Values
cmedit get * networkelement.radioAccessTechnology~~["4G" && "5G"]
Response
This command returns all NetworkElement MOs where the radioAccessTechnology list contains both entries "4G"
and "5G"
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has a
struct with the specified member values
cmedit get * NetworkElement.neProductVersion~~[{identity==CXPL17ACP1,revision==H11

60}]
Response
This command returns all NetworkElement MOs where the neProductVersion list contains a struct with identity
member CXPL17ACP1 and revision member H1160
neProductVersion : [{identity=CXPL17ACP1, revision=H1160}]
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the value of the list is exactly
matching
cmedit get * networkelement.technologyDomain==[EPS]
Response
15 of 24 3/11/2022, 4:25 PM
This command returns all NetworkElement MOs where the technologyDomain list is equal to [EPS]
2 instance(s)
Get Managed Object Instances of Specific Parent and Child Types
cmedit get LTE32ERBS00001 enodebfunction,eutrancellfdd
Response
FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1,EUtranCellFDD=LTE32E
RBS00001-1
2 instance(s)
Parent-Child query specifying in the filter an MO type with attributes
cmedit get LTE32ERBS00001 ManagedElement,ENodeBFunction EnodeBFunction.dnsLookupTi

mer
Response
dnsLookupTimer : 0
1 instance(s)
Get Managed Object Instances of Type GeraNetwork Towards the Specified Namespace and Version,
under a Given FDN
cmedit get MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1; ERBS001 geranetwor

k -ns=ERBS_NODE_MODEL -v=6.1.100
Response
FDN : MeContext=1,ManagedElement=1,ENodeBFunction=1,GeraNetwork=1
1 instance(s)
Get Managed Object instances under a mixed scope type of FDN and node name
cmedit get MeContext=ERBS001,ManagedElement=1;LTE* enodebfunction -t
Response
MeContext,ManagedElement,ENodeBFunction
NodeId ENodeBFunctionId
ERBS001 1
1 instance(s)
Note: -t option needs to aggregate the response in order to structure the table appropriately and therefore does not
stream the partial responses back to the user.
16 of 24 3/11/2022, 4:25 PM
Get Managed Object instances under a mixed scope of valid and invalid node name
cmedit get LTE02ERBS00031;NotExistingNode enodebfunction
Response
Scope: NotExistingNode
Error 1049 : The scope is incorrect or not associated with the correct Node Type
1 instance(s)
Get Managed Object instances under a mixed scope of invalid node names
cmedit get NotExistingNode1;NotExistingNode2 enodebfunction
Response
Error 1050 : All scope is incorrect or not associated with the correct Node Type
Error 5010 : The read command has errors.
Get two Attributes of a Single node name in table format
cmedit get 85BJ5 ReportConfigB2Utra.(b2Threshold1Rsrq,timeToTriggerB2) -t
Response
ManagedElement,ENodeBFunction,EUtranCellFDD,UeMeasControl,ReportConfigB2Utra
Node ID ENodeBFunctionId EUtranCellFDDId UeMeasControlId
ReportConfigB2UtraId b2Threshold1Rsrq timeToTriggerB2
85BJ5 1 85BJ1M 1
1 -195 320
85BJ5 1 85BJ1O 1
1 -195 320
2 instance(s)
Note: -t option needs to aggregate the response in order to structure the table appropriately and therefore does not
stream the partial responses back to the user.
Get Attribute of a Single node name
cmedit get LTE32ERBS00001
Response
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE32ERBS00001
1 instance(s)
Get all Managed Object Instances with public collection creation
cmedit get * networkelement --output pubColl collName
Response
17 of 24 3/11/2022, 4:25 PM
4 instance(s)
Collection: collName has been created.
Get Attributes with additional details of a Partial node name
cmedit get LTE07dg2ERBS000* --detailnode
Response
FDN : SubNetwork=NETSimW,ManagedElement=LTE07dg2ERBS00005
neType : RadioNode
FDN : NetworkElement=LTE07dg2ERBS00003
neType : RadioNode
syncStatus : UNSYNCHRONIZED
2 instance(s)
Get Attributes with additional details of a Partial node name and with scope option
cmedit get -n LTE03ERBS0000* --detailnode
Response
neType : ERBS
neType : ERBS
2 instance(s)
Get Attribute of a Single collection
cmedit get Collection2
Response
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00006
2 instance(s)
Get Attribute with additional details of a Single collection
cmedit get Collection2 --detailnode
Response
neType : RadioNode
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00006
neType: ERBS
18 of 24 3/11/2022, 4:25 PM
syncStatus : UNSYNCHRONIZED
2 instance(s)
Get Attribute with additional details and filtered by netype of a Single collection
cmedit get Collection2 --detailnode --netype=RadioNode
Response
neType : RadioNode
1 instance(s)
Get Attribute with additional details and filtered by netype of a collection and node name
cmedit get -n netsim_LTE03ERBS00008 -co collectionName1 --detailnode --netype=ERBS
Response
FDN : SubNetwork=NETSimW,ManagedElement=netsim_LTE03ERBS00008
neType : ERBS
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00004,ManagedElement=1,ENodeB
Function=1,EUtranCellFDD=LTE03ERBS00004-4
neType : ERBS
2 instance(s)
Get ManagedElement of a Single SavedSearch
cmedit get -sa savedsearch01 ManagedElement
Response
FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00007,ManagedElement=1
2 instance(s)
Get ManagedElement of a multiple SavedSearch
cmedit get -sa savedsearch01; savedsearch02 ManagedElement
Response
4 instance(s)
Get a list of attributes of ManagedElement of a partial node name as scope in table format with
19 of 24 3/11/2022, 4:25 PM
additional syncStatus attribute
cmedit get LTE03ERBS0000* ManagedElement.(neType,userLabel) -s -t
Response (Setting PIB parameter syncStatusInfoEnabled to true one may always get the "syncStatus"
attribute, without specifying --syncstatus option)
SubNetwork,MeContext,ManagedElement
Node ID syncStatus ParentId ManagedElementId neType
userLabel
LTE03ERBS00002 SYNCHRONIZED LTE03ERBS00002 1 ERBS
LTE_ERBS
LTE03ERBS00001 UNSYNCHRONIZED LTE03ERBS00001 1 ERBS
LTE_ERBS
2 instance(s)
Get a list of attributes of ManagedElement of a partial node name as scope in table format with private
collection creation
cmedit get LTE03ERBS0000* ManagedElement.userLabel --output priColl collName -t
Response
SubNetwork,MeContext,ManagedElement
Node ID ParentId ManagedElementId userLabel
LTE03ERBS00002 LTE03ERBS00002 1 LTE_ERBS
LTE03ERBS00001 LTE03ERBS00001 1 LTE_ERBS
2 instance(s)
Collection: collName has been created.
Get a non persistent Attribute when one node is unreachable
cmedit get * managedElement.userLabel
Response
FDN : SubNetwork=NETSimW,ManagedElement=CORE53SGSN001
userLabel : TEST
FDN : SubNetwork=NETSimW,ManagedElement=SGSN99SGSN00001
Error 9999 : Execution Error (Node ID: svc-3-mscmce. Exception occurred: The node SGS
N99SGSN00001 ()192.168.103.132) is currently unavailable
Error 5010 : The read command has errors.
Get One Struct Member inside Struct Attribute of a Single MO Class
cmedit get LTE32ERBS00001 ENodeBFunction.eNodeBPlmnId.(mcc)
Response
1 instance(s)
Get One Struct Member inside Struct Attribute of a Single MO Class whose current value satisfies the
20 of 24 3/11/2022, 4:25 PM
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc>=271)
Response
3 instance(s)
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc==271) ENodeBFunction.eN

odeBPlmnId.(mnc)
Response
3 instance(s)
Get One Struct Attribute of a Single MO Class whose current value satisfies the specified operator and
specified value
cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId=={mcc=271,mnc=27,mncLength=

2}
Response
eNodeBPlmnId : {mcc=271, mnc=27, mncLength=2}
1 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has One
Value
cmedit get * networkelement.radioAccessTechnology~~["3G"]
Response
This command returns all NetworkElement MOs where the radioAccessTechnology list contains entry "3G"
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has Two
Values
cmedit get * networkelement.radioAccessTechnology~~["4G" && "5G"]
Response
21 of 24 3/11/2022, 4:25 PM
This command returns all NetworkElement MOs where the radioAccessTechnology list contains both entries "4G"
and "5G"
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the value of the list is exactly
matching
cmedit get * networkelement.technologyDomain==[EPS]
Response
This command returns all NetworkElement MOs where the technologyDomain list is equal to [EPS]
2 instance(s)
Get Managed Object Instances Filtered by Attribute of List Type where the 'List Contains' Query has a
struct with the specified member values
cmedit get * NetworkElement.neProductVersion~~[{identity==CXPL17ACP1,revision==H11

60}]
Response
This command returns all NetworkElement MOs where the neProductVersion list contains a struct with identity
member CXPL17ACP1 and revision member H1160
2 instance(s)
Get all Structs inside List of Structs Attribute of a Single MO Class whose current value satisfies the
cmedit get * EUtranCellFDD.activePlmnList~&[{mcc==353}]
Response
RBS00001-1
activePlmnList : [{mcc=353, mnc=57, mncLength=2}, {mcc=353, mnc=58, mncLength=2}]
RBS00002-1
RBS00004-4
22 of 24 3/11/2022, 4:25 PM
3 instance(s)
Get all members of the Structs inside List of Structs Attribute of a Single MO Class whose current value
satisfies the specified operators and specified values
cmedit get * EUtranCellFDD.activePlmnList.[{mcc==353}]
Response
RBS00001-1
activePlmnList : [{mcc=353}, {mcc=353}]
RBS00002-1
activePlmnList : [{mcc=353}]
RBS00004-4
activePlmnList : [{mcc=353}]
3 instance(s)
Get all members of the Structs inside List of Structs Attribute of a Single MO Class whose current value
either satisfies the specified operators and specified values or has no match condition
cmedit get * EUtranCellFDD.activePlmnList.[{mcc==353, mnc}]
Response
RBS00001-1
activePlmnList : [{mcc=353, mnc=57}, {mcc=353, mnc=57}]
RBS00002-1
activePlmnList : [{mcc=353, mnc=58}]
RBS00004-4
activePlmnList : [{mcc=353, mnc=59}]
3 instance(s)
Get Managed Object instances using the "scopefilter" option to add further restrictions using MO with
cardinality 1:1 towards the node.
cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED AND ManagedElemen

t.siteLocation==Dublin) ENodeBFunction
Response
FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW-1,MeContext=netsi m_
LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1
1 instance(s)
Note: This command returns the ENodeBFunction MO for all nodes with the CM syncStatus SYNCHRONIZED and
located in “Dublin”.
Get Managed Object instances using the "scopefilter" option to add further restrictions using MO with
cardinality 1:x towards the node.
cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED AND EUtranCellFdd.
23 of 24 3/11/2022, 4:25 PM
cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED AND EUtranCellFdd.

administrativeState==UNLOCKED) ENodeBFunction
Response
FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW-1,MeContext=netsi m_
LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1
1 instance(s)
Note: This command returns the ENodeBFunction MO for all nodes synchronized and with at least one
EutrancellFdd MO in UNLOCK state.
24 of 24 3/11/2022, 4:25 PM

ENM CLI documentation with syntax examples

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ENM CLI documentation with syntax examples

Uploaded by

Copyright:

Available Formats

ENM CLI h�ps://mhsenm02.celcom.com.my/#help/app/cliapp/concept/synta...

cmedit get <FDN> [get by fdn options]

cmedit get <FDN> criteria [filter] [options]

Syntax to get an object by query

Syntax to get by node name or view contents of a collection

Syntax to get an object by name

cmedit get [scope type] scope [scope filter] criteria_for_MO_by_Id [options]

• collection [ -co | --collection ]

• nodenames [ -n | --node ] (*)

• saved search [ -sa | --savedSearch ] (**).

(*) in this case node names are case insensitive.

(**) not supported for get by node name.

<Partial Node Name>*

*<Partial Node Name>

*<Partial Node Name>*

--scopefilter (<MO Class>.<attribute name><operator><value> [AND <MO Class>.<attribute

See the examples for more details about cardinality behavior.

<MO Class1>;<MO Class2>

<MO Class1>,<MO Class2>

<MO Class>.<attr name>

<MO Class>.<struct attr name>.{<struct member name>}

<MO Class>.<list of structs attr name>.[{<struct member name>, ..}]

<MO Class>.<list attr name>~~[<simple data type elements>]

• [ "any" && "any" && ... && "any" ]

• [ "any" || "any" || ... || "any" ]

<MO Class>.<attr name><operator><value>

<MO Class>.<struct attr name>.{<struct member name><operator><value>}

<MO Class>.<list of structs attr name>~~[ { <struct member name><operator><value>, .. } ]

<MO Class>.<list of structs attr name>~&[{<struct member name><operator><value>}]

<MO Class>.<list of structs attr name>.[{<struct member name><operator><value>}]

<MO Class>.(<attr name1>,<attr name2><operator><value>)

<MO Class>=<MO_Id> <special identifier>

<MO Class>=<Partial MO_Id>*

<MO Class>=*<Partial MO_Id>

<MO Class>=*<Partial MO_Id>*

<MO Class>=<MO_Id> <attr name>

<MO Class>=<MO_Id> <struct attr name>.{<struct member name>}

<MO Class>=<MO_Id> <list of structs attr name>.[{<struct member name>, ..}]

<MO Class>=<MO_Id> <list attr name> ~~[<simple data type elements>]

• [ "any" && "any" && ... && "any" ]

• [ "any" || "any" || ... || "any" ]

<MO Class>=<MO_Id> <attr name><operator><value>

<MO Class>=<MO_Id> <struct attr name>.{<struct member name><operator><value>}

<MO Class>=<MO_Id> <list of structs attr name>~~[ { <struct member name><operator><value>, .. } ]

<MO Class>=<MO_Id> <list of structs attr name>~&[{<struct member name><operator><value>}]

<MO Class>=<MO_Id> <list of structs attr name>.[{<struct member name><operator><value>}]

<MO Class>.<attr name>

<MO Class>.<struct attr name>.(<struct member name>)

<MO Class>.(<attr name1>,<attr name2>)

<MO Class1>;<MO Class2>

--output <Output Type> <Output Name>

Options for Get by FDN

--output <Output Type> <Output Name>

Node Details Option

--output <Output Type> <Output Name>

Details of Case Sensitivity for cmedit commands.

Details of Special Characters for cmedit commands.

The supported "special" characters are:

If Collection/SavedSearch name includes <space>, then it must be contained in quotes.

• Without --output option there is no consequences in the Get command.

cmedit get MeContext=ERBS001,ManagedElement=1

Get one attribute of ManagedElement by FDN

cmedit get MeContext=ERBS001,ManagedElement=1 --attribute userLabel

<Partial Node Name>

<MO Class>=<Partial MO_Id>