5/25/23, 12:09 PM ENM CLI

Additional Information
Node Configuration

Change Prompt of SGSN-MME

Choose User of Juniper-MX

Choose User of Juniper-SRX

Choose User of Juniper-PTX

Other information

Working with BSC nodes

ENM CLI on iOS

ENM CLI Performance Tips

CM Edit Command Set for Overload Protection

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 1/21
5/25/23, 12:09 PM ENM CLI

Change Prompt of SGSN-MME

1.Change Prompt of SGSN-MME using Root user
There is a limitation when managing the SGSN-MME. The normal user id does not return a $ prompt on the SGSN-
MME node. The prompt ends with a#, for example, === om_admin@eqm01s14p2 ANCB ~ #. This causes MIA and
CNCT scripts to fail because they expect a $ prompt. To change the prompt for the user added above, do the following:

Switch to root, do # su - root # passwd: ****** .

Run usermod -s /bin/sh <newuser>.

Switch to root, do # su - root # passwd: ******.

For Linux SGSN-MME (MkV, MkVI or later):

Edit (or create if non-existent) theprofile file (/tmp/DPE_CORE/home/<user>/.profile) for the newly added user by adding
the following lines:

PS1="$"

TERM=vt100

export PS1 TERM

stty -echo

stty -icanon

PATH=/tmp/DPE_SC/LoadUnits/ttx/bin:$PATH

export PATH

Now when login occurs to the SGSN-MME node, prompt will be a $

2.Change Prompt of SGSN-MME (Removal of Root User)

For node versions where root user is removed, om_admin user should be used to change the prompt.

In this scenario, om_admin user should be used to change the prompt.

ssh om_admin@node_ip

Edit(or create if non-existent) the profile file(/tmp/DPR_CORE/home/user/.profile) for the newly added user by adding
the following lines:

PS1="$"

TERM=vt100

export PS1 TERM

stty -echo

stty -icanon

PATH=/tmp/DPE_SC/LoadUnits/ttx/bin:$PATH

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 2/21
5/25/23, 12:09 PM ENM CLI

export PATH

3.Change Prompt of SGSN-MME using external Ldap

In case of external Ldap, tcsh shell should be used. Following is an example of user profile created in an external Ldap
server

root@debian:/home/debian/ldapfiles# cat add_ userone_user.ldif

dn: uid= userone,ou=sgsnUsers,dc=sgsnexternal,dc=local

objectClass: posixAccount

objectClass: shadowAccount

objectClass: person

objectClass: pwdPolicy

pwdAttribute: userPassword

pwdPolicySubentry:cn=testPwdPolicy,ou=sgsnInternalData,dc=sgsnexternal,dc=local

uid: userone

cn: userone

sn: userone

uidNumber: 10075

gidNumber: 802

homeDirectory: /home/userone

loginShell: /bin/sh

userPassword: {SSHA}msFUautEbtgk5xaRCfBtH5cUjvAQE6

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 3/21
5/25/23, 12:09 PM ENM CLI

Choose User of Juniper-MX

Choose User of Juniper-MX
When connecting to a Juniper MX node use a secureusername that directly reaches the CLI of the node and not the
Linux shell.

By default the root user connects to the linux shell.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 4/21
5/25/23, 12:09 PM ENM CLI

Choose User of Juniper-SRX

Choose User of Juniper-SRX
When connecting to a Juniper SRX node use a secureusername that directly reaches the CLI of the node and not the
Linux shell.

By default the root user connects to the linux shell.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 5/21
5/25/23, 12:09 PM ENM CLI

Choose User of Juniper-PTX

Choose User of Juniper-PTX
When connecting to a Juniper PTX node use a secureusername that directly reaches the CLI of the node and not the
Linux shell.

By default the root user connects to the linux shell.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 6/21
5/25/23, 12:09 PM ENM CLI

Limitations of ENM CLI on iOS Platforms

The following describes the limitations on using the ENM CLI on a touchscreen iOS platform such as iPads and
iPhones, using the most common browsers.

Features with Limited Availability on iOS

Limitation Reason Browsers Detailed Description

Batch files contain a list of commands that can

Not supported on
be loaded into the CLI. The batch file is
File drag and drop Safari for iOS.
Batch File executed by entering the command 'batch
not supported on
Execution execute file: filename'.
iOS Not supported on
Chrome for iOS.
This is not possible on iOS.

Not supported on
The up and down cursor keys are used to scroll
No cursor keys on Safari for iOS. through command history. Due to the lack of up
Command
iOS onscreen
History and down cursor keys on iOS, this feature is
keyboard Not supported on
unavailable.
Chrome for iOS.

Not supported on
The CTRL + ENTER keyboard combination is
Save No CTRL key on Safari for iOS. used to output the result of a command to a
response to iOS onscreen
file keyboard Not supported on file. Due to the lack of a CTRL key on iOS, this
feature is unavailable.
Chrome for iOS.

Safari Support -

iOS requires there is an App (either built-in or

downloaded) that can handle the downloaded
file.

For example, with CM Edit Export a zip file is

downloaded, therefore an App supporting ZIP
files should be installed. If so, Safari will send
Limited on Safari for the file to the ZIP App.
iOS does not have iOS.
File Certificates are handled by a pre-installed App.
a traditional file
Download When a certificate is downloaded in Safari the
system Not supported on
Chrome for iOS. App handles the certificate.

XML Files downloaded in PKIADM are opened

in the Safari browser as this is the default App
for viewing XML files.

Chrome Support -

By default, Chrome does not support the

download of any file types.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 7/21
5/25/23, 12:09 PM ENM CLI

ENM CLI Performance Tips

The Command Line Interface (CLI) is a powerful tool to search for and manipulate data in the network. This page
contains guidelines for ENM CLI query optimization.

Queries on this page are constructed with the GET command, but the same may apply to SET and DELETE commands.

The syntax of the command is as follows:

cmedit get <nodeName...> criteria [filter] [options]

Query optimization
Searches over large parts of the network can be costly. Improve the response time of queries by searching over a
subset of the network where possible.

This can be done in the following ways:

1. Node name scope reduction

2. Targeting data with criteria

3. Targeting data with filtering

4. Targeting data with options

Node name scope reduction

nodeName is used when multiple MOs need to be targeted. Node names or partial node names using wildcards (*) may
be used to increase the scope of the search. The full node name gives the most efficient search, with partial name
queries affecting more of the network.

Query on node name

This is the most efficient way to query over node name LTE32ERBS00001.

cmedit get LTE32ERBS00001 enodebfunction

Replace wildcard with partial wildcard to reduce query scope.

Original query

cmedit get * managedelement

Optimized query examples

cmedit get LTE32ERBS* enodebfunction

cmedit get *ERBS* enodebfunction

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 8/21
5/25/23, 12:09 PM ENM CLI

Targeting data with criteria

The query criteria can be used to reduce the search scope. It can be used to get a managed object (MO) with specific
attribute values or to specify which attributes of the MO to return. When used in conjunction with wildcard or special
identifier searches, criteria can increase the efficiency of the query greatly.

<MO Class>.*
Use wildcard to display all 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>.<p>
Use the special identifier <p> to select all persistent attributes of the specified MO Class.

<MO Class>.<w>
Use the special identifier <p> to select all writable persistent attributes of the specified MO Class.

<MO Class>.<m>
Use the special identifier <p> to select all mandatory persistent attributes of the specified MO Class.

Use criteria to reduce the number of attributes returned

Original query

This query will return all ManagedElement MOs in the network and all of their persistent attributes.

cmedit get * managedelement.*

Optimized query examples

Displays FDN and persisted attributes only.

cmedit get * managedelement.<p>

Displays FDN and site only for all ManagedElement MOs regardless of value.

cmedit get * managedelement.site

Return multiple attribute values. Displays FDN, site and productNumber for all ManagedElement MOs regardless of
value.

cmedit get * managedelement.(site,productnumber)

Use criteria to search by MO attribute value.

Original query

This query will return the FDN for all ManagedElement MOs in the network. Filter results further by querying specific
attribute values.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 9/21
5/25/23, 12:09 PM ENM CLI

cmedit get * managedelement

Optimized query examples

Query a single attribute value to return the FDN and site of all ManagedElement MOs at "SampleSite" site.

cmedit get * managedelement.site=="SampleSite"

Query multiple attribute values to return the FDN, site and productNumber of all ManagedElement MOs at "SampleSite"
site with product number "ROF123".

cmedit get * managedelement.(site=="SampleSite",productnumber=="ROF123")

Targeting data with filtering

A query can target a large number of attributes, some of which we may not want to see in the search results. A filter can
be used to override the attributes displayed in search results.

Filter attributes on a complex query.

Original query

This query will return the FDN, site and productNumber of all ManagedElement MOs at "SampleSite" site with product
number "ROF123".

cmedit get * managedelement.(site=="SampleSite",productnumber=="ROF123")

Filtered query examples

Display only FDN and site attributes as site is specified in the filter. In this example the site attribute is in the query and
the filter.

cmedit get * managedelement.(site=="SampleSite",productnumber=="ROF123") managedelement.site

Display an attribute that is not part of the query. In this example the neType attribute is in the filter but not in the query.

cmedit get * managedelement.(site=="SampleSite",productnumber=="ROF123") managedelement.netyp

e

Incorrect use of filter

Do not use the filter in place of the criteria.

Original query

This query returns the FDN and site for all ManageElement MOs. In this case the criteria could have been used to
display the same information in a more efficient way. This query is inefficient because it first gets all ManagedElement
MOs with all of their persistent attributes. Then it displays only the FDN and site attributes. It throws away the remaining
information.

cmedit get * managedelement.* managedelement.site

Correct query using criteria

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 10/21
5/25/23, 12:09 PM ENM CLI

This query gets only the FDN and site attributes of each ManagedElement MO.

cmedit get * managedelement.site

Targeting data with options

Use the following options to target data more specifically.

-ns or --namespace
Specify a particular namespace.

-v or --version
Specify a particular version.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 11/21
5/25/23, 12:09 PM ENM CLI

CM Edit Command Set Overload for

Protection
CM Edit commands have an overload protection mechanism to limit GET/SET/ACTION/DELETE commands searches
on certain MO types which have a large number of instances in the network.

Requests on a wide scope of these MO types can generate Out of Memory errors in ENM.

This query overload protection mechanism is based on two blacklists and a maximum number of nodes.

Blacklists
Each blacklist is a table of MO types with the corresponding maximum number of nodes that each MO type can be
queried against.

There are two blacklists:

1. Blacklist for no attribute or specific attribute criteria

2. Blacklist for all attribute criteria

Both blacklists are used to prevent only network wide searches (* scope) on the listed MO types. Commands using
partial or complete node names, collections, saved searches or a specified list of Network Elements are not affected by
the protection mechanism.

‘Blacklist for no attribute or specific attribute criteria’ is used for MO type queries without attributes or with a subset
of specified attributes.

Example of CM CLI commands which are affected by this blacklist:

cmedit get * UtranCellRelation

cmedit get * UtranCellRelation.(loadBalancing,mobilityStatus)

‘Blacklist for all attribute criteria’ is used for MO type queries with all attributes.

Example of CM CLI commands which are affected by this blacklist:

cmedit get * UtranCellRelation.*

cmedit get * UtranCellRelation.<cm>

Values for Blacklist for no attribute or specific attribute criteria

MO Type Max number of Nodes

LoadModule 1000

SoftwareItem 1000

HwItem 1000

PiuType 1000

ExternalEUtranCellFDD 1000

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 12/21
5/25/23, 12:09 PM ENM CLI

EUtranCellRelation 1000

ExternalENodeBFunction 10000

UtranCellRelation 5000

TermPointToENB 5000

Hardware 1000

NodeExportResult 100

MeasurementType 100

Slot 1000

GtpuApplicationTunnel 1000

Cdma20001xRttCellRelation 1000

EventType 1000

MeasurementReader 1000

TermPointToLbm 5000

GeranCellRelation 10000

BbLink 5000

SupportedTrackingArea 50

GlobalEnodeb 50

SupportingGlobalEnodeb 50

GtpPath 5000

FmAlarmType 5000

Schema 10000

PmGroup 15000

OpenAlarm 0

ActivityJob 10000

UtranRelation 1000

FeatureKey 100

CapacityKey 100

OptionalFeatureLicense 1000

FeatureState 100

Rule 1000

SctpAssociation 1000

The values in this table are not configurable.

Values for Blacklist for all attribute criteria

MO Type Max number of Nodes

LoadModule 100

SoftwareItem 100

HwItem 100

PiuType 1000

ExternalEUtranCellFDD 100
https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 13/21
5/25/23, 12:09 PM ENM CLI

EUtranCellRelation 100

OptionalFeatureLicense 1000

LicenseUsage 1000

ExternalENodeBFunction 1000

UtranCellRelation 1000

TermPointToENB 1000

ExternalUtranCellFDD 1000

EUtranFreqRelation 1000

UtranFreqRelation 1000

ReliableProgramUniter 10000

Hardware 1000

TermPointToMme 5000

QciProfilePredefined 5000

NodeExportResult 0

EUtranFrequency 1000

MeasurementType 100

Slot 1000

GtpuApplicationTunnel 1000

Cdma20001xRttCellRelation 1000
EventType 100

MeasurementReader 100

TermPointToLbm 5000

GeranCellRelation 1000

BbLink 5000

SupportedTrackingArea 50

GlobalEnodeb 20

SupportingGlobalEnodeb 50

GtpPath 5000

Cdma2000CellRelation 10000

ExternalCdma20001xRttCell 1000

FmAlarmType 1000

Schema 1000

ExternalGeranCell 5000

GeranFrequency 10000

PmGroup 10000

OpenAlarm 0

EUtranCellFDD 1000

EUtranCellTDD 1000

UtranCell 1000

LicenseData 0

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 14/21
5/25/23, 12:09 PM ENM CLI

ActivityJob 1000

UtranRelation 1000

FeatureKey 100

CapacityKey 100

OptionalFeatureLicense 100

FeatureState 100

Rule 1000

SctpAssociation 1000

The values in this table are not configurable.

Parent-Child GET Command Limitations

All parent / child commands that contain blacklisted MO types are limited to a maximum scope of 450 nodes.

This includes all scope types, therefore:

Collections that contain more than 450 nodes

Saved searches that return more than 450 nodes
A list of Network Elements more than 450 nodes

CM CLI SET, ACTION, DELETE Command Limitations

All SET, ACTION, DELETE commands that contain blacklisted MO types are limited to a maximum scope of 450 nodes.

This includes all scope types, therefore:

Collections that contain more than 450 nodes

Saved searches that return more than 450 nodes
A list of Network Elements more than 450 nodes

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 15/21
5/25/23, 12:09 PM ENM CLI

savedsearch
< Back To Command Sets

Content
List of Commands

Notes

Summary of Error Codes and Messages

Commands
List

Notes
The savedsearch command set can be used to read Saved Search data.

The savedsearch commands are subject to access control.

The savedsearch commands cannot be interrupted after the command has been entered in the Configuration
Management Command Line Interface application.

Summary of error codes and messages for CMCLI savedsearch service

The table below lists all possible savedsearch error codes for the CM

savedsearch service and possible solutions or actions to remedy them.

Error
Error message* Solution/Action required
code

Command syntax error, cannot resolve Refer to usage instructions for the
22001
the savedsearch command {2} <DYNAMIC_LINK:savedsearch:{4}:>
Command syntax error while processing Refer to usage instructions for the
22002
{0} after {1} {3} <DYNAMIC_LINK:savedsearch:{4}:>

Command syntax error while processing Refer to usage instructions for the
22003
{0} incomplete after {1} {3} <DYNAMIC_LINK:savedsearch:{4}:>

Command syntax error, unexpected Refer to usage instructions for the

22004
input {2} while processing {0} {3} <DYNAMIC_LINK:savedsearch:{4}:>

Command syntax error, unrecognised or

22008 Please check online help for correct syntax
invalid option {1}

Command syntax error, invalid character Enclose the values containing invalid characters
22020
`{5}` at position {6} within quotes.

22999 System Error, unexpected exception See log files for more details

* {0}, {1}, and so on, indicate variable parts of the message which will be substituted by relevant information form the
request like FDN, MO type, attribute name, and so on.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 16/21
5/25/23, 12:09 PM ENM CLI

** The suggested solution is only proposed if necessary.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 17/21
5/25/23, 12:09 PM ENM CLI

savedsearch list
< Back To Savedsearch

Syntax
Syntax to list all Saved Searches available to the current user

savedsearch list

Description
savedsearch list is used to display details of all Saved Searches visible to the current user.

Examples
List all the Saved Searches available to the current user

savedsearch list

Response

In this case there are two Saved Searches 'my_savedsearch1' and 'my_savedsearch2':

Name : my_savedsearch1
Created By : cmedit_administrator_user
Date Created : 21-February-2017
Search Query : select all nodes of type ERBS
Sharing Permission : Public
Name : my_savedsearch2
Created By : cmedit_administrator_user
Date Created : 21-February-2017
Search Query : select all objects of type ManagedElement from node type RadioNode
Sharing Permission : Public
2 instance(s)

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 18/21
5/25/23, 12:09 PM ENM CLI

ENM CLI Error Codes and Error Messages

The ENM CLI can generate application specific errors.

Application Error Codes

The following table lists the error code ranges and their corresponding command sets. Click on the range to display
details on the individual errors.

Range Command Set Descriptions

1000 - 5999 cmedit "cmedit" error codes and messages

6000 - 6999 All Commands Generic CLI error codes and messages

7000 - 7999 cmedit import "cmedit import" error codes and messages

8000 - 8999 cmedit export "cmedit export" error codes and messages

9000 - 9999 config "config" error codes and messages

10000 - 10999 secadm "secadm" error codes and messages

11000 - 11999 pkiadm "pkiadm" error codes and messages

12000 - 12999 lcmadm "lcmadm" error codes and messages

13000 - 13999 shm "shm" error codes and messages

14000 - 14999 credm "credm" error codes and messages

15000 - 15999 nhc "nhc" error codes and messages

16000 - 16999 ap "ap" error codes and messages

17000 - 17999 ulsa "ulsa" error codes and messages

18000- 18999 alarm "alarm" error codes and messages

19000- 19999 netlog "netlog" error codes and messages

20000- 20999 fmedit "fmedit" error codes and messages

21000- 21999 collection "collection" error codes and messages

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 19/21
5/25/23, 12:09 PM ENM CLI

Generic Error Codes

Error Codes And Error Messages CLI (generic)
Context Description

The error messages are applicable for all commands provided by ENM CLI

HTTP Error Handling

In the event of a HTTP error, the error will be displayed in a dialog to the user

When the user acknowledges the error by pressing the continue button, the CLI will be enabled for use

If notifications persists please check the error log for more details or contact system administrator

Summary of generic error codes and messages for the ENM CLI
Error
Error message* Solution/Action required
code

Cannot recognize the CLI

6001 Please check online help for valid CLI commands
command {0}

The multipart form request key '{0}' must be set in the

6002 Invalid multipart form request key
form data

The number of arguments in the alias must match the

Invalid alias command
6003 number of arguments in the aliased command. Arguments
specification
must be unique and sequential in the range of $1 to $9

6004 Alias with name {0} already exists Create an alias with an unique name

Alias with name {0} expects {1} The number of arguments in the alias must match the
6005
argument(s) number of arguments in the aliased command

6006 Invalid alias command syntax Please check online help for correct syntax

The file {0} is not attached to A file must be associated with the command. Please drag
6007
command and drop a valid file into the CLI command area

6008 Invalid file name Please specify a valid file name

6009 Empty file encountered Please add a valid file to the workspace

Received an invalid response Verify if the command was successfully completed, if the
6010
which could not be processed problem persists contact system administrator

6011 Syntax Error - Commands with file

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 20/21
5/25/23, 12:09 PM ENM CLI

input syntax cannot be aliased

Cannot create alias with name "

6012
{0}" as it is a CLI Command Set

Service is currently unavailable.

6013 Please try again later or contact
your System Administrator.

This is an unhandled system error, please check the error

9999 {0}
log for more details

* {0}, {1}, and so on, indicate variable parts of the message with will be substituted by relevant information form the
request like FDN, MO type, attribute name etc. In case of error 9999 {0} will be substituted by error message caught in
the system.

https://enmhost-1.korektel.com/#help/app/cliapp/topic/additionalinfo 21/21