ENM CLI

User Guide

1/1553-CNA 403 2979 Uen AV

Copyright

© Ericsson AB 2017-2020. All rights reserved. No part of this document may be

reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to
continued progress in methodology, design and manufacturing. Ericsson shall
have no liability for any error or damage of any kind resulting from the use of this
document.

1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Contents

Contents

1 Overview 1

2 Command Sets 3
2.1 CLI Common Commands and Use Cases 4
2.2 admin 15
2.3 alarm 21
2.4 ap 154
2.5 cmedit 156
2.6 collection 485
2.7 config 496
2.8 credm 524
2.9 dhcp 533
2.10 fmedit 604
2.11 fmsnmp 675
2.12 lcmadm 686
2.13 netlog 709
2.14 NHC 750
2.15 pkiadm 802
2.16 secadm 956
2.17 shm 1303
2.18 ulsa 1433
2.19 LINK 1459
2.20 CMAUDIT 1472
2.21 nodecmd 1476

3 Tutorials 1542
3.1 Configuration Management 1542
3.2 Fault Management 1650
3.3 Tutorial: Enable/Disable PmFunction on the Network
Elements 1654
3.4 Scripting Support 1656
3.5 Command Completion 1703

4 Additional Information 1705

4.1 Change Prompt of SGSN-MME 1705

1/1553-CNA 403 2979 Uen AV | 2020-12-07

ENM CLI

4.2 Choose User of Juniper-MX 1707

4.3 Choose User of Juniper-SRX 1707
4.4 Choose User of Juniper-PTX 1708
4.5 Choose User of Juniper-vMX 1708
4.6 Choose User of Juniper-vSRX 1708
4.7 Limitations of ENM CLI on iOS Platforms 1708
4.8 ENM CLI Performance Tips 1709
4.9 CM Edit Command Set Overload for Protection 1714
4.10 savedsearch 1718
4.11 savedsearch list 1719
4.12 ENM CLI Error Codes and Error Messages 1721
4.13 Generic Error Codes 1721

5 Release Information 1724

1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Overview

1 Overview

ENM CLI provides common CLI functionality in a web browser. All supported
ENM CLI command sets are included.

The following features are included, and are common to all command sets:

Batch
The batch command can be used to configure the managed network with large
volumes of configuration data quickly, and efficiently.

This is done using a batch file of CLI commands. Single commands are executed
in their own transaction. As there is no dependency between commands, race
conditions can occur.

If dependencies between commands must be defined, use the Scripting

Integration Framework. This enables rules to be applied between each command
execution.

Alias
The Alias command is used to create an alias for a command or command
sequence. Optional arguments can also be applied to the alias.

Help
The Help command is used to get help for a command set. A command overview
is provided, with a link to the relevant command documentation.

Output to File
The Output to File feature allows a command to be output to a file rather than
the standard response area in the browser. The file is downloaded directly to the
users browser.

The maximum response size that can be displayed in the ENM CLI is 20,000
elements (an element represents a table cell). If the response is greater than
20,000 elements, use Ctrl+Enter to output the full response to a file.

Syntax Completion
The tab key provides syntax suggestions based on the command already entered.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 1

 ENM CLI

Command Mode
Command mode allows the command set name to be omitted from every
command. Command mode is enabled by typing the name of the command set
on the command line, and pressing the enter key.

Exit a command mode by typing exit and pressing the enter key.

Multiple Browser Tabs

Multiple browser tabs can be opened simultaneously. This allows the same user
to execute different commands in different tabs. One tab equates to one session.

Command History
Command history can be retrieved by using the up/down arrow keys to scroll
through previous commands.

Record CLI Session

The Record CLI Session feature allows all CLI activities to be logged to a file. This
is in addition to being displayed in the standard response area in the browser.
The file can be downloaded using a web browser.

This feature does not replace "Output to File".

The behavior of the feature when a user is leaving an application depends on the
browser being used. Firefox requires the user to save the file before leaving,
Chrome saves it automatically.

2 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2 Command Sets

ENM CLI provides the following command sets.

Command Set Description

CLI Common Commands ENM Command Line Interface (CLI) provides

some common commands that can be used with
any command set.

Admin The admin command can be used to manage EN

M application parameters.

Alarm The alarm command set is used to manage al

arms.

Ap The ap command set can be used to automati

cally integrate a node into the network.

Cmaudit The cmaudit command set is used to start/c

heck the state of cell consistency audit.

Cmedit The cmedit command set can be used to read

, manipulate, and export Configuration Man
agement data.

Collection The collection command set can be used to

read Collection data. Creation, modificati
on and deletion of collection is also supp
orted.

Config The config command set allows a user to vi

ew the history of changes and undo changes
requested via the CM Bulk Import applicat
ion.

Credm The credm command set manages security con

figuration and administration for the ENM
services.

DHCP The dhcp command set manages the dhcp serv

er configuration and administration for th
e ENM services.

Fmedit The fmedit command set can be used to perf

orm Fault Management operations on Routes
and CpiDetails.

Fmsnmp The fmsnmp command set can be used to hand

le the configuration of the snmp agent, to
manage requests from and to send alarms t
o the subscribers NMSs.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 3

 ENM CLI

Command Set Description

Lcmadm The lcmadm command set can add, edit and r

emove the licenses, and manage the license
usage information.

Link The link command set is used to perform li

nk management operations such as create, e
dit, delete and view.

Netlog The netlog command set is used to retrieve

Network Element logs.

Nhc The Node Health Check (nhc) command set is

used to check the state of the network el
ements and to manage acceptance criteria.
Acceptance criteria are used to determine
if a health check passes or fails.

Nodecmd The nodecmd command set is used to run nod

e native CLI commands in bulk on network n
odes.

Pkiadm The pkiadm command set can be used to perf

orm CRUD operations on profiles, entities
and certificates.

SavedSearch The savedsearch command set can be used to

read Saved Search data.

Secadm The secadm command set manages security co

nfiguration and administration on network
nodes.

Shm The shm command set performs various suppo

rted shm use cases from CLI

Ulsa The ulsa command set is used to start/stop

uplink spectrum sampling on nodes.

2.1 CLI Common Commands and Use Cases

< Back To Command Sets

Tutorials

Creating and Executing Aliases

Executing a Batch

4 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Commands

Creating and Executing Aliases

Executing a Batch

Notes
ENM Command Line Interface (CLI) provides some common commands that can
be used with any command set.

2.1.1 Tutorial: Creating ,Executing and Managing Aliases

< Back To CLI

Refer to alias help page for alias syntax and context description

Use Case 1 : Creating alias

1. Alias with no argument

alias "ls" "cmedit get * NetworkElement"

Example Command Response:

alias created

2. Alias with one argument

alias "del_1 $1" "cmedit delete * ENodeBFunction.userLabel==$ →

1"

Example Command Response:

alias created

3. Alias with one argument used multiple times

alias "del_2 $1" "cmedit delete * ENodeBFunction.(userLabel== →

$1, zzzTemporary2==$1)"

Example Command Response:

alias created

1/1553-CNA 403 2979 Uen AV | 2020-12-07 5

 ENM CLI

4. Alias with multiple arguments

alias "create_MC $1 $2 $3" "cmedit create MeContext=$1 MeCont →

extId=$1,neType=$2,platformType=CPP -ns=OSS_TOP -version=$3"

Example Command Response:

alias created

Use Case 2 : Executing alias

1. Alias with no argument

Specify the name of the alias (for example "ls") with no argument and press
enter.

ls

As shown above, the alias will be executed and the response will be printed
out in the CLI. Note: The alias will be replaced by the aliased command.

cmedit get * NetworkElement

FDN : NetworkElement=LTE01ERBS00001

FDN : NetworkElement=LTE01ERBS00002

FDN : NetworkElement=LTE01ERBS00003

3 instance(s)

2. Alias with argument (s)

Specify the name of the alias with required number of argument-values and
press enter.

create_MC LTE200ERBS00003 ERBS 3.0.0

As shown above, the alias will be executed and the response will be printed
out in the CLI. Note: The alias was replaced by the aliased command after
substituting the argument values.

cmedit create MeContext=LTE200ERBS00003 MeContextId=LTE200ERB →

S00003,neType=ERBS,platformType=CPP -ns=OSS_TOP -version=3.0. →
0

6 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : MeContext=LTE200ERBS00003
neType : ERBS
MeContextId : LTE200ERBS00003
platformType : CPP

1 instance(s) updated

Use Case 3 : Finding alias

1. Finding a specific alias

cmedit get * CliAlias.name==aliases CliAlias.* -t

Example Command Response:

CliAlias
arguments command commandContext name →
userId
get * CliAlias.* -t cmedit aliases

1 instance(s)

2. Finding all aliases

cmedit get * CliAlias.* -t

Example Command Response:

CliAlias
arguments command commandContext name →
userId
get * CliAlias.* -t cmedit aliases
delete * CliAlias cmedit unalias

2 instance(s)

3. Note: It is also possible to make aliases for these commands. For example,
one can make an alias named "aliases" as shown below; to find all aliases.

alias "aliases" "cmedit get * CliAlias.* -t"

Example Command Response:

alias created

1/1553-CNA 403 2979 Uen AV | 2020-12-07 7

 ENM CLI

Execute the alias command

aliases

Example Command Response:

cmedit get * CliAlias.* -t

CliAlias
arguments command commandContext name →
userId
get * CliAlias.* -t cmedit aliases
delete * CliAlias cmedit unalias

2 instance(s)

Use Case 4 : Deleting alias

1. Deleting a specific alias and Confirmation Request.

cmedit delete * CliAlias.name==aliases

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you wa →

nt to continue command execution.

PO : CliAlias:null

1 Object(s) will be deleted by this commands.

Response (after confirmation)

8 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

SUCCESS PO : CliAlias:null

1 instance(s) deleted

Note: This command was forced for execution following automat →

ic Preview Mode

2. Deleting all aliases and Confirmation Request.

cmedit delete * CliAlias.name==*

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you wa →

nt to continue command execution.

PO : CliAlias:null

PO : CliAlias:null

2 Object(s) will be deleted by this commands.

Response (after confirmation)

SUCCESS PO : CliAlias:null

1/1553-CNA 403 2979 Uen AV | 2020-12-07 9

 ENM CLI

SUCCESS PO : CliAlias:null

2 instance(s) deleted

Note: This command was forced for execution following automat →

ic Preview Mode

3. Deleting all aliases using preview option.

cmedit delete * CliAlias.name==* --preview

Response

Command Preview - List of Affected MO(s):

PO : CliAlias:null

PO : CliAlias:null

2 Object(s) will be deleted by this command.

4. Note: It is also possible to make aliases for these commands. For example,
one can make an alias named "unaliases" as shown below; to delete all
aliases.

alias "unalias" "cmedit delete * CliAlias.name==* CliAlias -t →

"

Example Command Response:

10 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

alias created

2.1.2 Tutorial: Executing a Batch of Commands

< Back To CLI

Starting a batch:

1. Using any plain text editor, create a file with valid Command Line Interface
CLI commands
2. Drag and Drop the batch file onto the CLI web browser
• Only one file is allowed to be dragged and dropped. If another file is
dropped into the browser, it will override any previous file
3. Executing the batch file: To execute the batch file, type this command on the
CLI : batch execute file: <file-name>

Expected Result

The commands shall be executed automatically one-by-one in the order specified

in the batch file.

The output of each command in the batch file is output to the CLI as the
commands are executed. This allows the user to monitor the progress of the
commands.

After successfully completing the entire file, the CLI will print out the total
execution time (in milliseconds) and the number of commands executed
successfully.

Stopping the batch process:

If the need arises to stop the execution, the user must close/refresh the browser.

This will only stop the execution from that point onwards - the commands that
are executed already will not be rolled back.

Restarting the batch process:

If an error/exception occurs; the execution will stop immediately, printing out the
number of commands that executed successfully. For example: "The batch job
executed 3 out of 5 commands successfully." - in this case the error has occurred
on the 4th line. Any command(s) that were successfully executed before the
failed command will not be rolled back.

The user can re-start the batch processing by first fixing the issue with the line
containing the error and then removing all previous lines from the batch file. Also,
the user will have to drag and drop the modified file into the browser again

1/1553-CNA 403 2979 Uen AV | 2020-12-07 11

 ENM CLI

before re-starting the process by repeating the same batch execute file: <file-
name> command

Sample batch file to import ER6000 NE (spfr_create.txt):

cmedit create MeContext=SPFR01 MeContextId=SPFR01,neType=Router6 →

672,platformType=ER6000 -ns=OSS_TOP -version=3.0.0

cmedit create NetworkElement=SPFR01 networkElementId=SPFR01,neTy →

pe=Router6672,platformType=ER6000,ossPrefix="MeContext=SPFR01" - →
ns=OSS_NE_DEF -version=2.0.0

cmedit create NetworkElement=SPFR01,Er6000ConnectivityInformatio →

n=1 ComConnectivityInformationId="1",port="22",ipAddress="192.16 →
8.0.252" -namespace=ER6000_MED -version=1.2.0

secadm credentials create --secureusername netsim --secureuserpa →

ssword netsim -n SPFR01

cmedit create MeContext=SPFR02 MeContextId=SPFR02,neType=Router6 →

672,platformType=ER6000 -ns=OSS_TOP -version=3.0.0

cmedit create NetworkElement=SPFR02 networkElementId=SPFR02,neTy →

pe=Router6672,platformType=ER6000,ossPrefix="MeContext=SPFR02" - →
ns=OSS_NE_DEF -version=2.0.0

cmedit create NetworkElement=SPFR02,Er6000ConnectivityInformatio →

n=1 ComConnectivityInformationId="1",port="22",ipAddress="192.16 →
8.0.253" -namespace=ER6000_MED -version=1.2.0

secadm credentials create --secureusername netsim --secureuserpa →

ssword netsim -n SPFR02

cmedit create MeContext=SPFR03 MeContextId=SPFR03,neType=Router6 →

672,platformType=ER6000 -ns=OSS_TOP -version=3.0.0

cmedit create NetworkElement=SPFR03 networkElementId=SPFR03,neTy →

pe=Router6672,platformType=ER6000,ossPrefix="MeContext=SPFR03" - →
ns=OSS_NE_DEF -version=2.0.0

12 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit create NetworkElement=SPFR03,Er6000ConnectivityInformatio →

n=1 ComConnectivityInformationId="1",port="22",ipAddress="192.16 →
8.0.254" -namespace=ER6000_MED -version=1.2.0

secadm credentials create --secureusername netsim --secureuserpa →

ssword netsim -n SPFR03

NOTE: The commands above are used for sample purposes and may need to be
tailored for your network

2.1.3 alias
< Back To CLI

Syntax
EBNF grammar

"alias" '"' ALIAS_NAME { ARGUMENT } '"' '"' COMMAND_CONTEXT COMM →

AND_STRING '"'

ALIAS_NAME ::= <alias-name>

ARGUMENT ::= '$' <argument-number> where 1 ≤ argument-number ≤ 9
COMMAND_CONTEXT ::= "cmedit"
COMMAND_STRING ::= <command-string>

Examples
Examples can be seen in the following tutorial:

— Creating and Executing Aliases

Context Description
— ENM Command Line Interface (CLI) can be used to create an alias of a CLI
command. This can be done for any command or command sequence

— The task is used when you want to create an alias for a command ( with
optional arguments )

— The alias is available to all ENM CLI users, not only the creator of the alias

— The alias name can contain any alpha-numeric characters and an underscore

— The alias name must be unique and therefore cannot be named the same as
any existing Command Set

— The alias command can take any number of arguments

1/1553-CNA 403 2979 Uen AV | 2020-12-07 13

 ENM CLI

— The alias commands are remembered and can subsequently be specified in

place of the aliased command

— Command syntax is case sensitive

— Commands with file input cannot be aliased

Prerequisites

— The user must have access to the CLI command to be aliased

— The aliased command must be a supported CLI command

Notes
— Alias command is not supported for use in scripting.

— Alias name argument can only contain word characters, i.e. [a-zA-Z_0-9].

2.1.4 batch
< Back To CLI

Syntax

Syntax to execute a batch command

batch execute file: <file-name>

Examples
Examples can be seen in the following tutorial:

— Executing commands in a batch

Context Description
— ENM Command Line Interface (CLI) can be used to run commands in batch

— The feature can be used by a Configuration Engineer to quickly and

efficiently execute a small number of commands in one batch file

— A batch file is basically a list of commands that are automatically executed

one after another in the order they are written in the file. Each command
when executed will provide a response in the normal way

14 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— If one command fails, the next command will not be executed and execution
of the batch job is halted. One command failing does not mean previous
commands are reversed (rolled back)

— A summary of the batch job is provided when finished

Prerequisites

— The user needs to prepare a batch file of CLI commands (for example
cm_create.txt)

— The file is stand-alone, that is, it has no special relationship (as far as the
OSS is concerned) with any other configuration changes in any other file

— This file shall only contain a list of commands from a valid ENM CLI
command set (for example any cmedit or config). It is possible to mix
commands from different command sets

— The file must not contain comments or other scripts (for example PERL,
BASH, PYTHON...)

— There is no pre-validation of the file. Validation of each individual command

is performed as it is being executed

— There is no limits on the size of the file (that is, no limit on the number of CLI
commands)

— The file must be a text file with any one-word name (no spaces)

— The batch file must be dropped onto the web browser before it can be
executed from the web browser

Notes
— If the browser is refreshed/closed or the session times out while batch
execution is still running; the execution will stop immediately at that point of
time without rolling back the already executed commands

— Batch command is not supported for use in scripting.

— Outputting the response of a batch file to a file (CTRL + ENTER) will result in
one file being generated per command. To get a response from many
commands in one complete file, Scripting Integration should be used.

2.2 admin
< Back To Command Sets

List of Tutorials

List of Commands

1/1553-CNA 403 2979 Uen AV | 2020-12-07 15

 ENM CLI

Notes

Summary of Error Codes and Messages

Tutorials

Modify Application Parameter

View Application Parameter

Command

Parameter

Notes
The admin command can be used to modify and view ENM application
parameters.

Summary of Error Codes and Messages for admin Command

The following table lists the possible admin error codes for the admin commands
and the consequent actions:

Error Code Error Message Solution/Action Required

6014 — Command syntax error For correct command syntax
please run "help <specified
command>"
6015 — Parameter <specified Provide a valid parameter name
parameter> not exist
6016 — Invalid parameter value Provide a valid parameter value
for Parameter <specified
parameter>
6017 — Update Parameter Please try again. If the problem
<specified parameter> persists contact system
failed administrator
6018 — Insufficient access rights If the operation is required to be
to perform the operation performed by current user, the
user profile must be updated by
the system administrator

2.2.1 admin parameter modify

< Back To admin parameter commands

Syntax

Syntax to modify ENM application parameter

16 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

admin parameter modify --name <parm-name> --value <parm-value>

Attributes
The following attributes are required to modify ENM application parameter.

--name

Specifies parameter name.

--value

Specifies parameter value.

Examples

modify application parameter

admin parameter modify --name NODE_SNMP_SECURITY --value {securi →

tyLevel:AUTH_PRIV,authProtocol:SHA1,authPassword:onlytest,privPr →
otocol:AES128,privPassword:onlytest2,user:snmpuser}

Response

Parameter NODE_SNMP_SECURITY updated successfully.

2.2.2 admin parameter

< Back To admin

The admin parameter command set manages ENM application parameters.

List of Commands

admin parameter modify

admin parameter view

1/1553-CNA 403 2979 Uen AV | 2020-12-07 17

 ENM CLI

2.2.3 admin parameter view

< Back To admin parameter commands

Syntax

Syntax to view ENM application parameter

admin parameter view [--name <parm-name>]

Option
The following option is optional when viewing ENM application parameter.

--name

Specifies parameter name.

Examples

View application parameter

admin parameter view --name NODE_SNMP_SECURITY

Response

NODE_SNMP_SECURITY: {securityLevel:AUTH_PRIV,authProtocol:SHA1,a →
uthPassword:onlytest,privProtocol:AES128,privPassword:onlytest2, →
user:snmpuser}

2.2.4 Modify Application Parameter

Prerequisites
You must have CLI access and one of the following roles:

— CM_Application_Administrator

— Custom role with the capability: "Resource: cm_app_param, Operation:

update"

NOTE: CLI access capability can be authorized using Cmedit_Operator,

Cmedit_Administrator or custom role with resource: cm_editor or cm_config.

18 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Objective

This tutorial describes the steps required to execute the modify application
parameter command in ENM using the admin CLI command.

Outline

1. Modify Application Parameter

Steps

1. Modify Application Parameter

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the modify application
parameter command:

Command Syntax:

admin parameter modify --name <parm-name> --value <parm-valu →

e>

Learn more about the admin parameter modify command

Command Example:

admin parameter modify --name NODE_SNMP_SECURITY --value {sec →

urityLevel:AUTH_PRIV,authProtocol:SHA1,authPassword:onlytest, →
privProtocol:AES128,privPassword:onlytest2,user:snmpuser}

Command Result:

Parameter NODE_SNMP_SECURITY updated successfully.

Results
ENM application parameter is modified for the admin parameter modify
command.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 19

 ENM CLI

2.2.5 View Application Parameter

Prerequisites
You must have CLI access and one of the following roles:

— CM_Application_Administrator

— Custom role with the capability: "Resource: cm_app_param, Operation: read"

NOTE: CLI access capability can be authorized using Cmedit_Operator,

Cmedit_Administrator or custom role with resource: cm_editor or cm_config.
Objective

This tutorial describes the steps required to execute the view application
parameter command in ENM using the admin CLI command.

Outline

1. View Application Parameter

Steps

1. View Application Parameter

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the view application parameter
command :

Command Syntax:

admin parameter view --name <parm-name>

Learn more about the admin parameter view command

Command Example:

admin parameter view --name NODE_SNMP_SECURITY

Command Result:

20 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

NODE_SNMP_SECURITY: {securityLevel:AUTH_PRIV,authProtocol:SHA →
1,authPassword:onlytest,privProtocol:AES128,privPassword:only →
test2,user:snmpuser}

Results
ENM application parameter is displayed for the admin parameter view command.

2.3 alarm
< Back To Command Sets

Content
List of Tutorials

List of Commands

Notes

Summary of Error Codes and Messages

Tutorials

Acknowledge Alarms

Unacknowledge Alarms

Clear Alarms

Comment Alarm

Change Heartbeat Timeout when Enabling Alarm Supervision

Change Heartbeat Timeout and Hertbeat Interval when Enabling Alarm Supervision

Change Heartbeat Timeout and Heartbeat Interval when Disabling Alarm Supervision

Change Heartbeat Timeout and Heartbeat Interval with Alarm Supervision Disabled

Change Heartbeat Timeout and Heartbeat Interval with Alarm Supervision Enabled

Change Automatic Synchronization when Enabling Alarm Supervision

1/1553-CNA 403 2979 Uen AV | 2020-12-07 21

 ENM CLI

Commands

Ack

Clear

Comment

Disable

Enable

Get

Hist

Status

Sync

Unack

Notes
The alarm command set is used to manage alarms. Results for the above
command set will be populated based on the authorisation of nodes.

Summary of user codes and messages in Alarm

The table below list all possible alarm error codes for the alarm application and
possible solutions or actions to remedy them.

Error Code Error Message Solution/Action Required

18000 Check the command syntax
Invalid Command: {0}

18001
Invalid attribute (or) valu
e

18002
Invalid command

18003
Invalid value(s) of attribu
te(s) given in filter crite
ria

18004
Invalid operator used in fi
lter criteria

18005
Invalid datetime range valu
es used in filter criteria

22 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

18006
Invalid attribute(s) given
in filter criteria

18007
Wrong parameter. Parameter
--count DOES NOT REQUIRE --
verbose parameter

18008
Wrong parameter. Parameter
--count DOES NOT REQUIRE --
output parameter

18009
Wrong parameter. Parameter
--count DOES NOT REQUIRE --
list parameter

18010
Wrong parameter. Parameter
--list DOES NOT REQUIRE --o
utput parameter

18011
Wrong parameter. Unknown at
tribute [{0}]

18012
Wrong parameter. Parameter
--count NOT IMPLEMENTED for
history alarms

18013
Unable to perform action fo
r given Child type. Please
try with a valid Child type

18014
Data not found

18015
Invalid attribute (or) oper
ator(s) used for filter cri
teria

18016
Invalid value(s) given to f
ilter criteria

18017
Can set/modify only one att
ribute at once. Try with on
ly one attribute

18018
Invalid beginTime. beginTim
e should not be greater tha
n endTime

18019
Insufficient access rights
for the node(s): [{0}]

20300
topologyCollectionService n
ot found

20301
Collection not existent or
insufficent access rights

1/1553-CNA 403 2979 Uen AV | 2020-12-07 23

 ENM CLI

Error Code Error Message Solution/Action Required

20302
Unable to SET/MODIFY the gi
ven attribute(or)value. Ple
ase try with any valid attr
ibute(or)value.

* {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.

2.3.1 Acknowledge Alarms

Prerequisites

— The node must exist in the ENM.

< Back To Alarm

This tutorial describes the tasks to acknowledge the alarms with a specific
severity in a node. In the following are defined as examples:

— nodeName = LTE01ERBS00080

— quick_filter = -war

Steps

1. Get the open alarms with a specific severity in a node:

alarm get LTE01ERBS00080 -war

The command in this example returns the warning alarms (if any) in the
LTE01ERBS00080 node as in the following example:

presen NodeN specifi eventT object proble alarm alarmI proba eventT record
tSeveri ame cProbl ime OfRefe mText State d bleCau ype Type
ty em rence se

WARN LTE01 NE 2016- MeCon ACTIV 75189 reinitia ET_PR CLEA

ING ERBS0 and 08-04 text=L E_UN 6634 lized OCESS RALL
0080 OSS T08:2 TE01E ACKN ING_E
alarms 7:48 RBS00 OWLE RROR
are 080,M DGED _ALAR
not in anage M
sync dElem
ent=1

24 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

presen NodeN specifi eventT object proble alarm alarmI proba eventT record
tSeveri ame cProbl ime OfRefe mText State d bleCau ype Type
ty em rence se

WARN LTE01 FEAT 2016- MeCon ACTIV 43792 Indete ET_EN SYNC
ING ERBS0 URER 08-05 text=L E_UN 3123 rminat VIRO HRON
0080 ESOU T02:1 TE01E ACKN e NMEN IZATI
RCEMI 7:55 RBS00 OWLE TAL_A ON_A
SSING 080,E DGED LARM LARM
Utran
CellFD
D=LTE
01ERB
S0008
0-1

2. Acknowledge the alarms with a specific severity in a node:

alarm ack LTE01ERBS00080 -war

The command in this example acknowledges the warning alarms (if any) in
the LTE01ERBS00080 node and returns a successful message as shown in
the following example:

MeContext=LTE01ERBS00080,ManagedElement=1-751896634 MeContext →
=LTE01ERBS00080,EUtranCellFDD=LTE01ERBS00080-1-437923123 Oper →
ation Successful for 2 alarm(s)

Results
The alarms with a specific severity in a node are acknowledged.

2.3.2 Unacknowledge Alarms

Prerequisites

— The node must exist in the ENM.

< Back To Alarm

This tutorial describes the tasks to unacknowledge the alarms with a specific
severity in a node. In the following are defined as examples:

— nodeName = LTE01ERBS00080

— quick_filter = -war

1/1553-CNA 403 2979 Uen AV | 2020-12-07 25

 ENM CLI

Steps

1. Get the open alarms with a specific severity in a node:

alarm get LTE01ERBS00080 -war

The command in this example returns the warning alarms (if any) in the
LTE01ERBS00080 node as in the following example:

presen NodeN specifi eventT object proble alarm alarmI proba eventT record
tSeveri ame cProbl ime OfRefe mText State d bleCau ype Type
ty em rence se

WARN LTE01 NE 2016- MeCon ACTIV 75189 reinitia ET_PR CLEA

ING ERBS0 and 08-04 text=L E_ACK 6634 lized OCESS RALL
0080 OSS T08:2 TE01E NOWL ING_E
alarms 7:48 RBS00 EDGE RROR
are 080,M D _ALAR
not in anage M
sync dElem
ent=1

WARN LTE01 FEAT 2016- MeCon ACTIV 43792 Indete ET_EN SYNC
ING ERBS0 URER 08-05 text=L E_ACK 3123 rminat VIRO HRON
0080 ESOU T02:1 TE01E NOWL e NMEN IZATI
RCEMI 7:55 RBS00 EDGE TAL_A ON_A
SSING 080,E D LARM LARM
Utran
CellFD
D=LTE
01ERB
S0008
0-1

2. Unacknowledge the alarms with a specific severity in a node:

alarm unack LTE01ERBS00080 -war

The command in this example unacknowledges the warning alarms (if any)
in the LTE01ERBS00080 node and returns a successful message as shown in
the following example:

MeContext=LTE01ERBS00080,ManagedElement=1-751896634 MeContext →
=LTE01ERBS00080,EUtranCellFDD=LTE01ERBS00080-1-437923123 Oper →
ation Successful for 2 alarm(s)

Results
The alarms with a specific severity in a node are unacknowledged.

26 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.3.3 Clear Alarms

Prerequisites

— The nodes must exist in the ENM.

< Back To Alarm

This tutorial describes the tasks to clear all the current alarms with a specific
severity in the network. In the following is defined as examples:

— quick_filter = -war

Steps

1. Get all the open alarms with a specific severity in the network:

alarm get * -war

The command in this example returns all the warning alarms (if any) in the
network as shown in the following example:

presen NodeN specifi eventT object proble alarm alarmI proba eventT record
tSeveri ame cProbl ime OfRefe mText State d bleCau ype Type
ty em rence se

WARN LTE05 NE 2016- MeCon ACTIV 75189 reinitia ET_PR CLEA

ING ERBS0 and 08-04 text=L E_UN 6634 lized OCESS RALL
0145 OSS T08:2 TE05E ACKN ING_E
alarms 7:48 RBS00 OWLE RROR
are 145,M DGED _ALAR
not in anage M
sync dElem
ent=1

WARN LTE05 NE 2016- MeCon ACTIV 78189 reinitia ET_PR CLEA

ING ERBS0 and 08-04 text=L E_UN 6634 lized OCESS RALL
0155 OSS T06:2 TE05E ACKN ING_E
alarms 4:28 RBS00 OWLE RROR
are 155,M DGED _ALAR
not in anage M
sync dElem
ent=1

2. Clear all the alarms with a specific severity in the network:

alarm clear * -war

The command in this example clears all the warning alarms in the networks
and returns a successful message as shown in the following example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 27

 ENM CLI

MeContext=LTE05ERBS00145,ManagedElement=1-751896634 MeContext →
=LTE05ERBS00045,MeContext=LTE05ERBS00155,ManagedElement=1-781 →
896634 MeContext=LTE05ERBS00055 Operation Successful for 2 al →
arm(s)

3. Verify the warning alarm are cleared:

alarm get * -war

The command in this example returns no warning alarms as shown in the

following example:

Total number of alarms fetched for the given query is :0

Results
All the current alarms with a specific severity in the network are cleared.

2.3.4 Comment Alarms

Prerequisites

— The node must exist in the ENM.

< Back To Alarm

This tutorial describes the tasks to comment the alarms for a node. In the
following is defined as examples:

— nodeName = ieatnetsimv5036-01_LTE01ERBS00122

— quick_filter = --minor

Steps

1. Add a comment to the alarms with a specific severity for a node:

alarm comment "minor severity" ieatnetsimv5036-01_LTE01ERBS00 →

122 --minor

The command in this example adds comment to the minor alarms (if any) in
the LTE01ERBS00080 node and returns a successful message as shown in
the following example:

28 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

SubNetwork=ERBS-SUBNW-1,MeContext=ieatnetsimv5036-01_LTE01ERB →
S00122,ManagedElement=1-358159662 Operation Successful for 1 →
alarm(s) .

2. Verify comment to the alarms with a specific severity for a node:

alarm comment ieatnetsimv5036-01_LTE01ERBS00122 --minor

The command in this example returns the comment for the minor alarms for
the node ieatnetsimv5036-01_LTE01ERBS00122:

NodeName CommentText alarmId

LTE01ERBS00080 minor severity 358159662

LTE01ERBS00080 minor severity 964119258

Results
The alarms with a specific severity for a node are commented.

2.3.5 Change Heartbeat Timeout when Enabling Alarm Supervision

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is disabled.

< Back To Alarm

This tutorial describes the tasks to change heartbeat timeout value when
enabling alarm supervision. The new heartbeat timeout value is applied
immediately after the task execution.

Steps

1. Enable alarm supervision and change heartbeat timeout

— Use the following command for a node:

alarm enable LTE05ERBS00040 heartbeattimeout=100

The command returns a successful message as shown in the following

example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 29

 ENM CLI

[NetworkElement=LTE05ERBS00040]Successfully modified the →

given [heartbeatTimeout] for 1 instance(s).
[NetworkElement=LTE05ERBS00040]Alarm Supervision has been →
enabled successfully for 1 instance(s).

— Use the following command for a ManagementSystem:

alarm enable ManagementSystem=ECI-LightSoft02 heartbeatti →

meout=100

The command returns a successful message as shown in the following

example:

[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatTimeout] for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision has b →
een enabled successfully for 1 instance(s).

Results
The heartbeat timeout value is changed and the supervision is enabled in the
Node or in the ManagementSystem.

2.3.6 Change Heartbeat Timeout and Heartbeat Interval when Enabling Alarm
Supervision

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is disabled.

< Back To Alarm

This tutorial describes the tasks to change heartbeat timeout and heartbeat
interval values when enabling alarm supervision. The new heartbeat timeout and
heartbeat interval values are applied immediately after the task execution.

Steps

1. Enable alarm supervision and change both the heartbeat timeout and
heartbeat interval values:
— Use the following command for a node:

alarm enable LTE05ERBS00130 heartbeattimeout=300 heartbea →

tinterval=100

30 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

The command returns a successful message as shown in the following

example:

[NetworkElement=LTE05ERBS00130]Successfully modified the →

given [heartbeatTimeout] for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Successfully modified the →
given [heartbeatinterval] for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Alarm Supervision has been →
enabled successfully for 1 instance(s).

— Use the following command for a ManagementSystem:

alarm enable ManagementSystem=ECI-LightSoft02 heartbeatti →

meout=300 heartbeatinterval=100

The command returns a successful message as shown in the following

example:

[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatTimeout] for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatinterval] for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision has b →
een enabled successfully for 1 instance(s).

Results
The heartbeat timeout and heartbeat interval values are changed when the
alarm supervision is enabling in the Node or in the ManagementSystem.

2.3.7 Change Heartbeat Timeout and Heartbeat Interval when Disabling Alarm
Supervision

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is enabled.

< Back To Alarm

This tutorial describes the tasks to change heartbeat timeout and heartbeat
interval values when disabling alarm supervision. The new heartbeat timeout
and heartbeat interval values are changed immediately after the task execution
but non applied until the alarm supervision is always enabled.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 31

 ENM CLI

Steps

1. Disable alarm supervision and change both the heartbeat timeout and
heartbeat interval values:
— Use the following command for a node:

alarm disable LTE05ERBS00130 heartbeattimeout=300 heartbe →

atinterval=100

The command returns a successful message as shown in the following

example:

[NetworkElement=LTE05ERBS00130]Successfully modified the →

given [heartbeatTimeout]. It will be applicable at next s →
upervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Successfully modified the →
given [heartbeatinterval]. It will be applicable at next →
supervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Alarm Supervision has been →
disabled successfully for 1 instance(s).

— Use the following command for a ManagementSystem:

alarm disable ManagementSystem=ECI-LightSoft02 heartbeatt →

imeout=300 heartbeatinterval=100

The command returns a successful message as shown in the following

example:

[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatTimeout]. It will be applicable at nex →
t supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatinterval]. It will be applicable at ne →
xt supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision has b →
een disabled successfully for 1 instance(s).

Results
The heartbeat timeout and heartbeat interval values are changed when the
alarm supervision is disabling in the Node or in the ManagementSystem.

32 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.3.8 Change Heartbeat Timeout and Heartbeat Interval with Alarm Supervision
Disabled

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is disabled.

< Back To Alarm

This tutorial describes the tasks to change heartbeat timeout and heartbeat
interval values leaving the alarm supervision status disabled unchanged. The
new heartbeat timeout and heartbeat interval values are changed immediately
after the task execution but non applied until the alarm supervision is always
enabled.

Steps

1. Leave the alarm supervision status disable unchanged and change both the
heartbeat timeout and heartbeat interval values:
— Use the following command for a node:

alarm disable LTE05ERBS00130 heartbeattimeout=300 heartbe →

atinterval=100

The command returns a successful message as shown in the following

example:

[NetworkElement=LTE05ERBS00130]Successfully modified the →

given [heartbeatTimeout]. It will be applicable at next s →
upervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Successfully modified the →
given [heartbeatinterval]. It will be applicable at next →
supervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Alarm Supervision is alrea →
dy disabled for 1 instance(s).

— Use the following command for a ManagementSystem:

alarm disable ManagementSystem=ECI-LightSoft02 heartbeatt →

imeout=300 heartbeatinterval=100

The command returns a successful message as shown in the following

example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 33

 ENM CLI

[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatTimeout]. It will be applicable at nex →
t supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatinterval]. It will be applicable at ne →
xt supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision is al →
ready disabled for 1 instance(s).

Results
The heartbeat timeout and heartbeat interval values are changed when the
alarm supervision is disabled in the Node or in the ManagementSystem.

2.3.9 Change Heartbeat Timeout and Heartbeat Interval with Alarm Supervision
Enabled

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is enabled.

< Back To Alarm

This tutorial describes the tasks to change heartbeat timeout and heartbeat
interval values leaving the alarm supervision status enabled unchanged. The new
heartbeat timeout and heartbeat interval values are changed immediately after
the task execution but non applied until the next alarm supervision status
transition from disabled to enabled.

Steps

1. Leave the alarm supervision status enabled unchanged and change both the
heartbeat timeout and heartbeat interval values:
— Use the following command for a node:

alarm enable LTE05ERBS00130 heartbeattimeout=300 heartbea →

tinterval=100

The command returns a successful message as shown in the following

example:

[NetworkElement=LTE05ERBS00130]Successfully modified the →

given [heartbeatTimeout]. It will be applicable at next s →
upervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Successfully modified the →

34 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

given [heartbeatinterval]. It will be applicable at next →

supervision status change for 1 instance(s).
[NetworkElement=LTE05ERBS00130]Alarm Supervision is alrea →
dy enabled for 1 instance(s).

— Use the following command for a ManagementSystem:

alarm enable ManagementSystem=ECI-LightSoft02 heartbeatti →

meout=300 heartbeatinterval=100

The command returns a successful message as shown in the following

example:

[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatTimeout]. It will be applicable at nex →
t supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Successfully modified t →
he given [heartbeatinterval]. It will be applicable at ne →
xt supervision status change for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision is al →
ready enabled for 1 instance(s).

Results
The heartbeat timeout and heartbeat interval values are changed when the
alarm supervision is enabled in the Node or in the ManagementSystem.

2.3.10 Change Automatic Synchronization when Enabling Alarm Supervision

Prerequisites

— The node or the ManagementSystem must exist in the ENM.

— Alarm supervision is disabled.

< Back To Alarm

This tutorial describes the tasks to change automatic synchronization value when
enabling alarm supervision. The new automatic synchronization value is applied
immediately after the task execution.

Steps

1. Enable alarm supervision and change automatic synchronization value

— Use the following command for a node:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 35

 ENM CLI

alarm enable LTE01ERBS00001 automaticsynchronization=fals →

e

The command returns a successful message as shown in the following

example:

[NetworkElement=LTE05ERBS00130]Successfully modified the →

given value(s) for 1 instance(s).
[NetworkElement=LTE01ERBS00001]Alarm Supervision has been →
enabled successfully for 1 instance(s)

— Use the following command for a ManagementSystem:

alarm enable ManagementSystem=ECI-LightSoft02 automaticsy →

nchronization=false

The command returns a successful message as shown in the following

example:

[ManagementSystem=ECI-LightSoft02]Succesfully modified th →
e given value. It will be applicable when the supervision →
is ON again for 1 instance(s).
[ManagementSystem=ECI-LightSoft02]Alarm Supervision has b →
een enabled successfully for 1 instance(s).

Results
The automatic synchronization value is changed and the alarm supervision is
enabled in the Node or in the ManagementSystem.

2.3.11 alarm ack

< Back To Alarm

Syntax

Syntax to acknowledge alarms

alarm ack scope [quick_filter] [filter]

36 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of Managed Objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

1/1553-CNA 403 2979 Uen AV | 2020-12-07 37

 ENM CLI

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm ack command by specifying either
the severity, state or both. If not specified, all instances are involved.

-cle, --cleared

Filter alarms that are cleared.

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

38 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

Filter alarms with severity minor.

-unack, --unack

Filter unacknowledged alarms.

-und, --undefined

Filter alarms with severity undefined.

-war, --warning

Filter alarms with severity warning.

--primary

1/1553-CNA 403 2979 Uen AV | 2020-12-07 39

 ENM CLI

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the alarms that are acknowledged by specifying an alarm
attribute. If not specified, all alarms are acknowledged.

-<attributeShortName>, --<attributeName>

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

— -cv, --correlatedVisibility

— -evt, --eventType

40 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

Specify the alarmId to filter alarms.

Note that alarmId is not unique in the ENM scope. To acknowledge a single
alarm, filter also by objectOfReference.

-ta, --timeAttribute

1/1553-CNA 403 2979 Uen AV | 2020-12-07 41

 ENM CLI

Specify the attribute to be used by --begin and --end options. The available
values are:

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --begin

Specify a starting date or time for filtering the alarms. The default attribute is the
eventTime The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (00:00:00 is assumed).

-e, --end

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

--relatedAlarms

Specify to acknowledge related alarms for each selected primary alarm. The
alarms, that are already acknowledged, are skipped.

Description
alarm ack is used to acknowledge alarms for the network nodes.

Command Consequences

— All alarms satisfying the quick filter are acknowledged.

42 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Examples

Acknowledge all the alarms in the network

alarm ack *

Response

SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS08--2 SubN →

etwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS05--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS09--2 →
MeContext=RNC01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →
ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS04 →
--2 MeContext=RNC01RBS05--2 MeContext=RNC01RBS09--2 MeContext=RN →
C01RBS07--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS08--2 MeCo →
ntext=RNC01RBS05--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContex →
t=RNC01RBS04--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS07--2 →
MeContext=RNC01RBS09--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →
ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS05 →
--2 MeContext=RNC01RBS09--2 MeContext=RNC01RBS04--2 MeContext=RN →
C01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01R →
BS05--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS09--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS08--2 →
Operation Successful for 37 alarm(s) .

Acknowledge all the alarms in a node

alarm ack LTE01ERBS00080

Response

MeContext=LTE01ERBS00080,EUtranCellFDD=LTE02ERBS00005-6-74950842 →
MeContext=LTE01ERBS00080 Operation Successful for 2 alarm(s) .

Acknowledge all the alarms with a specific severity in the network

alarm ack * -war

or

alarm ack * --warning

1/1553-CNA 403 2979 Uen AV | 2020-12-07 43

 ENM CLI

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842 →
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-5-9318281 →
23 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-4-71496 →
3580 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-3-498 →
099037 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-2-2 →
81234494 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-1 →
-64369951 MeContext=LTE02ERBS00007--2 MeContext=LTE02ERBS00006-- →
2 MeContext=LTE02ERBS00007,ManagedElement=1-647497937 MeContext= →
LTE02ERBS00007,ManagedElement=1-647497936 MeContext=LTE02ERBS000 →
07,ManagedElement=1-647497935 MeContext=LTE02ERBS00006,ManagedEl →
ement=1-612424562 MeContext=LTE02ERBS00006,ManagedElement=1-6124 →
24561 MeContext=LTE02ERBS00006,ManagedElement=1-612424560 MeCont →
ext=LTE02ERBS00007,ManagedElement=1-736447021 MeContext=LTE02ERB →
S00007,ManagedElement=1-736447018 MeContext=LTE02ERBS00006,Manag →
edElement=1-316930190 MeContext=LTE02ERBS00006,ManagedElement=1- →
316930187 MeContext=LTE02ERBS00007,ManagedElement=1-687435964 Me →
Context=LTE02ERBS00007,ManagedElement=1-195359517 MeContext=LTE0 →
2ERBS00007,ManagedElement=1-195359516 MeContext=LTE02ERBS00007,M →
anagedElement=1-195359514 MeContext=LTE02ERBS00007,ManagedElemen →
t=1-195359513 MeContext=LTE02ERBS00006,ManagedElement=1-18494537 →
3 MeContext=LTE02ERBS00006,ManagedElement=1-75239644 MeContext=L →
TE02ERBS00006,ManagedElement=1-75239643 MeContext=LTE02ERBS00006 →
,ManagedElement=1-75239641 MeContext=LTE02ERBS00006,ManagedEleme →
nt=1-75239640 Operation Successful for 28 alarm(s) .

Acknowledge the alarms with a specific severity in a node

alarm ack ERBS001 -cri

Response

MeContext=ERBS001 Operation Successful for 1 alarm(s) .

Acknowledge the alarms with a specific severity in a collection and in a node

alarm ack MyCollection;ERBS001 -min

Response

44 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842 →
MeContext=LTE02ERBS00004,EUtranCellFDD=LTE02ERBS00004-6-7495684 →
2 MeContext=ERBS001 Operation Successful for 3 alarm(s) .

Acknowledge all the alarms of a VirtualNetworkFunctionManager

alarm ack VirtualNetworkFunctionManager=ECM_01

Response

VirtualNetworkFunctionManager=ECM_01,Region=RegionOne,CeeFunctio →
n=1,CtrlDomain=1,CIC=cic-1-489 Operation Successful for 1 alarm( →
s) .

Acknowledge all the alarms in the network starting from a specific date and
time

alarm ack -b 2016-06-29

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842 →
MeContext=LTE02ERBS00005,MeContext=ERBS001 Operation Successful →
for 3 alarm(s) .

Acknowledge the alarms in the network with a specif attribute name

alarm ack -sp "Database Space Warning Level"

or

alarm ack --specificProblem "Database Space Warning Level"

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842 →
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-5-9318281 →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 45

 ENM CLI

23 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-4-71496 →
3580 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-3-498 →
099037 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-2-2 →
81234494 MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-1 →
-64369951 Operation Successful for 6 alarm(s) .

Acknowledge a single alarm in the network

alarm ack --objectOfReference ManagedElement=LTE04dg2ERBS00001 - →

id 53400

or

alarm ack -oor ManagedElement=LTE04dg2ERBS00001 -id 53400

Response

ManagedElement=LTE04dg2ERBS00001,EUtranCellFDD=LTE04dg2ERBS00001 →
-6-74950842 Operation Successful for 1 alarm(s) .

Acknowledge alarms using MeContext value to search nodes

alarm ack SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCont →

ext=NODE2

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2 →
Operation Successful for 2 alarm(s) .

Acknowledge of all primary alarms in the network

alarm ack * --primary

Response

SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS08--2 SubN →

etwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS05--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS09--2 →

46 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

MeContext=RNC01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →

ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS04 →
--2 MeContext=RNC01RBS05--2 MeContext=RNC01RBS09--2 MeContext=RN →
C01RBS07--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS08--2 MeCo →
ntext=RNC01RBS05--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContex →
t=RNC01RBS04--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS07--2 →
MeContext=RNC01RBS09--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →
ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS05 →
--2 MeContext=RNC01RBS09--2 MeContext=RNC01RBS04--2 MeContext=RN →
C01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01R →
BS05--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS09--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS08--2 →
Operation Successful for 37 alarm(s) .

Acknowledge of all secondary alarms in the network

alarm ack * --secondary

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2 →
Operation Successful for 2 alarm(s) .

Acknowledge of all the alarms of the node and related alarms for each
primary alarm.

alarm ack LTE01 --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 2 alarm(s) . Correlated →

alarm(s) added: 4

Acknowledge of all the alarms of the node with current severity minor and
related alarms for each primary alarm regardless any filter. Related alarms can
be raised on different nodes with different severity.

alarm ack LTE01 --minor --relatedAlarms

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 47

 ENM CLI

MeContext=LTE01 Operation Successful for 1 alarm(s) . Correlated →

alarm(s) added: 2

Acknowledge of all secondary alarms of the node. No related alarms are

found.

alarm ack LTE01 --secondary --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 1 alarm(s).

2.3.12 alarm clear

< Back To Alarm

Syntax

Syntax to clear alarms in the network nodes

alarm clear scope [quick_filter] [filter]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

48 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of managed objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

1/1553-CNA 403 2979 Uen AV | 2020-12-07 49

 ENM CLI

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm clear command by specifying
either the severity, state or both. If not specified, all instances are involved.

-ack, --ack

Filter acknowledged alarms.

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

50 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Filter alarms with severity minor.

-unack, --unack

Filter unacknowledged alarms.

-und, --undefined

Filter alarms with severity undefined.

-war, --warning

Filter alarms with severity warning.

--primary

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the alarms that are cleared by specifying an alarm attribute.
If not specified, all alarms are cleared.

-<attributeShortName>, --<attributeName>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 51

 ENM CLI

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

— -cv, --correlatedVisibility

— -evt, --eventType

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

52 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

Specify the alarmId to filter alarms.

Note that alarmId is not unique in the ENM scope. To clear a single alarm, filter
also by objectOfReference.

-ta, --timeAttribute

Specify the attribute to be used by --begin and --end options. The available
values are:

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --begin

1/1553-CNA 403 2979 Uen AV | 2020-12-07 53

 ENM CLI

Specify a starting date or time for filtering the alarms. The default attribute is the
eventTime The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (00:00:00 is assumed).

-e, --end

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

--relatedAlarms

Specify to clear related alarms for each selected primary alarm. The alarms, that
are already cleared, are skipped.

Description
alarm clear is used to clear alarms for the network nodes.

Command Consequences

— All alarms satisfying the quick filters are cleared.

— Performing an alarm get command using the same filters and quick filters,
nothing is shown.

Examples

Clear the alarms with specific severities for the nodes that match a string
starting with a specific name

alarm clear ERBS* -cri -maj

Response

MeContext=ERBS0002,EUtranCellFDD=ERBS0002-2-79950842 MeContext=E →
RBS0003,EUtranCellFDD=ERBS0003-9-18950842 MeContext=ERBS0005,EUt →
ranCellFDD=ERBS0005-7-71950842 MeContext=ERBS0006,EUtranCellFDD= →
ERBS0006-8-78950842 Operation Successful for 4 alarm(s) .

54 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Clear the alarms with a specific severity for the nodes that match a string
starting with a specific name

alarm clear E* -maj

or

alarm clear E* --major

Response

MeContext=ERBS0002,EUtranCellFDD=ERBS0002-2-79950842 MeContext=E →
RBS0003,EUtranCellFDD=ERBS0003-9-18950842 MeContext=ERBS0005,EUt →
ranCellFDD=ERBS0005-7-71950842 MeContext=ERBS0006,EUtranCellFDD= →
ERBS0006-8-78950842 Operation Successful for 4 alarm(s) .

Clear a single alarm in the network

alarm clear --objectOfReference ManagedElement=LTE04dg2ERBS00001 →

-id 53400

or

alarm clear -oor ManagedElement=LTE04dg2ERBS00001 -id 53400

Response

ManagedElement=LTE04dg2ERBS00001 Operation Successful for 1 alar →

m(s) .

Clear the acknowledged alarms for a collection and for a single node

alarm clear MyCollection;ERBS001 -ack

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 55

 ENM CLI

MeContext=ERBS0001,EUtranCellFDD=ERBS0001-8-78950842 MeContext=L →
TE0001,EUtranCellFDD=LTE0001-2-74910842 MeContext=LTE0002,EUtran →
CellFDD=LTE0002-6-74950842 Operation Successful for 3 alarm(s) .

Clear alarms using MeContext value to search nodes

alarm clear SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCo →

ntext=NODE2

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2 →
Operation Successful for 2 alarm(s) .

Clear all primary alarms in the network

alarm clear * --primary

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2 →
Operation Successful for 2 alarm(s) .

Clear all secondary alarms in the network

alarm clear * --secondary

Response

SubNetwork=NET1,MeContext=NODE3 Operation Successful for 1 alar →

m(s) .

Clear all alarms in the node and related alarms for each primary alarms.

alarm clear LTE01 --relatedAlarms

Response

56 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

MeContext=LTE01 Operation Successful for 2 alarm(s) . Correlated →

alarm(s) added: 4

Clear all the alarms of the node with current severity minor and related alarms
for each primary alarm regardless any filter. Related alarms can be raised on
different nodes with different severity.

alarm clear LTE01 --minor --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 1 alarm(s) . Correlated →

alarm(s) added: 2

Clear all secondary alarms of the node. No related alarms are found.

alarm clear LTE01 --secondary --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 1 alarm(s).

2.3.13 alarm comment

< Back To Alarm

Syntax

Syntax to add a comment to alarms

alarm comment "<comment_value>" scope [quick_filter] →

[filter]

Syntax to view alarm comments

1/1553-CNA 403 2979 Uen AV | 2020-12-07 57

 ENM CLI

alarm comment scope [quick_filter] [filter]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of managed objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

58 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm comment command by specifying
either the severity, state or both. If not specified, all instances are involved.

-ack, --ack

Filter acknowledged alarms.

-cle, --cleared

Filter alarms that are cleared.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 59

 ENM CLI

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

Filter alarms with severity minor.

-unack, --unack

Filter unacknowledged alarms.

-und, --undefined

Filter alarms with severity undefined.

60 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-war, --warning

Filter alarms with severity warning.

--primary

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the alarms that are commented by specifying an alarm
attribute. If not specified, all the alarms are commented.

-<attributeShortName>, --<attributeName>

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

1/1553-CNA 403 2979 Uen AV | 2020-12-07 61

 ENM CLI

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

— -cv, --correlatedVisibility

— -evt, --eventType

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

62 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Specify the alarmId for filtering alarms.

Note that alarmId is not unique in the ENM scope. To view comment/add
comment of a single alarm, filter also by objectOfReference.

-ta, --timeAttribute

Specify the attribute to be used by --begin and --end options. The available
values are:

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --begin

Specify a starting date or time for filtering the alarms. The default attribute is the
eventTime The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (00:00:00 is assumed).

-e, --end

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

Description
alarm comment is used to:
— Add a comment to alarms for the network nodes.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 63

 ENM CLI

— View alarm comments for the network nodes.

Command Consequences

— In case of add comment action:

• All the alarms satisfying the quick filters are commented.

— In case of view comment action:

• No consequences.

Examples

Add a comment to the alarms with a specific severity for a node

alarm comment "My critical comment" ERBS001 --critical

Response

MeContext=ERBS001--2 Operation Successful for 1 alarm(s) .

Add a comment to the alarms with specific severities for a collection

alarm comment "My useful comment" MyCollection -min -war

Response

MeContext=RNC01RBS05--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →

ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS04 →
--2 MeContext=RNC01RBS09--2 MeContext=RNC01RBS07--2 MeContext=LT →
E02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842 MeContext=L →
TE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-5-931828123 MeContext →
=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-4-714963580 MeConte →
xt=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-3-498099037 MeCon →
text=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-2-281234494 MeC →
ontext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-1-64369951 Op →
eration Successful for 13 alarm(s) .

Add a comment to the alarm with a specific Id attribute

alarm comment "My wise comment" -id 10234

64 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-1-64369951 →
Operation Successful for 1 alarm(s) .

View the comment for the alarm with a specific Id attribute

alarm comment -id 10234

Response

This command displays the following information for the alarm

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :1

View the comment for all the alarm in the newtwork

alarm comment *

Response

This command displays the following information for all the alarms in the
network

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :109

View the comment for a single alarm in the newtwork

1/1553-CNA 403 2979 Uen AV | 2020-12-07 65

 ENM CLI

alarm comment --objectOfReference ManagedElement=LTE04dg2ERBS000 →

01 -id 53400

or

alarm comment -oor ManagedElement=LTE04dg2ERBS00001 -id 53400;

Response

This command displays the following information for the alarm

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :1

View the comment for alarms using MeContext value to search nodes

alarm comment SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,Me →

Context=NODE2

Response

This command displays the following information for the alarms

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :30

View the comment of all primary alarms in the network

alarm comment * --primary

Response

This command displays the following information for the alarms

66 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :30

View the comment of all secondary alarms in the network

alarm comment * --secondary

Response

This command displays the following information for the alarms

— NodeName

— commentText

— alarmId

Total number of alarms fetched for the given query is :30

2.3.14 alarm disable

< Back To Alarm

Syntax

Syntax to disable alarm supervision for the network nodes

alarm disable scope [quick_filter] [attributes]

Scope
Use the scope to specify node names or collections or both to search on.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 67

 ENM CLI

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of managed objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign

68 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Character Description
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm disable command by specifying
either the severity, state or both. If not specified, all instances are involved.

-dis, --disabled

Filter nodes with supervision disabled.

-en, --enabled

Filter nodes with supervision enabled.

-fail, --failed

Filter nodes with heartbeat failure.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 69

 ENM CLI

-ok, --inservice

Filter nodes with supervision working.

--ongoing

Filter nodes with sync on going.

--suppressed

Filter nodes with alarm suppressed.

--suspended

Filter nodes with Node suspended to true.

--technician

Filter nodes with technician present.

Attributes
<attribute name>=<value>

Attribute values are specified by giving the name followed by "=" and then the
value. The supported attributes are:
— automaticSynchronization: the value admitted are true or false.

— heartbeatTimeout: the value admitted is a positive integer.

— heartbeatinterval: the value admitted is a positive integer.

70 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Description
alarm disable is used to:
— Disable supervision for the nodes in the network.

— Set automaticSynchronization.

— Unset automaticSynchronization.

— Define values for heartbeatTimeout.

— Define values for heartbeatinterval.

Command Consequences

— The supervision is disabled and the attributes (heartbeatTimeout,

heartbeatinterval and automaticSynchronization) are changed to the values
specified but their can not be used until the next alarm supervision status
transition from disabled to enabled.

Examples

Disable alarm supervision for all the nodes in the network

alarm disable *

Response

[NetworkElement=LTE09ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE09ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE09E →
RBS00002, NetworkElement=LTE09ERBS00001, NetworkElement=RNC01RBS →
08, NetworkElement=LTE09ERBS00005, NetworkElement=LTE09ERBS00006 →
, NetworkElement=RNC01RBS05]Alarm Supervision has been disabled →
successfully for 12 instance(s).

Disable alarm supervision for a node

alarm disable LTE09ERBS00001

Response

[NetworkElement=LTE09ERBS00001]Alarm Supervision has been disabl →

ed successfully for 1 instance(s).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 71

 ENM CLI

Disable alarm supervision for a management system

alarm disable ManagementSystem=ECI-LightSoft02

Response

[ManagementSystem=ECI-LightSoft02]Alarm Supervision has been dis →

abled successfully for 1 instance(s).

Disable alarm supervision for multiple nodes

alarm disable LTE09ERBS00001;LTE09ERBS00002

Response

[NetworkElement=LTE09ERBS00002, NetworkElement=LTE09ERBS00001]Al →
arm Supervision has been disabled successfully for 2 instance(s) →
.

Disable alarm supervision for multiple management systems

alarm disable ManagementSystem=ECI-LightSoft02;ManagementSystem= →

ECI-LightSoft03

Response

[ManagementSystem=ECI-LightSoft03, ManagementSystem=ECI-LightSof →
t02]Alarm Supervision has been disabled successfully for 2 insta →
nce(s).

Disable alarm supervision for multiple nodes that match a string starting with
a specific name

alarm disable LTE09*

Response

72 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

[NetworkElement=LTE09ERBS00003, NetworkElement=LTE09ERBS00007, N →
etworkElement=LTE09ERBS00002, NetworkElement=LTE09ERBS00001, Net →
workElement=LTE09ERBS00005, NetworkElement=LTE09ERBS00006, Netwo →
rkElement=LTE09ERBS00004]Alarm Supervision has been disabled suc →
cessfully for 7 instance(s).

Disable alarm supervision for multiple management systems that match a

string starting with a specific name

alarm disable ManagementSystem=ECI*

Response

[ManagementSystem=ECI-LightSoft01, ManagementSystem=ECI-LightSof →
t03, ManagementSystem=ECI-LightSoft02]Alarm Supervision has been →
disabled successfully for 3 instance(s).

Disable alarm supervision for a collection

alarm disable MyCollection

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02E →
RBS00002, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, N →
etworkElement=RNC01RBS08, NetworkElement=LTE02ERBS00005, Network →
Element=LTE02ERBS00006, NetworkElement=RNC01RBS05]Alarm Supervis →
ion has been disabled successfully for 13 instance(s).

Disable alarm supervision using MeContext value to search nodes

alarm disable SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,Me →

Context=NODE2

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 73

 ENM CLI

[NetworkElement=NODE1, NetworkElement=NODE2]Alarm Supervision ha →

s been disabled successfully for 2 instance(s).

2.3.15 alarm enable

< Back To Alarm

Syntax

Syntax to enable alarm supervision for the network nodes

alarm enable scope [quick_filter] [attributes]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

74 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

is the name of a collection of managed objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of the alarm enable command by specifying
either the severity, state or both. If not specified, all instances are involved.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 75

 ENM CLI

-dis, --disabled

Filter nodes with supervision disabled.

-en, --enabled

Filter nodes with supervision enabled.

-fail, --failed

Filter nodes with heartbeat failure.

-ok, --inservice

Filter nodes with supervision working.

--ongoing

Filter nodes with sync on going.

--suppressed

Filter nodes with alarm suppressed.

--suspended

Filter nodes with Node suspended to true.

76 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

--technician

Filter nodes with technician present.

Attributes
<attribute name>=<value>

Attribute values are specified by giving the name followed by "=" and then the
value. The supported attributes are:
— automaticSynchronization: the value admitted are true or false.

— heartbeatTimeout: the value admitted is a positive integer.

— heartbeatinterval: the value admitted is a positive integer.

Description
alarm enable is used to:
— Enable supervision for the nodes in the network.

— Set automaticSynchronization.

— Unset automaticSynchronization.

— Define values for heartbeatTimeout.

— Define values for heartbeatinterval.

Command Consequences

— The alarm supervision is enabled and the attributes are changed to the
values specified.

Note: Changes of the heartbeat timeout, heartbeat interval, and the automatic
synchronization values are applied only when the alarm supervision status
switch form disable to enabled. These values can also be changed if the
supervision is either disabled or already enabled, but the values can not be used
until the next transition from disabled to enabled.

Examples

Enable alarm supervision for all the nodes in the network

alarm enable *

1/1553-CNA 403 2979 Uen AV | 2020-12-07 77

 ENM CLI

Response

[NetworkElement=LTE09ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE09ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE09E →
RBS00002, NetworkElement=LTE09ERBS00001, NetworkElement=RNC01RBS →
08, NetworkElement=LTE09ERBS00005, NetworkElement=LTE09ERBS00006 →
, NetworkElement=RNC01RBS05]Alarm Supervision has been enabled s →
uccessfully for 12 instance(s).

Enable alarm supervision for a node

alarm enable LTE09ERBS00001

Response

[NetworkElement=LTE09ERBS00001]Alarm Supervision has been enable →

d successfully for 1 instance(s).

Enable alarm supervision for a management system

alarm enable ManagementSystem=ECI-LightSoft02

Response

[ManagementSystem=ECI-LightSoft02]Alarm Supervision has been ena →

bled successfully for 1 instance(s).

Enable alarm supervision for multiple nodes

alarm enable LTE09ERBS00001;LTE09ERBS00002

Response

[NetworkElement=LTE09ERBS00002, NetworkElement=LTE09ERBS00001]Al →
arm Supervision has been enabled successfully for 2 instance(s).

78 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Enable alarm supervision for multiple management systems

alarm enable ManagementSystem=ECI-LightSoft02;ManagementSystem=E →

CI-LightSoft03

Response

[ManagementSystem=ECI-LightSoft03, ManagementSystem=ECI-LightSof →
t02]Alarm Supervision has been enabled successfully for 2 instan →
ce(s).

Enable alarm supervision for multiple nodes that match a string starting with
a specific name

alarm enable LTE09*

Response

[NetworkElement=LTE09ERBS00003, NetworkElement=LTE09ERBS00007, N →
etworkElement=LTE09ERBS00002, NetworkElement=LTE09ERBS00001, Net →
workElement=LTE09ERBS00005, NetworkElement=LTE09ERBS00006, Netwo →
rkElement=LTE09ERBS00004]Alarm Supervision has been enabled succ →
essfully for 7 instance(s).

Enable alarm supervision for multiple management systems that match a

string starting with a specific name

alarm enable ManagementSystem=ECI*

Response

[ManagementSystem=ECI-LightSoft01, ManagementSystem=ECI-LightSof →
t03, ManagementSystem=ECI-LightSoft02]Alarm Supervision has been →
enabled successfully for 3 instance(s).

Enable alarm supervision for multiple nodes that match a string ending with a
specific name

1/1553-CNA 403 2979 Uen AV | 2020-12-07 79

 ENM CLI

alarm enable *0001

Response

[NetworkElement=RNC01RBS0001, NetworkElement=LTE09ERBS00001]Alar →
m Supervision has been enabled successfully for 2 instance(s).

Enable alarm supervision in multiple nodes that match a string containing a

specific name

alarm enable *ERBS*

Response

[NetworkElement=LTE09ERBS00003, NetworkElement=LTE09ERBS00007, N →
etworkElement=LTE09ERBS00002, NetworkElement=LTE09ERBS00001, Net →
workElement=LTE09ERBS00005, NetworkElement=LTE09ERBS00006, Netwo →
rkElement=LTE09ERBS00004]Alarm Supervision has been enabled succ →
essfully for 7 instance(s).

Enable alarm supervision and auto synchronization for a node

alarm enable LTE09ERBS00001 automaticSynchronization=true

Response

[NetworkElement=LTE09ERBS00001]Succesfully modified the given va →

lue. It will be applicable when the supervision is ON again for →
1 instance(s).[NetworkElement=LTE09ERBS00001]Alarm Supervision h →
as been enabled successfully for 1 instance(s).

Disable auto synchronization for a node

alarm enable NetworkElement=LTE09ERBS00001 automaticSynchronizat →

ion=false

Response

80 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

[NetworkElement=LTE09ERBS00001]Succesfully modified the given va →

lue. It will be applicable when the supervision is ON again for →
1 instance(s).[NetworkElement=LTE09ERBS00001]Alarm Supervision h →
as been enabled successfully for 1 instance(s).

Disable auto synchronization for all the nodes in the network

alarm enable * automaticSynchronization=false

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02E →
RBS00002, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, N →
etworkElement=RNC01RBS08, NetworkElement=LTE02ERBS00005, Network →
Element=LTE02ERBS00006, NetworkElement=RNC01RBS05]Succesfully mo →
dified the given value. It will be applicable when the supervisi →
on is ON again for 13 instance(s).[NetworkElement=LTE02ERBS00003 →
, NetworkElement=RNC01RBS07, NetworkElement=RNC01RBS09, NetworkE →
lement=LTE02ERBS00007, NetworkElement=RNC01RBS04, NetworkElement →
=RNC01RBS06, NetworkElement=LTE02ERBS00002, NetworkElement=LTE02 →
ERBS00001, NetworkElement=RNC01, NetworkElement=RNC01RBS08, Netw →
orkElement=LTE02ERBS00005, NetworkElement=LTE02ERBS00006, Networ →
kElement=RNC01RBS05]Alarm Supervision has been enabled successfu →
lly for 13 instance(s).

Enable auto synchronization for multiple nodes

alarm enable LTE09ERBS00001;LTE09ERBS00002 automaticSynchronizat →

ion=true

Response

[NetworkElement=LTE09ERBS00001, NetworkElement=LTE09ERBS00002]Su →
ccesfully modified the given value. It will be applicable when t →
he supervision is ON again for 2 instance(s).[NetworkElement=LTE →
09ERBS00001, NetworkElement=LTE09ERBS00002]Alarm Supervision has →
been enabled successfully for 2 instance(s).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 81

 ENM CLI

Disable auto synchronization for multiple nodes that match a string starting
with a specific name

alarm enable LTE02* automaticSynchronization=false

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=LTE02ERBS00002, N →
etworkElement=LTE02ERBS00001, NetworkElement=LTE02ERBS00007, Net →
workElement=LTE02ERBS00005, NetworkElement=LTE02ERBS00006]Succes →
fully modified the given value. It will be applicable when the s →
upervision is ON again for 6 instance(s).[NetworkElement=LTE02ER →
BS00003, NetworkElement=LTE02ERBS00002, NetworkElement=LTE02ERBS →
00001, NetworkElement=LTE02ERBS00007, NetworkElement=LTE02ERBS00 →
005, NetworkElement=LTE02ERBS00006]Alarm Supervision has been en →
abled successfully for 6 instance(s).

Set heartbeat timeout in all the nodes in the network

alarm enable * heartbeatTimeout=400

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02E →
RBS00002, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, N →
etworkElement=RNC01RBS08, NetworkElement=LTE02ERBS00005, Network →
Element=LTE02ERBS00006, NetworkElement=RNC01RBS05]Successfully m →
odified the given [heartbeatTimeout] for 13 instance(s).[Network →
Element=LTE02ERBS00003, NetworkElement=RNC01RBS07, NetworkElemen →
t=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElement=RNC0 →
1RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02ERBS00002 →
, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, NetworkEl →
ement=RNC01RBS08, NetworkElement=LTE02ERBS00005, NetworkElement= →
LTE02ERBS00006, NetworkElement=RNC01RBS05]Alarm Supervision has →
been enabled successfully for 13 instance(s).

Set heartbeat timeout for a node

alarm enable LTE09ERBS00001 heartbeatTimeout=200

Response

82 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

[NetworkElement=LTE09ERBS00001]Successfully modified the given [ →

heartbeatTimeout] for 1 instance(s).[NetworkElement=LTE09ERBS000 →
01]Alarm Supervision has been enabled successfully for 1 instanc →
e(s).

Set heartbeat timeout for multiple nodes

alarm enable LTE02ERBS00001;LTE02ERBS00002 heartbeatTimeout=100

Response

[NetworkElement=LTE02ERBS00002, NetworkElement=LTE02ERBS00001]Su →
ccessfully modified the given [heartbeatTimeout] for 2 instance( →
s).[NetworkElement=LTE02ERBS00002, NetworkElement=LTE02ERBS00001 →
]Alarm Supervision has been enabled successfully for 2 instance( →
s).

Set heartbeat timeout for multiple nodes that match a string starting with a
specific name

alarm enable LTE02* heartbeatTimeout=200

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=LTE02ERBS00002, N →
etworkElement=LTE02ERBS00001, NetworkElement=LTE02ERBS00007, Net →
workElement=LTE02ERBS00005, NetworkElement=LTE02ERBS00006]Succes →
sfully modified the given [heartbeatTimeout] for 6 instance(s).[ →
NetworkElement=LTE02ERBS00003, NetworkElement=LTE02ERBS00002, Ne →
tworkElement=LTE02ERBS00001, NetworkElement=LTE02ERBS00007, Netw →
orkElement=LTE02ERBS00005, NetworkElement=LTE02ERBS00006]Alarm S →
upervision has been enabled successfully for 6 instance(s).

Set heartbeat timeout in multiple nodes that match a string ending with a
specific name

alarm enable *00002 heartbeatTimeout=100

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 83

 ENM CLI

[NetworkElement=LTE02ERBS00002]Successfully modified the given [ →

heartbeatTimeout] for 1 instance(s).[NetworkElement=LTE02ERBS000 →
02]Alarm Supervision has been enabled successfully for 1 instanc →
e(s).

Enable alarm supervision for all the nodes in the network and set both the
heartbeatInterval and heartbeatTimeout

alarm enable * heartbeatInterval=6 heartbeatTimeout=11

Response

[NetworkElement=LTE02ERBS00003, NetworkElement=RNC01RBS07, Netwo →

rkElement=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElem →
ent=RNC01RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02E →
RBS00002, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, N →
etworkElement=RNC01RBS08, NetworkElement=LTE02ERBS00005, Network →
Element=LTE02ERBS00006, NetworkElement=RNC01RBS05]Successfully m →
odified the given [heartbeatTimeout] for 13 instance(s).[Network →
Element=LTE02ERBS00003, NetworkElement=RNC01RBS07, NetworkElemen →
t=RNC01RBS09, NetworkElement=LTE02ERBS00007, NetworkElement=RNC0 →
1RBS04, NetworkElement=RNC01RBS06, NetworkElement=LTE02ERBS00002 →
, NetworkElement=LTE02ERBS00001, NetworkElement=RNC01, NetworkEl →
ement=RNC01RBS08, NetworkElement=LTE02ERBS00005, NetworkElement= →
LTE02ERBS00006, NetworkElement=RNC01RBS05]Successfully modified →
the given [heartbeatinterval] for 13 instance(s).[NetworkElement →
=LTE02ERBS00003, NetworkElement=RNC01RBS07, NetworkElement=RNC01 →
RBS09, NetworkElement=LTE02ERBS00007, NetworkElement=RNC01RBS04, →
NetworkElement=RNC01RBS06, NetworkElement=LTE02ERBS00002, Netwo →
rkElement=LTE02ERBS00001, NetworkElement=RNC01, NetworkElement=R →
NC01RBS08, NetworkElement=LTE02ERBS00005, NetworkElement=LTE02ER →
BS00006, NetworkElement=RNC01RBS05]Alarm Supervision has been en →
abled successfully for 13 instance(s).

Enable alarm supervision for TCU02 and SIU02 nodes in the network and set
both the heartbeatInterval and heartbeatTimeout

Note: Prevent the node goes into timeout (heatbeatFailure), sett →

ing the values of Heartbeat Timeout and Heartbeat Interval suppo →
rted by the node.

In general set the Heartbeat Timeout and Interval values not too →
low compared to the default values.

84 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

For example the following are the lowest values supported by a T →

CU02 and SIU02 Nodes :

HB timeout=360 and HB Interval=120.

The HB interval and timeout should be multiple of 60.

alarm enable TCU02_node heartbeatinterval=120 heartbeatTimeout=3 →

60

Response

[NetworkElement=TCU02_node]Successfully modified the given [hear →

tbeatTimeout] for 1 instance(s).[NetworkElement=TCU02_node]Succe →
ssfully modified the given [heartbeatinterval] for 1 instance(s) →
.[NetworkElement=TCU02_node]Alarm Supervision has been enabled s →
uccessfully for 1 instance(s).

Enable alarm supervision for all the nodes with a given value of
ManagedElement

alarm enable ManagedElement=NODE1

Response

[NetworkElement=NODE1]Alarm Supervision has been enabled success →

fully for 1 instance(s).

Enable alarm supervision for a collection

alarm enable MyCollection

Response

[NetworkElement=RNC01RBS07, NetworkElement=RNC01RBS06, NetworkEl →

ement=RNC01RBS09, NetworkElement=RNC01, NetworkElement=RNC01RBS0 →
4, NetworkElement=RNC01RBS08, NetworkElement=RNC01RBS05]Alarm Su →
pervision has been enabled successfully for 7 instance(s).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 85

 ENM CLI

Enable alarm supervision using MeContext value to search nodes

alarm enable SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeC →

ontext=NODE2

Response

[NetworkElement=NODE1, NetworkElement=NODE2]Alarm Supervision ha →

s been enabled successfully for 2 instance(s).

2.3.16 alarm get

< Back To Alarm

Syntax

Syntax to get open alarms in the network

alarm get scope [quick_filter] [filter] [options]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName> is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

86 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName> is the name of a collection of managed objects. The supported

managed objects are: NetworkElement, ManagementSytem and
VirtualNetworkFunctionManager. One or more collections can be defined as
scope. Multiple collection names must be separated with a semi-colon, for
example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm get command by specifying either
the severity, state or both. If not specified, all instances are involved.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 87

 ENM CLI

-ack, --ack

Filter acknowledged alarms.

-cle, --cleared

Filter alarms that are cleared.

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

Filter alarms with severity minor.

-unack, --unack

Filter unacknowledged alarms.

-und, --undefined

Filter alarms with severity undefined.

88 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-war, --warning

Filter alarms with severity warning.

--primary

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the output of the get command by specifying an alarm
attribute.

-<attributeShortName>, --<attributeName>

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

— -cv, --correlatedVisibility

1/1553-CNA 403 2979 Uen AV | 2020-12-07 89

 ENM CLI

— -evt, --eventType

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

Specify the alarmId to filter alarms. Note that alarmId is not unique in the ENM
scope. To get a single alarm, filter also by objectOfReference.

-ta, --timeAttribute

Specify the attribute to be used by--beginand--endoptions. The available values

are:

90 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --beginSpecify a starting date or time for filtering the alarms. The default
attribute is the eventTime The format is YYYY-MM-DDThh:mm:ss. The time part
is an optional attribute (00:00:00 is assumed).

-e, --end

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

--correlation-group

Specify a correlation group to filter related alarms. Alarms are ordered by root
column.

Options
Use the options to further restrict the output specification.

--count, -ct

Show only the number of matching alarms.

--export, -xp

Export to a CSV file the matching alarms.

--list, -l

Specify the format of the output as a list. The default is a table.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 91

 ENM CLI

--verbose, -v

Show all the attributes:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— alarmingObject

— alarmNumber

— backupObjectInstance

— backupStatus

— trendIndication

— previousSeverity

— proposedRepairAction

— ceaseTime

— ceaseOperator

— ackTime

— ackOperator

— problemDetail

— additionalInformation

92 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— commentText

— insertTime

— eventPoId

— processingType

— fmxGenerated

— visibility

— lastUpdated

— commentTime

— repeatCount

--view-correlationInfo, -vci

Add the following attributes to the default view:

— root

— ciFirstGroup

— ciSecondGroup

The ciFirstGroup and ciSecondGroup attributes refers to correlation UUID alarm

and they can be used to retrieve alarms belonging to the same group (see --
correlation-group filter option for further details).

Description
alarm get is used to query alarms for the network nodes.

The output is ordered by severity from critical to cleared.

The output is ordered by event time from the more recent to the less recent.

Command Consequences

— No consequences with the alarm get command.

Examples

Get all the alarms in the network

alarm get *

1/1553-CNA 403 2979 Uen AV | 2020-12-07 93

 ENM CLI

Response

This command displays the following information for all the alarms in the
network. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :78

Get all the alarms for a node

alarm get ERBS001

Response

This command displays the following information for all the alarms of the
specified node. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

94 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :5

Get all the internal alarms and alarms for a node

alarm get ENM;ERBS001

Response

This command displays the following information for the alarms. The output is
formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :10

1/1553-CNA 403 2979 Uen AV | 2020-12-07 95

 ENM CLI

Get all the alarms for a collection

alarm get MyCollection

Response

This command displays the following information for the alarms of the nodes in
MyCollection. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :17

Get all the alarms for a VirtualNetworkFunctionManager

alarm get VirtualNetworkFunctionManager=ECM_01

Response

This command displays the following information for the alarms of the specified
VNF Manager. The output is formatted as a table:

— presentSeverity

— NodeName

96 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

Get the alarms with specific severities for the nodes that match a string
starting with a specific name

alarm get ERBS* -cri -war

or

alarm get ERBS* --critical --warning

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

1/1553-CNA 403 2979 Uen AV | 2020-12-07 97

 ENM CLI

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :3

Export the alarms with specific severities for the nodes that match a string
starting with a specific name

alarm get ERBS* -cri -war --xp

or

alarm get ERBS* --critical --warning --export

Response

Number of alarms found is : 3 Download started for file : /erics →

son/tor/no_rollback/fmexport/data/administrator_AlarmCli_1494598 →
540407.csv

Get the alarms with all the attributes and specific severities for the nodes that
match a string starting with a specific name

alarm get ERBS00* --critical --minor --verbose

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

98 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— alarmingObject

— alarmNumber

— backupObjectInstance

— backupStatus

— trendIndication

— previousSeverity

— proposedRepairAction

— ceaseTime

— ceaseOperator

— ackTime

— ackOperator

— problemDetail

— additionalInformation

— commentText

— insertTime

— eventPoId

— processingType

— fmxGenerated

— visibility

— lastUpdated

1/1553-CNA 403 2979 Uen AV | 2020-12-07 99

 ENM CLI

— commentTime

— repeatCount

Total number of alarms fetched for the given query is :8

Get the alarms with specific severities starting a specific date and time for the
nodes that match a string starting with a specific name

alarm get ERBS001* --critical --minor --verbose --begin 2016-08- →

23T10:04:28

or

alarm get ERBS001* -cri -min -v -b 2016-08-23T10:04:28

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— alarmingObject

— alarmNumber

100 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— backupObjectInstance

— backupStatus

— trendIndication

— previousSeverity

— proposedRepairAction

— ceaseTime

— ceaseOperator

— ackTime

— ackOperator

— problemDetail

— additionalInformation

— commentText

— insertTime

— eventPoId

— processingType

— fmxGenerated

— visibility

— lastUpdated

— commentTime

— repeatCount

Total number of alarms fetched for the given query is :8

Get all the alarms acknowledged until a specific date and time for the nodes
that match a string starting with a specific name

alarm get ERBS001* --timeattribute ackTime --end 2016-08-23T10:0 →

4:28

1/1553-CNA 403 2979 Uen AV | 2020-12-07 101

 ENM CLI

or

alarm get ERBS001* -ta ackTime -e 2016-08-23T10:04:28

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :2

Get all the alarms for the network raised in a specific date and time interval

alarm get * --begin 2016-06-20 --end 2016-06-21

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

102 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

Get all the alarms in the network with a specif attribute name

alarm get * --specificProblem "Database Space Warning Level"

or

alarm get * -sp "Database Space Warning Level"

Response

This command displays the following information for the alarms specified by
filter options. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

1/1553-CNA 403 2979 Uen AV | 2020-12-07 103

 ENM CLI

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

get the default attributes for the alarm with a specific Id

alarm get * -id 403969345

Response

This command displays the following information for the alarm with the specified
id. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

get and display as a list all the alarms for the nodes that match a string
starting with a specific name

104 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

alarm get ERBS001* --list

or

alarm get ieatnetsimv5036-01_LTE01ERBS001* -l

Response

This command displays the following information for all the alarms of nodes
matching the specified string in their name. The output is formatted as a list:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :8

Get a single alarm in the network

alarm get * --objectOfReference ManagedElement=LTE04dg2ERBS00001 →

-id 53400

or

alarm get * -oor ManagedElement=LTE04dg2ERBS00001 -id 53400;

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 105

 ENM CLI

This command displays the following information for the alarms matching the
search criteria. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

Get alarms using MeContext value to search nodes

alarm get SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCont →

ext=NODE2 --critical

Response

This command displays the following information for the alarms of the searched
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

106 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :13

Get alarms using ManagedElement value to search nodes

alarm get ManagedElement=NODE1 --warning

Response

This command displays the following information for the alarms of the searched
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :11

1/1553-CNA 403 2979 Uen AV | 2020-12-07 107

 ENM CLI

Get alarms using MeContext and ManagedElement values to search nodes

alarm get SubNetwork=NET1,MeContext=NODE1,ManagedElement=NODE1

Response

This command displays the following information for the alarms of the searched
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :11

Get and display default attributes, including correlation information, of all the
alarms in the network

alarm get * --view-correlationInfo

or

alarm get * -vci

Response

This command displays the following information for all the alarms. The output is
formatted as default:

108 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— root

— ciFirstGroup

— ciSecondGroup

Total number of alarms fetched for the given query is :8

Get and display default attributes of all primary alarms in the network

alarm get * --primary

Response

This command displays the following information for all the alarms. The output is
formatted as default:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

1/1553-CNA 403 2979 Uen AV | 2020-12-07 109

 ENM CLI

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :5

Get and display default attributes, including correlation information, of all

secondary alarms in the network

alarm get * --secondary --view-correlationInfo

Response

This command displays the following information for all the alarms. The output is
formatted as default:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— root

110 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— ciFirstGroup

— ciSecondGroup

Total number of alarms fetched for the given query is :12

Get and display default attributes, including root attribute, of all alarms with
specified correlation UUID in the network. Alarms are ordered by root column
(PRIMARY first).

alarm get * --correlation-group 81d4fae-7dec-11d0-a765-00a0c91e6 →

bf6

Response

This command displays the following information for all the alarms. The output is
formatted as default:

— root

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— ciFirstGroup

— ciSecondGroup

Total number of alarms fetched for the given query is :12

1/1553-CNA 403 2979 Uen AV | 2020-12-07 111

 ENM CLI

2.3.17 alarm hist

< Back To Alarm

Syntax

Syntax to get history alarms in the network

alarm hist scope [quick_filter] [filter] [options]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of Managed Objects.

112 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm hist command by specifying either
the severity, state or both. If not specified, all instances are involved.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 113

 ENM CLI

-ack, --ack

Filter acknowledged alarms.

-cle, --cleared

Filter alarms that are cleared.

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

Filter alarms with severity minor.

114 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-unack, --unack

Filter unacknowledged alarms.

-und, --undefined

Filter alarms with severity undefined.

-war, --warning

Filter alarms with severity warning.

--primary

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the output of the history command by specifying an alarm
attribute.

-<attributeShortName>, --<attributeName>

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 115

 ENM CLI

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

— -cv, --correlatedVisibility

— -evt, --eventType

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

116 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

Specify the alarmId attribute for filtering alarms.

-ta, --timeAttribute

Specify the attribute to be used by --begin and --end options. The available
values are:

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --begin

Specify a starting date or time for filtering the alarms. The default attribute is the
eventTime The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (00:00:00 is assumed).

-e, --end

1/1553-CNA 403 2979 Uen AV | 2020-12-07 117

 ENM CLI

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

Options
Use the options to further restrict the output specification.

--list, -l

Specify the format of the output as a list. The default is a table.

--verbose, -v

Show all the attributes:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

— alarmingObject

— alarmNumber

118 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— backupObjectInstance

— backupStatus

— trendIndication

— previousSeverity

— proposedRepairAction

— ceaseTime

— ceaseOperator

— ackTime

— ackOperator

— problemDetail

— additionalInformation

— commentText

— insertTime

— eventPoId

— processingType

— fmxGenerated

— visibility

— lastUpdated

— commentTime

— repeatCount

Description
alarm hist is used to query history alarms for the network nodes.

Command Consequences

— No consequences with the alarm history command.

Examples

Get history for all alarms in the network

1/1553-CNA 403 2979 Uen AV | 2020-12-07 119

 ENM CLI

alarm hist *

Response

This command displays the following information for history alarms of the
network. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :578

Get history for all alarms for a node

alarm hist ERBS001

Response

This command displays the following information for history alarms of the
specified node. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

120 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :54

Get history for all the internal alarms and alarms for a node

alarm hist ENM;ERBS001

Response

This command displays the following information for the alarms matching the
search criteria. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

1/1553-CNA 403 2979 Uen AV | 2020-12-07 121

 ENM CLI

Total number of alarms fetched for the given query is :78

Get history for a VirtualNetworkFunctionManager

alarm hist VirtualNetworkFunctionManager=ECM_01

Response

This command displays the following information for the alarms of the specified
VNF Manager. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :7

Get history for a collection

alarm hist MyCollection

Response

This command displays the following information for history alarms of nodes
specified in MyCollection. The output is formatted as a table:

122 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :12

Get history for the alarms with specific severities for the nodes that match a
string starting with a specific name

alarm hist ERBS* -cri -war

or

alarm hist ERBS* --critical --warning

Response

This command displays the following information for history alarms matching
the search criteria. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

1/1553-CNA 403 2979 Uen AV | 2020-12-07 123

 ENM CLI

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :5

Get history for the alarms with specific severities starting a specific date and
time for the nodes that match a string starting with a specific name

alarm hist ERBS001* --critical --begin 2016-06-20 --end 2016-06- →

21

Response

This command displays the following information for history alarms matching
the search criteria. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

124 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Total number of alarms fetched for the given query is :2

Get history data for the alarms in the network with a specif attributeNumber

alarm hist * -id 118234777

Response

This command displays the following information for history alarms with
specified id. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :1

Get history data for the alarms in the network with a specif recordType

alarm hist * --recordType "SYNCHRONIZATION_ALARM"

Response

This command displays the following information for history alarms matching
the search criteria. The output is formatted as a table:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 125

 ENM CLI

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :2

Get history data for the alarms using MeContext value to search nodes

alarm hist SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCon →

text=NODE2

Response

This command displays the following information for history alarms of specified
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

126 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :29

Get history data of all primary alarms in the network

alarm hist * --primary

Response

This command displays the following information for history alarms of specified
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :29

Get history data of all secondary alarms in the network

1/1553-CNA 403 2979 Uen AV | 2020-12-07 127

 ENM CLI

alarm hist * --secondary

Response

This command displays the following information for history alarms of specified
nodes. The output is formatted as a table:

— presentSeverity

— NodeName

— specificProblem

— eventTime

— objectOfReference

— problemText

— alarmState

— alarmId

— probableCause

— eventType

— recordType

Total number of alarms fetched for the given query is :10

2.3.18 alarm status

< Back To Alarm

Syntax

Syntax to get alarm supervision status for the nodes in the network

alarm status scope [quick_filter] [attributes] [opti →

ons]

128 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of Managed Objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

1/1553-CNA 403 2979 Uen AV | 2020-12-07 129

 ENM CLI

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm status command by specifying
either the severity, state or both. If not specified, all instances are involved.

-dis, --disabled

Filter nodes with supervision disabled.

-en, --enabled

Filter nodes with supervision enabled.

-fail, --failed

Filter nodes with heartbeat failure.

130 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-ok, --inservice

Filter nodes with supervision working.

--ongoing

Filter nodes with sync on going.

--suppressed

Filter nodes with alarm suppressed.

--suspended

Filter nodes with Node suspended to true.

--technician

Filter nodes with technician present.

Attributes
<attribute name>=<value>

Attribute values are specified by giving the name followed by "=" and then the
value. The supported attributes are:
— automaticSynchronization: the value admitted are true or false.

— heartbeatTimeout: number: the value admitted is a positive integer.

— heartbeatinterval: number: the value admitted is a positive integer.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 131

 ENM CLI

Options
Use the options to further restrict the output specification.

--list, -l

Specify the format of the output as a list (the default is a table) with the
following fields.

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Description
alarm status is used to get alarm supervision status for the network nodes.

Command Consequences

— The alarm supervision status is shown in table or list format depending to the
user selection.

Examples

Get all the alarm supervision status for all the nodes in the network

alarm status *

Response

132 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:131

Get the alarms supervision status with specific state for multiple nodes

alarm status ERBS001;ERBS003;ERBS005 --enabled

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

1/1553-CNA 403 2979 Uen AV | 2020-12-07 133

 ENM CLI

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:70

Get all the alarm supervision status for a management system

alarm status ManagementSystem=ECI-LightSoft01

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:1

Get the alarms supervision status with specific state for all the nodes in the
network

alarm status * --inservice

134 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:31

Get the alarms supervision status with specific state for the nodes that match
a string starting with a specific name

alarm status ERBS* --failed

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

1/1553-CNA 403 2979 Uen AV | 2020-12-07 135

 ENM CLI

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:3

Get the alarms supervision status with specific state for a collection

alarm status MyCollection -en --technician

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:2

Get and display as a list the alarms supervision status for the nodes that
match a string starting with a specific name

136 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

alarm status LTE* --list

Response

This command displays the following information. The output is formatted as a

list.

— NodeName

— Type

— Supervision Status

— Subscription Status

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:3

Get the alarms supervision status for nodes with specific MeContext values

alarm status SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeC →

ontext=NODE2

Response

This command displays the following information. The output is formatted as a

table:

— NodeName

— Type

— Supervision Status

— Subscription Status

1/1553-CNA 403 2979 Uen AV | 2020-12-07 137

 ENM CLI

— Heartbeat Failure

— Out Of Synchronization

— Node Suspended

— Alarm Suppressed

— Synchronization Ongoing

— Technician Present

Total number of node status data fetched for the given query is →
:3

2.3.19 alarm sync

< Back To Alarm

Syntax

Syntax to synchronize all the alarms for the network nodes

alarm sync scope [quick_filter]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

138 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of Managed Objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

1/1553-CNA 403 2979 Uen AV | 2020-12-07 139

 ENM CLI

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm sync command by specifying
either the severity, state or both. If not specified, all instances are involved.

-dis, --disabled

Filter nodes with supervision disabled.

-en, --enabled

Filter nodes with supervision enabled.

-fail, --failed

Filter nodes with heartbeat failure.

-ok, --inservice

Filter nodes with supervision working.

--ongoing

Filter nodes with sync on going.

--suppressed

140 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Filter nodes with alarm suppressed.

--suspended

Filter nodes with Node suspended to true.

--technician

Filter nodes with technician present.

Description
alarm sync is used to synchronized all the alarms for the network nodes:

Command Consequences

— All the alarms are synchronized.

Examples

Initiate alarm synchronization for all the nodes in the network

alarm sync *

Response

[NetworkElement=LTE02ERBS00006, NetworkElement=LTE02ERBS00005, N →
etworkElement=LTE02ERBS00003, NetworkElement=LTE02ERBS00002, Net →
workElement=LTE02ERBS00007, NetworkElement=LTE02ERBS00001]Succes →
sfully initiated the Alarm Synchronization request for 6 instanc →
e(s) .

Initiate alarm synchronization for a node

alarm sync LTE09ERBS00001

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 141

 ENM CLI

[NetworkElement=LTE09ERBS00001]Successfully initiated the Alarm →

Synchronization request for 1 instance(s) .

Initiate alarm synchronization for a management system

alarm sync ManagementSystem=ECI-LightSoft01

Response

[ManagementSystem=ECI-LightSoft01]Successfully initiated the Ala →

rm Synchronization request for 1 instance(s) .

Initiate alarm synchronization for multiple nodes

alarm sync LTE09ERBS00001;LTE09ERBS00002

Response

[NetworkElement=LTE09ERBS00001, NetworkElement=LTE09ERBS00002]Su →
ccessfully initiated the Alarm Synchronization request for 2 ins →
tance(s) .

Initiate alarm synchronization for multiple nodes that match a string starting
with a specific name

alarm sync LTE09*

Response

[NetworkElement=LTE09ERBS00001, NetworkElement=LTE09ERBS00002, N →
etworkElement=LTE09ERBS00003, NetworkElement=LTE09ERBS00004]Succ →
essfully initiated the Alarm Synchronization request for 4 insta →
nce(s) .

Initiate alarm synchronization for a collection and other nodes

142 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

alarm sync MyCollection;LTE09ERBS00001;LTE09ERBS00002

Response

[NetworkElement=LTE09ERBS00001, NetworkElement=LTE09ERBS00002, N →
etworkElement=LTE09ERBS00003, NetworkElement=LTE09ERBS00004]Succ →
essfully initiated the Alarm Synchronization request for 4 insta →
nce(s) .

Initiate alarm synchronization for multiple nodes that match a string ending
with a specific name

alarm sync *0002

Response

[NetworkElement=LTE09ERBS00002, NetworkElement=NODE002]Successfu →
lly initiated the Alarm Synchronization request for 4 instance(s →
) .

Initiate alarm syncronization for the nodes with a MeContext value

alarm sync SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCon →

text=NODE2

Response

[NetworkElement=NODE1, NetworkElement=NODE2]Successfully initiat →

ed the Alarm Synchronization request for 2 instance(s) .

2.3.20 alarm unack

< Back To Alarm

Syntax

Syntax to unacknowledge alarms

1/1553-CNA 403 2979 Uen AV | 2020-12-07 143

 ENM CLI

alarm unack scope [quick_filter] [filter]

Scope
Use the scope to specify node names or collections or both to search on.

<nodeName>

is a list separated by ";" of:

— NetworkElement id (it allows the use of the wildcard "*" for matching
characters)

— ManagementSystem id (it allows the use of the wildcard "*" for matching
characters)

— FDN of NetworkElement

— FDN of ManagementSytem

— FDN of VirtualNetworkFunctionManager

— FDN of MeContext (if it has been created)

— FDN of ManagedElement (if the node has been synchronized and the
MeContext is not present)

<collectionName>

is the name of a collection of managed objects.

The supported managed objects are: NetworkElement, ManagementSytem and

VirtualNetworkFunctionManager.

One or more collections can be defined as scope. Multiple collection names must
be separated with a semi-colon, for example: Collection01;Collection02

Partial collection names are not supported.

Saved searches are not supported.

144 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Names with special characters listed in following table must be used quoted (e.g.
"Special@Name_12")

Character Description
. full stop
? question mark
! exclamation mark
@ at sign
% percent sign
& ampersand
^ circumflex accent
_ low line
/ slash
| vertical bar
- hyphen-minus
= equal
$ dollar
space

Quotes are not required with supported characters.

Quick Filter
Use the quick filter to limit the output of alarm unack command by specifying
either the severity, state or both. If not specified, all instances are involved.

-ack, --ack

Filter acknowledged alarms.

-cle, --cleared

Filter alarms that are cleared.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 145

 ENM CLI

-closed, --closed

Filter closed alarms.

-cri, --critical

Filter alarms with severity critical.

-ind, --indeterminate

Filter alarms with severity indeterminate.

-maj, --major

Filter alarms with severity major.

-min, --minor

Filter alarms with severity minor.

-und, --undefined

Filter alarms with severity undefined.

-war, --warning

Filter alarms with severity warning.

146 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

--primary

Filter alarms with root primary.

--secondary

Filter alarms with root secondary.

Filter
Use the filter to limit the alarms that are unacknowledged by specifying an alarm
attribute. If not specified, all alarms are unacknowledged.

-<attributeShortName>, --<attributeName>

Specify a list of values to be used for filtering the alarms for a specific attribute.
The <attributeShortName> is either a two-letter or three-letter abbreviation. The
filter criteria for text attributes is always "contains". The available values are:

— -addi, --additionalInformation

— -aid, --alarmId

— -alobj, --alarmingObject

— -als, --alarmState

— -an, --alarmNumber

— -ao, --ackOperator

— -boi, --backupObjectInstance

— -bs, --backupStatus

— -co, --ceaseOperator

— -cop, --commentOperator

— -ctx, --commentText

1/1553-CNA 403 2979 Uen AV | 2020-12-07 147

 ENM CLI

— -cv, --correlatedVisibility

— -evt, --eventType

— -fmxg, --fmxGenerated

— -lao, --lastAlarmOperation

— -mc, --manualCease

— -oc, --oscillationCount

— -oor, --objectOfReference

— -pc, --probableCause

— -pd, --problemDetail

— -pra, --proposedRepairAction

— -press, --presentSeverity

— -prevs, --previousSeverity

— -ptx, --problemText

— -pty, --processingType

— -rpc, --repeatCount

— -rt, --recordType

— -sp, --specificProblem

— -ss, --syncState

— -ti, --trendIndication

— -tz, --timeZone

— -vis, --visibility

-id

Specify the alarmId to filter alarms.

Note that alarmId is not unique in the ENM scope. To unacknowledge a single
alarm, filter also by objectOfReference.

148 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-ta, --timeAttribute

Specify the attribute to be used by --begin and --end options. The available
values are:

— eventTime

— insertTime

— lastUpdated

— ackTime

— commentTime

— ceaseTime

-b, --begin

Specify a starting date or time for filtering the alarms. The default attribute is the
eventTime The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (00:00:00 is assumed).

-e, --end

Specify an end date or time for filtering the alarms. The default attribute is the
eventTime. The format is YYYY-MM-DDThh:mm:ss. The time part is an optional
attribute (23:59:59 is assumed).

--relatedAlarms

Specify to unacknowledge related alarms for each selected primary alarm. The
alarms, that are already unacknowledged, are skipped.

Description
alarm unack is used to unacknowledge alarms for the network nodes.

Command Consequences

1/1553-CNA 403 2979 Uen AV | 2020-12-07 149

 ENM CLI

— All alarms satisfying the quick filter are unacknowledged.

Examples

Unacknowledge all the alarms in the network

alarm unack *

Response

MeContext=RNC01RBS05--2 SubNetwork=RNC01,MeContext=RNC01--2
MeContext=RNC01RBS06--2 MeContext=RNC01RBS04--2
MeContext=RNC01RBS07--2
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-5-93182812
3
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-4-71496358
0
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-3-49809903
7
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-2-28123449
4 Operation Successful for 10 alarm(s) .

Unacknowledge the alarms with a specific severity for a node

alarm unack ERBS001 -cri

or

alarm unack ERBS001 --critical

Response

MeContext=ERBS001--2 Operation Successful for 1 alarm(s) .

Unacknowledge the alarms with a specific severity for a collection

alarm unack MyCollection -war

or

alarm unack MyCollection --warning

150 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842
Operation Successful for 1 alarm(s) .

Unacknowledge all the alarms in the network starting from a specific date
and time

alarm unack -b 2016-06-29

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842
Operation Successful for 1 alarm(s) .

Unacknowledge the alarms in the network with a specif attribute name

alarm unack --specificProblem "Database Space Warning Level"

or

alarm unack -sp "Database Space Warning Level"

Response

MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-6-74950842
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-5-93182812
3
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-4-71496358
0
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-3-49809903
7
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-2-28123449
4
MeContext=LTE02ERBS00005,EUtranCellFDD=LTE02ERBS00005-1-64369951
Operation Successful for 6 alarm(s) .

Unacknowledge a single alarm in the network

alarm unack --objectOfReference ManagedElement=LTE04dg2ERBS00001 →

-id 53400

1/1553-CNA 403 2979 Uen AV | 2020-12-07 151

 ENM CLI

or

alarm unack -oor ManagedElement=LTE04dg2ERBS00001 -id 53400;

Response

ManagedElement=LTE04dg2ERBS00001--2 Operation Successful for 1

alarm(s) .

Unacknoledge alarms using MeContext value to search nodes

alarm unack SubNetwork=NET1,MeContext=NODE1;SubNetwork=NET1,MeCo →

ntext=NODE2

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2
Operation Successful for 2 alarm(s) .

Unacknoledge of all primary alarms in the network

alarm unack * --primary

Response

SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS08--2 SubN →

etwork=RNC01,MeContext=RNC01--2 MeContext=RNC01RBS05--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS09--2 →
MeContext=RNC01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →
ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS04 →
--2 MeContext=RNC01RBS05--2 MeContext=RNC01RBS09--2 MeContext=RN →
C01RBS07--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS08--2 MeCo →
ntext=RNC01RBS05--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContex →
t=RNC01RBS04--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS07--2 →
MeContext=RNC01RBS09--2 SubNetwork=RNC01,MeContext=RNC01--2 MeCo →
ntext=RNC01RBS08--2 MeContext=RNC01RBS06--2 MeContext=RNC01RBS05 →
--2 MeContext=RNC01RBS09--2 MeContext=RNC01RBS04--2 MeContext=RN →
C01RBS07--2 SubNetwork=RNC01,MeContext=RNC01--2 MeContext=RNC01R →
BS05--2 MeContext=RNC01RBS07--2 MeContext=RNC01RBS09--2 MeContex →
t=RNC01RBS06--2 MeContext=RNC01RBS04--2 MeContext=RNC01RBS08--2 →
Operation Successful for 37 alarm(s) .

152 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Unacknoledge of all secondary alarms in the network

alarm unack * --secondary

Response

SubNetwork=NET1,MeContext=NODE1 SubNetwork=NET1,MeContext=NODE2 →
Operation Successful for 2 alarm(s) .

Unacknowledge of all alarms in the node and related alarms for each primary
alarm.

alarm unack LTE01 --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 2 alarm(s) . Correlated →

alarm(s) added: 4

Unacknowledge all the alarms of the node with current severity minor and
related alarms for each primary alarm regardless any filter. Related alarms can
be raised on different nodes with different severity.

alarm unack LTE01 --minor --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 1 alarm(s) . Correlated →

alarm(s) added: 2

Unacknowledge of all secondary alarms of the node. No related alarms are

found.

alarm unack LTE01 --secondary --relatedAlarms

Response

MeContext=LTE01 Operation Successful for 1 alarm(s).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 153

 ENM CLI

2.4 ap
< Back To Command Sets

Content

List of Commands

Notes

Summary of Error Codes and Messages

Commands

Bind

Cancel

Delete

Download

Order

Resume

Status

Upload

View

Notes
The ap command set can be used to automatically integrate a node into the
network.

Summary of Error Codes and Messages in ap

The table below lists all possible ap error codes for the CM ap service and
possible solutions or actions to remedy them.

Error code Error message Solution/Action required

16002 — Node is not managed by — Provide a node managed
Auto Provisioning by Auto Provisioning

154 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Node does not exist — Provide a valid node

name
— Project does not exist
— Provide a valid project
name
16003 Internal Server Error Use Log Viewer for more
information
16004 — Failed to download — Verify that the node has
artifact been successfully
imported for '-i -n' or
— Node does not contain successfully ordered for '-
any matching o -n'
configuration file {0}
— Rename the artifact file to
— The file type for file {0} is match the name of an
not supported by the existing artifact
upload command
— Rename the file to match
— The hardware serial the name of an existing
number {0} is already configuration file that is
bound to node {1} supported by the upload
command
— Internal Server Error
Delete failed for {0} — Provide a hardware serial
node(s): {1} number that is not bound
to another node
— {0}
— Use Log Viewer for more
Failure {0} information
—
— Use Log Viewer for more
— Internal Server Error information

— Fix errors and execute the

command again

— Use Log Viewer for more

information
16006 Unsupported node type: {0} Provide a valid node type. Valid
types are: [{0}]
16007 — Node is not in the correct — Ensure node is in correct
state to perform the state before executing the
operation [{0}] command. Valid state(s)
are [{0}]
— Project node(s) [{0}] are
not in the correct state to — Ensure project nodes are
execute the command in the correct state before
executing the command.
Valid state(s) are: [{0}]
16008 — Error(s) found validating — Fix errors and execute the
project command again

— {0} — Fix errors and execute the

command again
— The hardware serial
number {0} is not valid — See AP online help for the
correct format
16009 Invalid command syntax — For more information on
available commands run
'help ap'

— For correct command

syntax run 'help ap {0}'
16010 Insufficient access rights to Contact the system administrator
execute the command to update the user profile
16011 Unsupported command for this Refer to Auto Provisioning Online
node type Help for more information
16012 Node is not waiting for resume or Command can only be used on
cancel node waiting for resume or cancel

1/1553-CNA 403 2979 Uen AV | 2020-12-07 155

 ENM CLI

* {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.

2.5 cmedit
< Back To Command Sets

Content
List of Tutorials

List of Commands

Notes

Summary of Error Codes and Messages

Tutorials

Get Node Data by FDN

Get Node Data

Create Node Data

Set Node Data by FDN

Set Node Data

Delete Node Data by FDN

Delete Node Data

Import CM Data

Export CM Data

Action on a MOI

Describe Modelled Data

Non Persistent Attributes

Case Sensitivity in cmedit

Special Characters in cmedit

156 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Commands

Action

Get

Set

Create

Delete

Describe

Import

Export

Notes
The cmedit command set can be used to read, manipulate, and export
Configuration Management data.

Summary of user codes and messages in CM-Editor

The table below list all possible cm-editor error codes for the cm-editor
application and possible solutions or actions to remedy them.

Error Code Error Message Solution/Action Required

1001 The supplied FDN {0} does not Specify an existing FDN. It may be
exist in the database necessary to first create the
desired FDN
1002 Constraint violation: value Verify valid values for the
specified for attribute {0} is not attribute by executing the
valid - {1} following cmedit describe
command - ''cmedit describe {2}.
{0}''
1003 The parent MO {0} (namespace Execute the command ''cmedit
{1}, version {2}) cannot have a describe {0} -ns={1} -v={2}'' and
child type {3} verify valid children MOs
1004 The MO {0} is not a MIB root Check the model
1005 {0} requires the following Provide the mandatory
mandatory attribute(s): {1} attribute(s): {1}
1006 An unsupported attribute data Request Ericsson product support
type has been encountered for {0}
type {1} value {2}
1007 An incorrect attribute data type Check the model for allowed data
has been encountered for {0} types
expected type {1}, but received {2}

1/1553-CNA 403 2979 Uen AV | 2020-12-07 157

 ENM CLI

Error Code Error Message Solution/Action Required

1008 An incorrect member value has Verify valid values for Struct
been encountered for attribute {0} member(s) executing the
type {1} incorrect member: {2} following cmedit describe
command - ''cmedit describe {1}.*''
1009 An incorrect value ({0}) has been Provide a value from this list: {2}
encountered for {1} possible
value(s) are {2}
1010 An unknown attribute has been Verify valid attributes for the MO
encountered; name {0} in the MO type in the latest models by
class {1} executing the following cmedit
describe command - ''cmedit
describe {1}.*''
1011 Cannot delete {0} because it has Delete children first. Hint : Append
one or more child MOs -ALL to end of DELETE command
to automatically delete all
children.
1012 Invalid MO type, {0} not found Validate specified MO type. Use
the <CMEDIT_DESCRIBE_LINK>
to find valid MO types.
1013 Cannot do a numeric comparison Remove numeric comparison
({0}) for attribute {1} as it is not a
numeric type
1014 Cannot do a partial match ({0}) Remove partial match from query
for attribute {1} as it is not of type
string
1016 An incorrect action name ({0}) has Provide a value from this list: {2}
been encountered for the type {1}
possible value(s) are {2}
1017 An incorrect action parameter Valid parameters for action {1}
({0}) has been encountered for the are : {2}
action name {1}
1018 The following mandatory Provide the mandatory
argument(s) are required: {0} argument(s): {0}
1019 Type {0} exists in more than one Specify the required namespace
namespace : {1}
1020 {0} is a Remove criteria from attribute {0}
<NON_PERSISTED_LINK>,
filtering on the values of non
persisted attributes is not
supported
1021 Cannot update value of read-only Verify write behaviour for the MO
attribute {0} attribute executing the following
cmedit describe command -
''cmedit describe {1}.{0}''
1022 {0} is not valid for neType {1} and Check the model
ossModelIdentity {2}
1023 {0} is not a valid neType. Possible Provide a value from this list: {1}
value(s) are {1}
1024 Could not execute query, probably Try to use .* or .<pm> as attribute
because of of a non-persisted specfication instead
attribute

158 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

1025 An incorrect value ({0}) has been This attribute is of type Union.
encountered for {1}. Possible Please check the model for
types are {2} but constraints could possible types and constraints
apply too
1026 Querying of union type attribute Please remove union type
({0}) is not supported attribute from search criteria
1027 Null value on attribute {0} is not Please provide a non-null value
supported
1028 The attribute {0} is using a Please use Interval type for
between comparator with no Between queries
Interval type
1029 The start value on the interval Please use valid intervals
defined on the attribute {0}
cannot be higher than the end
value and both values cannot be
null
1030 The attribute ({0}) should be a Use the apropriate numeric type
numeric {1} type
1031 {0} not found in the latest version Refer to usage instructions for the
of any model <CMEDIT_DESCRIBE_LINK> for
more information about searching
the model. Hint : the --all option
searches across all versions
1032 {0} not found with the specified Refer to usage instructions for the
criteria <CMEDIT_DESCRIBE_LINK> for
more information about searching
the model.{1}
1033 Attribute {1} not found for the Execute the command ''cmedit
latest version of MO Class {0} describe <MO Class>.*'' to list valid
attributes for the MO class. Hint :
the --all option searches across all
versions
1034 Attribute {1} not found for the Execute the command ''cmedit
specified criteria describe <MO Class>.* {2}{3}'' to
list valid attributes for the MO
Class.{4}
1035 An incorrect action parameter For action {1} no parameter is
({0}) has been encountered for the expected
action name {1}
1036 Struct member {1} not found for Execute the command ''cmedit
the latest version of Struct {0} describe <Struct>.*'' to list valid
members for the Struct. Hint : the
--all option searches across all
versions
1037 Struct member {1} not found for Execute the command ''cmedit
the specified criteria describe <Struct>.* {2}{3}'' to list
valid members for the Struct.{4}
1038 {1} not found for the latest Execute the command ''cmedit
versions of {0} describe *<Partial MO Class>*'' to
list all matching types. Choose one
of the types returned and execute
''cmedit describe <MO Class>.*'' to
get detailed information for the
type

1/1553-CNA 403 2979 Uen AV | 2020-12-07 159

 ENM CLI

Error Code Error Message Solution/Action Required

1039 {1} not found for {0} with the Execute the command ''cmedit
specified criteria describe *<Partial MO Class>* {2}
{3}'' to list all matching types.
Choose one of the types returned
and execute ''cmedit describe <MO
Class>.* {2}{3}'' to get detailed
information for the type
1040 MO Name specified for create Specify namespace and version to
operation exists in more than one target intended MO.
namespace.
1041 An incorrect return type ({0}) has Void is the only valid return type
been encountered for action {1} for actions.
1042 Execution Error - Unsupported MO Try the command again with {0}
Class in command. A Network Nodes as scope.
Wide query for MO Class ({0}) is
performed with the executed
query, but is not supported, as
doing so will return an excessive
amount of data.
1043 Execution Error - Unsupported MO Remove MO Class ({0}) from the
Class in command. A Network query.
Wide query for MO Class ({0}) is
performed with the executed
query, which cannot be filtered by
node
1044 Execution Error - Querying for
Performance Management (PM)
attributes is only supported for
CPP node types
1045 System resources exhausted while
executing query. The subquery for
{0} and others are abandoned
1046 Query taking too long (subqueries
abandoned)
1047 Exceeded Node Scope Limit.
Maximum number of nodes
allowed in one operation is
configured to {0}
1048 System resources exhausted while
executing query. The subqueries
for {0} are abandoned
1049 The scope is incorrect or not
associated with the correct Node
Type
1050 All scope is incorrect or not
associated with the correct Node
Type
1051 Execution Error - Maximum Try split the objects up into
number of objects ({0}) for the smaller operations and try again.
Delete operation has been
reached.
1052 Collection creation failed : {0}.
1053 An unknown struct member has Verify valid members for the struct
been encountered; name {0} in the in the latest models by executing

160 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

struct with dataType {1} and the following cmedit describe
name {2} command - ''cmedit describe {1}.*''
1054 {0} ({1}) for {2}. This attribute is of
type Bits. Possible values are {3}
1055 Invalid MO type ({0}) for the Use the
node(s) provided in the scope(s) <CMEDIT_DESCRIBE_LINK> to
find valid MO types.
1056 Invalid Model {0}: {1}
2002 Cannot read from {0} original
message: {1}
2003 Did not receive a response from Please verify communication with
{0} in {1} seconds relevant node is working correctly
3001 No associated NetworkElement Check the parent FDN and the
found for {0} associated NetworkElement MO
3002 Cannot add node due to invalid/ Ensure that a valid license is
inadequate license installed for node type being
added
3003 Cannot add node, license service is Check status of License Control
unavailable and Monitoring service
3004 Access Denied. Your Target Based
Access Control rights do not allow
you to perform actions on the
Network Element(s).
3005 Access Denied. You do not have
access to this node.
3006 Execution prohibited - only 100
MO changes for command on a
BSC Node that includes Objects
with BscM as parent
3007 Partial attribute failure message –
{0}
3008 Optimistic Lock Exception
occurred. The command has been
retried {0} times
4001 Command syntax error, cannot Refer to usage instructions for the
resolve the cmedit command <DYNAMIC_LINK:cmedit:{4}:>
4002 Command syntax error while Refer to usage instructions for the
processing {0} after {1}.{3} <DYNAMIC_LINK:cmedit:{4}:>
4003 Command syntax error while Refer to usage instructions for the
processing {0} incomplete after <DYNAMIC_LINK:cmedit:{4}:>
{1}.{3}
4004 Command syntax error, Refer to usage instructions for the
unexpected input {2} while <DYNAMIC_LINK:cmedit:{4}:>
processing {0}.{3}
4005 Command syntax error, missing Please check online help for
closing parentheses while correct syntax
processing {0}
4006 Command syntax error, too many Please check online help for
parentheses while processing {0} correct syntax

1/1553-CNA 403 2979 Uen AV | 2020-12-07 161

 ENM CLI

Error Code Error Message Solution/Action Required

4007 Command syntax error, cannot Refer to usage instructions for the
specify {0} more than once <DYNAMIC_LINK:cmedit:{2}:>
4008 Command syntax error, Please check online help for
unrecognised or invalid option {1} correct syntax
4009 Command syntax error, missing Please check online help for
closing bracket while processing correct syntax
{0}
4010 Command syntax error, too many Please check online help for
brackets while processing {0} correct syntax
4011 Command syntax error, missing Please check online help for
closing double quotation mark correct syntax
while processing {0}
4012 Command syntax error, Please check online help for
incompatible options, select only correct syntax
{0} or {1}
4013 The command is supported on full Execute the command using <MO
or partial MO type Class> or *<Partial MO Class>*
4015 Command syntax error, no scope Scope is mandatory for the {1}
defined for the command command. Refer to usage
instructions for the
<DYNAMIC_LINK:cmedit:{1}:>
4016 Command syntax error, Provide double operators when
unexpected input ={2} for query querying on attributes. Refer to
part of command usage instructions for the
<DYNAMIC_LINK:cmedit:{1}:>
4017 Command syntax error, To query on a list of attributes,
unexpected input {2} for attribute wrap the list in rounded brackets.
query part of command Refer to usage instructions for the
<DYNAMIC_LINK:cmedit:{1}:>
4018 Command syntax error, Valid characters for an attribute
unexpected input {2} for query value are lowercase and
part of command uppercase letters, numbers, .?!@
%^&/|_-, other special characters
should be wrapped in quotes.
Refer to usage instructions for the
<DYNAMIC_LINK:cmedit:{1}:>
4019 Command syntax error, missing Provide comma or semi-colon
separator in attribute setter list between each element in the list.
after attribute {2} Refer to usage instructions for the
<DYNAMIC_LINK:cmedit:{1}:>
4020 Command syntax error, invalid Enclose the values containing
character `{5}` at position {6} invalid characters within quotes.
4021 Command syntax error, only
multiple attribute names or
multiple name/value pairs are
supported.
4022 Command syntax error,
referencing multiple MO classes by
name is not supported.
4023 Command syntax error, Please check online help for
unexpected input "{0}". correct syntax
<SPECIAL_CHARACTERS_LINK:>

162 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

4024 Command syntax error, only full or
partial MO ID names are
supported
5001 Insufficient access rights to If the operation is required to be
perform the operation performed by the current user, the
user profile must be updated by
the system administrator
5002 Did not receive a response from Verify status by executing a GET
the server in {0} seconds command on the MO.
5003 Did not receive a response from Verify status by executing a GET
the server in {0} seconds. command on the MO.
5004 The operation was tried several
times but was still unsuccessful
5005 Execution error. MO could not be Retry later.
processed after several attempts
5006 Execution error. Unable to verify if Verify status by executing a GET
operation on MO was successful. command on the MO.
5007 The write command is not valid Check the models for the relevant
for the following objects: {0} objects
5008 The command executed on {0} out
of {1} objects
5009 Topology Collection Service is not
available. Error message: {0}
5010 The read command has errors.
9999 {0} This is a generic error, please
check the error log 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.

Import Commmand Set

Error Code Error Message Solution/Action Required

7002 The specified file does not consist Please ensure file name specified
of data and is invalid. is correct.
7003 The specified file {0} was not Please ensure file name specified
found is correct.
7004 Error reading zip file. Please ensure zip file name
specified is correct and that zip file
contains relevant import data.
7005 The specified file is of an Please check 3GPP file format
unsupported 3GPP file format version in file header.
version.
7006 The supplied file format {0} is not Please specify a supported file
supported for import. format.
7007 The supplied flag for error,{0}, is The supported flags are continue
not supported for import. or stop.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 163

 ENM CLI

Error Code Error Message Solution/Action Required

7008 Unable to retrieve job details for Please check the job id.
job id: {0}
7009 The server was unable to process Please issue the import command
the request due to ongoing again.
upgrade activity.
7010 The supplied modifier {0} is not a Please specify 'create','update' or
valid import operation. 'delete' as the modifier.
7011 The model version for the Please issue the import command
managed object {0} has changed again.
during the import operation.
7012 Incorrect attribute {0} supplied for Please check the model for
the specified managed object {1}. allowed attributes.
7014 {0} Please fix the issue and re-execute
the import command.
7015 The operation {0} on The underlying error is {2}.
ManagedObject {1} failed due to a
model violation.
7016 The operation {0} on managed The underlying error is {3}.
object {1} failed as the managed
object is already defined.
7017 Attribute {0} is not compatible Please check the model for correct
with provided value type {1}. attribute type.
7018 The input file extension {0} is The allowed extensions are {2}.
invalid for {1} import process.
7019 The import file exceeds the
allowed size limit {0}
7020 Import failed due to unexpected The underlying error is {0}.
transaction rollback.
7021 {0}
7022 Database space warning level has Refer to OPI document Database
been exceeded. Space Warning Level.
7023 Database space critical level has Refer to OPI document Database
been exceeded. Space Critical Level.
7024 Syntax validation failed. Please Please consult the description of
ensure file is aligned to dynamic dynamic validation errors reported
format syntax. in the import verbose job status
and ensure the file is well-formed.
7025 Schema validation failed. Please Please consult the description of
ensure file is aligned to 3GPP XML schema validation errors reported
schema. in the import verbose job status
and ensure the file is well-formed.
7027 No license active for dynamic file Contact the system administrator
type import feature. to activate the appropriate license.
7028 Model validation failed. Please Please consult the description of
ensure file is aligned to the model validation errors reported in
models. the import verbose job status and
ensure the file passes all model
validation checks.
7037 {0} input file extension is invalid Please specify a supported file
for {1} import process. type for the chosen process.

164 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

7040 Instance validation failed. Please Please consult the description of
ensure that the file is valid against instance validation errors reported
Live configuration. in the import verbose job status
and ensure the file passes all
instance validation checks.
7041 Execution Error: There is no parse- Check import tutorials for help on
able commands or content inside how to structure your import file.
the import file.
7042 There are validation failures. Please consult the description of
the errors reported in the import
verbose job status.
7047 Unable to Cancel Job. Import Job
with ID {0} not found.
7048 Import Job with ID {0} cannot be Only Import Jobs in progress can
cancelled. {1} be cancelled. To check the status,
run the following command -
'cmedit import --status --job %s --
verbose'. Only Import Jobs
initiated from CLI can be
cancelled.
7049 Unable to invoke Job Execution.
Import Job with ID {0} cannot be
re-executed as the job has already
been cancelled.
7050 All operations are in EXECUTED Only operations with state
state and cannot be re-validated. different to EXECUTED can be re-
validated.
7051 Failed to authorize node {0} with Target Based Access Control
error : [{1}] {2}. (TBAC) Service is unavailable. Try
again later.
7052 User {0} is not authorized on node CM Bulk Import operations are
{1}. subject to Target Based Access
Control (TBAC) checks. Therefore
all nodes in the job should be
available in the executing users
target group to avoid
authorization errors.
7059 The supplied Managed Object is Please provide the correct
invalid. Topology Managed object.

* {0}, {1}, and so on, indicate variable parts of the message which will be
substituted by relevant information from the request like FDN, MO type, attribute
name, and so on. In case of error 7014 and 7021, {0} will be substituted by error
message propagated from the data persistence service and caught in the system.

Export Command Set

Error Code Error Message Solution/Action Required

8000 Exception occurred during export Request Ericsson product support.
process: {0}
8004 User defined filter and predefined Specify either one of user defined
filter cannot be used together filter or predefined filter.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 165

 ENM CLI

Error Code Error Message Solution/Action Required

8005 User defined filter file and filter Specify either user defined filter
content cannot be specified file or filter file content.
together
8006 User defined filter file must be Specify a valid user defined filter
specified file.
8007 User defined filter file {0} not Specify a valid user defined filter
found file.
8008 User defined filter file {0} cannot Specify a valid user defined filter
be read file.
8009 {2} {3}
8010 No nodes specified Specify nodes to export.
8011 Invalid scope specified Specify a valid scope.
8012 Invalid search criteria specified Specify a valid search criteria.
8013 Search criteria did not match any Specify a valid search criteria.
nodes
8014 Transformer not found for the Specify a valid export type.
export type {0}
8015 Invalid job ID {0} Specify a valid export job ID.
8017 Insufficient permissions to run Login as a user with permissions
command to run command.
8018 Invalid input specified for Specify valid managed object
managed objects filter names to filter.
8020 Invalid input specified for export Specify a valid export filter.
filter
8023 Can not delete active job Specify a job which has finished.
8024 Invalid job name Specify a valid job name.
8025 Job with name {0} not found Specify a valid job name.
8026 Job name {0} already exists Specify another job name.
8027 The server is currently busy due to Try again later.
a high number of exports
8028 Insufficient disk space available Contact the system administrator
for export job on {0} to ensure that sufficient disk space
is available.
8029 No license active for dynamic Contact the system administrator
export type. to activate the appropriate license.
8031 Invalid neType {0} Specify a valid neType.
8035 Unsupported operation error: {0} Check the online documentation.
8091 Job with ID {0} is not available for Ensure that the job was started
download and is in a COMPLETED state
or before downloading.
Job with name {0} is not available
for download

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

166 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

* {2} indicates a variable part of the message which will be substituted by

relevant information on user defined filter error. For details on the variable part of
the message refer to User-Defined Filter File.

* {3} indicates variable suggested solution/action that needs to be performed in

order to correct user defined filter. For details on the variable suggested solution/
action refer to User-Defined Filter File.

2.5.1 Tutorial: Get Node Data by FDN

< Back To Cmedit

1. Get a ManagedElement by FDN

Example Command:

cmedit get MeContext=ERBS001,ManagedElement=1

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1
ManagedElementId : 1
applicationConfiguration : []
healthCheckResult : {startTime=, message=, healthCheckResultC →
ode=INITIAL_VALUE}
healthCheckSchedule : []
logicalName :
mimInfo : {mimVersion=1, mimRelease=160, mimName=ERBS_NODE_MO →
DEL_H}
neType : ERBS
platformType : null
productName :
productNumber :
productRevision :
productType : Node
site :
userLabel : sampleUserLabel

1 instance(s)

Example Command Explanation: The above example command returns all

persistent attributes for all Managed Object Instances (MOIs) for the
provided FDN.

2.5.2 Tutorial: Get Node Data

< Back To Cmedit

1/1553-CNA 403 2979 Uen AV | 2020-12-07 167

 ENM CLI

1. Get the managed object instance of type ENodeBFunction under a node with
name "ERBS001", in namespace "ERBS_NODE_MODEL" (will return only
FDN):

Example Command:

cmedit get ERBS001 ENodeBFunction --namespace=ERBS_NODE_MODEL

(Note: the name of the namespace depends on the versions of the node in
the deployed network and the type of managed object being looked for)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

1 instance(s)

2. Get all managed object instances of type ENodeBFunction and return their
FDNs under nodes whose name starts with "ERBS" ie (Note: using 'short'
notation for --namespace -ns)

Example Command:

cmedit get ERBS* ENodeBFunction -ns=ERBS_NODE_MODEL

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS003,ManagedElement=1,ENodeBFunction=1

3 instance(s)

3. Get all managed object instances of type ENodeBFunction and return their
FDNs from under each of the MeContexts in the collection "CollectionOne"

Example Command:

cmedit get CollectionOne ENodeBFunction

168 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

2 instance(s)

4. Get all managed object instances of type ENodeBFunction and return all
their persistent attributes under nodes whose name ends with "01":

Example Command:

cmedit get *01 ENodeBFunction.* -ns=ERBS_NODE_MODEL

(Note: the use of the asterisk indicates that all persistent values shall be
returned.)

Example Command Response:

FDN : MeContext= ERBS001,ManagedElement=1,ENodeBFunction=1

ENodeBFunctionId : 1

alignTtiBundWUlTrigSinr : OFF

altNasBackTo : DEFAULT_DCN

biasThpWifiMobility : 10

caAwareMfbiIntraCellHo : false

checkEmergencySoftLock : false

combCellSectorSelectThreshRx : 300

combCellSectorSelectThreshTx : 300

1/1553-CNA 403 2979 Uen AV | 2020-12-07 169

 ENM CLI

csfbMeasFromIdleMode : true

dlMaxWaitingTimeGlobal : 0

dnsLookupOnTai : ON

dnsLookupTimer : 0

dnsSelectionS1X2Ref :

dscpLabel : 24

enabledUlTrigMeas : false

eNBId : 81

eNodeBPlmnId : {mcc=353, mnc=57, mncLength=2}

eranVlanPortRef :

forcedSiTunnelingActive : false

gtpuErrorIndicationDscp : 40

initPreschedulingEnable : true

interEnbCaTunnelDscp : 14

ipsecEpAddressRef :

licCapDistrMethod : SYSTEM

licConnectedUsersPercentileConf : 90

licDlBbPercentileConf : 90

170 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

licDlPrbPercentileConf : 90

licUlBbPercentileConf : 90

licUlPrbPercentileConf : 90

maxRandc : 255

measuringEcgiWithAgActive : false

mfbiSupport : true

mfbiSupportPolicy : false

minRandc : 1

mtRreWithoutNeighborActive : true

nnsfMode : RPLMN_IF_SAME_AS_SPLMN

prioritizeAdditionalBands : false

pwsPersistentStorage : OFF

randUpdateInterval : 200

releaseInactiveUesInactTime : 1

releaseInactiveUesMpLoadLevel : VERY_HIGH_LOAD

rrcConnReestActive : false

s1GtpuEchoDscp : 14

s1GtpuEchoEnable : DISABLED

1/1553-CNA 403 2979 Uen AV | 2020-12-07 171

 ENM CLI

s1GtpuEchoFailureAction : NONE

s1HODirDataPathAvail : false

s1RetryTimer : 30

sctpRef : MeContext=ERBS001,ManagedElement=1,TransportNetwork →
=1,Sctp=1

sctpX2Ref :

softLockRwRWaitTimerInternal : 60

softLockRwRWaitTimerOperator : 60

tddVoipDrxProfileId : -1

timeAndPhaseSynchAlignment : false

timeAndPhaseSynchCritical : false

timePhaseMaxDeviation : 100

timePhaseMaxDeviationCdma2000 : 100

timePhaseMaxDeviationEdrx : 10

timePhaseMaxDeviationIeNbCa : 30

timePhaseMaxDeviationMbms : 50

timePhaseMaxDeviationOtdoa : 9

timePhaseMaxDeviationSib16 : 100

timePhaseMaxDeviationTdd : 15

172 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

tOutgoingHoExecCdma1xRtt : 5

tRelocOverall : 5

tS1HoCancelTimer : 3

ulMaxWaitingTimeGlobal : 0

ulSchedulerDynamicBWAllocationEnabled : true

upIpAddressRef :

upX2IpAddressRef :

useBandPrioritiesInSCellEval : false

useBandPrioritiesInSib1 : false

userLabel : RegionA

x2BlackList : []

x2GtpuEchoDscp : 14

x2GtpuEchoEnable : DISABLED

x2IpAddrViaS1Active : true

x2retryTimerMaxAuto : 1440

x2retryTimerStart : 30

x2SetupTwoWayRelations : true

x2WhiteList : []

1/1553-CNA 403 2979 Uen AV | 2020-12-07 173

 ENM CLI

zzzTemporary1 :

zzzTemporary10 : -2000000000

zzzTemporary11 : -2000000000

zzzTemporary12 : -2000000000

zzzTemporary2 :

zzzTemporary3 :

zzzTemporary4 :

zzzTemporary5 :

zzzTemporary6 :

zzzTemporary7 :

zzzTemporary8 :

zzzTemporary9 : -2000000000

1 instance(s)

5. Get all managed object instances of type ManagedElement across all

namespaces and return only the userLabel attribute under any node (will
also return the FDNs):

Example Command:

cmedit get * ManagedElement.userLabel

(Note: omitting the namespace parameter may decrease the performance of

the query)

Example Command Response:

174 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : MeContext=ERBS001,ManagedElement=1

userLabel : sampleUserLabel

1 instance(s)

(Note: Response will be received from all available nodes. If a node is not
available an error will be received )
6. Get managed object instances of type GeranFreqGroup across all
namespaces under node ERBS001 and under a given FDN:
MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,GeraNetwork
=1

Example Command:

cmedit get MeContext=ERBS002,ManagedElement=1,ENodeBFunction= →

1,GeraNetwork=1; ERBS001 GeranFreqGroup

Example Command Response:

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1,GeranFreqGroup=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1,GeranFreqGroup=2

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1,GeranFreqGroup=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1,GeranFreqGroup=2

4 instance(s)

7. Get all managed object instances of type ENodeBFunction in the

ERBS_NODE_MODEL namespace with version 3.1.72 and return the FDN,
userLabel and dnsLookupOnTai attributes under any node:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 175

 ENM CLI

Example Command:

cmedit get * ENodeBFunction.(userLabel,dnsLookupOnTai) -ns=ER →

BS_NODE_MODEL -v=3.1.72

(Note: the name of the namespace depends on the versions of the node in
the deployed network and the type of managed object being looked for)

(Note: a list of attributes for a specified MO Class may be specified,

contained within brackets and separated by a comma)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

dnsLookupOnTai : ON

userLabel : sampleUserLabel

1 instance(s)

8. Get all managed object instances of type ENodeBFunction across all

namespaces and return the userLabel and dnsLookupOnTai attributes under
any node where the value of userLabel equals to "Ireland":

Example Command:

cmedit get * ENodeBFunction.(userLabel=="Ireland",dnsLookupOn →

Tai)

(Note: the value for a string object has to be enclosed in quotes when it
contains any special characters like space, full stop or dollar sign)

(Note: when querying for attributes with a specified value a "double" equals
is required. A single equals is used when setting a modeled value)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

dnsLookupOnTai : ON

userLabel : Ireland

176 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

1 instance(s)

9. Get all managed object instances of type EUtranCellFDD across all

namespaces on the node ERBS001 and return only the FDNs with an
latitudeDir facing North:

Example Command:

cmedit get ERBS001 EUtranCellFDD.(latitudeDir==NORTH)

(Note: the value for a string object has to be enclosed in quotes when it
contains any special characters like space, full stop or dollar sign)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

latitudeDir : NORTH

1 instance(s)

10. Get all managed object instances of type ENodeBFunction across all nodes
and namespaces along with userLabel attributes, whose value starts with
"Ire"

Example Command:

cmedit get * ENodeBFunction.userLabel==Ire*

(Note: when querying on a partial value, the attribute dataType must be a

string, that is, it is not possible to specify a partial enumerated dataType
attribute)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,ENo →
deBFunction=1

userLabel : Ireland

1/1553-CNA 403 2979 Uen AV | 2020-12-07 177

 ENM CLI

1 instance(s)

11. Get all managed object instances of type ENodeBFunction under ERBS001,
ERBS002 and ERBS003 with userLabel attributes, whose value starts with
"Ire"

Example Command:

cmedit get ERBS001;ERBS002;ERBS003 ENodeBFunction.userLabel== →

Ire* -ns=ERBS_NODE_MODEL

(Note: the attribute must be a string)

(Note: a list of node identifiers is separated by a semi-colon)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

userLabel : Ireland

FDN : MeContext=ERBS003,ManagedElement=1,ENodeBFunction=1

userLabel : Ireland

2 instance(s)

12. Get all managed object instances of type EUtranCellFDD with a cellRange
attribute, whose value is greater than 12

Example Command:

cmedit get * EUtranCellFDD.cellRange>12

(Note: the attribute dataType must be a numerical value)

Example Command Response:

FDN : MeContext=ERBS6003,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=2

178 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cellRange : 15

1 instance(s)

13. Get all managed object instances of type ENodeBFunction under ERBS001
with userLabel attribute and all direct child managed object instances of
type EUtranCellFDD (in the same namespace) with no attributes.

Example Command:

cmedit get ERBS001 ENodeBFunction.userLabel,EUtranCellFDD

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

userLabel : sampleUserLabel

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

2 instance(s)

14. Get all managed object instances of type ENodeBFunction under ERBS001
with userLabel attribute and all child MOs of any type (in any namespace)

Example Command:

cmedit get ERBS001 ENodeBFunction.userLabel,*

(Note: a wildcard asterix specified in-lieu of an MO will result in all MO

Instances being returned in the query)

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

userLabel : sampleUserLabel

1/1553-CNA 403 2979 Uen AV | 2020-12-07 179

 ENM CLI

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Anr →
Function=1

4 instance(s)

15. Get all managed object instances of type ENodeBFunction under a list of
node name IDs whose specified attribute matches a specified value

Example Command:

cmedit get ERBS001;ERBS002;ERBS003 ENodeBFunction.x2retryTime →

rMaxAuto==1440

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

x2retryTimerMaxAuto : 1440

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

x2retryTimerMaxAuto : 1440

FDN : MeContext=ERBS003,ManagedElement=1,ENodeBFunction=1

180 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

x2retryTimerMaxAuto : 1440

3 instance(s)

16. For a specified node, get the managed object instances of a specified parent
MO, a specified child MO and that MO's child MOIs

Example Command:

cmedit get ERBS0001 ENodeBFunction,EUtranCellFDD,*

Note: MO Classes seperated by a comma indicate that the MO is a child of

the preceding parent MO.

Example Command Response:

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=1

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=2

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=3

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=3,EUtranFreqRelation=1

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=3,EUtranFreqRelation=2

1/1553-CNA 403 2979 Uen AV | 2020-12-07 181

 ENM CLI

6 instance(s)

17. For all nodes with a specified MO that matches a specified condition, get all
of that MO's children but only output the specified MO types

Note: When the user wants to query network data based on certain criteria,
but wants to view different or additional data than the data specified in the
search criteria, the data that is desired to be output from the search can be
specified

Example Command:

cmedit get * EUtranCellFDD.userLabel==Cell001*,* EUtranFreqRe →

lation; UeMeasControl

Note:The information that is displayed is independent of the information

specified in the search criteria. In the example, the query is based on all
EUtranCellFDD MOIs with userLabel starts with Cell001 and all it's child
MOIs. The desired output is all EUtranFreqRelation MOIs and all
UeMeasControl MOIs but as stated not the EUtranCellFDD MOIs.

Example Command Response:

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1,UeMeasControl=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1,EUtranFreqRelation=1

FDN : MeContext=ERBS003,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1,EUtranFreqRelation=1

3 instance(s)

18. For all nodes of type ENodeB, get all specified MOIs along with the specified
attributes

Note: When the user wants to contain a query across the network to return
data only for a type of node, the netype optional command parameter can be
specified to limit the data that is returned in the search criteria

182 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command:

cmedit get * EUtranCellFDD.(userLabel,ulInterferenceManagemen →

tActive,ulChannelBandwidth) -ne=ERBS

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

ulChannelBandwidth : 10000

userLabel : ulInterferenceManagementActive : true

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

ulChannelBandwidth : 10000

userLabel : ulInterferenceManagementActive : true

FDN : MeContext=ERBS003,ManagedElement=1,ENodeBFunction=1,EUt →
ranCellFDD=1

ulChannelBandwidth : 10000

userLabel : ulInterferenceManagementActive : true

3 instance(s)

19. For all nodes get all instances of a parent MO Class that has a specified child
MO

Note: The parent (and child) MO will only be returned if a child exists that
fulfills the child cmObjectSpecification. If more then one child specification is
specified then all of those need to be fulfilled for the parent and those

1/1553-CNA 403 2979 Uen AV | 2020-12-07 183

 ENM CLI

children to be returned. An output specification can be used to return just the

parent or child MO types as required.

Example Command:

cmedit get * ManagedElement,(Equipment;ENodeBFunction)

Note: MOs specified with in the brackets must be child MO's of the preceding
MO

Example Command Response:

FDN : MeContext=ERBS0001,ManagedElement=1,Equipment

FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS0001,ManagedElement=1

3 instance(s)

Note: All commands and search options in ENM CLI are case sensitive - MO
Class and attributes are as per modeled data
20. For ERBS001 get all instances of the MOs of type ManagedElement AND
ENodeBFunction, specifying all persistent attributes on the
ManagedElement

Note:The search shall be contained to look for all MO instances under

MeContext=ERBS001

Example Command:

cmedit get ERBS001 ManagedElement.*;ENodeBFunction

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

184 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : MeContext=ERBS001,ManagedElement=1

ManagedElementId : 1

applicationConfiguration : []

healthCheckResult : {startTime=, message=, healthCheckResultC →

ode=INITIAL_VALUE}

healthCheckSchedule : []

logicalName :

mimInfo : {mimVersion=1, mimRelease=160, mimName=ERBS_NODE_MO →

DEL_H}

neType : ERBS

platformType : null

productName :

productNumber :

productRevision :

productType : Node

site :

userLabel :

2 instance(s)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 185

 ENM CLI

21. For ERBS001 get all instances of the MOs of type ManagedElement and
ENodeBFunction, specifying all persisted attributes on the ManagedElement
and PM Counters on ENodeBFunction MO

Note:The search shall be contained to look for all MO instances under

MeContext=ERBS001

Example Command:

cmedit get ERBS001 ManagedElement.<p>;ENodeBFunction.<pm>

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

pmIotConnectedUsersMax : 0

pmLic5MHzSectorCarrierActual : 0

pmLic5Plus5MHzScFddActual : 0

pmLic5Plus5MHzScTddActual : 0

pmLicConnectedUsersActual : 0

pmLicConnectedUsersDistr : []

pmLicConnectedUsersLevSamp : 0

pmLicConnectedUsersLevSum : 0

pmLicConnectedUsersLicense : 0

pmLicConnectedUsersMax : 0

pmLicConnectedUsersTimeCong : 0

pmLicDlCapLicense : 0

186 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

pmLicDlPrbCapLicense : 0

pmLicUlCapLicense : 0

pmLicUlPrbCapLicense : 0

pmMoFootprintMax : 0

pmPagS1Discarded : 0

pmPagS1DiscDistr : []

pmPagS1EdrxDiscarded : 0

pmPagS1EdrxReceived : 0

pmPagS1RecDistr : []

pmPagS1Received : 0

pmRimAssocMax : 0

pmRimReportErr : 0

pmZtemporary34 : 0

pmZtemporary35 : 0

FDN : MeContext=ERBS001,ManagedElement=1

ManagedElementId : 1

applicationConfiguration : []

1/1553-CNA 403 2979 Uen AV | 2020-12-07 187

 ENM CLI

healthCheckResult : {startTime=, message=, healthCheckResultC →

ode=INITIAL_VALUE}

healthCheckSchedule : []

logicalName :

mimInfo : {mimVersion=1, mimRelease=160, mimName=ERBS_NODE_MO →

DEL_H}

neType : ERBS

platformType : null

productName :

productNumber :

productRevision :

productType : Node

site :

userLabel :

2 instance(s)

22. For ERBS001 get all instances of the MOs of type ManagedElement,
specifying all writable persistent attributes on the ManagedElement MO and
displaying the output in Dynamic format

Note:The search shall be contained to look for all MO instances under

MeContext=ERBS001

Example Command:

cmedit get ERBS001 ManagedElement.<w> --dynamic

188 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command Response:

FDN : "MeContext=ERBS001,ManagedElement=1"

ManagedElementId : "1"

applicationConfiguration : []

healthCheckSchedule : []

logicalName : ""

neType : ERBS

platformType : <empty>

productName : ""

productNumber : ""

productRevision : ""

productType : "Node"

site : ""

userLabel : "Label1"

1 instance(s)

23. For ERBS001 get all instances of the MOs of type ManagedElement,
specifying all mandatory persistent attributes on the ManagedElement MO

Note:The search shall be contained to look for all MO instances under

MeContext=ERBS001

Example Command:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 189

 ENM CLI

cmedit get ERBS001 ManagedElement.<m>

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1

ManagedElementId : 1

neType : ERBS

1 instance(s)

24. Count the MOs of type ManagedElement and ENodeBFunction

Example Command:

cmedit get * ManagedElement;ENodeBFunction --count

Example Command Response:

ManagedElement 4 instance(s) found

ENodeBFunction 4 instance(s) found

8 instance(s)

2.5.3 Tutorial: Create Node MOI Data

< Back To Cmedit

1. Example command to create an ENodeBFunction MO under a Managed

Element.

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1 ENodeBFunctionId=1; userLabel="sampleUserLabel"; eNodeBP →
lmnId=(mcc=272,mnc=7,mncLength=2)

190 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Note: a struct data type attribute is defined within round brackets, with
members separated by commas.

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

ENodeBFunctionId : 1
alarmSuppressed : false
collectTraceStatus : null
csfbMeasFromIdleMode : true
dnsLookupOnTai : ON
dnsLookupTimer : 0
dscpLabel : 24
eNBId : 1015
eNodeBPlmnId : {mcc=272, mnc=7, mncLength=2}
forcedSiTunnelingActive : false
initPreschedulingEnable : true
licCapDistrMethod : SYSTEM
maxRandc : 255
mfbiSupport : null
minRandc : 1
nnsfMode : RPLMN_IF_SAME_AS_SPLMN
oaMLinkSuperVisionActive : true
pwsPersistentStorage : OFF
randUpdateInterval : 200
rrcConnReestActive : false
s1HODirDataPathAvail : false
s1RetryTimer : 30
schedulingStrategy : ROUND_ROBIN
sctpRef : null
technicianPresent : null
tHODataFwdReordering : 50
timeAndPhaseSynchCritical : false
timePhaseMaxDeviation : 100
tOutgoingHoExecCdma1xRtt : 5
tRelocOverallValue : 5
ulSchedulerDynamicBWAllocationEnabled : true
upIpAccessHostRef : null
upIpAddressRef : null
userLabel : null
x2BlackList : null
x2IpAddrViaS1Active : true
x2retryTimerMaxAuto : 1440
x2retryTimerStart : 30
x2SetupTwoWayRelations : true
x2WhiteList : null
zzzTemporary1 : null
zzzTemporary10 : -2000000000
zzzTemporary11 : -2000000000
zzzTemporary12 : -2000000000
zzzTemporary13 : -2000000000

1/1553-CNA 403 2979 Uen AV | 2020-12-07 191

 ENM CLI

zzzTemporary14 : -2000000000
zzzTemporary15 : -2000000000
zzzTemporary16 : -2000000000
zzzTemporary17 : -2000000000
zzzTemporary18 : -2000000000
zzzTemporary19 : -2000000000
zzzTemporary2 : null
zzzTemporary20 : -2000000000
zzzTemporary21 : -2000000000
zzzTemporary22 : -2000000000
zzzTemporary23 : -2000000000
zzzTemporary24 : -2000000000
zzzTemporary25 : -2000000000
zzzTemporary26 : -2000000000
zzzTemporary27 : -2000000000
zzzTemporary3 : null
zzzTemporary4 : null
zzzTemporary5 : null
zzzTemporary6 : null
zzzTemporary7 : null
zzzTemporary8 : null
zzzTemporary9 : -2000000000

1 instance(s) updated

2. Example command to create a child MO under the ENodeBFunction MO

created in step 2.

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,GeraNetwork=1 GeraNetworkId=1

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Ger →
aNetwork=1
GeraNetworkId : 1
userLabel: null

1 instance(s) updated
3. Example command to create an MO with Complex Data Type Attribute
( Sequence Attributes ) under the ENodeBFunction MO created in step 1.

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1 ENodeBFunctionId=1, x2BlackList=[{enbId=1,mcc=1,mnc=123, →
mncLength=2}]

Note: a sequence data type attribute is defined within square brackets.

192 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1
ENodeBFunctionId : 1
alarmSuppressed : false
collectTraceStatus : null
csfbMeasFromIdleMode : true
dnsLookupOnTai : ON
dnsLookupTimer : 0
dscpLabel : 24
eNBId : 1015
eNodeBPlmnId : {mcc=272, mnc=7, mncLength=2}
forcedSiTunnelingActive : false
initPreschedulingEnable : true
licCapDistrMethod : SYSTEM
maxRandc : 255
mfbiSupport : null
minRandc : 1
nnsfMode : RPLMN_IF_SAME_AS_SPLMN
oaMLinkSuperVisionActive : true
pwsPersistentStorage : OFF
randUpdateInterval : 200
rrcConnReestActive : false
s1HODirDataPathAvail : false
s1RetryTimer : 30
schedulingStrategy : ROUND_ROBIN
sctpRef : null
technicianPresent : null
tHODataFwdReordering : 50
timePhaseMaxDeviation : 100
timeAndPhaseSynchCritical : false
tOutgoingHoExecCdma1xRtt : 5
tRelocOverallValue : 5
ulSchedulerDynamicBWAllocationEnabled : true
upIpAccessHostRef : null
upIpAddressRef : null
userLabel : null
x2BlackList : x2BlackList : [{mcc=1, mnc=123, mncLength=2, en →
bId=1}]
x2IpAddrViaS1Active : true
x2retryTimerMaxAuto : 1440
x2retryTimerStart : 30
x2SetupTwoWayRelations : true
x2WhiteList : null
zzzTemporary1 : null
zzzTemporary10 : -2000000000
zzzTemporary11 : -2000000000
zzzTemporary12 : -2000000000
zzzTemporary13 : -2000000000
zzzTemporary14 : -2000000000
zzzTemporary15 : -2000000000
zzzTemporary16 : -2000000000

1/1553-CNA 403 2979 Uen AV | 2020-12-07 193

 ENM CLI

zzzTemporary17 : -2000000000
zzzTemporary18 : -2000000000
zzzTemporary19 : -2000000000
zzzTemporary2 : null
zzzTemporary20 : -2000000000
zzzTemporary21 : -2000000000
zzzTemporary22 : -2000000000
zzzTemporary23 : -2000000000
zzzTemporary24 : -2000000000
zzzTemporary25 : -2000000000
zzzTemporary26 : -2000000000
zzzTemporary27 : -2000000000
zzzTemporary3 : null
zzzTemporary4 : null
zzzTemporary5 : null
zzzTemporary6 : null
zzzTemporary7 : null
zzzTemporary8 : null
zzzTemporary9 : -2000000000

1 instance(s) updated

Note: It is possible to supply any number of attribute names and values

which are separated by commas. If creating a Managed Object with any
mandatory attributes, these attributes must be supplied. When supplying
string data type attribute values quotation marks are optional, however if
quotation marks are not supplied only alphanumeric, dashes and underscore
characters can be used.
4. Example command to create attributes of type MO ref under the
ENodeBFunction MO created in step 1.

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1, QciTable=3 QciTableId=3, reservedBy=["MeContext=ERBS001 →
,ManagedElement=1"]

Note: a list data type attribute is defined within square brackets.

Example Command Response:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,Qci →
Table=3
QciTableId : 3
reservedBy : MeContext=ERBS001,ManagedElement=1

1 instance(s) updated

194 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.5.4 Tutorial: Set Node Data by FDN

< Back To Cmedit

1. Example command to modify a list of simple modeled attribute(s):

cmedit set MeContext=ERBS2000, ManagedElement=1 userLabel:sam →

pleUserLabel, productNumber=CXC101101

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1

1 instance(s) updated

2. Example command to modify a structured complex attribute:

cmedit set MeContext=ERBS2000,ManagedElement=1,ENodeBFunction →

=1 eNodeBPlmnId=(mcc=999,mnc=666,mncLength=2)

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s) updated

Note: a STRUCT dataType attribute is specified within round or curly

brackets, with members separated by commas
3. Example command to modify an enumerated attribute:

cmedit set MeContext=ERBS2000,ManagedElement=1,ENodeBFunction →

=1 dnsLookupOnTai:OFF

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s) updated

4. Example command to modify a sequenced complex data attribute:

cmedit set MeContext=ERBS2000,ManagedElement=1,ENodeBFunction →

=1 x2BlackList:[{enbId=0,mcc=100,mnc=60,mncLength=2}, {enbId= →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 195

 ENM CLI

100,mcc=999,mnc=999,mncLength=3}, {enbId=100000,mcc=500,mnc=1 →
0,mncLength=2}] --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s) updated

Note: a SEQUENCE dataType attribute is specified within square brackets

5. Example command to set an attribute to a null value:

cmedit set ManagedElement=SGSN-16A-CP01-V102,MmeFunction=1 us →

erlabel=<null>

or

cmedit set ManagedElement=SGSN-16A-CP01-V102,MmeFunction=1 us →

erlabel=<empty>

Example Command Response:

SUCCESS FDN : MeContext=SGSN-16A-CP01-V102,MmeBFunction=1

1 instance(s) updated

Note the angular brackets syntax for <null> and <empty>

2.5.5 Tutorial: Set Node Data

< Back To Cmedit

1. Modify a list of simple modeled attribute(s)

Example Command:

cmedit set ERBS2000 ManagedElement userLabel=sampleUserLabel, →

productNumber=CXC101101

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1

196 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

1 instance(s) updated

2. Modify an enumerated attribute

Example Command:

cmedit set ERBS2000 ENodeBFunction dnsLookupOnTai:OFF

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s) updated

3. Set a simple modeled attribute for all instances of ENodeBFunction from

under each of the MeContexts in the collection "CollectionOne"

Example Command:

cmedit set CollectionOne ENodeBFunction userLabel=sampleUserL →

abel --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1

2 instance(s)

4. Filter for object instances of type EUtranCellFDD in the ERBS_NODE_MODEL

namespace with version 3.1.72 across all nodes defined in the network and
filtered on one attribute containing a partial String-value, to set one attribute
on these Managed Objects

Example Command:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 197

 ENM CLI

cmedit set * EUtranCellFDD.userLabel==*sample* tac=13254 -ns= →

ERBS_NODE_MODEL -v=3.1.72 --force

Example Command Response:

SUCCESS FDN : MeContext=Node001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=Node002,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

2 instance(s) updated

Note: that == is used to specify the criteria. A single = (or a colon) is used to
set data
5. Filter for object instances of type EUtranCellFDD under nodes with an ID
starting with a partially specified value and filtered on one attribute value
equal to a specific String-value, to set one attribute on these Managed
Objects. The change is to be made across all node versions in the network

Example Command:

cmedit set ERBS* EUtranCellFDD.userLabel==sampleUserLabel use →

rLabel:"User Label With Spaces" --force

(Note: the value for a string object has to be enclosed in quotes when it
contains any special characters like space, full stop or dollar sign )

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

2 instance(s) updated

198 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

6. Set an attribute on instances of type GeranFreqGroup underneath 2 FDN's

Example Command:

cmedit set MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,GeraNetwork=1; MeContext=ERBS002,ManagedElement=1 GeranFreq →
Group userLabel="New Label" --force

(Note: the FDNs do not have to point to the direct parent of the MO to be
modified, but can be any MO in the network tree above that MO)

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,GeraNetwork=1,GeranFreqGroup=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,GeraNetwork=1,GeranFreqGroup=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,GeraNetwork=1,GeranFreqGroup=2

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,GeraNetwork=1,GeranFreqGroup=3

4 instance(s) updated

7. Filter for object instances of type EUtranCellFDD under nodes with an ID

ending with a partially specified value filtered by one attribute with values
ending with a specific String-value and filtered by another attribute with a
value less-than or equal to a specific numeric value, to set multiple attributes
on these Managed Objects. The change is to be made across all node
versions in the network. However, one of the attributes the command is
intending to set, earfcndl, is a restricted attribute. Once the value of this
attribute is initialized, it cannot be modified

Example Command:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 199

 ENM CLI

cmedit set *001 EUtranCellFDD.(userLabel==*"sampleUserLabel", →

earfcndl<=17000) earfcndl:17999, earfcnul=20000 --force

(Note: the value for a string object has to be enclosed in quotes when it
contains any special characters like space)

Example Command Response:

FAILED FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=ERBS001-1
Error 9999 : Internal Error Model Constraint Violated: Reason →
: Attribute is immutable and was already set, Affected Entity →
=earfcndl; Supplied Value=17999

Note: multiple filters can be specified in the MOI search criteria. Data will be
set only on the MOIs(s) which match the search criteria
8. Example command, filter for object instances of type EUtranCellFDD under
all nodes and filtered by multiple attribute values, to set one attribute on
these Managed Objects. The change is to be made across all node versions in
the network

cmedit set * EUtranCellFDD.(userLabel==*, cellId==1) tac:1325 →

4 --force

Example Command Response:

SUCCESS FDN : MeContext=NODE001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

3 instance(s) updated

9. Filter for object instances of type EUtranCellFDD under all nodes and filtered
by an attribute value not-equal-to a specific value, to set one attribute on

200 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

these Managed Objects. The change is to be made across all node versions in
the network

Example Command:

cmedit set * EUtranCellFDD.(userLabel==*, cellId!=5) tac=1325 →

4 --force

Example Command Response:

SUCCESS FDN : MeContext=NODE001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

3 instance(s) updated

10. Set different values on the same attribute used across multiple MOs for a
given search filter

Example Command:

cmedit set * ManagedElement.userLabel==ERBS1,ENodeBFunction.d →

scpLabel>=36, EUtranCellFDD.earfcndl==17000 ManagedElement.us →
erLabel=ERBS1_ME1, ENodeBFunction.userLabel:ERBS1_ENODEB1 --f →
orce

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 201

 ENM CLI

2 instance(s) updated

11. Set multiple attributes, specifying multiple node IDs in the

ERBS_NODE_MODEL namespace with version 8.1.140 and filtered by one
attribute value greater-than or equal to a specific value

Example Command:

cmedit set Node001;Node002 ENodeBFunction.dscpLabel>=27 userL →

abel=EQUAL; dscpLabel=27 -ns=ERBS_NODE_MODEL -v=8.1.140 --for →
ce

Example Command Response:

SUCCESS FDN : MeContext=Node001,ManagedElement=1,ENodeBFuncti →

on=1

SUCCESS FDN : MeContext=Node002,ManagedElement=1,ENodeBFuncti →

on=1

2 instance(s) updated

12. Set multiple attributes, specifying multiple node IDs in the

ERBS_NODE_MODEL namespace with version 3.1.72 and filtered by
multiple attribute value ranges

Example Command:

cmedit set Node001;Node002 ENodeBFunction.(dscpLabel>=27, x2r →

etryTimerStart<1000) userLabel:EQUAL, dscpLabel:27 -ns=ERBS_N →
ODE_MODEL -v=3.1.72 --force

Example Command Response:

SUCCESS FDN : MeContext=Node001,ManagedElement=1,ENodeBFuncti →

on=1

202 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

SUCCESS FDN : MeContext=Node002,ManagedElement=1,ENodeBFuncti →

on=1

2 instance(s) updated

13. Set multiple attributes on specific Managed Objects, specifying a node ID

and filtered by multiple attribute value ranges

Example Command:

cmedit set ERBS001 ENodeBFunction.userLabel==ENODEB1, EUtranC →

ellFDD.tac==13254, EUtranFreqRelation.qOffsetFreq==-14 EUtran →
CellFDD.userLabel="sample user label", EUtranFreqRelation.qOf →
fsetFreq=-16, EUtranCellFDD.cellRange=30 --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1,EUtranFreqRelation=1

2 instance(s) updated

14. Set multiple attributes on specific and multiple Managed Objects, specifying
a node ID and filtered by multiple attribute value ranges

Example Command:

cmedit set ERBS001 ENodeBFunction.userLabel==ENODEB1, EUtranC →

ellFDD.tac==13254, EUtranFreqRelation.qOffsetFreq==-14 userLa →
bel="sample user label"; EUtranFreqRelation.pMax:25 --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 203

 ENM CLI

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFuncti →

on=1,EUtranCellFDD=1,EUtranFreqRelation=1

3 instance(s) updated

15. Modify a sequenced complex data attribute

Example Command:

cmedit set ERBS2000 ENodeBFunction x2BlackList:[{enbId=0,mcc= →

100,mnc=60,mncLength=2}, {enbId=100,mcc=999,mnc=999,mncLength →
=3}, {enbId=100000,mcc=500,mnc=10,mncLength=2}]

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s) updated

16. Modify the MIM information of a node (a structured complex attribute)

Example Command:

cmedit set ERBS2000 ManagedElement mimInfo=(mimVersion="3.1.7 →

2", mimRelease="", mimName="") -ns=CPP_NODE_MODEL -v=3.12.0

Example Command Response:

SUCCESS FDN : MeContext=ERBS2000 ,ManagedElement=1

1 instance(s) updated

17. Set userLabel attribute to a null value for all MmeFunction MOs

204 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command:

cmedit set MmeFunction userlabel:<null>

or

cmedit set MmeFunction userlabel:<empty>

Example Command Response:

SUCCESS FDN : MeContext=SGSN-16A-CP01-V102,MmeBFunction=1

1 instance(s) updated

2.5.6 Tutorial: Delete Node Data by FDN

< Back To Cmedit

1. Example command to delete an ENodeBFunction and all MOIs under the

ENodeBFunction:

cmedit delete MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1 -ALL --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC002

3 instance(s) deleted

Note: the -ALL parameter is used to force the deletion of MOIs, even if other
MOIs are defined under the specified MOI. The specified FDN and all MOIs
under the FDN are deleted

1/1553-CNA 403 2979 Uen AV | 2020-12-07 205

 ENM CLI

2. Example command to delete the ENodeBFunction and all MOIs under the 2
ENodeBFunctions:

cmedit delete MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1; MeContext=LTE002,ManagedElement=1,ENodeBFunction=1 -ALL →
--force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC002

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

5 instance(s) deleted

3. Example command to attempt to delete an ENodeBFunction instance, which

has at least 1 child defined below it:

cmedit delete MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1 --force

Example Command Response:

FAILED FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunction →

=1

Error 1011 : Cannot delete MeContext=LTE001,ManagedElement=1, →

ENodeBFunction=1 because it has one or more child MOs Delete →
children first. Hint : Append -ALL to end of DELETE command t →
o automatically delete all children.

206 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Note: it is not allowed to delete an MOI if MOIs are defined below the FDN.
To force a delete of the FDN, the -ALL parameter must be specified
4. Example command to delete a ENodeBFunction, which has no Child MOs
defined (for example they have been deleted already):

cmedit delete MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1 --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

1 instance(s) deleted

Note: It is possible to delete an FDN if no MOIs are defined under the FDN,
without specifying the -ALL parameter

Note: It is not possible to delete a system created MO directly. To delete a system

created MO you must delete it's user created parent MO

2.5.7 Tutorial: Delete Node Data

< Back To Cmedit

1. Delete ENodeBFunction instances and all Child MOIs under node with name
LTE001

Example Command:

cmedit delete LTE001 ENodeBFunction -ALL --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

4 instance(s) deleted

1/1553-CNA 403 2979 Uen AV | 2020-12-07 207

 ENM CLI

2. Delete ENodeBFunction instances and all MOIs under them for each of the
MeContexts in the collection "CollectionOne"

Example Command:

cmedit delete CollectionOne ENodeBFunction -ALL --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

4 instance(s) deleted

3. Attempt to delete ENodeBFunction instances under a node with name

LTE001, some of which have Child MOs defined below them whilst others
have no Child MO

Example Command:

cmedit delete LTE001 ENodeBFunction --force

Example Command Response:

FAILED FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE001,Managed →

Element=1,ENodeBFunction=1

Error 9999 : Internal Error The operation was reverted becaus →

e of a system error (Node ID: svc-1-mscm. Exception occurred: →
[Error received from node: aNodeError])

Note: MOs which have child MOs defined below them will not be deleted
even if they satisfy the specified, filtered criteria.
4. Delete ENodeBFunction with the incorrect TYPE_FOR_DELETION specified

208 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Example Command:

cmedit delete LTE001 ENodeBFunction ManagedElement -ALL

Example Command Response:

0 instance(s) found

5. Delete ENodeBFunction instances with userLabel attribute equal to "LTE"

Example Command:

cmedit delete LTE001;LTE002;LTE003 ENodeBFunction.userLabel== →

"LTE" --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1

2 instance(s) deleted

Note: Perform a delete when filtering across a single MO Type, there is no

need to specify the MO type in the delete command.
6. Delete MOs across all nodes defined in the network, which satisfy a specified,
filtered criteria. The MOs to be deleted have no Child MOs

cmedit delete LTE001;LTE002;LTE003 EUtranCellFDD.(EUtranCellF →

DDId==EUC001, cellId==123) EUtranCellFDD --force

Example Command Response:

SUCCESS FDN : MeContext=LTE001,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1,EUtranCellFDD=EUC001

2 instance(s) deleted

1/1553-CNA 403 2979 Uen AV | 2020-12-07 209

 ENM CLI

7. Attempt to delete ENodeBFunction instances, some of which have attributes

filters on different MO types

Example Command:

cmedit delete LTE001;LTE002;LTE003 ENodeBFunction.attr1==x,EU →

tranCellFDD.attrA==y ENodeBFunction

Example Command Response:

SUCCESS FDN : MeContext=LTE002,ManagedElement=1,ENodeBFunctio →

n=1

1 instance(s) deleted

Note: The user shall specifically state the MO Class to be deleted when
querying over multiple type MOs.

Note: It is not possible to delete a system created MO directly. To delete a system

created MO you must delete it's user created parent MO

2.5.8 Tutorial: Import CM Data

< Back To Cmedit

1. Drag and drop the file to be imported into the ENM CLI.

Example Drag and Drop Response:

3gppImportFile.xml added to workspace

or

dynamicImportFile.txt added to workspace

Note Import file must be ordered by managed object hierarchy. Parents must
be created before their children.
2. Import the data file from step 1:

Example Command - Dynamic Format:

cmedit import -f file:dynamicImportFile1.csv -ft dynamic

or

210 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit import -f file:dynamicImportFile1.csv --filetype dynam →

ic

Example Command Response:

Import started with job ID 1

Notes:
— Ericsson dynamic file format is available with the Dynamic CM Value
Package license.
3. Import the data file from step 1 by disabling instance validation phase

Example Command - 3GPP Format:

cmedit import -f file:3gppImportFile.xml -ft 3GPP -val noinst →

ance

or

cmedit import -f file:3gppImportFile.xml --filetype 3GPP --va →

lidate noinstance

Instance validation will be skipped for the import job.

4. Import the data file from step 1 with continue-on-error on node level

Example Command - Dynamic Format:

cmedit import -f file:dynamicImportFile.txt -ft dynamic -e no →

de

or

cmedit import -f file:dynamicImportFile.txt --filetype dynami →

c --error node

If a non-fatal error is encountered for a node, import will mark the operation
as failed, skip the remaining operations on the current node and will continue
to execute operations on subsequent nodes. Non-fatal errors such as
attempting to create an MO that already exists. Fatal errors such as an
incorrectly formatted import file or not well-formed import file will still cause
immediate import failure. The user can also provide stop as a value for the
error flag, resulting in import stopping on first error encountered, this is the
default behaviour for import.for all other possible continue on error values
please refer Import Data

1/1553-CNA 403 2979 Uen AV | 2020-12-07 211

 ENM CLI

5. Query all job details:

Example Command:

cmedit import -st

or

cmedit import --status

Example Command Response:

6. Query job details for a specific job id.

Example Command querying successful job:

cmedit import -st -j 13

or

cmedit import --status --job 13

Example Command Response:

7. Query operation details for a specific job id.

Example Command querying successful job:

cmedit import -st -j 13 -v

or

cmedit import --status --job 13 --verbose

Example Command Response:

212 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

8. Query job details for a specific job id.

Example Command querying failed job:

cmedit import --status --job 14

Example Command Response:

9. Retry an Import Job for a specific job id.

Example Command retrying a failed job:

cmedit import --retry --job 17

Example Command querying the status of a retried job:

cmedit import --status --job 17 -v

Example Command Response:

10. Cancel an Import Job for a specific job id.

Example Command for cancelling a job:

cmedit import --cancel --job 100

Example Command Response:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 213

 ENM CLI

Example Command querying the status of a cancelled job:

cmedit import --status --job 100 -v

Example Command Response:

11. Query job details between the specified begin and end time.

Example Command querying successful job:

cmedit import -st --begin 2016-11-08T08:56:48 --end 2016-11-0 →

8T12:10:27

or

cmedit import --status --begin 2016-11-08T08:56:48 --end 2016 →

-11-08T12:10:27

Example Command Response:

12. Query job details with specified begin time.

Example Command querying successful job:

cmedit import -st --begin 2016-11-08T12:10:27

214 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

or

cmedit import --status --begin 2016-11-08T12:10:27

Example Command Response:

13. Query job details with specified end time.

Example Command querying successful job:

cmedit import -st --end 2016-11-08T12:10:27

or

cmedit import --status --end 2016-11-08T12:10:27

Example Command Response:

14. Sample 3GPP Import File

Sample 3GPP Import File

15. Sample Dynamic Import File

Sample Dynamic Import File

16. When you create a Parent MO with a mandatory Child, the Child MO must be
provided to create the Parent MO successfully.

For Example: If a presence container contains a non presence container with

a mandatory leaf, when the outer container is created, the leaf value must
also be supplied.

Before you create an import file for (v)EPG-OI NE Type, when creating an
MO object, consider the following: The child MO ("requires" tag) is required
when a Parent MO ("Ancestor" tag) is created as per Yang RFC.

(v)EPG-OIBulk Import Dependency

1/1553-CNA 403 2979 Uen AV | 2020-12-07 215

 ENM CLI

2.5.9 Tutorials: Export CM Data

< Back To Cmedit

Create an Export File Without Filtering

Create an Export File in 3GPP Format Using a Node Scope

Create an Export File in 3GPP Format for Synchronized Nodes Only

Create an Export File in Dynamic Format Using a Node Scope

Create an Export File Using Filtering

Create an Export File in 3GPP Format Using a Predefined Filter

Create an Export File in 3GPP Format Using a User-Defined Filter

Create an Export File in Dynamic Format Containing Topology Data Only

Create an Export File in 3GPP Format Using predefined filter

In_Service_Performance_Data Periodically

2.5.10 Tutorial: Initiate a Modeled Action on a MOI

< Back To Cmedit

1. Action by FDN

Example Command:

cmedit action MeContext=ERBS0001,ManagedElement=1 manualResta →

rt.(restartRank=RESTART_WARM,restartReason=PLANNED_RECONFIGUR →
ATION,restartInfo=someInfo)

Example Command Response:

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1,ENodeBFunct →

ion=1

1 instance(s)

2. Action Using MO Query with Node Name

Example Command:

216 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit action ERBS0001;ERBS0002 ManagedElement.userLabel==sam →

ple* manualRestart.(restartRank=RESTART_WARM;restartReason=PL →
ANNED_RECONFIGURATION;restartInfo=someInfo) --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1 userLabel : →

sampleUserLabel

SUCCESS FDN : MeContext=ERBS0002,ManagedElement=1 userLabel : →

sampleUserLabel

2 instance(s)

Note 1: For more examples of different 'Scopes' and 'Filters' check the "Get
Node Data tutorial".

Note 2: As it is possible to target more than one MO Types with one action
command (similar to the get command) this will not be successful unless all
these types support the same modeled action.
3. Action Using MO Query with Node Name Resulting in Partial Failure

Example Command:

cmedit action ERBS000* ManagedElement.userLabel==sample* manu →

alRestart.(restartRank=RESTART_WARM;restartReason=PLANNED_REC →
ONFIGURATION;restartInfo=someInfo) --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1 userLabel : →

sampleUserLabel

SUCCESS FDN : MeContext=ERBS0002,ManagedElement=1 userLabel : →

sampleUserLabel

FAILED FDN : MeContext=ERBS0003,ManagedElement=1 userLabel : →

sampleUserLabel

Error 9999 : Internal Error The operation was reverted becaus →

e of a system error (Node ID: svc-1-mscm. Exception occurred: →
[Error received from node: aNodeError])

1/1553-CNA 403 2979 Uen AV | 2020-12-07 217

 ENM CLI

Error 5008 : The command executed on 2 out of 3 objects

4. Action on ManagedElement under each of the MeContexts in the collection

"CollectionOne"

Example Command:

cmedit action CollectionOne ManagedElement manualRestart.(res →

tartRank=RESTART_WARM;restartReason=PLANNED_RECONFIGURATION;r →
estartInfo=someInfo) --force

Example Command Response:

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1

SUCCESS FDN : MeContext=ERBS0002,ManagedElement=1

2 instance(s)

2.5.11 How To Describe Modeled Data

< Back To Cmedit

List of Contents

— Describe Ne Type

— Describe MO Type - Basic Examples

— Describe MO Type with Options

— Describe Multiple MO Types

— Describe Mo Types with Attributes

1. Describe Network Element (NE) Type

Command to describe version information for NeType

cmedit describe --netype <NE Type>

This example command returns version information for NE Type SGSN-MME. The
list is populated from the model service. Some fields may be blank if information
is unavailable in the model.

Example:

218 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit describe --netype SGSN-MME

Result:

The attributes of all SGSN-MME NE types deployed on the system are displayed.

2. Describe MO Type - Basic Examples

Command to describe the latest versions in all namespaces of the specified

MO Type

cmedit describe <Mo Type>

This example command returns descriptions for the most recent version of the
MO Type in all namespaces.

Example:

cmedit describe managedelement

Result:

All Managed Elements for the latest version of each NE Type deployed on the
system are displayed.

3. Describe MO Type Examples with Options

Command to describe a specific version of MO Type only

cmedit describe <Mo Type> --version=<Version>

This example command returns descriptions for all namespaces of the specified
MO Type version.

Example:

cmedit describe ManagedElement --version=G.1.301

Result:

All Managed Elements for the specified version deployed on the system are
displayed.

Command to describe MO Type for a specific namespace only

1/1553-CNA 403 2979 Uen AV | 2020-12-07 219

 ENM CLI

cmedit describe <Mo Type> --namespace=<Namespace>

This example command returns descriptions for the most recent version of the
MO Type in the specified namespace.

Example:

cmedit describe managedelement --namespace=ERBS_NODE_MODEL

Result:

The latest version of the Managed Element for the specified namespace deployed
on the system is displayed.

Command to describe MO Type of a specific version and namespace only

cmedit describe <Mo Type> --namespace=<Namespace> --version=<Ver →

sion>

This example command returns descriptions for the specified version and
namespace of the MO Type.

Example:

cmedit describe managedelement --namespace=ERBS_NODE_MODEL --ver →

sion=G.1.101

Result:

The Managed Element for the specified namespace and version is displayed.

Command to describe all model instances of the specified type

cmedit describe <MO Type> --ALL

This example command returns all model instance descriptions across all
namespaces and versions for the specified MO Type.

Example:

cmedit describe managedelement --all

Result:

All Managed Elements deployed on the system are displayed.

220 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Command to describe all model instances for the specified namespace

cmedit describe <Mo Type> -ns=<Namespace> --ALL

This example command returns all model instances for the specified namespace.

Example:

cmedit describe managedelement -ns ERBS_NODE_MODEL --all

Result:

All Managed Elements for the specified namespace deployed on the system are
displayed.

4. Describe Multiple MO Types:

Command to describe Multiple MO Types for latest versions in all namespaces

cmedit describe <Mo Type1>;<Mo Type2>;<Mo Type3>

This example command returns multiple descriptions for same MO Type. This
occurs if you do not specify a namespace/version in the command.

Example:

cmedit describe ManagedElement;ENodeBFunction;EUtranCellFDD

Result:

All ManagedElements, ENodeBFunctions, and EUtranCellFDDs for the latest

versions in each namespace deployed in the system are displayed.

Command to describe Multiple MO Types for latest versions in the specified

namespace

cmedit describe <Mo Type1>;<Mo Type2>;<Mo Type3> --namespace=<Na →

mespace>

This example command returns descriptions for MO Types with the OSS_TOP
namespace.

If a version is specified, the results are filtered to return the modeled descriptions
for that version.

Example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 221

 ENM CLI

cmedit describe mecontext;managedelement -ns OSS_TOP

Result:

All MeContexts and ManagedElements for the latest version in the specified
namespace are displayed.

5. Describe MO Types with Attributes:

Command to describe latest MO Type with specified attribute

cmedit describe <Mo Type>.<Mo Attribute>

This example command returns a description(s) of the specified Mo Attribute.

(Note: The following command requests can specify the version and namespace
options).

Example:

cmedit describe managedelement.healthcheckresult

Result:

All ManagedElement healthCheckResult attributes for the latest deployed

version on the system is displayed.

Command to describe latest MO Type with specified attribute in the specified

namespace

cmedit describe <Mo Type>.<Mo Attribute> --namespace=<Namespace>

This example command returns descriptions of the specified MO Attribute and

namespace. The command returns the description(s) for the attributes in that
namespace for all model versions.

Example:

cmedit describe managedelement.healthcheckresult -ns ERBS_NODE_M →

ODEL

Result:

All ManagedElement healthCheckResult attributes for the latest version in the

specified namespace deployed on the system are displayed.

222 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Command to describe latest MO Type with specified multiple attributes

cmedit describe <Mo Type>.(<Mo Attribute1>,<Mo Attribute2>)

This example command returns descriptions of the specified attributes.

Example:

cmedit describe enodebfunction.(userlabel,enodebfunctionid)

Result:

All ENodeBFunction userLabel, and eNodeBFunctionId attributes for the latest

version of each namespace deployed on the system are displayed.

Command to describe latest MO Type with all attributes

cmedit describe <Mo Type>.*

This example command returns descriptions for all MO Attributes of the MO Type
from all namespaces, and latest versions.

By default, inherited attributes from the super type are also displayed.

If namespace ERBS_NODE_MODEL is specified, OSS_TOP attributes (the

inherited ones), and ERBS_NODE_MODEL attributes are returned.

Example:

cmedit describe managedelement.*

Result:

All ManagedElement attributes for the latest version in each namespace

deployed on the system are displayed.

Command to describe specific and all attributes on multiple MO Types

cmedit describe <Mo Type1>.*;<Mo Type2>.(<Mo Attribute1>,<Mo Att →

ribute2>)

This example command returns descriptions of the all/specified attributes for

multiple MOs at the same time.

Example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 223

 ENM CLI

cmedit describe ManagedElement.*;ENodeBFunction.(ENodeBFunctionI →

d, pmRimReportErr)

Result:

All ManagedElement attributes and ENodeBFunction attributes

(ENodeBFunctionId, pmRimReportErr) for the latest version in each namespace
deployed on the system are displayed.

2.5.12 Non Persisted Attributes

< Back To Cmedit

Non Persisted Attributes are attributes which exist in the node but are not
persisted locally to the database.

Therefore these attributes can be read but not queried by ENM CLI.

2.5.13 Case Sensitivity in the cmedit Command Set

< Back To Cmedit

This page details which parts of the commands are case insensitive and which
are not.

Case Insensitive
The following parts of cmedit commands are case insensitive:

— MO class and attribute names

— Action and Action parameter names

— Struct and Struct member names

— Node names or partial node names if scope type option is -n or --node

Case Sensitive
The following parts of cmedit commands are case sensitive:

— Command keywords. All keywords are in lowercase. For example "cmedit",

"get", "create"

— Command options and flags. Most of the options and flags are in lowercase.
Except "-ALL" (see delete and export commands)

— Namespace names and versions

224 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Attribute identifiers. All of the attribute identifiers are in lowercase. For

example "ManagedElement.<cm>", "ManagedElement.<pm>"

— String data. Any string values stored in the database or models, which
include but not limited to:
• FDNs

• String values. The values of fields of type String. For example "My user
label"

• Enum values. The value of fields of type Enum are typically in

UPPERCASE. For example "LOCKED", "UNLOCKED",
"SHUTTING_DOWN"

• Node Types. Since node types are also Enum values they are case
sensitive. For example "ERBS", "RNC", "MGW"

• <null>

Example Use of Case Insensitivity

Get a MO Class with Criteria Using a Case Insensitive Query

cmedit get * managedelement.userlabel

Response

This command returns all instances of MO Class "ManagedElement". The

following is the information shown for one instance:

FDN : MeContext=LTE10ERBS00001,ManagedElement=1

userLabel : label1

Get a MO Class with Criteria Using a Case Insensitive Query and Case
Insensitive Node Name

cmedit get --node lte10ERBS00001 managedelement.userlabel

Response

FDN : MeContext=LTE10ERBS00001,ManagedElement=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 225

 ENM CLI

userLabel : label1

1 instance(s)

Get a MO Class with Criteria Using a Case Insensitive Query and Case
Insensitive Partial Node Name

cmedit get --node lte10ERBS0000* managedelement.userlabel

Response

FDN : MeContext=LTE10ERBS00001,ManagedElement=1

userLabel : label1

FDN : MeContext=LTE10ERBS00002,ManagedElement=2

userLabel : label2

FDN : MeContext=LTE10ERBS00003,ManagedElement=3

userLabel : label3

3 instance(s)

2.5.14 cmedit Command Set Special Characters

< Back To Cmedit

This tutorial details cmedit special characters and how to use them.

Supported Characters in cmedit command arguments

Character Description Usage

[a-z][A-Z] alphabetic characters All MO class, scope name, RDN
value and attribute value

226 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Character Description Usage

[0-9] numeric characters All MO class, scope name, RDN
value and attribute value
. full stop All scope name, RDN value and
attribute value
? question mark All attribute value
! exclamation mark All RDN value and attribute value
@ at sign All RDN value and attribute value
% percent sign All RDN value and attribute value
& ampersand All RDN value and attribute value
^ circumflex accent All RDN value and attribute value
_ low line All scope name, RDN value and
attribute value
/ slash All RDN value and attribute value
| vertical bar All RDN value and attribute value
- hyphen-minus All scope name, RDN value and
attribute value but not as first
character
= equal All attribute value but not as first
character
$ dollar All RDN value and attribute value
but not more than one consecutive
symbol

NOTE: Quotes are not required with supported characters.

What are Special Characters?

Special characters are any characters other than the supported characters. These
characters must be wrapped in quotes to be accepted in the scope name or
attribute value part of the command.

The set of special characters allowed in RDN value are:

*()[]\+ and space

If an FDN contains an RDN value with special characters, the entire FDN String
must be wrapped in quotes. The spaces at the beginning and/or at the end of the
RDN value are stripped.

When a special character is used without quotes an error is displayed.

See the example below.

Special Characters Examples

Get an MO Class with an FDN with Supported Characters in RDN value

1/1553-CNA 403 2979 Uen AV | 2020-12-07 227

 ENM CLI

cmedit get SubNetwork=ERBS-SUBNW-1,MeContext=ERBS@001,ManagedEle →

ment=1^5

Example Command Response:

This command returns the instance of MO Class "ManagedElement" with given

FDN. The following information is displayed for one instance:

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS@001,ManagedElement= →
1^5

ManagedElementId : 1^5

applicationConfiguration : []

healthCheckResult : {startTime=, message=, healthCheckResultCode →

=INITIAL_VALUE}

healthCheckSchedule : []

logicalName :

mimInfo : {mimVersion=1, mimRelease=160, mimName=ERBS_NODE_MODEL →

_H}

neType : null

platformType : null

productName :

productNumber :

productRevision :

productType : Node

site :

228 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

userLabel :

1 instance(s)

Delete a MO Class with Supported Character in Attribute Value

cmedit delete * ENodeBFunction.userLabel==sample-UserLabel^01

Example Command Response:

This command deletes the instances of MO Class "ENodeBFunction" with

attribute value containing allowed special character. The following information is
displayed for one instance:

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

1 instance(s) deleted

Create a MO Class with Special Characters in Attribute Value (ipv6 address)

cmedit create SubNetwork=Eric3,MeContext=Ne-ipv6-R234,ManagedEle →

ment=1,Transport=1,Router=FRONTHAUL,InterfaceIPv6=FRONTHAUL,Addr →
essIPv6=1 addressIPv6Id=1,address="2001:1b70:8210:8740::2c4/64"

Example Command Response:

This command creates the SubNetwork MO Class with attribute value containing
Special Character wrapped in quotes. The following information is displayed in
the response:

FDN : SubNetwork=Eric3,MeContext=Ne-ipv6-R234,ManagedElement=1,T →
ransport=1,Router=FRONTHAUL,InterfaceIPv6=FRONTHAUL,AddressIPv6= →
1

addressIPv6Id=1

address=2001:1b70:8210:8740::2c4/64

1/1553-CNA 403 2979 Uen AV | 2020-12-07 229

 ENM CLI

1 instance(s) updated

Get a MO Class with Special Characters in the RDN value

cmedit get "NetworkElement=Eric04 LTE01ERBS00088,PMICScannerInfo →

=USERDEF-node duplicate chack.Cont.Y.STATS"

Example Command Response:

The FDN contains RDN value with space symbol that is a Special Character, this
must be wrapped in quotes. The following information is displayed in the
response:

FDN : NetworkElement=Eric04 LTE01ERBS00088,PMICScannerInfo=USERD →

EF-node duplicate chack.Cont.Y.STATS

PMICScannerInfoId : USERDEF-node duplicate chack.Cont.Y.STATS

errorCode : -1

fileCollectionEnabled : true

id : 14

name : USERDEF-node duplicate chack.Cont.Y.STATS

nodeName : null

processType : STATS

ropPeriod : 900

status : ACTIVE

subscriptionId : 281476044782780

1 instance(s)

230 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.5.15 Sample 3GPP import file

< Back To Cmedit

Format Information
Please note the following regarding the format on the 3GPP Import file:

1. Import using 3GPP format is compliant with 3GPP TS 32.615 V4.5.0

schemas
2. Import supports 4 modifier operations that can be configured within the
3GPP Import file
• create: Signifies a create operation on the specified managed object(s)
• update: Signifies an update operation on the specified managed
object(s)

• delete: Signifies a delete operation on the specified managed object(s)

• action: Signifies an action operation on the specified managed object
3. Create operation is not supported for Network Element Managed Object.
4. The sample file below assumes that the SubNetwork, Node and MO structure
required for the import to succeed are already present on the system
5. The sample is intended as a guide to illustrate the syntax and XML structure
of each type of operation supported by import
6. Import supports breakpoints in the 3GPP Import file to control the
operations committed per transaction:
• Breakpoints are optional

• When a breakpoint is specified for a given operation in the import file,

the commit will be performed after that operation. The transaction will
contain that operation and the previous operations for the node which
have not yet been committed

• When a breakpoint is supplied for an operation which does not contain

modifier(CREATE/UPDATE/DELETE/ACTION) then that operation will
be skipped and breakpoint will be ignored.

• The breakpoint, when included for an operation, must be included as the

first element in the VsDataContainer for that operation

• A breakpoint contains 3 attributes:

— The type attribute is mandatory. This attribute currently supports
one breakpoint type: commit. This signifies that a transaction
commit will be performed after the Import operation which contains
the breakpoint

1/1553-CNA 403 2979 Uen AV | 2020-12-07 231

 ENM CLI

— The id and description attributes are optional. The id value

represents an identifier for a breakpoint. The description value
contains additional information that an operator could provide for
the breakpoint

• See sample file below for breakpoint usage

Syntax

<?xml version="1.0" encoding="UTF-8"?>

<bulkCmConfigDataFile xmlns:un="utranNrm.xsd" xmlns:xn="genericN →
rm.xsd" xmlns:gn="geranNrm.xsd" xmlns:es="EricssonSpecificAttrib →
utes.14.02.xsd" xmlns="configData.xsd">
<fileHeader fileFormatVersion="32.615 V4.5" vendorName="Eric →
sson"/>
<configData dnPrefix="Undefined">
<xn:SubNetwork id="WESTMEATH">
<xn:MeContext id="ATHLONE_1">
<xn:ManagedElement id="ATHLONE_1">
<xn:VsDataContainer id="ATHLONE_1">
<xn:attributes>
<xn:vsDataType>vsDataENodeBFunction< →
/xn:vsDataType>
<xn:vsDataFormatVersion>EricssonSpec →
ificAttributes</xn:vsDataFormatVersion>
<es:vsDataENodeBFunction/>
</xn:attributes>
<xn:VsDataContainer id="CORNAMADDY_1" mo →
difier="update">
<xn:breakpoint type="commit" id="BP_ →
1" description="My Breakpoint"/>
<xn:attributes>
<xn:vsDataType>vsDataEUtranCellF →
DD</xn:vsDataType>
<xn:vsDataFormatVersion>Ericsson →
SpecificAttributes</xn:vsDataFormatVersion>
<es:vsDataEUtranCellFDD>
<es:tac>64321</es:tac>
</es:vsDataEUtranCellFDD>
</xn:attributes>
</xn:VsDataContainer>
<xn:VsDataContainer id="CORNAMADDY_2" mo →
difier="create">
<xn:attributes>
<xn:vsDataType>vsDataEUtranCellF →
DD</xn:vsDataType>
<xn:vsDataFormatVersion>Ericsson →
SpecificAttributes</xn:vsDataFormatVersion>
<es:vsDataEUtranCellFDD>

232 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<es:userLabel>USER_LABEL_EUC →
3</es:userLabel>
<es:administrativeState>UNLO →
CKED</es:administrativeState>
<es:earfcndl>17500</es:earfc →
ndl>
<es:earfcnul>35500</es:earfc →
nul>
<es:cellId>100</es:cellId>
<es:physicalLayerCellIdGroup →
>0</es:physicalLayerCellIdGroup>
<es:physicalLayerSubCellId>0 →
</es:physicalLayerSubCellId>
<es:tac>64543</es:tac>
<es:noOfPucchCqiUsers>50</es →
:noOfPucchCqiUsers>
<es:noOfPucchSrUsers>50</es: →
noOfPucchSrUsers>
<es:emergencyAreaId>10</es:e →
mergencyAreaId>
<es:emergencyAreaId>24334</e →
s:emergencyAreaId>
<es:emergencyAreaId>54436</e →
s:emergencyAreaId>
<es:emergencyAreaId>34</es:e →
mergencyAreaId>
<es:emergencyAreaId>-1</es:e →
mergencyAreaId>
<es:qRxLevMinOffset>1000</es →
:qRxLevMinOffset>
<es:prsPeriod>PP320</es:prsP →
eriod>
<es:sectorCarrierRef>SubNetw →
ork=ONRM_RootMo_R,SubNetwork=DUBLIN,MeContext=RATHMINES001,Manag →
edElement=1,vsDataSectorEquipmentFunction=1</es:sectorCarrierRef →
>
</es:vsDataEUtranCellFDD>
</xn:attributes>
</xn:VsDataContainer>
<xn:VsDataContainer id="CORNAMADDY_WEST" →
modifier="delete">
<xn:attributes>
<xn:vsDataType>vsDataEUtranCellF →
DD</xn:vsDataType>
<xn:vsDataFormatVersion>Ericsson →
SpecificAttributes</xn:vsDataFormatVersion>
<es:vsDataEUtranCellFDD/>
</xn:attributes>
</xn:VsDataContainer>
<xn:VsDataContainer id="CORNAMADDY_2" mo →
difier="action">
<xn:attributes>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 233

 ENM CLI

<xn:vsDataType>vsDataEUtranCellF →
DD</xn:vsDataType>
<xn:vsDataFormatVersion>Ericsson →
SpecificAttributes.14.02</xn:vsDataFormatVersion>
<es:vsDataEUtranCellFDD>
<es:changeFrequency>
<es:earfcn>17999</es:ear →
fcn>
</es:changeFrequency>
</es:vsDataEUtranCellFDD>
</xn:attributes>
</xn:VsDataContainer>
</xn:VsDataContainer>
</xn:ManagedElement>
</xn:MeContext>
</xn:SubNetwork>
</configData>
<fileFooter dateTime="2008-09-11T15:27:07Z"/>
</bulkCmConfigDataFile>

< Back

2.5.16 Sample Dynamic Import file

< Back To Cmedit

Format Information
Please note the following regarding the format on the dynamic import file:

1. Dynamic file format is an Ericsson proprietary file format

2. Dynamic import file supports 4 operations:
• create: Signifies a create operation on the specified managed object(s)
• set: Signifies an set operation on the specified managed object(s)
• delete: Signifies a delete operation on the specified managed object(s)
• action: Signifies a action operation on the specified managed object(s)
3. Import supports breakpoints in the dynamic import file to control the
operations committed per transaction:
• Breakpoints are optional

• When a breakpoint is specified for a given operation in the import file,

the commit will be performed after that operation. The transaction will
contain that operation and the previous operations for the node which
have not yet been committed

234 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

• When a breakpoint is supplied for an operation which does not contain

modifier(CREATE/SET/DELETE/ACTION) then that operation will be
skipped and breakpoint will be ignored.

• The breakpoint, when included for an operation, must be included as the

last line for that operation

• A breakpoint contains 3 attributes:

— The type attribute is mandatory. This attribute currently supports
one breakpoint type: commit. This signifies that a transaction
commit will be performed after the Import operation which contains
the breakpoint

— The id and description attributes are optional. The id value

represents an identifier for a breakpoint. The description value
contains additional information that an operator could provide for
the breakpoint

• Attributes of the breakpoint should be supplied in the same order as

specified below in the syntax section

• See sample file below for breakpoint usage

Syntax
File Format Template

#Some comment text // The # denotes that the line →

is a comment
#More comment text // Comments can appear anywher →
e in the file
<command>: // ‘create’, ‘set’, ‘delete’ o →
r ‘action’ + optional colon. Command line is optional
FDN : <fdn1> // FDN of MO being operated on
<action name> // Only needed if the command →
is ‘action’
<attribute 1> : <value 1> // Attributes not needed for d →
elete
<attribute 2> : <value 2>
<attribute 3> : <value 3>
@breakpoint:type=<breakpoint type>,id="<id>",description →
="<description>" // Breakpoint is optional.
→
// Breakpoint type is mandatory - ‘commit’.
→
// id and description are optional.
→
// Order of the attributes should be same.
//Blank line(s), or line(s) →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 235

 ENM CLI

with single colon, are

: //optional anywhere in file →
(parser will ignore them)
#Some more comment text
<command>
FDN : <fdn2>
<attribute 4> : <value 4>
<attribute 5> : <value 5>
<attribute 6> : <value 6>

#Block(s) without heading command are skipped.

FDN : <fdn3>
<attribute 7> : <value 7>
<attribute 8> : <value 8>
<attribute 9> : <value 9>

Example

#This file makes the updates requested in Work Order 457 →

-92

#Create relations
create
FDN : SubNetwork=Stockholm,MeContext=Stk1,…,EUtranCellRe →
lation=33
EUtranCellRelationId : 33
neighborCellRef : "SubNetwork=Stockholm,MeContext=Stk1,… →
,ExternalEUtranCellFDD=1-1"

#Update cell 1-1

set
FDN : SubNetwork=Stockholm,MeContext=Stk1,..,ENodeBFunct →
ion=1,EUtranCellFDD=1-1
userLabel : Cell1-1
tac : 50
administrativeState : LOCKED
eutranCellCoverage : {posCellOpeningAngle=-1, posCellRad →
ius=0, posCellBearing=-1}
additionalPlmnReservedList : [false, false]
additionalPlmnList : [{mcc=353, mnc=57, mncLength=2}, {m →
cc=353, mnc=58, mncLength=2}]
sectorCarrierRef : [“MeContext=Stk1,...,SectorCarrier=1” →
,”MeContext=Stk1,..,SectorCarrier=2”]
externalCdma20001xRttCellRef : <empty>

#Delete problem relation

delete

236 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=Stockholm,MeContext=Stk1…,EUtranCellRel →
ation=32

#Change cell frequency

action
FDN : SubNetwork=Stockholm,MeContext=Stk1,..,ENodeBFunct →
ion=1,EUtranCellFDD=1-1
changeFrequency
earfcn : 5000
@breakpoint:type=commit,id="BP_1",description="My breakp →
oint"

#Modify cell 1-1 again

set
FDN : SubNetwork=Stockholm,MeContext=Stk1,..,ENodeBFunct →
ion=1,EUtranCellFDD=1-1
cellSubscriptionCapacity : 100000

< Back

2.5.17 Interdependency in (v)EPG-OI Bulk Import

EPG-OI 2.5 Bulk Import Interdependency

vEPG-OI 2.5 Bulk Import Interdependency

EPG-OI 2.6 Bulk Import Interdependency

vEPG-OI 2.6 Bulk Import Interdependency

EPG-OI 2.11 Bulk Import Interdependency

vEPG-OI 2.11 Bulk Import Interdependency

EPG-OI 3.4 Bulk Import Interdependency

vEPG-OI 3.4 Bulk Import Interdependency

EPG-OI 3.5 Bulk Import Interdependency

vEPG-OI 3.5 Bulk Import Interdependency

EPG-OI 2.5 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 237

 ENM CLI

th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)

238 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 239

 ENM CLI

p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →
ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /epg/sgw/user-plane-pool/pool (list)
requires: /epg/sgw/user-plane-pool/pool/node-name →
(list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)

240 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/congestion-avoidance-map/queue/queu →
e-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queu →
e-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 241

 ENM CLI

requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/t →
m-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)
Ancestor: /security-gateway/ipsec/ike2-policy (lis →
t)
requires: /security-gateway/ipsec/ike2-policy/seq- →
ike2-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-acl (list)
requires: /security-gateway/ipsec/ipsec-acl/acl-ru →
le (list)
Ancestor: /security-gateway/ipsec/ipsec-policy (li →
st)
requires: /security-gateway/ipsec/ipsec-policy/seq →
-ipsec-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-proposal ( →
list)
requires: /security-gateway/ipsec/ipsec-proposal/e →
sp (list)
Ancestor: /security-gateway/ipsec/ipsec-sa (list)
requires: /security-gateway/ipsec/ipsec-sa/inbound →
(list)
requires: /security-gateway/ipsec/ipsec-sa/outboun →
d (list)
Ancestor: /security-gateway/ipsec/vpn (list)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/context (leaf)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/local (leaf)

vEPG-OI 2.5 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)

242 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /confdConfig/subagents/subagent/tcp (con →

tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 243

 ENM CLI

edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)

244 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /epg/sgw/user-plane-pool/pool (list)
requires: /epg/sgw/user-plane-pool/pool/node-name →
(list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 245

 ENM CLI

Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)

EPG-OI 2.6 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →

246 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 247

 ENM CLI

requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →

248 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →
ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 249

 ENM CLI

Ancestor: /qos/congestion-avoidance-map/queue/queu →
e-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queu →
e-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group (li →
st)
requires: /qos/policy/metering/l2-access-group/l2- →
access-group-opt/aclname-rg (leaf)
requires: /qos/policy/metering/l2-access-group/l2- →
access-group-opt/gpol-ctxname (leaf)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group (li →
st)
requires: /qos/policy/policing/l2-access-group/l2- →
access-group-opt/aclname-rg (leaf)
requires: /qos/policy/policing/l2-access-group/l2- →
access-group-opt/gpol-ctxname (leaf)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →

250 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/t →
m-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)
Ancestor: /security-gateway/ipsec/ike2-policy (lis →
t)
requires: /security-gateway/ipsec/ike2-policy/seq- →
ike2-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-acl (list)
requires: /security-gateway/ipsec/ipsec-acl/acl-ru →
le (list)
Ancestor: /security-gateway/ipsec/ipsec-policy (li →
st)
requires: /security-gateway/ipsec/ipsec-policy/seq →
-ipsec-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-proposal ( →
list)
requires: /security-gateway/ipsec/ipsec-proposal/e →
sp (list)
Ancestor: /security-gateway/ipsec/ipsec-sa (list)
requires: /security-gateway/ipsec/ipsec-sa/inbound →
(list)
requires: /security-gateway/ipsec/ipsec-sa/outboun →
d (list)
Ancestor: /security-gateway/ipsec/vpn (list)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/context (leaf)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/local (leaf)

vEPG-OI 2.6 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 251

 ENM CLI

requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →

252 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 253

 ENM CLI

Ancestor: /contexts/snmp/target (list)

requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →
ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)

254 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/congestion-avoidance-map/queue/queu →
e-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queu →
e-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group (li →
st)
requires: /qos/policy/metering/l2-access-group/l2- →
access-group-opt/aclname-rg (leaf)
requires: /qos/policy/metering/l2-access-group/l2- →
access-group-opt/gpol-ctxname (leaf)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group (li →
st)
requires: /qos/policy/policing/l2-access-group/l2- →
access-group-opt/aclname-rg (leaf)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 255

 ENM CLI

requires: /qos/policy/policing/l2-access-group/l2- →
access-group-opt/gpol-ctxname (leaf)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/t →
m-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)
Ancestor: /security-gateway/ipsec/ike2-policy (lis →
t)
requires: /security-gateway/ipsec/ike2-policy/seq- →
ike2-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-acl (list)
requires: /security-gateway/ipsec/ipsec-acl/acl-ru →
le (list)
Ancestor: /security-gateway/ipsec/ipsec-policy (li →
st)
requires: /security-gateway/ipsec/ipsec-policy/seq →
-ipsec-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-proposal ( →
list)
requires: /security-gateway/ipsec/ipsec-proposal/e →
sp (list)
Ancestor: /security-gateway/ipsec/ipsec-sa (list)
requires: /security-gateway/ipsec/ipsec-sa/inbound →
(list)
requires: /security-gateway/ipsec/ipsec-sa/outboun →
d (list)
Ancestor: /security-gateway/ipsec/vpn (list)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/context (leaf)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/local (leaf)

EPG-OI 2.11 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO

256 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /confdConfig/subagents/subagent (list)

requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 257

 ENM CLI

Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)

258 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /contexts/snmp/notify-target (list)

requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →
ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profile →
(list)
requires: /epg/pgw/credit-control/retention-profile →
/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profile →
/quota-handling/validity-time (leaf)
Ancestor: /epg/upf/reporting/event-reporting/profil →
e (list)
requires: /epg/upf/reporting/event-reporting/profil →
e/event (list)
Ancestor: /interfaces/interface/l3-interface (conta →
iner)
requires: /interfaces/interface/l3-interface/inter- →
context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 259

 ENM CLI

Ancestor: /pm/measurement-capabilities (container)

requires: /pm/measurement-capabilities/measurement- →
jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement- →
jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement- →
jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement- →
jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement- →
jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-job →
s/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-jo →
bs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (leaf →
)
Ancestor: /qos/congestion-avoidance-map/queue/queue →
-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queue →
-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (lea →
f)
Ancestor: /qos/policy/metering/class-group/class/ra →
te/conform (container)
requires: /qos/policy/metering/class-group/class/ra →
te/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl- →
class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl- →
class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/ac →
l-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/ac →
l-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl- →
class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl- →
class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/ra →
te/conform (container)
requires: /qos/policy/policing/class-group/class/ra →
te/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl- →
class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl- →
class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/ac →
l-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/ac →

260 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

l-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl- →
class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl- →
class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate/ →
arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate/ →
arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate/ →
arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/tm →
-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority/ →
priority (leaf-list)
Ancestor: /security-gateway/ipsec/ike1-policy (list →
)
requires: /security-gateway/ipsec/ike1-policy/seq-i →
ke1-proposal (list)
Ancestor: /security-gateway/ipsec/ike2-policy (list →
)
requires: /security-gateway/ipsec/ike2-policy/seq-i →
ke2-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-acl (list)
requires: /security-gateway/ipsec/ipsec-acl/acl-rul →
e (list)
Ancestor: /security-gateway/ipsec/ipsec-policy (lis →
t)
requires: /security-gateway/ipsec/ipsec-policy/seq- →
ipsec-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-proposal (l →
ist)
requires: /security-gateway/ipsec/ipsec-proposal/es →
p (list)
Ancestor: /security-gateway/ipsec/ipsec-sa (list)
requires: /security-gateway/ipsec/ipsec-sa/inbound →
(list)
requires: /security-gateway/ipsec/ipsec-sa/outbound →
(list)
Ancestor: /security-gateway/ipsec/vpn (list)
requires: /security-gateway/ipsec/vpn/peer-end-poin →
t-v4/context (leaf)
requires: /security-gateway/ipsec/vpn/peer-end-poin →
t-v4/local (leaf)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 261

 ENM CLI

vEPG-OI 2.11 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)

262 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 263

 ENM CLI

requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /epg/upf/reporting/event-reporting/profi →
le (list)
requires: /epg/upf/reporting/event-reporting/profi →
le/event (list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)

264 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)

EPG-OI 3.4 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 265

 ENM CLI

dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →

266 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop(leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop(leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop(leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 267

 ENM CLI

arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →
ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw/credit-control/retention-profil →
e (list)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/retention-profil →
e/quota-handling/validity-time (leaf)
Ancestor: /epg/sgw/user-plane-pool/pool (list)
requires: /epg/sgw/user-plane-pool/pool/node-name →
(list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)

268 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/congestion-avoidance-map/queue/queu →
e-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queu →
e-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 269

 ENM CLI

requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/t →
m-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)
Ancestor: /security-gateway/ipsec/ike2-policy (lis →
t)
requires: /security-gateway/ipsec/ike2-policy/seq- →
ike2-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-acl (list)
requires: /security-gateway/ipsec/ipsec-acl/acl-ru →
le (list)
Ancestor: /security-gateway/ipsec/ipsec-policy (li →
st)
requires: /security-gateway/ipsec/ipsec-policy/seq →
-ipsec-proposal (list)
Ancestor: /security-gateway/ipsec/ipsec-proposal ( →
list)
requires: /security-gateway/ipsec/ipsec-proposal/e →
sp (list)
Ancestor: /security-gateway/ipsec/ipsec-sa (list)
requires: /security-gateway/ipsec/ipsec-sa/inbound →
(list)
requires: /security-gateway/ipsec/ipsec-sa/outboun →
d (list)
Ancestor: /security-gateway/ipsec/vpn (list)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/context (leaf)
requires: /security-gateway/ipsec/vpn/peer-end-poi →
nt-v4/local (leaf)

vEPG-OI 3.4 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /epg/user-plane/abr-shaping/profile (lis →
t)
requires: /epg/user-plane/abr-shaping/profile/serv →
ice (list)
Ancestor: /epg/user-plane/acls/acl/aces/ace (list)
requires: /epg/user-plane/acls/acl/aces/ace/action →
s/forwarding (leaf)
Ancestor: /epg/user-plane/reporting/event-reportin →

270 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

g/profile (list)
requires: /epg/user-plane/reporting/event-reportin →
g/profile/event (list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 271

 ENM CLI

Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)

EPG-OI 3.5 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/ippm/twamp-light/refle →
ctor/session (list)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-ip (leaf)
requires: /contexts/context/ippm/twamp-light/refle →
ctor/session/session-network-parameter/sender-port (leaf)
Ancestor: /contexts/context/ippm/twamp-light/sende →
r/session (list)
requires: /contexts/context/ippm/twamp-light/sende →

272 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

r/session/session-network-parameter/source-ip (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/source-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/reflector-port (leaf)
requires: /contexts/context/ippm/twamp-light/sende →
r/session/session-network-parameter/session-network-parameter-ch →
oice (choice)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 273

 ENM CLI

fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)
requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-a (container)
requires: /contexts/synchronization/bits/output/bi →
ts-a/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/synchronization/bits/output/bi →
ts-b (container)
requires: /contexts/synchronization/bits/output/bi →

274 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

ts-b/ssm-option-2/ssm-option-2-choice (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw (container)
requires: /epg/pgw/user-plane-selection/default-po →
ol (leaf)
Ancestor: /epg/pgw/apn (list)
requires: /epg/pgw/apn/user-profile-selection/poli →
cy-charging-rule-scope/default (leaf)
Ancestor: /epg/pgw/credit-control/gy-retention-pro →
file (list)
requires: /epg/pgw/credit-control/gy-retention-pro →
file/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/gy-retention-pro →
file/quota-handling/validity-time (leaf)
Ancestor: /epg/sgw/user-plane-pool/pool (list)
requires: /epg/sgw/user-plane-pool/pool/node-name →
(list)
Ancestor: /epg/user-plane/abr-shaping/profile (lis →
t)
requires: /epg/user-plane/abr-shaping/profile/serv →
ice (list)
Ancestor: /epg/user-plane/acls/acl/aces/ace (list)
requires: /epg/user-plane/acls/acl/aces/ace/action →
s/forwarding (leaf)
Ancestor: /epg/user-plane/reporting/event-reportin →
g/profile (list)
requires: /epg/user-plane/reporting/event-reportin →
g/profile/event (list)
Ancestor: /interfaces/interface/l3-interface (cont →
ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 275

 ENM CLI

-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/congestion-avoidance-map/queue/queu →
e-choice/red (list)
requires: /qos/congestion-avoidance-map/queue/queu →
e-choice/red/dscp/dscp-value (leaf-list)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →

276 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/profile/resource/port (list)
requires: /qos/profile/resource/port/tm-resource/t →
m-resource (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)

vEPG-OI 3.5 Bulk Import Interdependency

Ancestor:ParentMO ; requires:ChildMO
Ancestor: /confdConfig/subagents/subagent (list)
requires: /confdConfig/subagents/subagent/mount/pa →
th (leaf)
Ancestor: /confdConfig/subagents/subagent/tcp (con →
tainer)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/user (leaf)
requires: /confdConfig/subagents/subagent/tcp/conf →
dAuth/group (leaf)
Ancestor: /contexts/context/route-map (list)
requires: /contexts/context/route-map/seq (list)
Ancestor: /contexts/context/router/msdp/peer (list →
)
requires: /contexts/context/router/msdp/peer/local →
-tcp-source/local-tcp-source (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate (container)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/bsr-candidate/bsr-candidate-opt/cand-hashlen (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv4/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join (list)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf (leaf)
requires: /contexts/context/router/pim/address-fam →
ily/ipv6/dual-join/rpf-interface/rpf-intf2 (leaf)
Ancestor: /contexts/forward/ip-access-group/class/ →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 277

 ENM CLI

redirect-destination/redirect-destination-choice/ip (container)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ip/next-hopfake →
/next-hop (leaf-list)
Ancestor: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6 (container →
)
requires: /contexts/forward/ip-access-group/class/ →
redirect-destination/redirect-destination-choice/ipv6/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip (container →
)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ip/next-hopfa →
ke/next-hop (leaf-list)
Ancestor: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6 (contain →
er)
requires: /contexts/forward/ipv6-access-group/clas →
s/redirect-destination/redirect-destination-choice/ipv6/next-hop →
fake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ip/next-hopfake/next-hop (leaf-list)
Ancestor: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6 (container)
requires: /contexts/forward/redirect-destination/r →
edirect-destination-choice/ipv6/next-hopfake/next-hop (leaf-list →
)
Ancestor: /contexts/icr/bgp-based/multi-protocol/t →
rack (list)
requires: /contexts/icr/bgp-based/multi-protocol/t →
rack/state-option/state-option (choice)
Ancestor: /contexts/icr/general/active-standby/tra →
ck (list)
requires: /contexts/icr/general/active-standby/tra →
ck/link-option/link-option-choice (choice)
Ancestor: /contexts/pseudowire/instance/vlan-rewri →
te (container)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/seq (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/push (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/outer (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/dot1q (leaf)
requires: /contexts/pseudowire/instance/vlan-rewri →
te/ingress/symmetric (leaf)
Ancestor: /contexts/snmp/notify-target (list)

278 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

requires: /contexts/snmp/notify-target/transport/i →
p (leaf)
requires: /contexts/snmp/notify-target/transport/t →
ag (leaf)
requires: /contexts/snmp/notify-target/transport/p →
arameters (leaf)
Ancestor: /contexts/snmp/target (list)
requires: /contexts/snmp/target/transport/ip (leaf →
)
requires: /contexts/snmp/target/transport/security →
-params/security-name/security-name (choice)
Ancestor: /contexts/snmp/target-parameters (list)
requires: /contexts/snmp/target-parameters/securit →
y-name/security-name (choice)
Ancestor: /contexts/tunnel/gre/keepalive (containe →
r)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-value (leaf)
requires: /contexts/tunnel/gre/keepalive/keepalive →
-opt/keepalive-retries (leaf)
Ancestor: /contexts/tunnel/keepalive (container)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-value (leaf)
requires: /contexts/tunnel/keepalive/keepalive-opt →
/keepalive-retries (leaf)
Ancestor: /epg/pgw (container)
requires: /epg/pgw/user-plane-selection/default-po →
ol (leaf)
Ancestor: /epg/pgw/apn (list)
requires: /epg/pgw/apn/user-profile-selection/poli →
cy-charging-rule-scope/default (leaf)
Ancestor: /epg/pgw/credit-control/gy-retention-pro →
file (list)
requires: /epg/pgw/credit-control/gy-retention-pro →
file/quota-handling/volume-quota (leaf)
requires: /epg/pgw/credit-control/gy-retention-pro →
file/quota-handling/validity-time (leaf)
Ancestor: /epg/sgw/user-plane-pool/pool (list)
requires: /epg/sgw/user-plane-pool/pool/node-name →
(list)
Ancestor: /epg/user-plane/abr-shaping/profile (lis →
t)
requires: /epg/user-plane/abr-shaping/profile/serv →
ice (list)
Ancestor: /epg/user-plane/acls/acl/aces/ace (list)
requires: /epg/user-plane/acls/acl/aces/ace/action →
s/forwarding (leaf)
Ancestor: /epg/user-plane/reporting/event-reportin →
g/profile (list)
requires: /epg/user-plane/reporting/event-reportin →
g/profile/event (list)
Ancestor: /interfaces/interface/l3-interface (cont →

1/1553-CNA 403 2979 Uen AV | 2020-12-07 279

 ENM CLI

ainer)
requires: /interfaces/interface/l3-interface/inter →
-context/inter-context (choice)
Ancestor: /pm/group (list)
requires: /pm/group/measurement-type (list)
Ancestor: /pm/job (list)
requires: /pm/job/measurement-reader (list)
Ancestor: /pm/measurement-capabilities (container)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-prioritization-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/file-rp-supported (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/job-grouping-support (leaf)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-reporting-periods (leaf-list)
requires: /pm/measurement-capabilities/measurement →
-jobs/supported-meas-job-gps (leaf-list)
requires: /pm/measurement-capabilities/realtime-jo →
bs/supported-rt-job-gps (leaf-list)
requires: /pm/measurement-capabilities/threshold-j →
obs/supported-thresh-job-gps (leaf-list)
Ancestor: /qos/class-map/ip/qos (list)
requires: /qos/class-map/ip/qos/qos-choice/ip (lea →
f)
Ancestor: /qos/policy/mdrr/queue (list)
requires: /qos/policy/mdrr/queue/weight/weight (le →
af)
Ancestor: /qos/policy/metering/class-group/class/r →
ate/conform (container)
requires: /qos/policy/metering/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/metering/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/metering/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/class-group/class/r →
ate/conform (container)
requires: /qos/policy/policing/class-group/class/r →
ate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/ip-access-group/acl →
-class/rate/conform/mark/mark (choice)

280 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Ancestor: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform (container)
requires: /qos/policy/policing/ipv6-access-group/a →
cl-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform (container)
requires: /qos/policy/policing/l2-access-group/acl →
-class/rate/conform/mark/mark (choice)
Ancestor: /qos/policy/protocol-rate-limit/arp-rate →
(container)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/rate-num (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst (leaf)
requires: /qos/policy/protocol-rate-limit/arp-rate →
/arp-rate/burst-num (leaf)
Ancestor: /qos/queue-map/num-queues/queue (list)
requires: /qos/queue-map/num-queues/queue/priority →
/priority (leaf-list)

2.5.18 User-Defined Filter File

< Back To Cmedit Export

File Name Format

Note the following regarding the file name format for the user-defined filter file:
— The specified filter file name must start with a letter, numeral or underscore.
It can contain any other combination of letters, numerals, underscores or
hyphen-minus (Unicode: U+002D), and periods to separate file extensions.

— The specified filter file name cannot contain spaces or quotes.

The following are examples of valid user-defined filter file names:

— userDefinedFilterFile.txt

— 2_userDefinedFilterFile.txt

— _userDefinedFilterFile-2.txt

— userDefinedFilterFile

The following are examples of invalid user-defined filter file names:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 281

 ENM CLI

— -userDefinedFilterFile.txt Begins with hyphe →

n-minus

— userDefinedFilterFile(2).txt Invalid character →

s '(' and ')'

— userDefined FilterFile.txt Contains space

File Content Format

A user-defined filter consists of one or more filter clauses separated by
semicolons. It may contain either INCLUDE filter clauses or EXCLUDE filter
clauses but not both. INCLUDE filter clauses specify the content to be included.
Everything else is excluded by default. EXCLUDE filter clauses specify the content
to be excluded, with all other content which would have been exported in a non-
filtered export included by default.

Include Filtering

<MO Class>.<attr name>

Include instances of the specified MO Class and the specified attribute. The
specified attribute can be either a persistent attribute or a non-persistent
attribute.

Note that the export takes longer if non-persistent attributes are specified in the
filter.

If the export filter contains non-persistent attributes, a read from the node is
required at the time of export. If there is a connectivity issue, the export of that
node fails. Hence it is recommended to export only synchronized nodes for
filtered export with non-persistent attributes.

<MO Class>.*

Include instances of the specified MO Class including all persistent attributes.

<MO Class>.<w>

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

282 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<MO Class>.<m>

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

<MO Class>.(*)

Include instances of the specified MO Class including all persistent attributes.

<MO Class>.(<w>)

Include instances of the specified MO Class including all writable persistent

attributes.

<MO Class>.(<m>)

Include instances of the specified MO Class including all mandatory persistent

attributes.

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

Use round brackets to group multiple attributes for the same MO Class.

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

Use round brackets containing * to group all persistent attributes and some
specified non-persistent attributes for the same MO Class.

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

Use round brackets containing <w> to group all writable persistent attributes and
some specified non-persistent attributes for the same MO Class.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 283

 ENM CLI

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

Use round brackets containing <m> to group all mandatory persistent attributes
and some specified non-persistent attributes for the same MO Class.

<MO Class>+.*

Include instances of the specified MO Class, and all MO Classes in its sub-tree.
Include all persistent attributes for all included MO Classes.

Explicit MO Class attribute specification is not supported for sub-tree filters.

<MO Class>+.<w>

Include instances of the specified MO Class, and all MO Classes in its sub-tree.
Include all writable persistent attributes for all included MO Classes.

Explicit MO Class attribute specification is not supported for sub-tree filters.

<MO Class>+.<m>

Include instances of the specified MO Class, and all MO Classes in its sub-tree.
Include all mandatory persistent attributes for all included MO Classes.

Explicit MO Class attribute specification is not supported for sub-tree filters.

<MO Class1>+.*;<MO Class2>.<attr name>;<MO Class3>.*;<MO Class4>.(<attr

name1>,<attr name2>);...

Any combination of the above INCLUDE filter clauses is supported here. Use a
semi-colon ';' to separate multiple MO Classes.

Note: If the same MO class is specified multiple times with same or different
attribute(s), only attribute(s) of the last MO class occurrence are included in the
export file.

Explicit MO Class attribute specification overrides the given MO Class sub-tree

attribute specification.

284 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

For example filter: ENodeBFunction+.*;EUtranCellFDD.userLabel

This means all ENodeBFunction MO instances, with all persistent attributes are
included. All MO instances in its sub-tree, with all persistent attributes are also
included. However, EUtranCellFDD MOs only include the userLabel attribute.

Exclude Filtering

!<MO Class>

Exclude the specified MO Class. It includes instances of all the other MO Classes.

!<MO Class>+

Exclude the specified MO Class, and all MO Classes in its sub-tree. It includes
instances of all the other MO Classes.

!<MO Class1>+;!<MO Class2>

Any combination of the above EXCLUDE filter clauses is supported here. Use a
semi-colon ';' to separate multiple MO Classes.

Additional Information
Note the following information on the content of the user-defined filter file:
— The SubNetwork MO class and its attributes are unrecognized in INCLUDE
and EXCLUDE filter specifications.

— The SubNetwork, MeContext, and ManagedElement MO classes are not

supported with EXCLUDE sub-tree filter specifications.

— MO class and attribute names are case-insensitive.

— MO class and attribute names are not validated to ensure they exist in the
model. If at least one MO class included in the filter is valid, any other
unrecognized MO classes will be ignored and no error will be given. For a
valid MO class with attributes specified, if at least one attribute included in
the filter clause is valid, then any other unrecognized attributes will be
ignored and no error will be given. If all MO classes or attributes included in

1/1553-CNA 403 2979 Uen AV | 2020-12-07 285

 ENM CLI

the filter are unrecognized, the export job will fail with status "FAILED Failed
due to no nodes to export".

— The user-defined filter file content may be split across multiple lines. In this
case line breaks are ignored and it is still necessary to use a semi-colon ';' to
separate filters.

— Comment lines are not supported.

— Attribute specification is not supported for the EXCLUDE clause.

— For the INCLUDE MO Class, EXCLUDE MO Class, and EXCLUDE with sub-
tree cases, the recommended maximum number of filter clauses is 300.
Numbers higher than this can impact the performance of the export.

— For the INCLUDE with sub-tree case, the recommended maximum number of
filter clauses is 10. Numbers higher than this can impact the performance of
the export.

User-Defined Filter Content Examples

The following examples illustrate the syntax and structure of a user-defined filter
file:

User-defined filter for instances of the specified MO Class including the

specified attribute

EUtranCellFDD.tac

User-defined filter for instances of the specified MO Class including all

persistent attributes

EUtranCellFDD.*

OR

EUtranCellFDD.(*)

User-defined filter for instances of the specified MO Class including all

writable persistent attributes

EUtranCellFDD.<w>

OR

EUtranCellFDD.(<w>)

286 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

User-defined filter for instances of the specified MO Class including all

mandatory persistent attributes

EUtranCellFDD.<m>

OR

EUtranCellFDD.(<m>)

User-defined filter for instances of the specified MO Class including multiple

specified attributes

EUtranCellFDD.(tac,altitude,cellId)

User-defined filter for instances of the specified case-insensitive MO Class

including multiple specified case-insensitive attributes. In this example, the MO
Class in the filter represents valid MO Classes from two different models.

eutranetwork.(eutranetworkid,userLabel)

This filter will match both EUtraNetwork and EutraNetwork.

User-defined filter for instances of the specified MO Class including all

persistent attributes and some non-persistent attributes

EUtranCellFDD.(*,pmErabBrMax,pmErabBrSum)

User-defined filter for instances of the specified MO Class including all

writable persistent attributes and some non-persistent attributes

EUtranCellFDD.(<w>,pmErabBrMax,pmErabBrSum)

User-defined filter for instances of the specified MO Class including all

mandatory persistent attributes and some non-persistent attributes

EUtranCellFDD.(<m>,pmErabBrMax,pmErabBrSum)

User-defined filter for all persistent attributes and some non-persistent

attributes

MeContext.*;ManagedElement+.*;NetworkElement+.*;EUtranCellFDD.(* →
,pmErabBrMax,pmErabBrSum)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 287

 ENM CLI

This filter includes all MOs with their persisted attributes (which is equivalent to
an unfiltered export). It also includes two non-persistent attributes from the
EUtranCellFDD MO Class.

Note:If the subtree filter clause MeContext+.* is used, the system configuration
that determines whether unfiltered Bulk CM export includes the Inventory MOs is
obeyed. (Inventory MOs are modeled directly under the MeContext for nodes
based on the CPP platform.)

User-defined filter for all instances of the specified MO Class names, and the
specified attributes for each specified MO

ManagedElement.userLabel;ENodeBFunction.randUpdateInterval;EUtra →
nCellFDD.cellId

The following equivalent filter is split across multiple lines (one MO class per line)
for readability:

ManagedElement.userLabel;
ENodeBFunction.randUpdateInterval;
EUtranCellFDD.cellId

Note that the separating semicolons ';' are still required.

User-defined filter for including instances of the specified MO Class and its
sub-tree, and instances of the specified MO Class including the specified attribute

ENodeBFunction+.*;EUtranCellFDD.userLabel

User-defined filter for including instances of the specified MO Class and its
sub-tree with their writable persistent attributes, and instances of the specified
MO Class including the specified attribute

ENodeBFunction+.<w>;EUtranCellFDD.userLabel

User-defined filter for including instances of the specified MO Class and its
sub-tree with their mandatory persistent attributes, and instances of the
specified MO Class including the specified attribute

ENodeBFunction+.<m>;EUtranCellFDD.userLabel

288 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

User-defined filter for excluding instances of the specified MO Class and

including all the other MO Classes and the sub-tree of the excluded MO Class
with their persistence attributes

!EUtranCellFDD

User-defined filter for excluding instances of the specified MO Classes and

including all the other MO Classes and the sub-tree of the excluded MO Classes
with their persistence attributes

!ENodeBFunction;!EUtranCellFDD

User-defined filter for excluding instances of the specified MO Class and its
sub-tree, and excluding instances of the specified MO Class but including its sub-
tree

!ENodeBFunction+;!SwManagement

Error Code 8009 Examples

Error Message and Solution/Action Required for Error Code 8009:

User-defined filter contains blank character

EUtranCellRelation. neighborCellRef

Error Message and Solution/Action Required:

Error 8009 : User-defined filter "EUtranCellRelation. neighborCe →

llRef" contains blank characters.

Suggested Solution : Remove blank characters from the given filt →

er.

User-defined filter contains too many period characters

EUtranCellRelation..neighborCellRef

Error Message and Solution/Action Required:

Error 8009 : User-defined filter "EUtranCellRelation..neighborCe →

llRef" contains too many period characters.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 289

 ENM CLI

Suggested Solution : Provide period only between MO class and at →

tributes definition.

User-defined filter for an invalid element inside attribute list

ManagedElement.(neType=="ERBS",platformType)

Error Message and Solution/Action Required:

Error 8009 : User defined filter "ManagedElement.(neType=="ERBS" →

,platformType)" contains an invalid element inside attribute lis →
t: "neType=="ERBS""

Suggested Solution : Provide MO class and attribute definitions →

containing lowercase and uppercase letters, numbers, _- characte →
rs.

User-defined filter does not contain matching brackets for attribute

EUtranCellRelation.(neighborCellRef,cellIndividualOffsetEUtran

Error Message and Solution/Action Required:

Error 8009 : User-defined filter "EUtranCellRelation.(neighborCe →

llRef,cellIndividualOffsetEUtran" does not contain matching brac →
kets for attribute list: "(neighborCellRef,cellIndividualOffsetE →
Utran"

Suggested Solution : Provide matching brackets for attribute lis →

t.

User-defined filter contains unsupported attribute specification

EUtranCellRelation+.(neighborCellRef,cellIndividualOffsetEUtran)

Error Message and Solution/Action Required:

Error 8009 : User-defined filter "EUtranCellRelation+.(neighborC →

ellRef,cellIndividualOffsetEUtran)" contains unsupported attribu →
te specification.

Suggested Solution : Remove attribute specification from filter.

290 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

User-defined filter contains both include and exclude filter clauses

EUtranCellRelation+.*;!EUtranCellFDD

Error Message and Solution/Action Required:

Error 8009 : User-defined filter contains both include and exclu →

de filter clauses.

Suggested Solution : Ensure user-defined filter content does not →

contain both include and exclude filter clauses.

User-defined filter contains unsupported clauses with duplicate or multiple

persistent specifiers(<m>/ <w>/ *) in attribute list

EUtranCellRelation.(<w>,neighborCellRef,<m>,cellIndividualOffset →
EUtran)

Error Message and Solution/Action Required:

Error 8009 : User-defined filter "EUtranCellRelation.(<w>,neighb →

orCellRef,<m>,cellIndividualOffsetEUtran)" contains unsupported →
clauses with duplicate or multiple persistent specifiers(<m>/<w> →
/*) in attribute list.

Suggested Solution : Remove duplicate or multiple persistent spe →

cifiers(<m>/<w>/*) in attributes list for any Mo clause.

2.5.19 Create an Export File in 3GPP Format Using a Node Scope

Prerequisites

— There are nodes on the system to be exported.

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in 3GPP format using a node
scope.

Outline

1. Start an Export Job in 3GPP Format using a Node Scope

1/1553-CNA 403 2979 Uen AV | 2020-12-07 291

 ENM CLI

2. Check the Export Job Progress

3. Check that the Export Job is Completed

4. Download the Generated Export File

Steps

1. Start an Export Job in 3GPP Format using a Node Scope

Run the following command:

cmedit export -n * --filetype 3GPP -jn Export3gppNodeScope

The command returns an export job name and an export job ID.

Export job Export3gppNodeScope started with job ID 3

2. Check the Export Job Progress

Run the following command:

cmedit export --status --job 3

The command returns the status of an export job with the job ID 3 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

3 Expo STAR 2017 40 16 0 0 1244 admi

rt3gp TED -05- 59 nistr
pNod 09T1 ator
eSco 2:35:
pe 24

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

— The Nodes exported field lists the number of nodes successfully

exported.

292 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 3.

3. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 3

The command returns the status of an export job with the job ID 3 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

3 Expo COM 2017 2017 0h 40 40 0 0 3194 / admi

rt3gp PLET -05- -05- 0m 96 erics nistr
pNod ED 09T1 09T1 43s son/ ator
eSco 2:35: 2:36: batc
pe 24 07 h/
data
/
expo
rt/
3gpp
_exp
ort/
Expo
rt3gp
pNod
eSco

1/1553-CNA 403 2979 Uen AV | 2020-12-07 293

 ENM CLI

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d
pe.zi
p

4. Download the Generated Export File

Run the following command:

cmedit export --download --job 3

This command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, the response will indicate that
this job is not available for download.

Results
The user has downloaded to the client an export file containing CM data for the
specified nodes.

2.5.20 Create an Export File in 3GPP Format for Synchronized Nodes Only

Prerequisites

— There are nodes on the system to be exported.

— One or more nodes on the system are NOT SYNCHRONIZED, and one or
more nodes on the system are SYNCHRONIZED

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in 3GPP format for
synchronized nodes only.

For this tutorial, nodes LTE03 and LTE04 are SYNCHRONIZED. Nodes LTE01 and
LTE02 is not SYNCHRONIZED.

Outline

1. Start an Export Job in 3GPP Format for Synchronized Nodes Only

294 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2. Check the Export Job Progress

3. Check that the Export Job is Completed

4. Check the Status Details of the Export Job

5. Download the Generated Export File

Steps

1. Start an Export Job in 3GPP Format for Synchronized Nodes Only

Run the following command:

cmedit export -n LTE01;LTE02;LTE03;LTE04 -ft 3GPP --syncstate →

sync -jn Export3gppSync

The command returns an export job name and an export job ID.

Export job Export3gppSync started with job ID 9

2. Check the Export Job Progress

Run the following command:

cmedit export --status --job 9

The command returns the status of an export job with the job ID 9 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

9 Expo STAR 2017 4 1 1 0 2103 admi

rt3gp TED -05- nistr
pSyn 10T1 ator
c 6:50:
07

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 295

 ENM CLI

— The Nodes exported field lists the number of nodes successfully

exported.

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 9.

3. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 9

The command returns the status of an export job with the job ID 9 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

9 Expo COM 2017 2017 0h 4 2 2 0 6107 / admi

rt3gp PLET -05- -05- 0m erics nistr
pSyn ED 10T1 10T1 43s son/ ator
c Com 6:50: 6:50: batc
plete 07 10 h/
d data
with /
2 expo
nod rt/
e(s) 3gpp
missi _exp
ng ort/
Expo
rt3gp

296 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d
pSyn
c.zip

— Where the status of a job is 'COMPLETED', the export file contains the
node data for all nodes specified in the node scope.

— Where the status of a job is 'COMPLETED Completed with <n> node(s)

missing', the export file contains the node data for only the nodes
specified in the node scope which are SYNCHRONIZED.

— Where the status of a job is 'FAILED Failed due to no nodes to export', all
nodes specified in the node scope may not be SYNCHRONIZED. No
export file is generated in this case.

4. Check the Status Details of the Export Job

Check the status details of the export job to see the reasons for the nodes not
being exported. Run the following command:

cmedit export --status --job 9 --verbose

This command returns the status details of an export job with the job ID 9, as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

9 Expo COM 2017 2017 0h 4 2 2 0 6107 / admi

rt3gp PLET -05- -05- 0m erics nistr
pSyn ED 10T1 10T1 43s son/ ator
c Com 6:50: 6:50: batc
plete 07 10 h/
d data
with /
2 expo
nod rt/
e(s) 3gpp
missi _exp
ng ort/

1/1553-CNA 403 2979 Uen AV | 2020-12-07 297

 ENM CLI

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d
Expo
rt3gp
pSyn
c.zip

Node status

Node name Export status Export status message FDN

LTE03 EXPORTED MeContext=LTE03

LTE04 EXPORTED MeContext=LTE04

LTE01 NOT_EXPORTED MeContext=LTE01 not MeContext=LTE01

synchronized.

LTE02 NOT_EXPORTED MeContext=LTE02 not MeContext=LTE02

synchronized.

The reason for the nodes not being exported is given here as
"MeContext=<nodeName> not synchronized."

5. Download the Generated Export File

Run the following command:

cmedit export --download --job 9

This command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, the response will indicate that
this job is not available for download.

Results
The user has downloaded to the client an export file containing CM data for the
specified SYNCHRONIZED nodes, if the export job has not failed.

298 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.5.21 Create an Export File in Dynamic Format Using a Node Scope

Prerequisites

— There are nodes on the system to be exported.

— Dynamic CM Value Package license is installed

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in dynamic format using a
node scope.

Outline

1. Start an Export Job in Dynamic Format using a Node Scope

2. Check the Export Job Progress

3. Check that the Export Job is Completed

4. Download the Generated Export File

Steps

1. Start an Export Job in Dynamic Format using a Node Scope

Run the following command:

cmedit export -n * --filetype dynamic -jn ExportDynamicNodeSc →

ope

The command returns an export job name and an export job ID.

Export job ExportDynamicNodeScope started with job ID 5

2. Check the Export Job Progress

Run the following command:

cmedit export --status --job 5

The command returns the status of an export job with the job ID 5 as
displayed in the following example:

Job status

1/1553-CNA 403 2979 Uen AV | 2020-12-07 299

 ENM CLI

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

5 Expo STAR 2017 40 16 0 0 1244 admi

rtDy TED -05- 59 nistr
nami 09T1 ator
cNod 4:11:
eSco 14
pe

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

— The Nodes exported field lists the number of nodes successfully

exported.

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 5.

3. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 5

The command returns the status of an export job with the job ID 5 as
displayed in the following example:

Job status

300 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

5 Expo COM 2017 2017 0h 40 40 0 0 3199 / admi

rtDy PLET -05- -05- 0m 76 erics nistr
nami ED 09T1 09T1 52s son/ ator
cNod 4:11: 4:12: batc
eSco 14 06 h/
pe data
/
expo
rt/
dyna
mic_
expo
rt/
Expo
rtDy
nami
cNod
eSco
pe.zi
p

4. Download the Generated Export File

Run the following command:

cmedit export --download --job 5

The command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, then the response will indicate
that this job is not available for download.

Results
The user has downloaded to the client an export file containing CM and Topology
data for the specified nodes.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 301

 ENM CLI

2.5.22 Create an Export File in 3GPP Format Using a Predefined Filter

Prerequisites

— There are nodes on the system to be exported.

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in 3GPP format using a
predefined filter for ERBS nodes.

Outline

1. List the Predefined Export Filters

2. Start an Export Job in 3GPP Format using ERBS Predefined Filter

3. Check the Export Job Progress

4. Check that the Export Job is Completed

5. Download the Generated Export File

Steps

1. List the Predefined Export Filters

Run the following command:

cmedit export --listfilters

The following table is displayed:

Filter name Filter description

3GPP_Topology This is the predefined export filter model for 3GPP

Topology information.

Dynamic_Topology This filter exports topology data only and is solely

for use with dynamic format export.

ERBS This is the predefined export filter model for ERBS

nodes.

InventoryData This is the predefined export filter model for CPP

based nodes Inventory Data.

LTE_MPC_OTDOA This is the predefined export filter model for

filtering MOs for LTE MPC OTDOA.

302 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Filter name Filter description

SON This is the predefined export filter model for ERBS

nodes SON Data.

SON_EDNET This is the predefined export filter model for ERBS

nodes SON EDNET Data.

Subnetwork This is the predefined export filter model for

filtering MOs under subnetwork for ERBS nodes.

In_Service_Performance_Data This is the predefined export filter model for

Performance specific MOs of Base band Radio
nodes and DU Radio nodes.

Note: In_Service_Performance_Data filter exports non-persistent attributes.

The time taken to export non-persistent attributes depends on external
factors such as network latency and node response time. So it is advised to
reduce the node scope to include few node(s) or one ne-type to avoid delay
in response time.

It is possible to schedule periodic generation of bulk export with

In_Service_Performance_Data. Click here for more details

The "ERBS" filter is used in this tutorial.

2. Start an Export Job in 3GPP Format using ERBS Predefined Filter

Run the following command:

cmedit export -n SubNetwork=SubNwk1 --filetype 3GPP --filtern →

ame ERBS -jn Export3gppPredefined

The command returns an export job name and an export job ID.

Export job Export3gppPredefined started with job ID 6

3. Check the Export Job Progress

Run the following command:

cmedit export --status --job 6

The command returns the status of an export job with the job ID 6 as
displayed in the following example:

Job status

1/1553-CNA 403 2979 Uen AV | 2020-12-07 303

 ENM CLI

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

6 Expo STAR 2017 40 16 0 0 241 admi

rt3gp TED -05- nistr
pPre 09T1 ator
defin 4:38:
ed 21

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

— The Nodes exported field lists the number of nodes successfully

exported.

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 6.

4. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 6

The command returns the status of an export job with the job ID 6 as
displayed in the following example:

Job status

304 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

6 Expo COM 2017 2017 0h 40 40 0 0 305 / admi

rt3gp PLET -05- -05- 0m erics nistr
pPre ED 09T1 09T1 5s son/ ator
defin 4:38: 4:38: batc
ed 21 27 h/
data
/
expo
rt/
3gpp
_exp
ort/
Expo
rt3gp
pPre
defin
ed.zi
p

5. Download the Generated Export File

Run the following command:

cmedit export --download --job 6

The command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, then the response will indicate
that this job is not available for download.

Results
The user has downloaded to the client an export file containing ERBS data for all
nodes successfully exported under the specified SubNetwork.

2.5.23 Create an Export File in 3GPP Format Using a User-Defined Filter

Prerequisites

— There are nodes on the system to be exported.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 305

 ENM CLI

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in 3GPP format using a user-
defined filter.

Outline

1. Create a User-Defined Filter File

2. Drag and Drop the User-Defined Filter File into the ENM CLI

3. Start an Export Job in 3GPP Format using the User-Defined Filter

4. Check the Export Job Progress

5. Check that the Export Job is Completed

6. Download the Generated Export File

Steps

1. Create a User-Defined Filter File

Create a User-Defined Filter File using a .txt file. See User-Defined Filter File
for more information.

2. Drag and Drop the User-Defined Filter File into the ENM CLI
When the file is dragged and dropped into the ENM CLI, the following
confirmation message is displayed:

EUtranCellFDDFilter.txt added to workspace

3. Start an Export Job in 3GPP Format using the User-Defined Filter

Run the following command:

cmedit export -n * --filetype 3GPP -f file:EUtranCellFDDFilte →

r.txt -jn Export3gppUserDefined

The command returns an export job name and an export job ID.

Export job Export3gppUserDefined started with job ID 7

4. Check the Export Job Progress

Run the following command:

306 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit export --status --job 7

The command returns the status of an export job with the job ID 7 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

7 Expo STAR 2017 40 16 0 0 16 admi

rt3gp TED -05- nistr
pUse 09T1 ator
rDefi 5:06:
ned 49

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

— The Nodes exported field lists the number of nodes successfully

exported.

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 7.

5. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 7

The command returns the status of an export job with the job ID 7 as
displayed in the following example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 307

 ENM CLI

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

7 Expo COM 2017 2017 0h 40 40 0 0 40 / admi

rt3gp PLET -05- -05- 0m erics nistr
pUse ED 09T1 09T1 4s son/ ator
rDefi 5:06: 5:06: batc
ned 49 54 h/
data
/
expo
rt/
3gpp
_exp
ort/
Expo
rt3gp
pUse
rDefi
ned.z
ip

6. Download the Generated Export File

Run the following command:

cmedit export --download --job 7

The command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, then the response will indicate
that this job is not available for download.

Results
The user has downloaded to the client an export file containing CM data for the
specified nodes.

308 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.5.24 Create an Export File in Dynamic Format Containing Topology Data Only

Prerequisites

— There are nodes on the system to be exported.

— Dynamic CM Value Package license is installed

< Back To Export CM Data

Objective

This tutorial describes how to create an export file in dynamic format containing
Topology data only. By default, export in dynamic format includes both CM and
Topology data.

Outline

1. List the Predefined Export Filters

2. Start an Export Job in Dynamic Format using Dynamic_Topology Filter

3. Check the Export Job Progress

4. Check that the Export Job is Completed

5. Download the Generated Export File

Steps

1. List the Predefined Export Filters

Run the following command:

cmedit export --listfilters

The following table is displayed:

Filter name Filter description

3GPP_Topology This is the predefined export filter model for 3GPP

Topology information.

Dynamic_Topology This filter exports topology data only and is solely

for use with dynamic format export.

ERBS This is the predefined export filter model for ERBS

nodes.

InventoryData This is the predefined export filter model for CPP

based nodes Inventory Data.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 309

 ENM CLI

Filter name Filter description

LTE_MPC_OTDOA This is the predefined export filter model for

filtering MOs for LTE MPC OTDOA.

SON This is the predefined export filter model for ERBS

nodes SON Data.

SON_EDNET This is the predefined export filter model for ERBS

nodes SON EDNET Data.

Subnetwork This is the predefined export filter model for

filtering MOs under subnetwork for ERBS nodes.

"Dynamic_Topology" filter is used to export only Topology for the dynamic

format.

2. Start an Export Job in Dynamic Format using Dynamic_Topology Filter

Run the following command:

cmedit export -n LTE01 -ft dynamic --filtername Dynamic_Topol →

ogy -jn ExportDynamicTopology

The command returns an export job name and an export job ID.

Export job ExportDynamicTopology started with job ID 8

3. Check the Export Job Progress

Run the following command:

cmedit export --status --job 8

The command returns the status of an export job with the job ID 8 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

8 Expo STAR 2017 0 0 0 0 0 admi

rtDy TED -05- nistr
nami 10T1 ator
cTop 3:20:
ology 06

310 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— The Expected nodes exported field lists the number of nodes matched by
the node scope. The is the expected number of nodes to be exported.

— The Nodes exported field lists the number of nodes successfully

exported.

— The Nodes not exported field lists the number of nodes not successfully
exported.

— The Nodes no match found field lists the number of nodes and neTypes
for which no match was found by the node scope.

— The MOs exported field lists the total number of MOs exported for all
nodes exported.

— The File name field describes the name and location of the generated
export file.

— The User name field describes the ID of the user that executed the
export job.

The above result confirms the Status as 'STARTED' for the job ID 8.

4. Check that the Export Job is Completed

Run the following command:

cmedit export --status --job 8

The command returns the status of an export job with the job ID 8 as
displayed in the following example:

Job status

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d

8 Expo COM 2017 2017 0h 1 1 0 0 12 / admi

rtDy PLET -05- -05- 0m erics nistr
nami ED 10T1 10T1 1s son/ ator
cTop 3:20: 3:20: batc
ology 06 08 h/
data
/
expo
rt/
dyna
mic_

1/1553-CNA 403 2979 Uen AV | 2020-12-07 311

 ENM CLI

Job Job Statu Start End Elaps Expe Node Node Node MOs File User
ID nam s date/ date/ ed cted s s not s no expo nam nam
e time time time node expo expo matc rted e e
s rted rted h
expo foun
rted d
expo
rt/
Expo
rtDy
nami
cTop
ology
.zip

5. Download the Generated Export File

Run the following command:

cmedit export --download --job 8

The command will download the export file to the client browser.

downloading...

Note: If the job is not in a 'COMPLETED' state, then the response will indicate
that this job is not available for download.

Results
The user has downloaded to the client an export file containing only the
Topology data for the specified nodes.

2.5.25 Schedule Periodic Bulk Export with 'In_Service_Performance_Data' pre-

defined filter

Prerequisites
To initiate periodic bulk export, you must have an account with following roles

1. Scripting_Operator

2. CM_REST_Administrator

Note: With 'Scripting_Operator' role, you can only:

— View or access exported files

312 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Cancel a scheduled periodic export

Objective

The tutorial describes the steps required to initiate the periodic exports with the
'In_Service_Performance_Data' pre-defined filter.

Outline

1. Initiate Periodic Export

2. Reschedule Periodic Export

3. Cancel Periodic Export

Steps

1. Initiate Periodic Export

— Login to scripting VM with a user with roles mentioned in pre-requisites
section

— Execute script: /opt/ericsson/cmexport/schedule_periodic_export

— Input login credentials: Username and Password. Same as of user with

roles mentioned in pre-requisite section
• If Username or Password are empty or not valid, the periodic bulk
export is not scheduled.

— Input schedule start time(hours and minutes) when the daily export is
triggered.

The export file ‘Periodic_Export_In

Service_Performance_Data_[DD_MM_YYYY-HH_MM].zip is found at: /
ericsson/batch/data/export/3gpp_export

Sample usage:

./schedule_periodic_export.sh
Enter login credentials
username : scripting-and-export-user
password :
Enter schedule time in hours and minutes
Hours [0-23] : 13
Minutes [0-59]: 17

Periodic bulk export, scheduled to run daily at 13:17 success →

fully. Exiting...

Exported files:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 313

 ENM CLI

Periodic_Export_In_Service_Performance_Data_13_10_2020-13_17. →
zip

Periodic_Export_In_Service_Performance_Data_14_10_2020-13_17. →
zip

Note: The time taken for export file generation depends on number of non-
persistent attributes present, external factors such as network latency and
node response time.

Note: When DST(Day Light Savings time) changes takes effect on the
environment and if the periodic export scheduled time conflicts with DST, it is
possible for periodic export for that day is lost. To mitigate this, consider re-
scheduling the daily export to not clash with DST.

2. Reschedule Periodic Export

Note: This step is applicable only if periodic export is already scheduled.

— Login to scripting VM with a user with roles mentioned in pre-requisites

section.

— Execute script: /opt/ericsson/cmexport/schedule_periodic_export

— List of available options are shown.

C - To cancel scheduled Periodic bulk export.

R - To Reschedule Periodic bulk export.
E - To exit.

— Input 'R' to re-schedule periodic export.

— Input login credentials: Username and Password, same as of user with

roles mentioned in pre-requisite section.

— Input schedule start time(hours and minutes) when the daily export is
triggered.
• If the scheduled time is not in valid range, the periodic bulk export is
not scheduled.

Sample usage:

./schedule_periodic_export.sh
Periodic bulk export generation is already scheduled at 13:17 →
. Select one of the following
C - To cancel scheduled Periodic bulk export.
R - To Reschedule Periodic bulk export.
E - To exit.

314 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

[C/R/E]: R

Rescheduling
Enter login credentials
username : scripting-and-export-user
password :
Enter schedule time in hours and minutes
Hours [0-23] : 13
Minutes [0-59]: 50

Periodic bulk export, scheduled to run daily at 13:50 success →

fully. Exiting...

3. Cancel Periodic Export

Note: This step is applicable only if periodic export is already scheduled.

— Login to scripting VM with a user with roles mentioned in pre-requisites

section.

— Execute script: /opt/ericsson/cmexport/schedule_periodic_export

— List of available options are shown.

C - To cancel scheduled Periodic bulk export.

R - To Reschedule Periodic bulk export.
E - To exit.

— Input 'C' to cancel scheduled periodic export.

Sample usage:

./schedule_periodic_export.sh
Periodic bulk export is already scheduled at 13:50. Select on →
e of the following
C - To cancel scheduled Periodic bulk export.
R - To Reschedule Periodic bulk export.
E - To exit.

[C/R/E]: C

Scheduled Periodic bulk export cancelled successfully. Exitin →

g...

Results
Periodic bulk export is scheduled, re-scheduled or canceled successfully with
predefined filter In_Service_Performance_Data.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 315

 ENM CLI

2.5.26 cmedit action

< Back To Cmedit

Syntax

Syntax to Initiate a Modeled Action by FDN

cmedit action <FDN> action

cmedit action <FDN> [scope filter] criteria acti →

on [options]

Syntax to Initiate a Modeled Action by Query

cmedit action [scope type] scope [scope filter] →

criteria action [options]

Syntax for action on object by name

cmedit action [scope type] scope [scope filter] →

criteria_for_MO_by_Id action [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.

316 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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.

*<Partial Node Name>*

Contains the specified partial node name, i.e. *RBS0*.

References all nodes in the network.

<Collection Name>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 317

 ENM CLI

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.

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.

318 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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 operate on.

<MO Class>

Operate on all instances of the specified MO Class.

<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" ]

— [ "any" && "any" && ... && "any" ]

— [ "any" || "any" || ... || "any" ]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 319

 ENM CLI

Note:

The <value> must not contain a combination of && and ||.

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

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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:

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.

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.

320 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

<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:

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 .

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 321

 ENM CLI

<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:

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 .

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>.(<attr name><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>=<Partial MO_Id>*

Starts with the specified partial MO_Id, i.e. - cell*.

322 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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*.

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.

Action

Used to specify the action and its parameters.

<action name>.(<param name>=<param value>)

Parameters values are specified by giving the name, followed by "=" and then the
value.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 323

 ENM CLI

<action name>.(<param1 name>=<param1 value>,<param2 name>=<param2

value>...)

Use semi-colon or comma to separate multiple parameters name and value pairs.

<action name>.(<struct param name>.(<struct member1 name>=<struct

member1 value>,<struct member2 name>=<struct member2 value>)...)

Use round brackets to group struct member names and values together,
separated by a comma.

Options

-ns or --namespace

Specify a particular namespace.

-ne or --netype

Specify a particular netype.

-v or --version

Specify a particular version.

--force

Force the command execution. This option is not required when using scripting
integration or batch scripts. It is assumed that all commands in a script should be
executed without user intervention.

324 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-prev or --preview

Preview the MOI(s) involved in the command.

Description
cmedit action is used to initiate a modeled action on an MOI in the network.

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.

If an action command updates more nodes than the system allows an execution
error will be showed.

The action command may result in changes to MOI(s). Therefore, a preview of

affected MOIs will be displayed to prevent users from making potentially harmful
changes via CLI asking to confirm if they want to go ahead; this could happen in
the following conditions:

— If an attribute is modelled with the "disturbances" flag a warning message to

indicate it may cause a significant disturbance in traffic will be showed;

— If too many MO's will be changed then a warning message will be showed.
The number of MOs is controlled by PIB parameter
(maxAffectedObjectsWithoutConfirmation), default setting is 10.

To execute the command after preview has been displayed there are two options
for the user:

— to click the button labeled 'Execute' displayed in suggestion area;

— issue again the command with the option '-- force'.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 325

 ENM CLI

If the user requests an output to file for the command and a preview of affected
MOIs is needed two files will be generated : one for preview and one for
command output after confirmation

CM Edit commands have an overload protection mechanism to limit

ACTION 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

— The action command result is the execution of the action on the MOI(s).

Examples

Action by FDN.

cmedit action MeContext=ERBS001,ManagedElement=1 manualrestart.( →

restartrank=RESTART_WARM,restartreason=PLANNED_RECONFIGURATION,r →
estartinfo=someInfo) --force

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1

1 instance(s)

Action by FDN with complex return value.

cmedit action MeContext=ERBS001,ManagedElement=1,NodeManagementF →

unction=1,UlSpectrumAnalyzer=1 getulsasamplingcapability.(target →
Radiounit='ManagedElement=1,Equipment=1,AuxPlugInUnit=1') --forc →
e

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,NodeManagementF →

unction=1,UlSpectrumAnalyzer=1

326 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

RETURN VALUE : {carrierRfPort2=2, carrierRfPort1=1, maxNumSampli →

ngs2=[0], minFrequency1=[0], numSpectrumTypes2=0, numTriggerType →
s2=0, numTriggerTypes1=0, minFrequency2=[0], maxNumSamplings1=[0 →
], minPower2=0, minPower1=0, flatGainBW1=[0], flatGainBW2=[0], t →
rigger1DataDefined1=false, numSpectrumTypes1=0, samplingRate1=[0 →
], maxFrequency1=[0], samplingRate2=[0], maxPower1=0, maxFrequen →
cy2=[0], trigger1DataDefined2=false, maxPower2=0}

1 instance(s)

Action by FDN with string return value.

cmedit action MeContext=ERBS001,ManagedElement=1,IpOam=1 tracero →

ute.(host="131.160.198.38") --force

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,IpOam=1

RETURN VALUE : /2001:1b70:82a1:103::64:115/159.107.0.57/192.168. →

242.90/212.21.217.2159.107.0.57/192.168.242.90/212.21.217.254/62 →
.6.6.74/213.15.200.18/192.16.151.1054/62.6.6.74/213.15.200.18/19 →
2.16.151.10/131.160.198.38

1 instance(s)

Action by Query

cmedit action ERBS001;ERBS002 managedelement manualrestart.(rest →

artrank=RESTART_WARM,restartreason=PLANNED_RECONFIGURATION,resta →
rtinfo=someInfo) --force

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 327

 ENM CLI

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS0002,Managed →

Element=1

2 instance(s)

Action by Query with added [scope type]

cmedit action -n ERBS001;ERBS002 managedelement manualrestart.(r →

estartrank=RESTART_WARM,restartreason=PLANNED_RECONFIGURATION,re →
startinfo=someInfo) --force

Response

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS0002,Managed →

Element=1

2 instance(s)

Action by Query when the changes may result in Network Traffic Disturbance
and Confirmation Request.

cmedit action ERBS001;ERBS002 managedelement manualrestart.(rest →

artrank=RESTART_WARM,restartreason=PLANNED_RECONFIGURATION,resta →
rtinfo=someInfo)

Response (with confirmation request in suggestion area)

328 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution.

FDN : MeContext=ERBS0001,ManagedElement=1

manualRestart Disturbance : manualRestart causes loss of traffic →

!

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS0002,ManagedElement= →
1

manualRestart Disturbance : manualRestart causes loss of traffic →

!

2 instance(s) will be affected by this command.

WARNING: Continuing in Preview Mode due to the following reasons →

:

- This action may cause a significant disturbance in the System →

or in the Network

Response (after confirmation)

SUCCESS FDN : MeContext=ERBS0001,ManagedElement=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 329

 ENM CLI

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS0002,Managed →

Element=1

2 instance(s)

Note: This command was forced for execution following automatic →

Preview Mode

Action by Query when the changes may result in Network Traffic Disturbance
and too many MO's will be affected, then Confirmation Request.

cmedit action * ManagedElement manualrestart.(restartrank=RESTAR →

T_WARM,restartreason=PLANNED_RECONFIGURATION,restartinfo=someInf →
o)

Response (with confirmation request in suggestion area)

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution.

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00001,Ma →
nagedElement=1

manualRestart Disturbance : manualRestart causes loss of traffic →

!

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00002,Ma →
nagedElement=1

330 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

manualRestart Disturbance : manualRestart causes loss of traffic →

!

.....

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00040,Ma →
nagedElement=1

manualRestart Disturbance : manualRestart causes loss of traffic →

!

40 instance(s) will be affected by this command.

WARNING: Continuing in Preview Mode due to the following reasons →

:

- This action may cause a significant disturbance in the System →

or in the Network

- More than 10 Objects will be affected by this command. Total O →

bjects (40).

Response (after confirmation)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 331

 ENM CLI

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS →

00028,ManagedElement=1

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS →

00021,ManagedElement=1

SUCCESS FDN : .....

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS →

00009,ManagedElement=1

40 instance(s)

Note: This command was forced for execution following automatic →

Preview Mode

Action by Query using preview option

cmedit action * ManagedElement startHealthCheck --preview

Response

Command Preview - List of affected MO(s) with applied action par →

ameters:

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS001,ManagedElement=1

332 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=ERBS002,ManagedElement=1

2 Object(s) will be affected by this command.

Action by Query using preview option and with [scope type]

cmedit action --collection collection_name1 ManagedElement start →

HealthCheck --preview

Response

Command Preview - List of affected MO(s) with applied action par →

ameters:

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00005,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00018,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00017,Ma →
nagedElement=1

3 Object(s) will be affected by this command.

Action by Query using preview option and with savedSearch [scope type]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 333

 ENM CLI

cmedit action -sa savedsearch01 eutrancellfdd changeFrequency.ea →

rfcn=25 --preview

Response

Command Preview - List of affected MO(s) with applied action par →

ameters:

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00017,Ma →
nagedElement=1,ENodeBFunction=1,EUtranCellFDD=LTE03ERBS00017-1

changeFrequency.earfcn : 25

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00036,Ma →
nagedElement=1,ENodeBFunction=1,EUtranCellFDD=LTE03ERBS00036-1

changeFrequency.earfcn : 25

2 Object(s) will be affected by this command.

Action on a node unauthorized by TBAC

cmedit action ERBS002 EUtranCellFDD changeFrequency.(earfcn=1)

Response

Error 3004 : Access Denied. Your Target Based Access Control rig →
hts do not allow you to perform actions on the Network Element(s →
).

Action by Query using preview option when one specified node is

unauthorized by TBAC

334 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit action ERBS001;ERBS002 EUtranCellFDD changeFrequency.(ear →

fcn=1) --preview

Response

Command Preview - List of affected MO(s) with applied action par →

ameters:

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=ERBS002-1

warning : Access Denied. You do not have access to this node.

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=ERBS001-1

changeFrequency.earfcn : 1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=ERBS001-2

changeFrequency.earfcn : 1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=ERBS001-3

changeFrequency.earfcn : 1

3 Object(s) will be affected by this command.

Action by Query when one specified node is unauthorized by TBAC

1/1553-CNA 403 2979 Uen AV | 2020-12-07 335

 ENM CLI

cmedit action ERBS001;ERBS002 EUtranCellFDD changeFrequency.(ear →

fcn=1) --force

Response

FAILED FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1 →

,EUtranCellFDD=ERBS002-1

Error 3005 : Access Denied. You do not have access to this node.

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=ERBS001-1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=ERBS001-2

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=ERBS001-3

Error 5008 : The command executed on 3 out of 4 objects

Action by Query using the "scopefilter" option to add further restrictions using
MO with cardinality 1:1 towards the node.

cmedit action * --scopefilter (CmFunction.syncStatus==SYNCHRONIZ →

ED AND ManagedElement.siteLocation==Dublin) managedElement manua →
lRestart.(restartrank=RESTART_WARM,restartreason=PLANNED_RECONFI →
GURATION,restartinfo=someInfo) --force

Response

This command execute an action for all nodes with the CM syncStatus
SYNCHRONIZED and located in “Dublin”.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00036,ManagedElement=1

336 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

1 instance(s)

Action by Query using the "scopefilter" option to add further restrictions using
MO with cardinality 1:x towards the node.

cmedit action * --scopefilter (CmFunction.syncStatus==SYNCHRONIZ →

ED AND EUtranCellFDD.administrativeState==UNLOCKED) managedEleme →
nt manualRestart.(restartrank=RESTART_WARM,restartreason=PLANNED →
_RECONFIGURATION,restartinfo=someInfo) --force

Response

This command execute an action for all nodes synchronized and with at least one
EUtranCellFDD MO in UNLOCKED state.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00033,ManagedElement=1

1 instance(s)

2.5.27 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]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 337

 ENM CLI

Syntax to get an object by query

cmedit get [scope type] scope [scope filter] cri →

teria [filter] [options]

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

cmedit get [scope type] scope [scope filter] [no →

de details options]

Syntax to get an object by name

cmedit get [scope type] scope [scope filter] cri →

teria_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>

338 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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.

*<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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 339

 ENM CLI

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.

340 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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.

<MO Class>.<pm>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 341

 ENM CLI

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 <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.

342 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 343

 ENM CLI

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" ]

— [ "any" && "any" && ... && "any" ]

— [ "any" || "any" || ... || "any" ]

Note:

The <value> must not contain a combination of && and ||.

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

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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:

Only use this syntax with attributes of type struct whose members are not
complex types (list or struct).

344 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Use round or curly brackets, comma to separate multiple members of the

specified struct attribute.

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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

<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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 345

 ENM CLI

Use square brackets, comma to separate multiple members of the struct in the
specified list of structs .

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>}]

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:

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 .

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>.(<attr name1>,<attr name2><operator><value>)

Use round brackets to group multiple attributes for the same MO Class.

Criteria for MO by Id

346 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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>, <p> 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:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 347

 ENM CLI

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>=<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:

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>=<MO_Id> <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" ]

— [ "any" && "any" && ... && "any" ]

— [ "any" || "any" || ... || "any" ]

348 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Note:

The <value> must not contain a combination of && and ||.

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

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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>=<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 satisfies the specified operator and specified
value.

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.

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 349

 ENM CLI

<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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

<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:

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 .

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.

350 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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 satisfies the specified operator and
specified value.

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 .

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.

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 351

 ENM CLI

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.

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>.*

Only show instances of the specified MO Class including persistent attributes

<MO Class>.<cm>

352 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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 <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 Class>.(<attr name1>,<attr name2>)

Use round brackets to group multiple attributes for the same MO Class.

<MO Class1>;<MO Class2>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 353

 ENM CLI

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.

354 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 355

 ENM CLI

Options for Get by FDN

Use the options to further restrict the output specification.

-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.

-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

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.

356 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<Output Type>

priColl: Create a private collection.

pubColl: Create a public collection.

<Output Name>

Name of the Output created.

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 357

 ENM CLI

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 issues with
formatting.

-l or --list

Present the response in list 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.

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

358 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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

1/1553-CNA 403 2979 Uen AV | 2020-12-07 359

 ENM CLI

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

360 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit get MeContext=ERBS001,ManagedElement=1 --attribute userLa →

bel

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:

FDN : MeContext=ERBS001,ManagedElement=1

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:

FDN : MeContext=ERBS001,ManagedElement=1

neType : ERBS

userLabel : Region5

FDN : MeContext=ERBS002,ManagedElement=1

neType : ERBS

1/1553-CNA 403 2979 Uen AV | 2020-12-07 361

 ENM CLI

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:

FDN : MeContext=ERBS001,ManagedElement=1

mimInfo : {mimRelease=160,mimVersion=1}

FDN : MeContext=ERBS002,ManagedElement=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=L →

TE08ERBS00002,ManagedElement=1 -attr neType,userLabel --syncstat →
us

Response (Setting PIB parameter syncStatusInfoEnabled to true one may

always get the "syncStatus" attribute, without specifying --syncstatus option)

362 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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:

FDN : MeContext=LTE03ERBS00001,ManagedElement=1

syncStatus : SYNCHRONIZED

neType : ERBS

userLabel : Region5

FDN : MeContext=LTE08ERBS00002,ManagedElement=1

syncStatus : SYNCHRONIZED

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/1553-CNA 403 2979 Uen AV | 2020-12-07 363

 ENM CLI

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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction= →
1

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)

364 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Response

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction= →
1

eNodeBPlmnId : {mcc=271}

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction= →
1

eNodeBPlmnId : {mcc=272}

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction= →
1

eNodeBPlmnId : {mcc=271}

3 instance(s)

cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc==271) →

ENodeBFunction.eNodeBPlmnId.(mnc)

Response

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction= →
1

eNodeBPlmnId : {mnc=27}

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction= →
1

eNodeBPlmnId : {mnc=28}

1/1553-CNA 403 2979 Uen AV | 2020-12-07 365

 ENM CLI

3 instance(s)

Get all 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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction= →
1,EUtranCellFDD=LTE32ERBS00001-1

activePlmnList : [{mcc=353, mnc=57, mncLength=2}, {mcc=353, mnc= →

58, mncLength=2}]

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction= →
1,EUtranCellFDD=LTE32ERBS00002-1

activePlmnList : [{mcc=353, mnc=58, mncLength=2}]

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction= →
1,EUtranCellFDD=LTE32ERBS00004-4

activePlmnList : [{mcc=353, mnc=59, mncLength=2}]

3 instance(s)

Get One Struct Attribute of a Single MO Class whose current value satisfies
the specified operator and specified value

366 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId=={mcc=271, →

mnc=27,mncLength=2}

Response

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction= →
1

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,posi →

tionCoordinates)

Response

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE08ERBS00010,M →
anagedElement=1,Equipment=1,AuxPlugInUnit=1

positionCoordinates : {altitude=0, geoDatum=WGS84, latitude=0, l →

ongitude=0}

productData : {productionDate=, serialNumber=, productNumber=, p →

roductRevision=2B, productName=IRU}

1 instance(s)

Get Struct Members inside Struct Attributes of a Single MO Class

cmedit get netsim_LTE08ERBS00010 AuxPlugInUnit.(productData.(pro →

ductName, productRevision),positionCoordinates.(geoDatum))

1/1553-CNA 403 2979 Uen AV | 2020-12-07 367

 ENM CLI

Response

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE08ERBS00010,M →
anagedElement=1,Equipment=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"

368 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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:

FDN : NetworkElement=LTE32ERBS00001

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:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 369

 ENM CLI

FDN : NetworkElement=LTE32ERBS00001

neType : ERBS

platformType : CPP

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"

FDN : NetworkElement=LTE32ERBS00001

FDN : NetworkElement=LTE32ERBS00002

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"

370 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : NetworkElement=LTE32ERBS00003

FDN : NetworkElement=LTE32ERBS00004

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==CXPL17 →

ACP1,revision==H1160}]

Response

This command returns all NetworkElement MOs where the neProductVersion list
contains a struct with identity member CXPL17ACP1 and revision member
H1160

FDN : NetworkElement=LTE01ERBS00002

neProductVersion : [{identity=CXPL17ACP1, revision=H1160}]

FDN : NetworkElement=LTE01ERBS00001

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

1/1553-CNA 403 2979 Uen AV | 2020-12-07 371

 ENM CLI

cmedit get * networkelement.technologyDomain==[EPS]

Response

This command returns all NetworkElement MOs where the technologyDomain

list is equal to [EPS]

FDN : NetworkElement=LTE32ERBS00001

technologyDomain : [EPS]

FDN : NetworkElement=LTE32ERBS00002

technologyDomain : [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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00001-1

2 instance(s)

Parent-Child query specifying in the filter an MO type with attributes

372 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit get LTE32ERBS00001 ManagedElement,ENodeBFunction EnodeBFu →

nction.dnsLookupTimer

Response

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1

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 geranetwork -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* enodebfunctio →

n -t

Response

MeContext,ManagedElement,ENodeBFunction

NodeId ENodeBFunctionId

1/1553-CNA 403 2979 Uen AV | 2020-12-07 373

 ENM CLI

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.

Get Managed Object instances under a mixed scope of valid and invalid node
name

cmedit get LTE02ERBS00031;NotExistingNode enodebfunction

Response

FDN : MeContext=LTE02ERBS00031,ManagedElement=1,ENodeBFunction=1

Scope: NotExistingNode

Error 1049 : The scope is incorrect or not associated with the c →

orrect 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 c →

orrect Node Type

374 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error 5010 : The read command has errors.

Get two Attributes of a Single node name in table format

cmedit get 85BJ5 ReportConfigB2Utra.(b2Threshold1Rsrq,timeToTrig →

gerB2) -t

Response

ManagedElement,ENodeBFunction,EUtranCellFDD,UeMeasControl,Report →
ConfigB2Utra

Node ID ENodeBFunctionId EUtranCellFDDId UeM →

easControlId 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/1553-CNA 403 2979 Uen AV | 2020-12-07 375

 ENM CLI

1 instance(s)

Get all Managed Object Instances with public collection creation

cmedit get * networkelement --output pubColl collName

Response

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE32ERBS00001

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE32ERBS00002

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE32ERBS00003

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE32ERBS00004

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

syncStatus : SYNCHRONIZED

376 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE03ERBS00009

neType : ERBS

syncStatus : SYNCHRONIZED

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=LTE03ERBS00008

neType : ERBS

syncStatus : SYNCHRONIZED

2 instance(s)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 377

 ENM CLI

Get Attribute of a Single collection

cmedit get Collection2

Response

FDN : SubNetwork=NETSimW,ManagedElement=LTE07dg2ERBS00005

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

FDN : SubNetwork=NETSimW,ManagedElement=LTE07dg2ERBS00005

neType : RadioNode

syncStatus : SYNCHRONIZED

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00006

neType: ERBS

syncStatus : UNSYNCHRONIZED

2 instance(s)

378 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Get Attribute with additional details and filtered by netype of a Single

collection

cmedit get Collection2 --detailnode --netype=RadioNode

Response

FDN : SubNetwork=NETSimW,ManagedElement=LTE07dg2ERBS00005

neType : RadioNode

syncStatus : SYNCHRONIZED

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 --detail →

node --netype=ERBS

Response

FDN : SubNetwork=NETSimW,ManagedElement=netsim_LTE03ERBS00008

neType : ERBS

syncStatus : SYNCHRONIZED

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00004,Ma →
nagedElement=1,ENodeBFunction=1,EUtranCellFDD=LTE03ERBS00004-4

neType : ERBS

syncStatus : SYNCHRONIZED

1/1553-CNA 403 2979 Uen AV | 2020-12-07 379

 ENM CLI

2 instance(s)

Get ManagedElement of a Single SavedSearch

cmedit get -sa savedsearch01 ManagedElement

Response

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00007,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00010,Ma →
nagedElement=1

2 instance(s)

Get ManagedElement of a multiple SavedSearch

cmedit get -sa savedsearch01; savedsearch02 ManagedElement

Response

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00007,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00010,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00012,Ma →
nagedElement=1

380 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00014,Ma →
nagedElement=1

4 instance(s)

Get a list of attributes of ManagedElement of a partial node name as scope in

table format with 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 Managed →

ElementId 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 priC →

oll collName -t

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 381

 ENM CLI

SubNetwork,MeContext,ManagedElement

Node ID ParentId ManagedElementId userL →

abel

LTE03ERBS00002 LTE03ERBS00002 1 LTE_E →

RBS

LTE03ERBS00001 LTE03ERBS00001 1 LTE_E →

RBS

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 o →

ccurred: The node SGSN99SGSN00001 ()192.168.103.132) is currentl →
y unavailable

382 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1

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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1

eNodeBPlmnId : {mcc=271}

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction=1

eNodeBPlmnId : {mcc=272}

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 383

 ENM CLI

eNodeBPlmnId : {mcc=271}

3 instance(s)

cmedit get LTE32ERBS0000* ENodeBFunction.eNodeBPlmnId.(mcc==271) →

ENodeBFunction.eNodeBPlmnId.(mnc)

Response

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1

eNodeBPlmnId : {mnc=27}

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction=1

eNodeBPlmnId : {mnc=28}

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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1

eNodeBPlmnId : {mcc=271, mnc=27, mncLength=2}

384 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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"

FDN : NetworkElement=LTE32ERBS00001

FDN : NetworkElement=LTE32ERBS00002

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"

FDN : NetworkElement=LTE32ERBS00003

FDN : NetworkElement=LTE32ERBS00004

1/1553-CNA 403 2979 Uen AV | 2020-12-07 385

 ENM CLI

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]

FDN : NetworkElement=LTE32ERBS00001

technologyDomain : [EPS]

FDN : NetworkElement=LTE32ERBS00002

technologyDomain : [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==CXPL17 →

ACP1,revision==H1160}]

Response

This command returns all NetworkElement MOs where the neProductVersion list
contains a struct with identity member CXPL17ACP1 and revision member
H1160

FDN : NetworkElement=LTE01ERBS00002

386 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

neProductVersion : [{identity=CXPL17ACP1, revision=H1160}]

FDN : NetworkElement=LTE01ERBS00001

neProductVersion : [{identity=CXPL17ACP1, revision=H1160}]

2 instance(s)

Get all 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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00001-1

activePlmnList : [{mcc=353, mnc=57, mncLength=2}, {mcc=353, mnc= →

58, mncLength=2}]

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00002-1

activePlmnList : [{mcc=353, mnc=58, mncLength=2}]

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00004-4

activePlmnList : [{mcc=353, mnc=59, mncLength=2}]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 387

 ENM CLI

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

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00001-1

activePlmnList : [{mcc=353}, {mcc=353}]

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00002-1

activePlmnList : [{mcc=353}]

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00004-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

388 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : MeContext=LTE32ERBS00001,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00001-1

activePlmnList : [{mcc=353, mnc=57}, {mcc=353, mnc=57}]

FDN : MeContext=LTE32ERBS00002,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00002-1

activePlmnList : [{mcc=353, mnc=58}]

FDN : MeContext=LTE32ERBS00003,ManagedElement=1,ENodeBFunction=1 →
,EUtranCellFDD=LTE32ERBS00004-4

activePlmnList : [{mcc=353, mnc=59}]

3 instance(s)

Get Managed Object instances using the "scopefilter" option to add further
restrictions on MO with cardinality 1:1 towards the node.

cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED →

AND ManagedElement.siteLocation==Dublin) ENodeBFunction

Response

This command returns the ENodeBFunction MO for all nodes with the CM
syncStatus SYNCHRONIZED and located in “Dublin”.

FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW →
-1,MeContext=LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1

1 instance(s)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 389

 ENM CLI

Get Managed Object instances using the "scopefilter" option to add further
restrictions on MO with cardinality 1:x towards the node where only 1 MO
instance is expected in the result set.

cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED →

AND EUtranCellFDD.administrativeState==UNLOCKED) ENodeBFunction

Response

This command returns the ENodeBFunction MO for all nodes synchronized and
at least one EUtranCellFDD in UNLOCKED state.

FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW →
-1,MeContext=LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1

1 instance(s)

Get Managed Object instances using the "scopefilter" option to add further
restrictions on MO with cardinality 1:x towards the node where multiple
instances are expected in the result set.

cmedit get * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED →

AND EUtranCellFDD.administrativeState==UNLOCKED) EUtranCellFDD.a →
dministrativeState

Response

The command returns all EUtranCellFDD MOs beneath all nodes synchronized
and at least one EUtranCellFDD in UNLOCKED state.

FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW →
-1,MeContext=LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=LTE02ERBS00027-1

administrativeState : LOCKED

390 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ERBS-SUBNW →
-1,MeContext=LTE02ERBS00027,ManagedElement=1,ENodeBFunction=1,EU →
tranCellFDD=LTE02ERBS00027-2

administrativeState : UNLOCKED

2 instance(s)

Note: All EUtranCellFDD instances will be returned and not only those matching
the scope filter.

2.5.28 cmedit set

< Back To Cmedit

Syntax

Syntax to Set Data by FDN

cmedit set <FDN> attributes

cmedit set <FDN> [scope filter] criteria attribu →

tes [options]

Syntax to Set Data by Query

cmedit set [scope type] scope [scope filter] cri →

teria attributes [options]

Syntax to set an object by name

1/1553-CNA 403 2979 Uen AV | 2020-12-07 391

 ENM CLI

cmedit set [scope type] scope [scope filter] cri →

teria_for_MO_by_Id attributes [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.

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.

392 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

*<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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 393

 ENM CLI

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 operate on.

<MO Class>

Operate on all instances of the specified MO Class.

<MO Class1>,<MO Class2>

394 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Use a comma to separate multiple MO Classes when operating on all instances of

*either* MO Class1 or MO Class2.

<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" ]

— [ "any" && "any" && ... && "any" ]

— [ "any" || "any" || ... || "any" ]

Note:

The <value> must not contain a combination of && and ||.

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

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 395

 ENM CLI

<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:

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.

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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

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

name><operator><value>}]

396 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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:

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 .

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>}]

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:

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 .

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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 397

 ENM CLI

<MO Class>.(<attr name><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>=<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> <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:

398 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— [ "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>

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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>=<MO_Id> <attr name><operator><value>

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 399

 ENM CLI

<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 satisfies the specified operator and specified
value.

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.

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>=<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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

400 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<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:

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 .

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>=<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 satisfies the specified operator and
specified value.

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 .

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).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 401

 ENM CLI

Search on operators <, >, !<, !>, <=, >= is supported for integer data member
attribute types only.

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.

Attributes

Used to specify attributes.

<attribute name>=<attribute value> or

<attribute name>:<attribute value>

Attribute values are specified by giving the name, followed by "=" or ":" and then
the value.

<attribute1 name>=<attribute1 value>;<attribute2 name>=<attribute2 value>...

or

<attribute1 name>=<attribute1 value>,<attribute2 name>=<attribute2 value>...

402 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Use semi-colon or comma to separate multiple attribute name and value pairs.

<struct attribute name>=( <struct member1 name>=<struct member1

value>,<struct member2 name>=<struct member2 value>...) or

<struct attribute name>={ <struct member1 name>=<struct member1

value>,<struct member2 name>=<struct member2 value>...}

Use round brackets or curly brackets to group struct member names and values
together, separated by a comma.

Use this syntax when you want to set the whole struct attribute (with all its
members).

<struct attribute name>.( <struct member1 name>=<struct member1

value>,<struct member2 name>=<struct member2 value>...) or

<struct attribute name>.{ <struct member1 name>=<struct member1

value>,<struct member2 name>=<struct member2 value>...}

Use round brackets or curly brackets to group struct member names and values
together, separated by a comma.

Use this syntax when you want to set a subset of the members of the struct
attribute.

Options

-ns or --namespace

Specify a particular namespace.

-ne or --netype

Specify a particular netype.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 403

 ENM CLI

-v or --version

Specify a particular version.

--force

Force the command execution. This option is not required when using scripting
integration or batch scripts. It is assumed that all commands in a script should be
executed without user intervention.

-prev or --preview

Preview the MOI(s) involved in the command.

Description
cmedit set is used to set the configuration data for one or multiple nodes in the
network.

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.

If a set command updates more nodes than the system allows an execution error
will be showed.

The set command result will be the modification of the specified attributes for
specified MOI(s). Therefore, a preview of affected MOIs will be displayed to

404 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

prevent users from making potentially harmful changes via CLI asking to confirm
if they want to go ahead; this could happen in the following conditions:

— If an attribute is modelled with the "disturbances" flag a warning message to

indicate it may cause a significant disturbance in traffic will be showed;

— If too many MO's will be modified then a warning message will be showed.
The number of MOs is controlled by PIB parameter
(maxAffectedObjectsWithoutConfirmation), default setting is 10.

To execute the command after preview has been displayed there are two options
for the user:

— to click the button labeled 'Execute' displayed in suggestion area;

— to issue again the command with the option '-- force'.

Update operations are batched by node. For example, if the command changes 5
MOs per node, a failure on one MO will cause all changes for the node to be
reverted. To force the update on the four non failing MO's execute an update
command on each MO individually.

If the user requests an output to file for the command and a preview of affected
MOIs is needed two files will be generated : one for preview and one for
command output after confirmation

The command response could be very slow when more than 100 FDN items are
used as scope type, as in the command: cmedit set <FDN1>;…;<FDN100> criteria
attributes. The user should use instead Collection or SavedSearch as scope or as
an alternative the following syntax: cmedit set <FDN1>;…;<FDN100> attributes.

CM Edit commands have an overload protection mechanism to limit

SET 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

— The set command result is the modification of the specified attributes for
specified MOIs.

Examples

Set by FDN: Set a single attribute of an MO Instance.

cmedit set MeContext=ERBS001,ManagedElement=1 userlabel=sampleUs →

erLabel

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 405

 ENM CLI

FDN : MeContext=ERBS001,ManagedElement=1

1 instance(s) updated

Set multiple attributes on an MO Instance

cmedit set ERBS001 managedelement userlabel=sampleUserLabel, pro →

ductnumber=CXC101101

Response

FDN : MeContext=ERBS001,ManagedElement=1

1 instance(s) updated

Set a single struct attribute on an MO Instance.

cmedit set MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1 e →

nodebplmnid:(mcc=999,mnc=666,mnclength=2)

Response

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

1 instance(s) updated

Set a single member of a struct attribute on an MO Instance.

406 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit set MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1 e →

nodebplmnid.(mnclength=2)

Response

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

1 instance(s) updated

Set an attribute on MO Instance(s) using filter criteria.

cmedit set * managedelement.userlabel==sampleUserLabel,enodebfun →

ction.dscplabel>=36,eutrancellfdd.earfcndl==17000 managedelement →
.userlabel=ERBS1_ME1,enodebfunction.userlabel=ERBS1_ENODEB1

Response

FDN : MeContext=ERBS001,ManagedElement=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

2 instance(s) updated

Set an attribute on MO Instance(s) using filter criteria with 'List Contains'

query.

cmedit set * networkelement.radioAccessTechnology~~["4G" && "5G" →

] networkelement.userlabel="Multi RAT"

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 407

 ENM CLI

This command sets userLabel for all NetworkElement MOs where the
radioAccessTechnology list value contains both entries "4G" and "5G"

FDN : NetworkElement=LTE32ERBS00003

FDN : NetworkElement=LTE32ERBS00004

2 instance(s)

Set an attribute on MO Instance(s) using filter criteria when the changes may
result in Network Traffic Disturbance and Confirmation Request.

cmedit set * managedelement.userlabel==sampleUserLabel,enodebfun →

ction.dscplabel>=36,eutrancellfdd.earfcndl==17000 managedelement →
.userlabel:ERBS1_ME1,enodebfunction.timeAndPhaseSynchAlignment:t →
rue

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution.

FDN : MeContext=ERBS001,ManagedElement=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

timeAndPhaseSynchAlignment Disturbance : Changing this attribute →

can affect traffic.

2 instance(s) will be affected by this command.

408 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

WARNING: Continuing in Preview Mode due to the following reasons →

:

- Some attribute(s) may cause a significant disturbance in the →

System or in the Network

Response (after confirmation)

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1

2 instance(s) updated

Note: This command was forced for execution following automatic →

Preview Mode

Set an attribute on MO Instance(s) using filter criteria with preview option.

cmedit set * ManagedElement userLabel=newLabel --preview

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 409

 ENM CLI

Command Preview - List of affected MO(s) with current attribute →

values:

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS001,ManagedElement= →

1

userLabel : myLabel

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS002,ManagedElement= →

1

userLabel : myLabel

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS003,ManagedElement= →

1

userLabel : myLabel

3 Object(s) will be updated by this command.

Set an attribute on MO Instance(s) using filter criteria with savedSearch

[scope type] and preview option.

cmedit set -sa savedsearch01 ManagedElement userLabel=newLabel - →

-preview

Response

Command Preview - List of affected MO(s) with current attribute →

values:

410 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00017,Ma →
nagedElement=1

userLabel : myLabel

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00019,Ma →
nagedElement=1

userLabel : myLabel

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS00039,Ma →
nagedElement=1

userLabel : myLabel

3 Object(s) will be updated by this command.

Set an attribute on MO Instance(s) using filter criteria with savedSearch,

collection [scope type].

cmedit set -sa savedsearch01 -co collection_name1 ManagedElement →

userLabel=newLabel --force

Response

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS →

00021,ManagedElement=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 411

 ENM CLI

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE03ERBS →

00004,ManagedElement=1

2 instance(s) updated

Set multiple attributes, specifying multiple node IDs in the

ERBS_NODE_MODEL namespace with version 6.1.100 and filtered by one
attribute value greater-than or equal to a specific value.

cmedit set MeContext=ERBS001;MeContext=ERBS002 enodebfunction.ds →

cplabel>=20 userlabel:newUserLabel; dscplabel:30 -ns=ERBS_NODE_M →
ODEL -v=6.1.100

Response

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

2 instance(s) updated

Set userLabel attribute to a null value for all MmeFunction MOs.

cmedit set * mmefunction userLabel=<null>

or

cmedit set * mmefunction userLabel=<empty>

Response

412 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : MeContext=SGSN-16A-CP01-V102,MmeFunction=1

1 instance(s) updated

Set by FDN: Set a single attribute of an MO Instance with Preview Mode and
Confirmation Request.

cmedit set netsim_LTE01ERBS001* ManagedElement userlabel:myUserL →

abel

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS00116,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS00117,Ma →
nagedElement=1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS00114,Ma →
nagedElement=1

...

13 instance(s) will be affected by this command.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 413

 ENM CLI

WARNING: Continuing in Preview Mode due to the following reasons →

:

- More than 10 Object(s) will be affected by this command. Total →

Objects (13).

Response (after confirmation)

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS →

00116,ManagedElement=1

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS →

00117,ManagedElement=1

SUCCESS FDN : SubNetwork=ERBS-SUBNW-1,MeContext=netsim_LTE01ERBS →

00114,ManagedElement=1

...

13 instance(s) updated

Note: This command was forced for execution following automatic →

Preview Mode

414 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Set an attribute on MO Instance(s) on a node unauthorized by TBAC

cmedit set ERBS002 NetworkElement utcOffset="+00:28"

Response

Error 3004 : Access Denied. Your Target Based Access Control rig →
hts do not allow you to perform actions on the Network Element(s →
).

Set an attribute on MO Instance(s) with preview option when one specified

node is unauthorized by TBAC

cmedit set ERBS001;ERBS002 NetworkElement utcOffset="+00:28" --p →

review

Response

Command Preview - List of affected MO(s) with current attribute →

values:

FDN : NetworkElement=ERBS002

warning : Access Denied. You do not have access to this node.

FDN : NetworkElement=ERBS001

utcOffset : +00:28

1 Object(s) will be updated by this command.

Set an attribute on MO Instance(s) when one specified node is unauthorized

by TBAC

1/1553-CNA 403 2979 Uen AV | 2020-12-07 415

 ENM CLI

cmedit set ERBS001;ERBS002 NetworkElement utcOffset="+00:28" --f →

orce

Response

FAILED FDN : NetworkElement=ERBS002

Error 3005 : Access Denied. You do not have access to this node.

SUCCESS FDN : NetworkElement=ERBS001

Error 5008 : The command executed on 1 out of 2 objects

Set "managementState" attribute on NetworkElement when the user is

authorized to modify it (with Nedo_Administrator role)

cmedit set ERBS001 networkelement managementState=MAINTENANCE

Response

SUCCESS FDN : NetworkElement=ERBS001

1 instance(s) updated

Set "managementState" attribute on NetworkElement when the user is

unauthorized to modify it (without Nedo_Administrator role)

cmedit set ERBS001 networkelement managementState=MAINTENANCE

Response

Error 5001 : Insufficient access rights to perform the operation

Suggested Solution : If the operation is required to be performe →

d by the current user, the user profile must be updated by the s →
ystem administrator.

416 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Set Managed Object instances using the "scopefilter" option to add further
restrictions using MO with cardinality 1:1 towards the node.

cmedit set * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED →

AND ManagedElement.siteLocation==Dublin) ENodeBFunction dscpLabe →
l=45

Response

This command set the ENodeBFunction.dscpLabel MO attribute for all nodes

with the CM syncStatus SYNCHRONIZED and located in “Dublin”.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00012,ManagedElement=1,ENod →
eBFunction=1

1 instance(s) updated

Set Managed Object instances using the "scopefilter" option to add further
restrictions using MO with cardinality 1:x towards the node.

cmedit set * --scopefilter (CmFunction.syncStatus==SYNCHRONIZED →

AND EUtranCellFDD.administrativeState==UNLOCKED) ENodeBFunction →
dscpLabel=45

Response

This command set the ENodeBFunction.dscpLabel MO attribute for all nodes

synchronized and with at least one EUtranCellFDD MO in UNLOCKED state.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00012,ManagedElement=1,ENod →
eBFunction=1

1 instance(s) updated

1/1553-CNA 403 2979 Uen AV | 2020-12-07 417

 ENM CLI

2.5.29 cmedit create

< Back To Cmedit

Syntax

Syntax to Create Node Data in the Management System

cmedit create <FDN> attributes [options]

Attributes

Used to specify attributes.

<attribute name>=<attribute value>

Attribute values are specified by giving the name, followed by "=" and then the
value.

<attribute1 name>=<attribute1 value>;<attribute2 name>=<attribute2 value>...

Use semi-colon or comma to separate multiple attribute name and value pairs.

<struct attribute name>=(<struct member1 name>=<struct member1

value>,<struct member1 name>=<struct member1 value>...) or

<struct attribute name>={<struct member1 name>=<struct member1

value>,<struct member1 name>=<struct member1 value>...}

Use round brackets or curly brackets to group struct member names and values
together, separated by a comma.

418 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

<sequence attribute name>=[<value1>,<value2>,<value3>...]

Use square brackets to group multiple values in a sequence attribute, separated

by a comma.

Options

Use the options to further refine the object creation.

-ns or --namespace

Specify a particular namespace.

-v or --version

Specify a particular version.

-t or --table

Present the response in table format.

-l or --list

Present the response in list format.

Note:

The two options namespace and version must be used together in this command.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 419

 ENM CLI

Description
cmedit create is used to create Node data in the management system.

Details of Case Sensitivity for cmedit commands.

Details of Special Characters for cmedit commands.

Command Consequences

— The create command creates one MO instance.

Examples

Create an ENodeBFunction MO under the Managed Element MO and Set an

Attribute of Type Struct, Specifying the version and the namespace

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1 ENodeBFunctionId=1; userlabel="sampleUserLabel"; enodebplmnid →
=(mcc=272,mnc=7,mnclength=2) -ns=ERBS_NODE_MODEL -v=6.1.100

Response

This command returns the created ENodeBFunction MO with the list of all
attributes.

Create a Child MO Under the ENodeBFunction MO Created in the Previous

Example

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,GeraNetwork=1 geranetworkid=1

Response

FDN: MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,GeraNet →
work=1
GeraNetworkId : 1
userLabel: null

Create Attributes of Type MO Ref under the ENodeBFunction MO Created in

the First Example and Set an Attribute of Type List

420 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3 eutrancellfddid=3,sectorfunctionref="MeContext →
=ERBS001,ManagedElement=1,SectorEquipmentFunction=1",earfcndl=17 →
999,earfcnul=20175,cellid=1,physicallayercellidgroup=130,tac=1,p →
hysicallayersubcellid=2,pciconflict=[YES,YES]

Response

This command returns the created EUtranCellFDD MO with the list of all
attributes.

Create an ENodeBFunction MO when specified node is unauthorized by TBAC

cmedit create MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1 ENodeBFunctionId=1; userlabel="sampleUserLabel"; enodebplmnid →
=(mcc=272,mnc=7,mnclength=2) -ns=ERBS_NODE_MODEL -v=6.1.100

Response

Error 3004 : Access Denied. Your Target Based Access Control rights do not allow
you to perform actions on the Network Element(s).

Create/Add an attribute "timeZone" under the NetworkElement MO/

NodeFDN NetworkElement=*MSC* (Mandatory attribute of the NetworkElement
MSC and its variants during addition)

cmedit create NetworkElement=MSC-S-DB-APG43L-R18A01 networkEleme →

ntId=MSC-S-DB-APG43L-R18A01, neType=MSC-DB, platformType=APG, os →
sPrefix="MeContext=MSC-S-DB-APG43L-R18A01", timeZone="Europe/Dub →
lin" -ns=OSS_NE_DEF -version=2.0.0

Response

This command returns the created NetworkElement MO with the list of all
attributes.

SubNetwork can be created on its own first before adding the node

cmedit create SubNetwork=ERBS SubNetworkId=ERBS -ns=OSS_TOP -ver →

sion=3.0.0

Response

1/1553-CNA 403 2979 Uen AV | 2020-12-07 421

 ENM CLI

FDN : SubNetwork=ERBS
SubNetworkId : ERBS

2.5.30 cmedit delete

< Back To Cmedit

Syntax

Syntax to Delete an Object by Specifying the FDN

cmedit delete <FDN> [-ALL]

cmedit delete <FDN> [scope filter] criteria [fil →

ter] [-ALL] [options]

Syntax to Delete an Object by Query

cmedit delete [scope type] scope [scope filter] →

criteria [filter] [-ALL] [options]

Syntax to delete an object by name

cmedit delete [scope type] scope [scope filter] →

criteria_for_MO_by_Id [filter] [-ALL] [options]

Scope type
Use Scope Type option to restrict the scope to:

— collection [ -co | --collection ]

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

— saved search [ -sa | --savedSearch ]

422 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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

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.

*<Partial Node Name>*

Contains the specified partial node name, i.e. *RBS0*.

References all nodes in the network.

<Collection Name>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 423

 ENM CLI

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.

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.

424 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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 operate on.

<MO Class>

Operate on all instances of the specified MO Class.

<MO Class1>,<MO Class2>

Use a comma to separate multiple MO Classes when operating on all instances of

*either* MO Class1 or MO Class2.

<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:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 425

 ENM CLI

— [ "any" ]

— [ "any" && "any" && ... && "any" ]

— [ "any" || "any" || ... || "any" ]

Note:

The <value> must not contain a combination of && and ||.

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

Search for all instances of the specified MO Class which contains the specified
attribute whose current 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:

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.

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).

426 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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:

Only use this syntax with attributes of type list of structs whose members in the
structs are not complex types (list or struct).

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 attribute
types only.

<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:

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 .

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).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 427

 ENM CLI

Search on operators <, >, !<, !>, <=, >= is supported for integer data member
attribute types only.

<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:

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 .

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>.(<attr name><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>=<Partial MO_Id>*

428 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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*.

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.

Filter

Use filter to specify which of the types that is to be deleted.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 429

 ENM CLI

<MO Class>

Operate on all instances of the specified MO Class.

Options

-ns or --namespace

Specify a particular namespace.

-v or --version

Specify a particular version.

--force

Force the command execution. This option is not required when using scripting
integration or batch scripts. It is assumed that all commands in a script should be
executed without user intervention.

-prev or --preview

Preview the MOI(s) involved in the command.

Note: The two options namespace and version must be used together in this
command.

Description
cmedit delete is used to delete a hierarchical structure of node Managed Object
Instances (MOI) (such as an entire node) or to delete individual MOIs in the
Network.

430 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— The -ALL parameter is used to force the deletion of MOIs, even if other MOIs
are defined under the specified MOI. The specified FDN and all MOIs under
the FDN are deleted.

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.

- If a delete command cancels more nodes than the system allows an execution
error will be showed.

- A delete command will attempt to remove MOI(s) and it may result in Network
Traffic Disturbance. Therefore, a preview of affected MOIs will be displayed.

To execute the command after preview has been displayed there are two options
for the user:

— to click the button labeled 'Execute' displayed in suggestion area

— to issue again the command with the option '-- force'

If the user requests an output to file for the command and a preview of affected
MOIs is needed two files will be generated : one for preview and one for
command output after confirmation

CM Edit commands have an overload protection mechanism to limit

DELETE 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 the -ALL option, the delete command will attempt to delete the
specified MOI(s) only. If MOI(s) have children, the deletion of these MOI(s)
fail.

— With the -ALL option, the delete command will delete the specified MOI(s)
and their children.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 431

 ENM CLI

Examples

Delete Node by FDN: delete an ENodeBFunction and all MOIs under the
ENodeBFunction

cmedit delete MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1 -ALL --force

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3

2 instance(s) deleted

Delete ENodeBFunction instances and all MOIs under them

cmedit delete * enodebfunction -ALL --force

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction= →

1

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3

432 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

4 instance(s) deleted

Delete ENodeBFunction instances and all MOIs under them when the
changes may result in Network Traffic Disturbance and Confirmation Request.

cmedit delete * enodebfunction -ALL

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution.

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=3

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=3

4 instance(s) will be deleted by this command.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 433

 ENM CLI

Response (after confirmation)

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=3

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1

FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction=1,EUtran →
CellFDD=3

4 instance(s) deleted

Note: This command was forced for execution following automatic →

Preview Mode

Delete ManagedElement instances using preview option

cmedit delete * ManagedElement --preview

Response

Command Preview - List of Affected MO(s):

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS001,ManagedElement= →

1

434 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS002,ManagedElement= →

1

FDN : SubNetwork=ERBS-SUBNW-1,MeContext= ERBS003,ManagedElement= →

1

3 Object(s) will be deleted by this command.

Delete ENodeBFunction instances, some of which have Child MOs defined

below them whilst others have no child MO.

cmedit delete * enodebfunction --force

Response

FAILED FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction=1

Error 1011 : Cannot delete MeContext=ERBS001,ManagedElement=1,EN →

odeBFunction=1 because it has one or more child MOs Delete child →
ren first. Hint : Append -ALL to end of DELETE command to automa →
tically delete all children.

Note: MOs which have child MOs defined below them will not be deleted even if
they satisfy the specified, filtered criteria.

Delete ENodeBFunction with wrong MO Class specified.

cmedit delete * enodebfunction managedelement -ALL

Response

0 instance(s) found

1/1553-CNA 403 2979 Uen AV | 2020-12-07 435

 ENM CLI

Delete ENodeBFunction instances with userLabel attribute equal to

"sampleUserLabel".

cmedit delete * enodebfunction.userlabel=="sampleUserLabel" --fo →

rce -ALL

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1

1 instance(s) deleted

Delete NetworkElement instances using 'List Contains' query where attribute

radioAccessTechnology contains both "4G" and "5G" entries.

cmedit delete * networkelement.radioAccessTechnology~~["4G" && " →

5G"] --force -ALL

Response

SUCCESS FDN : NetworkElement=ERBS001

1 instance(s) deleted

Delete MOs across all nodes defined in the network, which satisfy a specified,
filtered criteria. The MOs to be deleted have no Child MOs.

436 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit delete * eutrancellfdd.(eutrancellfddid==3, cellid==1) eu →

trancellfdd --force -ALL

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3

SUCCESS FDN : MeContext=ERBS002,ManagedElement=1,ENodeBFunction= →

1,EUtranCellFDD=3

2 instance(s) deleted

Delete ENodeBFunction instances, some of which have attributes filters on

different MO types, Specifying the Namespace and the Version.

cmedit delete * enodebfunction.userlabel==sampleUserLabel,eutran →

cellfdd.cellid==1 enodebfunction -ns=ERBS_NODE_MODEL -v=6.1.100 →
--force -ALL

Response

SUCCESS FDN : MeContext=ERBS001,ManagedElement=1,ENodeBFunction= →

1

1 instance(s) deleted

Delete ENodeBFunction instances, some of which have attributes filters on

different MO types, Specifying the savedSearch [scope type], Namespace and the
Version.

cmedit delete -sa savedsearch01;savedsearch02 enodebfunction.use →

rlabel==sampleUserLabel,eutrancellfdd.cellid==1 enodebfunction - →
ns=ERBS_NODE_MODEL -v=6.1.100 --force -ALL

1/1553-CNA 403 2979 Uen AV | 2020-12-07 437

 ENM CLI

Response

SUCCESS FDN : MeContext=LTE03ERBS00010,ManagedElement=1,ENodeBFu →

nction=1

SUCCESS FDN : MeContext=LTE03ERBS00008,ManagedElement=1,ENodeBFu →

nction=1

SUCCESS FDN : MeContext=LTE03ERBS00015,ManagedElement=1,ENodeBFu →

nction=1

3 instance(s) deleted

Delete a NetworkElement when specified node is unauthorized by TBAC

cmedit delete ERBS002 NetworkElement

Response

Error 3004 : Access Denied. Your Target Based Access Control rig →
hts do not allow you to perform actions on the Network Element(s →
).

Delete NetworkElement objects using preview option when one specified

node in unauthorized by TBAC

cmedit delete ERBS001;ERBS002 NetworkElement --ALL --preview

Response

Command Preview - List of Affected MO(s):

FDN : NetworkElement=ERBS002

438 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

warning : Access Denied. You do not have access to this node.

FDN : NetworkElement=ERBS001

FDN : NetworkElement=ERBS001,SHMFunction=1,InventoryFunction=1

FDN : NetworkElement=ERBS001,CppConnectivityInformation=1

FDN : NetworkElement=ERBS001,CmNodeHeartbeatSupervision=1

FDN : NetworkElement=ERBS001,InventorySupervision=1

FDN : NetworkElement=ERBS001,FmAlarmSupervision=1

FDN : NetworkElement=ERBS001,CmFunction=1

FDN : NetworkElement=ERBS001,SHMFunction=1

FDN : NetworkElement=ERBS001,PmFunction=1

FDN : NetworkElement=ERBS001,FmFunction=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 439

 ENM CLI

FDN : NetworkElement=ERBS001,SecurityFunction=1

11 Object(s) will be deleted by this command.

Delete SubNetworks instances and Confirmation Request.

cmedit delete SubNetwork=ERBS

Response (with confirmation request)

WARNING: Continuing in Preview Mode. Please confirm if you want →

to continue command execution.

FDN : SubNetwork=ERBS

1 instance(s) will be deleted by this command.

Response (after confirmation)

SUCCESS FDN : SubNetwork=ERBS

1 instance(s) deleted

440 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Note: This command was forced for execution following automatic →

Preview Mode

Delete Managed Object instances using the "scopefilter" option to add further
restrictions using MO with cardinality 1:1 towards the node.

cmedit delete * --scopefilter (CmFunction.syncStatus==SYNCHRONIZ →

ED AND ManagedElement.siteLocation==Dublin) ENodeBFunction -ALL →
--force

Response

This command delete the ENodeBFunction MO for all nodes with the CM
syncStatus SYNCHRONIZED and located in “Dublin”.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00023,ManagedElement=1,ENod →
eBFunction=1

1 instance(s) deleted

Delete Managed Object instances using the "scopefilter" option to add further
restrictions using MO with cardinality 1:x towards the node.

cmedit delete * --scopefilter (CmFunction.syncStatus==SYNCHRONIZ →

ED AND EUtranCellFDD.administrativeState==UNLOCKED) ENodeBFuncti →
on -ALL --force

Response

This command delete the ENodeBFunction MO for all nodes synchronized and
with at least one EUtranCellFDD MO in UNLOCKED state.

SUCCESS FDN : SubNetwork=Europe,SubNetwork=Ireland,SubNetwork=ER →

BS-SUBNW-1,MeContext=netsim_LTE02ERBS00023,ManagedElement=1,ENod →
eBFunction=1

1/1553-CNA 403 2979 Uen AV | 2020-12-07 441

 ENM CLI

1 instance(s) deleted

2.5.31 cmedit describe

< Back To Cmedit

Syntax

Syntax to Describe the Modeled Data by NeType

cmedit describe -ne | --netype <neType>

Syntax to Describe the Modeled Data by MO

cmedit describe criteria [options]

Criteria

Use the criteria to specify the Managed Object (MO) Classes, attributes and
actions to describe.

Structs and struct members can also be described using the same syntax.

<MO Class>

Describe one MO Class.

<MO Class>.<field name>

Describe the specified MO Class field. A field can be an attribute or an action of

the MO class.

442 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

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

Use round brackets to describe multiple fields for the same MO Class.

<MO Class>.*<Partial field name>*

Describe all attributes and actions matching partial field name for specified MO
Class.

<MO Class>.*

Describe all persistent attributes and all actions of the specified MO Class.

<MO Class>.<cm>

Use the special identifier <cm> to describe all Configuration Management (CM)
attributes of the specified MO Class.

<MO Class>.<pm>

Use the special identifier <pm> to describe 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 describe all persistent attributes of the specified
MO Class.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 443

 ENM CLI

<MO Class>.<w>

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

<MO Class>.<m>

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

*<Partial MO Class>*

Describe all MO Classes containing the partial specified MO Class. The above
criteria are valid also with a Partial MO Class.

Options

-ns or --namespace

Specify a particular namespace.

-v or --version

Specify a particular version.

-l or --list

Present the response in list format.

-t or --table

444 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Present the response in table format.

This can be useful when comparing results.

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 issues with
formatting.

--all

Specify output contains all MO Class versions.

Note: The two options version and --all cannot be used together. Avoid to use --
all with commands including a Partial MO Class.

Description
cmedit describe is used to read the description of modeled data in the system.

Details of Case Sensitivity for cmedit commands.

Command Consequences

— There is no consequences in the Describe command.

Examples

Describe version information for NeType

Example:

cmedit describe --netype ERBS

Result:

— Ne Type: ERBS

— Ne Release: 16B

— Product Identity: -

— Revision (R-State): -

— Functional MIM Name: ERBS_NODE_MODEL

1/1553-CNA 403 2979 Uen AV | 2020-12-07 445

 ENM CLI

— Functional MIM Version: G.1.301

— Model ID: 16B-G.1.301

Describe all attributes of MO Classes with partial MO Class specified

Example:

cmedit describe *cell*

Result:

This command lists all MO Classes and attributes with the specified partial MO
Class. The following attribute information is displayed:

MO Class

— Name: ExternalUtranCellFDD

— Description: This Managed Object contains a UTRAN cell for Frequency

Division Duplex (FDD).

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Parent MOs: UtranFrequency

— Child MOs:

— Ne Type:

— Life Cycle State: CURRENT

Struct

— Name: CellIdentityUtra

— Description: CellIdentityUtra

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— References from: ExternalUtranCellFDD, ExternalUtranCellTDD

— Life Cycle State: CURRENT

446 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Describe the latest versions in all namespaces of the specified MO Type

Example:

cmedit describe managedelement

Result:

This command lists the descriptions for one MO Type for the most recent version,
in all namespaces, with the list of all attributes. The following attribute
information is displayed:

MO Class

— Name: ManagedElement

— Description: This represents super-type for all managed elements.

— Namespace: OSS_TOP

— Version: 3.0.0

— Parent MOs: MeContext, SubNetwork

— Child MOs: Inventory

— Ne Type:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

Describe the latest versions in all namespaces and information about

modeled actions of the specified MO Type

Example:

cmedit describe managedelement.*

Result:

This command lists the descriptions for one MO Type for the most recent version,
in all namespaces, with the list of all persistent attributes and all actions. The
following information are displayed:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 447

 ENM CLI

MO Attribute

— Name: ManagedElement.mimName

— Description: The name and version of the MIM on the node.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Data Type: STRING

— Disturbances:

— Default Value:

— Read Behavior: FROM_DELEGATE

— Write Behavior: NOT_ALLOWED

— Additional Information: noNotification

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

MO Action

— Name: ManagedElement.manualRestart

— Description: Manual restart of the node.

— Namespace: ERBS_NODE_MODEL

— Version: 7.1.301

— Return Type:

— Disturbances: manualRestart causes loss of traffic!

448 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

Describe MO Type of a specific version and namespace.

Example:

cmedit describe managedelement --namespace=ERBS_NODE_MODEL --ver →

sion=7.1.301

Result:

This command lists the descriptions for one MO Type for the specified version
and namespace, with the list of all attributes. The following attribute information
is displayed:

MO Class

— Name: ManagedElement

— Description: Managed Element This MO is the top MO in the MOM. A

management application will communicate with the ManagedElement MO
for the purpose of monitoring and controlling it. This MO is created
automatically and cannot be deleted. The RDN of this MO is
ManagedElement=1.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Parent MOs: MeContext, SubNetwork

— Child MOs: ENodeBFunction, Equipment, EquipmentSupportFunction,

IpOam, IpSystem, ManagedElementData, MceFunction,
NodeManagementFunction, ResourceAllocationFunction,
SectorEquipmentFunction, SwManagement, SystemFunctions,
TransportNetwork

— Ne Type:

— Life Cycle State: CURRENT

1/1553-CNA 403 2979 Uen AV | 2020-12-07 449

 ENM CLI

— Dependencies:

— Precondition:

Describe Multiple MO Types for latest versions in all namespaces.

Example:

cmedit describe managedelement;enodebfunction;eutrancellfdd

Result:

This command lists the descriptions for one MO Types with the list of all
attributes, for the latest versions in all namespaces. The following attribute
information is displayed:

MO Class

— Name: ENodeBFunction

— Description: ENodeBFunction

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Parent MOs: ManagedElement

— Additional Information:

— Child MOs: AdmissionControl, AirIfLoadProfile, AmoFunction, AnrFunction,

AutoCellCapEstFunction, CarrierAggregationFunction, Cdma2000Network,
CellSleepNodeFunction, DrxProfile, EUtraNetwork, EUtranCellFDD,
EUtranCellTDD, GeraNetwork, ImeisvTable, LoadBalancingFunction, Mbms,
MdtConfiguration, NonPlannedPciDrxProfile, OpProfiles, Paging,
ParameterChangeRequests, PlmnInfo, PmEventService,
PreschedulingProfile, QciTable, RadioBearerTable, Rcs,
ResourcePartitionGroup, ResourcePartitions, RlfProfile, Rrc, SectorCarrier,
SecurityHandling, SubscriberProfileID, TermPointToMme, TermPointToSGW,
TimerProfile, UlCompGroup, UtraNetwork

— Ne Type:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

450 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Describe latest MO Type with specified attribute.

Example:

cmedit describe managedelement.healthcheckresult

Result:

This command lists the descriptions of the specified attribute. The following
attribute information is displayed:

MO Attribute

— Name: ManagedElement.healthCheckResult

— Description: The result of the latest health check.

— Namespace: RNC_NODE_MODEL

— Version: 22.5.4505

— Data Type: COMPLEX_REF

— Disturbances:

— Default Value:

— Read Behavior: FROM_PERSISTENCE

— Write Behavior: NOT_ALLOWED

— Additional Information: noNotification

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 451

 ENM CLI

Describe latest MO Type with partial specified attribute.

cmedit describe ManagedElement.healthCheck*

Response

This command returns a list and shows the descriptions of the specified
attributes matching a given partial attribute name. The following attribute
information is displayed:

MO Attribute

— Name: ManagedElement.healthCheckResult

— Description: The result of the latest health check.

— Namespace: RNC_NODE_MODEL

— Version: 22.5.4505

— Data Type: COMPLEX_REF

— Disturbances:

— Default Value:

— Read Behavior: FROM_PERSISTENCE

— Write Behavior: NOT_ALLOWED

— Additional Information: noNotification

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

452 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Describe latest MO Type with specified multiple attributes.

Example:

cmedit describe enodebfunction.(userlabel,enodebfunctionid)

Result:

This command lists the descriptions of the specified multiple attributes. The
following attribute information is displayed:

MO Attribute

— Name: ENodeBFunction.userLabel

— Description: Label for free use.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Data Type: STRING

— Disturbances:

— Default Value:

— Read Behavior: FROM_PERSISTENCE

— Write Behavior: PERSIST_AND_DELEGATE

— Additional Information: noNotification

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 453

 ENM CLI

Describe target specific MO Type.

Example:

cmedit describe ManagedElement --namespace=ComTop --version=10.2 →

1.0

Result:

This command lists the descriptions for one MO Type for the specified version
and namespace, with the list of all attributes specific to supported target type(s).
The following attribute information is displayed:

MO Class

— Name: ManagedElement

— Description: The top-level class in the Common Information Model is

Managed Element root Managed Object Class. From this class, all model
entities are contained. The Managed Object Class (MOC) has attributes that
provide information on the Managed Element Identity, primary location and
the products it contains.

— Namespace: ComTop

— Version: 10.21.0

— Parent MOs: MeContext, SubNetwork

— Child MOs: BorderGatewayFunction, BtsFunction, CscfFunction,

DmxcFunction, DscFunction, DuaSFunction, ENodeBFunction, EmeFunction,
Epg, Equipment, EquipmentSupportFunction, JavaCaf, JavaSip, Legacy,
MceFunction, MediaResourceFunction, Mmas, MtasFunction,
NodeBFunction, NodeSupport, PolicyControlFunction, SbgFunction,
SystemFunctions, Transport, WcgFunction, bridge, bridge-state, contexts,
contexts-state, ericsson-qos-ipos$$qos, interfaces, interfaces-state

— Ne Type:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

MO Class

— Name: ManagedElement

454 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Description: The top-level class in the Common Information Model is

Managed Element root Managed Object Class. From this class, all model
entities are contained. The Managed Object Class (MOC) has attributes that
provide information on the Managed Element Identity, primary location and
the products it contains.

— Namespace: ComTop

— Version: 10.21.0

— Parent MOs: MeContext, SubNetwork

— Child MOs: Equipment, JavaCaf, Legacy, Mmas, SystemFunctions, Transport,

bridge, bridge-state, contexts, contexts-state, ericsson-qos-ipos$$qos,
interfaces, interfaces-state

— Ne Type: Router6672, Router6675, Router6x71, Router6274, Router6273

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

Describe details of MO Action with a specific version and namespace

Example:

cmedit describe managedelement.manualRestart --namespace=ERBS_NO →

DE_MODEL --version=7.1.301

Result:

This command lists the descriptions for the specified MO action. The following
information are displayed:

MO Action

— Name: ManagedElement.manualRestart

— Description: Manual restart of the node.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Return Type:

— Disturbances: manualRestart causes loss of traffic!

1/1553-CNA 403 2979 Uen AV | 2020-12-07 455

 ENM CLI

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

MO Action Parameter

— Name: restartRank

— Description: The restart rank.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Data Type: RestartRank

— Default Value:

— Value Range: RESTART_WARM, RESTART_REFRESH, RESTART_COLD,

RESTART_COLDWTEST

— Life Cycle State: CURRENT

MO Action Parameter

— Name: restartReason

— Description: The reason for the restart.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Data Type: RestartReason

— Default Value:

— Value Range: PLANNED_RECONFIGURATION,

UNPLANNED_NODE_EXTERNAL_PROBLEMS,
UNPLANNED_NODE_UPGRADE_PROBLEMS,
UNPLANNED_O_AND_M_ISSUE, UNPLANNED_CYCLIC_RECOVERY,
UNPLANNED_LOCKED_RESOURCES,
UNPLANNED_COLD_WITH_HW_TEST,
UNPLANNED_CALL_PROCESSING_DEGRADATION,
UNPLANNED_LOW_COVERAGE, OPERATOR_CLASSIFIED_PROBLEMS,
UPGRADE_BOARD_RESTART

456 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Life Cycle State: CURRENT

MO Action Parameter

— Name: restartInfo

— Description: A free text field where extra information can be added.

— Namespace: ERBS_NODE_MODEL

— Version: G.1.301

— Data Type: STRING

— Default Value:

— Value Range:

— Life Cycle State: CURRENT

Describe the latest versions in all namespaces of the specified PO Type

Example:

cmedit describe LicenseData

Result:

This command lists the descriptions for one PO Type for the most recent version,
in all namespaces. The following attribute information is displayed:

PO Class

— Name: LicenseData

— Description: Holds LicenseData file information

— Namespace: shm

— Version: 1.0.0

— Parent MOs:

— Child MOs:

— Ne Type:

— Life Cycle State: CURRENT

1/1553-CNA 403 2979 Uen AV | 2020-12-07 457

 ENM CLI

— Dependencies:

— Precondition:

Describe latest PO Type with specified attribute.

Example:

cmedit describe LicenseData.signature

Result:

This command lists the descriptions of the specified attribute. The following
attribute information is displayed:

PO Attribute

— Name: LicenseData.signature

— Description: signature

— Namespace: shm

— Version: 1.0.0

— Data Type: STRING

— Disturbances:

— Default Value:

— Value Range:

— Read Behavior: INHERITED

— Write Behavior: INHERITED

— Additional Information:

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

— Precondition:

— Side Effects:

458 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Takes Effect:

— Unit:

— Multiplication Factor:

Describe details of MO Attribute with Life Cycle information

Example:

cmedit describe OamAccessPoint.ipv4address

Result:

This command lists the details for an MO attribute with life cycle information. The
following attribute information is displayed:

MO Attribute

— Name: OamAccessPoint.ipv4address

— Description: Refers to the IPv4 interface address to which the OAM services
shall bind.

— Namespace: RcsOamAccessPoint

— Version: 1.2.0

— Data Type: ManagedObject

— Disturbances:

— Default Value:

— Value Range:

— Read Behavior: FROM_PERSISTENCE

— Write Behavior: PERSIST_AND_DELEGATE

— Additional Information:

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 459

 ENM CLI

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

MO Attribute

— Name: OamAccessPoint.ipv4address

— Description: Refers to the IPv4 interface MO to which the OAM services shall
bind.

— Namespace: RcsSysM

— Version: 1.1.1

— Data Type: ManagedObject

— Disturbances:

— Default Value:

— Value Range:

— Read Behavior: FROM_DELEGATE

— Write Behavior: DELEGATE

— Additional Information:

— Child MOs:

— Life Cycle State: OBSOLETE

— Life Cycle Description: Deprecated since 16A. Use attribute accessPoint

instead.

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

460 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Multiplication Factor:

MO Attribute

— Name: OamAccessPoint.ipv4address

— Description: Refers to the IPv4 interface MO to which the OAM services shall
bind.

— Namespace: ComSysM

— Version: 3.2.1002

— Data Type: ManagedObject

— Disturbances:

— Default Value:

— Value Range:

— Read Behavior: FROM_DELEGATE

— Write Behavior: DELEGATE

— Additional Information:

— Child MOs:

— Life Cycle State: DEPRECATED

— Life Cycle Description: Deprecated since 16A. Use attribute accessPoint

instead.

— Dependencies:

— Precondition:

— Side Effects:

— Takes Effect:

— Unit:

— Multiplication Factor:

Note: When MOM Life Cycle State is 'CURRENT' then Life Cycle Description is not
shown.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 461

 ENM CLI

Describe latest MO Type with specified attribute.

Example:

cmedit describe GeranCell.cgi

Result:

This command lists the descriptions of the specified attribute. The following
attribute information is displayed:

MO Attribute

— Name: GeranCell.cgi

— Description: Cell global identity. The CGI must be unique, that is, cannot be
the same for another cell or generic access network. The maximum number
ofLAs in the BSC is 512. An LA is defined by values of the information units
mcc, mnc and lac specified in this attribute. Expressed as "mcc-mnc-lac-ci"
where: mcc Mobile country code, digit string 000 - 999 mnc Mobile network
code, digit string 00 - 99, 000 - 999 lac Location area code, numeral 1 -
65535 ci Cell identity, numeral 0 - 65535 Attribute can be set to no value
only by the system. Depends on RLDEC: CGI

— Namespace: BscM

— Version: 7.15.10

— Data Type: STRING

— Disturbances:

— Default Value:

— Value Range:

— Read Behavior: FROM_PERSISTENCE

— Write Behavior: PERSIST_AND_DELEGATE

— Additional Information:

— Child MOs:

— Life Cycle State: CURRENT

— Dependencies:The size of the mnc part of this attribute depends on the value
of the attribute CoreNetwork.mncDigitHand.

— Precondition:To change this attribute, attribute GeranCell.state must be set

to HALTED.

462 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— Side Effects:The change of the LA for a cell influences CS and PS cell paging
arrays.

— Takes Effect:GeranCell.state is set to ACTIVE.

— Unit:

— Multiplication Factor:

2.5.32 cmedit import

< Back To Cmedit

Syntax
The import command is described with the following EBNF grammar:

"cmedit" "import" ( RUN_IMPORT | RETRY_JOB | GET_JOB_STATUS | ST →

ATUS_WITH_TIME_SPECIFICATION | CANCEL_JOB )

RUN_IMPORT ::= FILE_NAME FILE_TYPE [ VALIDATE ] →

[ CONTINUE_ON_ERROR ]

RETRY_JOB ::= RETRY JOB [ CONTINUE_ON_ERROR ]

CANCEL_JOB ::= CANCEL JOB

GET_JOB_STATUS ::= STATUS [ JOB [ DETAIL ] ]

STATUS_WITH_TIME_SPECIFICATION ::= STATUS TIME_S →

PECIFICATION

FILE_NAME ::= "-f file:<file-name>"

FILE_TYPE ::= ( "-ft" | "--filetype" ) <file-typ →

e>

VALIDATE ::= ( "-val" | "--validate" ) <skip-val →

idation-type>

RETRY ::= ( "-rt" | "--retry" )

CANCEL ::= ( "--cancel" )

CONTINUE_ON_ERROR ::= ( "-e" | "--error" ) <cont →

inue-on-error>

STATUS ::= ( "-st" | "--status" )

JOB ::= ( "-j" | "--job" ) <job_ID>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 463

 ENM CLI

DETAIL ::= ( "-v" | "--verbose" )

TIME_SPECIFICATION ::= BEGIN [ END ] | [ BEGIN ] →

END

BEGIN ::= "--begin" <beginTime>

END ::= "--end" <endTime>

Examples
Examples can be seen in the following tutorial:

— Import configuration management data.

Context Description
— Configuration Management (CM) Editor, cmedit, is used to bulk import CM
data through the ENM Command Line Interface (CLI).

— Import task is performed by a configuration engineer. The engineers add or

modify large amounts of network data to the management system.

— The following parameters are mandatory: <file-name> and <file-type>.

— For 3GPP file-type, schema validation is performed automatically as part of

an import to ensure that the import file is well formed and compliant with the
“configData.xsd” and “genericNrm.xsd” schemas.

— Validation is performed automatically as part of an import. Validation

reduces the risk of an invalid configuration being applied to a network. If
there is a validation error, import will not attempt to apply any of the
operations, regardless of whether or not <continue-on-error> was requested
in the import command. The validation errors can be read by retrieving the
job status in verbose mode. Types of validation include model and instance.
Model Validation is implicit. Instance Validation is optional and is enabled by
default. See sections “Model Validation” and "Instance Validation" for the list
of checks performed.

— <file-type> is the format of the file being imported. The following file formats
are supported:
— 3GPP - 3GPP file format

— dynamic - Ericsson Dynamic file format

— <file-name> cannot contain spaces or quotes. It must start with a letter,

numeral or underscore. It can contain any other combination of letters,
numerals, underscores or hyphen-minus (Unicode: U+002D), and periods to
separate file extensions.

464 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— <status> will provide status of jobs created with the CM Edit Import
command or the Import end points on the CM REST NBI. Response is limited
to 10000 rows and only the most recent jobs will be displayed. Jobs created
with the Bulk Configuration UI and the CM Bulk Import to Live NBI will not
be displayed. Individual jobs and their details can be queried using the
optional <job_ID> and <verbose> parameters.

— <skip-validation-type> Offers the possibility to disable/suppress particular

phase of validation. Currently supported value(s) are 'noinstance', which
when supplied, skips instance validation phase of import.

— <retry> Allows import jobs which have passed validation but failed during
the execution phase to be retried. An import job is retried using its jobId. A
file cannot be used.There are no limits on the number of times an import job
can be retried. The default <continue-on-error> behavior for retry is the
behavior of the original import job. If a <continue-on-error> behavior
differing from the original behavior is specified when retrying the job, this is
used. The status of the retry job is queried in the same manner as an import
job. The start time of a retried job is the start time of the original import job,
the end time is the end time of the last retry for that import job and the
elapsed time is the cumulative times of the import job and all subsequent
retries. If a retry job fails, the latest failure is shown. Records of previous
failures are not kept. Cancelled import job cannot be retried.
Prerequisites for retrying a job:

— Schema validation for the file must have previously passed

— Model validation for the file must have previously passed

— Instance validation for the file must have previously passed if it is not
disabled at the time of import

— A valid jobId must exist for the import job being retried

— <cancel> Allows to abort the current execution of an import job. Import job
cancellation is supported on best effort basis which means that cancellation
of job is not always guaranteed. Import job can be cancelled at any phase
(Validation or Execution).
Prerequisites for canceling a job:

— A valid jobId must exist for the import job being cancelled

— Only Import jobs created from the ENM Command Line Interface (CLI)
can be cancelled

— Jobs whose status is completed or failed or cancelled or canceling,

cannot be cancelled

When an operator issues cancel command,

— An acknowledgement will be provided that cancel has been requested

on the job.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 465

 ENM CLI

— Operator would be guided to check the import job status to confirm the
status of cancellation.

— Querying the import job status at this moment, shows the status as
"CANCELLING".

— Operator has to poll for the job status to determine whether the job has
actually been cancelled.

— When the job has actually been cancelled, its status will be set to
"CANCELLED". In case the job could not be cancelled (since it is on best
effort basis), it goes to either COMPLETED or FAILED status.

— Cancelling an import job implies that the on-going transaction will be

rolled back and subsequent transactions (operations) will not be
executed.

— The changes that were already committed to the network from the
previous transactions of this job remain applied to the network.

— <continue-on-error> offers the possibility to continue, when errors occur

during an import, depending on the value input by the user. The following are
the supported values:
— Operation - In case of error, import will mark the operation as failed and
will continue to execute remaining operations.

— Node - In case of error, import will mark the operation as failed, skip the
remaining operations on the current node and will continue to execute
operations on subsequent nodes.

— Stop - In case of error, import will mark the operation as failed and will
skip the remaining operations.

Note: continue on error values are case insensitive.

Errors such as an incorrectly formatted import file will still cause immediate
import failure. Without this flag the default behavior is immediate import
failure on the first error encountered. The following errors are non fatal:
— Attempting to create an MO that already exists

— Attempting to delete an MO that doesn't exist

In case of errors, the actual reason for import failure can be read by
retrieving the job status in verbose mode.

Expect performance degradation when an import job experiences a large

number of operation errors.

— <beginTime> is a time filter. Results are restricted to return the jobs that were
executed after or on the provided time specification and is limited to 10000
rows with the most recent jobs being displayed.

466 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

— <endTime> is a time filter. Results are restricted to return the jobs that were
executed before or on the provided time specification and is limited to 10000
rows with the most recent jobs being displayed.

— <beginTime> and <endTime> support the following formats:

— Date and time: YYYY-MM-DDThh:mm:ss

— Date only: YYYY-MM-DD

— Time only: hh:mm:ss (The time specified is applied to the current day)

— In all cases midnight is considered '00:00:00'

— The order of all non-mandatory flags in the command are irrelevant.

— Zipped archives containing 1 import file are supported. Only the first file in
the archive will be imported, the remaining files will not be imported. The file
must be of a supported type. For 3GPP import format only xml is supported.
For Ericsson dynamic file format only txt or csv file are supported.

— Command syntax is case sensitive.

Prerequisites

— The target file being imported should exist.

— The target file must be dragged and dropped into the browser, before
starting an import.

— The target file must be ordered by managed object hierarchy. Parents must
be created before their children.

— When using 3GPP file format, target file must be adhered to 3GPP
Schemas(configData.xsd and genericNrm.xsd).

— When using dynamic file format, target file must follow Ericsson Dynamic file
format.

— The maximum size of an uncompressed import file is 150 MB for 3GPP and
50 MB for EDFF. If the file size exceeds the specified limits then split the file
into smaller files for attempting import.

Model Validation

— The following checks are performed on Managed Object Class (MOC) level:
— The MOC exists in the model

— For create or delete operations, the MOC is not system created

— For deletion of a child MOC, the relationship between parent and child is
not marked 'not deletable'

1/1553-CNA 403 2979 Uen AV | 2020-12-07 467

 ENM CLI

— The following checks are performed on attribute level for create or modify
operations:
— The attribute exists in the model (for the specified MOC)

— The attribute is read only or restricted

— The attribute is of the correct type

— For numeric and boolean data types, the attribute is within the allowed
value range or set of values

— For Union and Bits data types, the attribute is within the allowed set of
values

— For strings, the attribute is within the allowed length range

— For enumerations, the attribute has a valid value from a predefined

allowed set of values. (This can be either a string or the corresponding
integer value)

— For create operation, all the mandatory attributes are provided

— Members of complex attributes (structs and lists) are also subject to the
same checks as simple attributes (types, ranges etc.)

— The following checks are performed on Managed Object Class (MOC) level
for action operations:
— The action exists in the model

— The action has a void return type

— All mandatory arguments are provided

— Provided arguments are supported and have valid data type

— In some cases it is not possible to perform the complete set of model

validation checks on a MOC or attribute. For example, if the MOC does not
exist in the model no further checking of the MOC or its attributes is possible,
If an attribute has an incorrect data type it is not possible to check its value
range etc..

— If an attribute is not supplied with a value, Import attempts to provide a

value based on constraints and default values modeled for the respective
MOCs and can vary between attribute types. Support is currently available
for limited attribute types which includes String, enum, Boolean, Numerals
and MOC References and will be applied on Best Effort basis.

Instance Validation

Instance validation is performed to ensure that import operations are valid

against live configuration. It also checks import operation validity against
previous import operations in the import file. This validation helps in reducing the

468 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

risk of undesired updates being applied to the network. Instance validation is

done for the below operation types

— CREATE: To verify the create operation below checks are performed.

— MO is neither created earlier by the import file nor exists in live
configuration

— Any Parent MO is not deleted earlier by the import file and exists in live
configuration

— Cumulative number of MOs of same type under the Parent MO in DB and

Import file, should not exceed maximum cardinality constraint (if
applicable)

— DELETE: To verify the delete operation below checks are performed.

— MO is created earlier by the import file or exists in live configuration

— MO is not deleted earlier by the import file

— Any Parent MO is not deleted earlier by the import file.

— Cumulative number of MOs of same type under the Parent MO in DB and

Import file, should not fall below minimum cardinality constraint (if
applicable)

— UPDATE: To verify the update operation below checks are performed.

— MO is created earlier by the import file or exists in live configuration

— MO is not deleted earlier by the import file

— Any Parent MO is not deleted earlier by the import file.

— ACTION: To verify the action operation below checks are performed.

— MO is created earlier by the import file or exists in live configuration

— MO is not deleted earlier by the import file

— Any Parent MO is not deleted earlier by the import file.

Note:

Instance validation checks are not exhaustive and import execution failures are
possible.

Notes
— BSC Limitation
There is no Bulk CM import support for Managed Objects below BscM on the
BSC node.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 469

 ENM CLI

— File Format
As described above, both 3GPP and Ericsson Dynamic file formats are
supported for Import.
— 3GPP file format
• 3GPP import format is a telecommunications industry standard
format.

• The 3GPP file format in import supports only UTF-8 encoding.

— Ericsson Dynamic file format

• Ericsson dynamic file format is an Ericsson proprietary format.

• Ericsson dynamic file format in import supports only UTF-8

encoding.

• Ericsson dynamic file format is available with the Dynamic CM Value

Package license.

• Ericsson dynamic file format provides the user a way to import CM

data via csv or txt file, which are simple to create and write and can
be easily manipulated starting from an export file, which is produced
with txt extension.

• Import and export files contain nearly the same information; the
only difference is that import ones contain operations on data.

• When using cvs extension and opening the file in Excel, Excel should
be instructed to use a colon as the delimiter for each column to
ensure that attribute names and values are placed in separate
columns.

2.5.33 cmedit export

< Back To Cmedit

Syntax

Syntax to run an export

cmedit export scope --filetype <filetypeName> [f →

ilter] [options]

Syntax to get the status of an export job for a given job ID

470 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit export --status --job <jobID> [-v | --ver →

bose]

Syntax to get the status of an export job for a given job name

cmedit export --status --jobname <jobName> [-v | →

--verbose]

Syntax to get the status of all export jobs

cmedit export --status

Syntax to download an export file for a given job ID

cmedit export --download --job <jobID>

Syntax to download an export file for a given job name

cmedit export --download --jobname <jobName>

Syntax to list predefined filters

cmedit export --listfilters

Syntax to remove an export job for a given job ID

cmedit export --remove --job <jobID>

Syntax to remove an export job for a given job name

1/1553-CNA 403 2979 Uen AV | 2020-12-07 471

 ENM CLI

cmedit export --remove --jobname <jobName>

Scope
Use the following information when performing a search to specify nodes to be
included in the export file. One or many scopes can be defined. The maximum
number of individually specified items supported in the scope is 3000. Multiple
scopes should be separated with a semi-colon, for example -n
SubNetwork=SubNwk1;MeContext=ERBS03;ERBS0*.

-n <SubNetwork FDN> or --ne <SubNetwork FDN>

All nodes within the specified SubNetwork are included.

-n <Search node by FDN> or --ne <Search node by FDN>

The node that the specified FDN belongs to is included. Any FDN from the
Network Resource Data Model or ENM Data Model can be used.

-n <Node Name> or --ne <Node Name>

The node with the specified name is included.

-n <Partial Node Name>* or --ne <Partial Node Name>*

All node names starting with the specified partial node name are included, for
example -n ERBS0*.

-n *<Partial Node Name> or --ne *<Partial Node Name>

All node names ending with the specified partial node name are included, for
example -n *001.

472 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-n *<Partial Node Name>* or --ne *<Partial Node Name>*

All node names containing the specified partial node name are included, for
example -n *RBS0*.

-n * or --ne *

All nodes in the network are included.

-nt <neType> or --netype <neType>

Can be used to specify an neType, indicating all nodes of that Type to export.
Partial neType names are not supported.

One or many neTypes can be defined as scope. Multiple neTypes should be

separated with a semi-colon, for example -nt ERBS;RNC.

All spaces at the beginning or at the end of an neType name will be trimmed.
Note that the combination of neType, ne, collection and savedsearch in the scope

exports all the nodes of that neType and all the nodes specified in ne, collection
and savedsearch.

-co <Collection Name> or --collection <Collection Name>

Can be used to specify a Collection indicating nodes to export.

For each FDN in the collection, the node that the FDN belongs to is included. Any
FDN from the Network Resource Data Model or ENM Data Model can be used.

Partial Collection names are not supported.

One or many Collections can be defined as scope. Multiple Collection names

should be separated with a semi-colon, for example -co collection01;collection02.

Collection name containing space must be wrapped in quotes, for example -co
"collection 10". All spaces at the beginning or at the end of the name will be
trimmed.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 473

 ENM CLI

For more information on Collections, see Manage Collections in Network Explorer

Online Help.

-sa <Saved Search Name> or --savedsearch <Saved Search Name>

Can be used to specify a Saved Search indicating nodes to export.

For each FDN in the search result, the node that the FDN belongs to is included.
Any FDN from the Network Resource Data Model or ENM Data Model can be
used.

Partial Saved Search names are not supported.

One or many Saved Searches can be defined as scope. Multiple Saved Search
names should be separated with a semi-colon, for example -sa
savedsearch01;savedsearch02.

For more information on Saved Searches, see Manage Saved Searches in

Network Explorer Online Help.

Filters
Filtering allows you to limit the output of the export command. The filtering
formats currently supported for cmedit export are predefined filtering and user-
defined filtering. If predefined filtering or user-defined filtering is not specified, all
MO classes and persistent attributes of the nodes given in the scope are exported.

-fn or --filtername

The predefined filter is specified by providing a predefined filter name. The

cmedit export command has the option [-lf | --listfilters] to list the predefined
filters available for use.

-f file:<userDefinedFilterFileName>

The user-defined filter is specified by providing a text file which is uploaded to

the ENM CLI and referenced in the export command. The user filters the output
of the export command by specifying in the filter file the MO Class names and
attribute names to include or exclude. A user-defined filter and a predefined filter
cannot be specified together. For user-defined filter file name format and filter
file content format refer to User-Defined Filter File.

474 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

No data is exported for a node (specified in the scope) that does not contain any
instances of the MO classes specified in the filter. In the verbose response for the
export job status the node has "Export status" NOT_EXPORTED with the "Export
status message": "<FDN> not exported because there are no MOs to export."
where <FDN> is the FDN of the node.

No export file is produced if none of the nodes contain any instances of the MO
classes specified in the filter. The export job will have status: "FAILED Failed due
to no nodes to export".

Note:

Non-persistent attributes can be exported as part of a filtered export. The time

taken to export managed objects containing non-persistent attributes depends
on external factors such as network latency and node response times.Export of a
node must be completed within 5 minutes, therefore the number of managed
object instances containing non-persistent attributes must be limited. The export
of a node will fail if the read for non persistent attributes exceeds 5 minutes.

Options

Use the options to further restrict the output specification.

-ft or --filetype

The format of the file generated by the export command. The following file
formats are supported:

— 3GPP - The Bulk Configuration 3GPP allows you to configure supported

network elements. The service is described in the following document:
Configuration Management, Bulk Configuration Management IRP, XML File
Format Definition, (Rel.4) 3GPP TS 32.615 V4.5.0.
— dynamic - Ericsson dynamic file format is an Ericsson proprietary format.
Ericsson dynamic file format is available with the Dynamic CM Value
Package license. Ericsson dynamic file format provides the user with the
exported data as a txt file which is easy to read and which can be
manipulated to produce an import file. The downloaded export file contains

1/1553-CNA 403 2979 Uen AV | 2020-12-07 475

 ENM CLI

data in the same format as that obtained from cmedit get. This can be edited
within a text editor.

-dc or --datacategories

The list of export data categories which determine the data models that will be
exported. The allowed values of the list elements are:

— NETWORK_RESOURCE_DATA - Export file will include SubNetwork,

MeContext, ManagedElement, and their sub-tree data.

— ENM_DATA - Export file will include NetworkElement and its sub-tree data.
Note that password data is excluded from the export. ENM_DATA must be
specified for datacategories to export a never synced node (that is a node
without an associated ManagedElement or MeContext).

— TCIM_DATA - Export file will include Network and its sub-tree data.
TCIM_DATA is only supported for the FDN scope Network=1 and cannot be
specified with any other datacategory or scope.

TCIM ((Transport Common Information Model) Model Description document

details information on the managed objects, attributes and relationships

See TCIM Model Description document, 3/15519-CNA 403 3141. This is

available in ENM CPI Library, EN/LZN 703 0205 R95A

The following is also allowed as an argument:

— ALL - Export file will include NETWORK_RESOURCE_DATA and ENM_DATA

models in the same order. Note that the value ALL must be alone, it cannot
be specified in a list of data categories.

The order of elements in the list determines the order of the corresponding data
in the export file. However, duplicate elements are ignored. If exporting data for
multiple nodes, the output is grouped by data categories rather than by node.

By default, the dynamic format export includes Network Resource Data

(NETWORK_RESOURCE_DATA) and ENM Network Element Topology Data
(ENM_DATA), however it is possible to export just the ENM Network Element
Topology Data by using predefined filter "Dynamic_Topology".

476 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

By default, the 3GPP format export includes Network Resource Data

(NETWORK_RESOURCE_DATA) and may also include ENM Network Element
Topology Data (ENM_DATA) depending on system configuration. Contact the
System Administrator.

-st or --status

Get the status of export jobs. This option is only compatible with the --job and --
jobname options. If --job or --jobname is provided, then the status of that
specified job is returned, otherwise the status for all jobs is returned in the order
of newest jobs last.

-j or --job

The job ID of a specific job. Only compatible with the --status, --download and --
remove commands.

-jn or --jobname

When starting an export job, it is possible to optionally specify a job name. The
specified job name cannot already exist. It must start with a letter, numeral or
underscore. It can contain any other combination of letters, numerals,
underscores, or hyphens. Example: "[a-zA-Z0-9_]([a-zA-Z0-9_] | '-')*". If a job
name is specified, the generated export file is named the same as the job name.
If a job name is not supplied, then the system will generate a default file name in
the format export_<filetype>_<timestamp>_<unique_id>. The timestamp is
provided in the format "yyyy-MM-dd'T'HH-mm-ss-SSS", for example:
"2019-10-30T17-53-59-177". The unique ID is a random series of hexDigit
values in the format "<8*hexDigit>-<4*hexDigit>-<4*hexDigit>-<4*hexDigit>-
<12*hexDigit>", for example: "553a3fa1-676c-4a38-b0d7-2b3c214301c8".

-dl or --download

Download the generated file for a specified export job. It is mandatory to specify
a job using either --job or --jobname option.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 477

 ENM CLI

-lf or --listfilters

List the predefined export filters.

-rm or --remove

Remove a specified export job. This option is only compatible with the --job and
--jobname options. When an export job is removed, both the generated export
file and all job data are removed from the system.

-fc or --filecompression

The command to start an export has an optional parameter to specify the file
compression type to be used to generate the export file. The compression types
supported are 'zip', 'gzip', and 'none'. If this optional parameter is not included the
command will use zip compression by default.

-et or --enumtranslate

The command to start an export has an optional parameter to specify how enum
attribute values are translated in the export file. The parameter has two options,
'true' and 'false'. If the parameter is set to 'true', enum attribute values are
translated as string literals for the export job. If the parameter is set to 'false',
enum attribute values are translated as integers for the export job. If the
parameter is not included, the default behavior configured by the system
administrator is used.

-ss or --syncstate

The command to start an export has an optional parameter to specify CM

synchronization state for nodes to be included in the export file. The parameter
has two options, 'sync' and 'all'. If the parameter is set to 'sync', only synchronized
nodes will be exported. Non-synchronized nodes will be added to the 'Nodes not
exported' count in the export status response. The verbose export status
response will show the non-synchronized nodes as not exported with the reason
given. If the parameter is set to 'all', nodes with any synchronization state will be

478 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

included in the export file. If the parameter is not included, the default behavior
configured by the system administrator is used.

Note:

— By default for 3GPP export, CM supervision disabled nodes will not be

exported. If NetworkElement MO of the node(s) is linked with MeContext MO
using ossPrefix, then the nodes will be exported with only MeContext MO.

— By default for EDFF export, CM supervision disabled nodes will be exported.

Export of MeContext Mo will also be done for such nodes if NetworkElement
MO of the node(s) is linked with MeContext MO using ossPrefix.

-pf or --prettyformat

The command to start an export has an optional parameter to enable or disable

pretty formatting of the export file. Pretty formatting generates export files with
line feeds, and indentations (white spaces). This parameter applies only to 3GPP
export files. For dynamic export files, this parameter does not apply and will be
ignored. The parameter has two options, 'true' and 'false'. If the parameter is set
to 'true', the export file will be formatted. If the parameter is set to 'false', the
export file will not be formatted. If the parameter is not included, the default
behavior configured by the system administrator is used.

-v or --verbose

When you get the status of a specific job you may get additional information
about that job using verbose. Lists each of the operations which were attempted
on the specified export job. If this option is specified for a job which is still
running, no extra detail is included in the output.

Only compatible with use of --status --job <jobID> or --status --jobname

<jobName>.

Description

Configuration Management (CM) Editor export, or cmedit export command, can

be used to initiate an export of node data from the network through the ENM
Command Line Interface (CLI).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 479

 ENM CLI

— The export command is asynchronous. This means that when the export job
starts, the system responds with the job name and job ID. Either the job
name or ID can be used for future interaction with the job (such as querying
the status of the job or removing the job).

— The command supports the starting of an export job, querying the status of
an export job, downloading the export file for a completed job, listing the
available filters and removing completed jobs.

— Supported filetype(s): "3GPP" and "dynamic".

Command Consequences

— With --ne, --collection or --savedsearch an export job is started, and a job ID

is displayed in the CLI

— With --status a summary of the export job is displayed in the CLI

— With --download an export file is downloaded to the client browser

— With --listfilters a list of export filters is displayed in the CLI

— With --remove an export job and its export file are removed from the system

Examples

Start an export job for a specific node in the 3GPP format

cmedit export --ne ERBS001 --filetype 3GPP

Response

Export job <jobName> started with job ID <jobID>

Start an export job for a specific NetworkElement type in the 3GPP format

cmedit export --netype ERBS --filetype 3GPP

Response

Export job <jobName> started with job ID <jobID>

Start an export job for a specific collection in the dynamic format

cmedit export --collection mycollection --filetype dynamic

480 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Response

Export job <jobName> started with job ID <jobID>

Start an export job for a specific savedsearch in the dynamic format

cmedit export --savedsearch mysavedsearch --filetype dynamic

Response

Export job <jobName> started with job ID <jobID>

Start an export job using a predefined filter

cmedit export --ne ERBS001 --filetype 3GPP --filtername Inventor →

yData

Response

Export job <jobName> started with job ID <jobID>

Start an export job using a user-defined filter

cmedit export --ne ERBS001 --filetype 3GPP -f file:UserDefinedFi →

lter.txt

Response

Export job <jobName> started with job ID <jobID>

Start an export job with a given job name

cmedit export --ne ERBS001 --filetype 3GPP --jobname ExportJobNa →

me

Response

Export job <jobName> started with job ID <jobID>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 481

 ENM CLI

Start an export job with gzip file compression

cmedit export --ne ERBS001 --filetype 3GPP --filecompression gzi →

p

Response

Export job <jobName> started with job ID <jobID>

Start an export job with enum attribute values translated as integers

cmedit export --ne ERBS001 --filetype 3GPP --enumtranslate false

Response

Export job <jobName> started with job ID <jobID>

Start an export job which exports only synchronized nodes

cmedit export --ne ERBS001 --filetype 3GPP --syncstate sync

Response

Export job <jobName> started with job ID <jobID>

Start an export job which exports only data from the Network Element model
(including never synchronized nodes)

cmedit export --ne ERBS001;NetworkElement=ERBS002 --filetype 3GP →

P --datacategories ENM_DATA --syncstate all

Response

Export job <jobName> started with job ID <jobID>

Start an export job which exports data from both models in a specified order.

482 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit export --ne ERBS001 --filetype dynamic --datacategories E →

NM_DATA;NETWORK_RESOURCE_DATA

Response

Export job <jobName> started with job ID <jobID>

Start an export job which exports TCIM data.

cmedit export --ne Network=1 --filetype 3GPP --datacategories TC →

IM_DATA

Response

Export job <jobName> started with job ID <jobID>

Start an export job with pretty formatting enabled.

cmedit export --ne ERBS001 --filetype 3GPP --prettyformat true

Response

Export job <jobName> started with job ID <jobID>

Get the status of a specific export job with a job ID

cmedit export --status --job 3

Response

The command returns the status of the export job with ID 3

Get the status of a specific export job with a job name

cmedit export --status --jobname ExportJobName

Response

The command returns the status of the export job with name ExportJobName

1/1553-CNA 403 2979 Uen AV | 2020-12-07 483

 ENM CLI

Get the status of all stored export jobs

cmedit export --status

Response

The command returns a list of statuses for all export jobs

Download a specific export job export file

cmedit export --download --job 3

Response

The export file for export job 3 is downloaded to the client browser.

Show a list of the predefined filters which can be used with an export
command

cmedit export --listfilters

Response

The command returns a list of export filters.

Filter name Filter description

3GPP_Topology This is the predefined export filter model for Network
Resource Topology Data.
Dynamic_Topology This filter exports ENM Network Element Topology
Data.
ERBS This is the predefined export filter model for ERBS
nodes.
InventoryData This is the predefined export filter model for CPP
based nodes Inventory Data.
LTE_MPC_OTDOA This is the predefined export filter model for filtering
MOs for LTE MPC OTDOA.
SON This is the predefined export filter model for ERBS
nodes SON Data.
SON_EDNET This is the predefined export filter model for ERBS
nodes SON EDNET Data.

484 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Filter name Filter description

Subnetwork This is the predefined export filter model for filtering
MOs under Subnetwork for ERBS nodes.

Remove a specific export job

cmedit export --remove --job 3

Response

Export job was successfully removed.

2.6 collection
< Back To Command Sets

Content

List of Commands

Notes

Summary of Error Codes and Messages

Commands

Get

List

Create

Modify

Delete

Notes
The collection command set can be used to read Collection data. Creation,
modification and deletion of collection is also supported.

— The collection commands are subject to access control.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 485

 ENM CLI

— The collection 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 collection service

The table below lists all possible collection error codes for the CM collection
service and possible solutions or actions to remedy them.

Error code Error message* Solution/Action required

21001 Syntax Error : Unknown command See the help page {1}
'{0}'
21002 Syntax Error : {0} See the help page {1}**
21003 System Error : Unsupported See log files for more details
Operation
21010 Authentication Error : The user Contact administrator
does not have permission to
perform this command
21100 System Error : Database or Try again later
Collection Service unavailable
21101 System Error : {0} See log files for more details
21200 Access Denied: Specified Enter command “collection list” to
Collection {0} does not exist or you view a list of available collections.
have insufficient access rights.
21201 Execution Error: Collection name Enter command “collection list” to
already exists view a list of available collections.
21202 Execution Error: Collection name See the help page collection
cannot match a managed object create command
name
21203 Execution Error: The collection has Remove unwanted objects and try
reached its limit of {0} Objects. again
21999 System Error : Unexpected See log files for more details
Exception

* {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.

** The suggested solution is only proposed if necessary.

2.6.1 collection get

< Back To Collecton

Syntax

Syntax to get the contents of a collection available to the current user

486 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

collection get <collection_name>

Description
collection get <collection_name> is used to display the contents of a collection.

You can view your own private collections and all public collections.

If a collection name contains spaces, the name should be wrapped in quotes.

Examples

Display the contents of a collection visible to the current user

collection get my_collection

Response

This command returns all the FDN(s) contained in the provided collection

FDN : MeContext=ERBS001

FDN : MeContext=ERBS002

2 instance(s)

Display the contents of a collection with spaces in the collection name.

collection get "my collection with spaces"

Response

This command returns all the FDN(s) contained in the provided collection

FDN : MeContext=ERBS001

1/1553-CNA 403 2979 Uen AV | 2020-12-07 487

 ENM CLI

FDN : MeContext=ERBS002

2 instance(s)

2.6.2 collection list

< Back To Collecton

Syntax

Syntax to list all collections available to the current user

collection list [CollectionName] [options]

CollectionName
CollectionName is optional and can only be used directly after 'collection list'.

<CollectionName>

Returns Collection named <CollectionName>.

*<CollectionName>

Returns collections ending in "CollectionName".

<CollectionName>*

Returns collections starting with "CollectionName".

*<CollectionName>*

Returns collection with names containing the word "CollectionName".

Note:

488 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

CollectionName supports alphanumeric characters (A-Z, a-z and 0-9) and certain
"special" characters.

The supported "special" characters are:

. - _ <space>

If CollectionName includes a special character, then it must be contained in

double quotes.

Options

-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 issues.

-pu or --public

Returns all public collections only.

-pr or --private

Returns user private collections only.

Note:The public and private options are mutually exclusive.

Description
collection list is used to display details of all collections visible to the current user.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 489

 ENM CLI

Examples

List all the collections available to the current user

collection list

Response

In this case there are two collections 'my_collection1' and 'my_collection2':

Name : my_collection1

Created By : cmedit_administrator_user

Date Created : 21-February-2017

Sharing Permission : Public

Name : my_collection2

Created By : cmedit_administrator_user

Date Created : 21-February-2017

Sharing Permission : Public

2 instance(s)

2.6.3 collection create

< Back To Collection

Syntax

490 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Syntax to create a new collection available to the current user

collection create <collection_name> [-f file:<file_name.txt>] [- →

pu | --public]

Description
collection create <collection_name> is used to create a new collection.

If no file is specified then an empty collection named <collection_name> is

created.

In case a file is specified then new collection is created containing the list of valid
FDNs or node names.

Default sharing permission for new collection is "private" (no option specified),
instead to create a new "public" collection the option -pu or --public is required.

Note 1:

Collection name supports only alphanumeric characters (A-Z, a-z and 0-9) and
certain "special" characters.

The supported "special" characters are:

. - _ <space>

If collection name includes a special character, then it must be contained in

double quotes.

Note 2:

Example of file containing a list of valid FDNs

1/1553-CNA 403 2979 Uen AV | 2020-12-07 491

 ENM CLI

SubNetwork=ERBS-SUBNW-1,MeContext=LTE36ERBS00093
SubNetwork=ERBS-SUBNW-1,MeContext=LTE36ERBS00064

Examples

Create a new private empty collection only visible to the current user

collection create mycollection

Response

This command returns created empty collection

Collection : mycollection

Total(0) Added(0) Failed(0)

Create a new public collection from file, input file containing a list of valid
FDN’s or Node names.

collection create mycollection -f file:"collection_inputfile.txt →

" --public

Response

This command returns created collection, number of valid FDN’s or Node names
is displayed

Collection : mycollection

Total(3) Added(3) Failed(0)

Create a new public collection from file, input file containing also some invalid
or non-existing FDN’s or Node names.

492 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

collection create mycollection -f file:"collection_inputfile.txt →

" --public

Response

The collection is created even if some objects cannot be added, list of failed
objects is displayed

Failed Objects

Name Reason

LTE11ERBS00040 Duplicated object

LTE99ERBS99999 Object not found

Total(5) Added(3) Failed(2)

Collection : mycollection

The collection mycollection has been created but some objects co →

uld not be added. Please check object names and try again.

2.6.4 collection modify

< Back To Collection

Syntax

Syntax to modify an existing collection

collection modify <collection_name> -f file:<file_name.txt> [-r →

| --replace]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 493

 ENM CLI

Description
collection modify <collection_name> is used to modify an existing collection.

By default the FDNs and Node names will be added to the existing collection.

Any objects that are specified in the file and already exist in the collection will be
ignored.

If the --replace option is used then only the name of the collection is retained and
the contents is completely replaced by the contents of the file.

Note:

Collection name supports only alphanumeric characters (A-Z, a-z and 0-9) and
certain "special" characters.

The supported "special" characters are:

. - _ <space>

If Collection name includes a special character, then it must be contained in

double quotes.

Examples

Modify an existing collection, input file containing a list of valid FDNs or Node
names.

collection modify mycollection -f file:"collection_inputfile.txt →

"

Response

The existing collection is modified and the number of valid FDNs or Node names
added are displayed

494 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Collection : mycollection

Total(3) Added(3) Failed(0)

Modify an existing collection, input file containing a list of valid FDN’s or Node
names, previous collection content is completely replaced by the contents of the
file

collection modify mycollection -f file:"collection_inputfile.txt →

" --replace

Response The existing collection is modified, previous collection content is

completely replaced by the contents of the file

Collection : mycollection

Total(4) Added(4) Failed(0)

2.6.5 collection delete

< Back To Collection

Syntax

Syntax to delete an existing collection

collection delete <collection_name>

Description
collection delete <collection_name> is used to delete an existing collection.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 495

 ENM CLI

Note:

Collection name only supports alphanumeric characters (A-Z, a-z and 0-9) and
certain "special" characters.

The supported "special" characters are:

. - _ <space>

Examples

Delete an existing collection.

collection delete mycollection

Response

The existing collection is deleted

1 instance(s) deleted

2.7 config
< Back To Command Sets

Content
List of Tutorials

List of Commands

Notes

Summary of Error Codes and Messages

496 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Tutorials

View Configuration History

Undo Configuration

Commands

History

Undo

Notes
The live configuration is the database representing the Live network
configuration in ENM. This is automatically created by ENM and cannot be
deleted by a user.

Configuration Handling enables the user to perform the following:

— Display the history of CM data changes made to one or more network
elements in the live configuration made by CM Bulk Import operations.

— Undo the changes performed on nodes by CM Bulk Import operations.

Summary of user codes and messages for CM Config service

The table below lists all possible config error codes for the CM config service and
possible solutions or actions to remedy them.

Error code Error message* Solution/Action required

9000 CM Config internal error Request Ericsson product support.
9004 Invalid scope Specify a valid scope. Check online
help for correct syntax.
9005 Invalid search criteria Specify a valid search criteria.
Check online help for correct
syntax.
9009 Invalid job ID: {0} Specify a valid job ID.
9010 Insufficient permissions to run If the operation is required to be
command performed by the current user, the
user profile must be updated by
the system administrator.
9016 {0} is not supported Refer to usage instructions for {1}.
9018 Command syntax error, parameter Refer to usage instructions for {2}.
{0} is not allowed with {1}.
9021 Failed to read configuration Contact the system administrator.
management history.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 497

 ENM CLI

9022 Command syntax error, parameter Refer to usage instructions for {2}.
{0}, invalid value {1}.
9023 Can not delete active job. Specify a job which has finished.
9024 Undo file not found. Create a new undo job.
9026 Invalid job state for download Wait for job to complete for
operation. running jobs, retry undo job for
failed jobs.
9027 License FAT1023443 for dynamic Contact the system administrator
undo import type is invalid. to activate the appropriate license.
9030 Invalid Command Syntax. Please specify a valid command.
9031 The specified collection is not Please specify a collection that
valid. contains at least one Network
Element, SubNetwork or Node
Root.
9032 Collection service unavailable. Please try again later or contact
your System Administrator.
9033 The collection does not exist. Please specify a different
collection. Use command
“collection list” for a list of the
available collections you have
access to.
9034 UNAUTHORIZED : User {1} Ensure you have access
cannot access nodes : {2}. permissions to all nodes to be
activated.
9035 The access control service is Please try again later.
unavailable.
9036 Only Live Configuration is Refer to usage instructions for {0}.
supported for Config History.

* {0},{1},{2} indicates variable parts of the message which will be substituted by

relevant information from the request like job ID, attribute name, and so on.

2.7.1 config history

< Back To Config

— View the History of Changes to the Live Configuration.

— View the History of Changes to the Live Configuration Made by a Specific

Import.

2.7.2 config undo

< Back To Config

— Undo changes executed towards the live configuration via CM Bulk Import

— Remove an Undo Job

498 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.7.3 Tutorial: Config job with L3VPN example

< Back To Config

Creating a configuration job for dependent Managed Objects

YANG models are mapped to ENM Managed Objects as described in Working
with YANG In the following tutorial we refer to managed object classes derived
from YANG models as "YANG MO". In some cases the target network element
requires ENM to create or delete multiple MOs in one transaction. This is achieved
in ENM CLI using CM configurations. Any attempt to create theses MOs
separately in the live bucket will be rejected by Network Element.

Note:

Network elements that do not commit the current configuration automatically to

persistent memory provide a distinct startup datastore as a part of Distinct
Startup Capability (RFC 6241). This is the case for network elements using the
Ericsson IP operating system (IPOS) such as Router 6672. For Router 6672, ENM
will schedule a periodic copy of the running configuration to the startup datastore
to ensure that the device configuration is not lost in case of power loss or restart.
Copy-config operation is the equivalent of a periodic execution of the "save
configuration" command on an IPOS device, such as a Router 6672. If the
operator requires the configuration of the IPOS device to be saved to non-volatile
memory immediately, and does not wish to wait for the automatic copy-config
operation, the Node CLI application can be used to connect to the IPOS CLI and
issue the "save configuration" command manually. More information about Node
CLI can be found under Node CLI Help. Refer to the Router 6672 System
Administrator Guide for a complete desciption of the Router 6672 configuration
management commands.

Steps to create configuration job

First create configuration for nonlive bucket.

config create [configuration name]

Copy live bucket configuration into it.

config copy --ne [source configuration] --source Live --target [ →

configuration name]

As there can be delay in the copy action, existance of MOs is verified with get
commands.

cmedit get [MO FDN]

Every command is followed by attribute --config=[configuration name]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 499

 ENM CLI

The following command will trigger mediation of the created MOs to the network
element through a Netconf RPC.

config activate -s [configuration name]

Delete the configuration.

config delete [configuration name]

Examples

Sample L3VPN configuration applicable to Router6672 16A GA

This configuration example makes use of IPOS-specific concepts such as

Contexts, interface etc. Please refer to Router 6672 16A GA CPI for detailed
description.

Configure ProviderEdge in a L3VPN service creation.

config create myConfig

config copy --ne r2_65 --source Live --target myConfig

cmedit get MeContext=r2_65,ManagedElement=1

cmedit get MeContext=r2_65,ManagedElement=1,contexts=1

cmedit get MeContext=r2_65,ManagedElement=1,interfaces=1

1) Configure Loopback Interface and IP address under context local.

cmedit create MeContext=r2_65,ManagedElement=1,interfaces=1,inte →

rfaces$$interface=1 name="loop65@local";type="softwareLoopback" →
-ns="urn:ietf:params:xml:ns:yang:ietf-interfaces" -v=2014.5.8 -- →
config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=loop65@local",l3-interface=1 l3-interface-key=1;context=l →
ocal -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfaces-ext →
-ipos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=loop65@local,l3-interface=1",ip=1 ip-key=1 -ns="urn:rdns: →

500 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

com:ericsson:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12.7 →
--config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=loop65@local,l3-interface=1,ip=1",ip$$address=1 address-k →
ey=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfaces-ext →
-ipos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=loop65@local,l3-interface=1,ip=1,address=1",addr-primary= →
1 addr-primary-key=1;addr="2.2.2.2/32" -ns="urn:rdns:com:ericsso →
n:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12.7 --config=m →
yConfig

2) Configure IP Forwarding Interface and IP address under context local.

cmedit create MeContext=r2_65,ManagedElement=1,interfaces=1,inte →

rfaces$$interface=1 name="toR3@local";type="ipForward" -ns="urn: →
ietf:params:xml:ns:yang:ietf-interfaces" -v=2014.5.8 --config=my →
Config

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR3@local",l3-interface=1 l3-interface-key=1;context=loc →
al -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfaces-ext-i →
pos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR3@local,l3-interface=1",ip=1 ip-key=1 -ns="urn:rdns:co →
m:ericsson:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12.7 - →
-config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR3@local,l3-interface=1,ip=1",ip$$address=1 address-key →
=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfaces-ext-i →
pos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR3@local,l3-interface=1,ip=1,address=1",addr-primary=1 →
addr-primary-key=1;addr="10.1.23.2/24" -ns="urn:rdns:com:ericsso →
n:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12.7 --config=m →
yConfig

3) Configure local context.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 501

 ENM CLI

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1 router-key=1 -ns="urn:rdns:com:ericsson:oammode →
l:ericsson-isis-ipos" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,router$$isis=1 isis=BACKBONE;net="47.0001.2222. →
2222.2222.00";traffic-engineering="level-1-2" -ns="urn:rdns:com: →
ericsson:oammodel:ericsson-isis-ipos" -v=2015.12.7 --config=myCo →
nfig

3.1) Configure IS-IS protocol for the L3VPN service.

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,is=1 is-key=1;type="level-1" -ns= →
"urn:rdns:com:ericsson:oammodel:ericsson-isis-ipos" -v=2015.12.7 →
--config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,interface=1 interface="loop65@loc →
al" -ns="urn:rdns:com:ericsson:oammodel:ericsson-isis-ipos" -v=2 →
015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,interface=1 interface="toR3@local →
" -ns="urn:rdns:com:ericsson:oammodel:ericsson-isis-ipos" -v=201 →
5.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,isis$$address-family=1 address-fa →
mily-key=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-isis-ipo →
s" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,address-family=1,isis$$address-fa →
mily$$ipv4=1 ipv4-key=1 -ns="urn:rdns:com:ericsson:oammodel:eric →
sson-isis-ipos" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,isis=BACKBONE,address-family=1,ipv4=1,isis$$add →
ress-family$$ipv4$$unicast=1 unicast-key=1 -ns="urn:rdns:com:eri →
csson:oammodel:ericsson-isis-ipos" -v=2015.12.7 --config=myConfi →
g

3.2) Configure LDP protocol.

502 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,ldp=1 ldp-key=1;router-id="2.2.2.2" -ns="urn:rd →
ns:com:ericsson:oammodel:ericsson-ldp-ipos" -v=2015.12.7 --confi →
g=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,ldp=1,interfaces=1 interfaces-key=1;interface=[ →
"loop65@local","toR3@local"] -ns="urn:rdns:com:ericsson:oammodel →
:ericsson-ldp-ipos" -v=2015.12.7 --config=myConfig

3.3) Configure MPLS protocol

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,mpls=1 mpls-key=1 -ns="urn:rdns:com:ericsson:oa →
mmodel:ericsson-mpls-ipos" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,mpls=1,mpls$$interface=1 interface="loop65@loca →
l" -ns="urn:rdns:com:ericsson:oammodel:ericsson-mpls-ipos" -v=20 →
15.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,mpls=1,mpls$$interface=1 interface="toR3@local" →
-ns="urn:rdns:com:ericsson:oammodel:ericsson-mpls-ipos" -v=2015 →
.12.7 --config=myConfig

3.4) Configure BGP protocol.

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,bgp=65001 bgp=65001;router-id="2.2.2.2" -ns="ur →
n:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --c →
onfig=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=local,router=1,bgp=65001,neighbor=1 neighbor-choice="3.3.3.3"; →
neighbor-choice1=internal;next-hop-self=true -ns="urn:rdns:com:e →
ricsson:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --config=myConf →
ig

cmedit create "MeContext=r2_65,ManagedElement=1,contexts=1,conte →

xt=local,router=1,bgp=65001,neighbor=3.3.3.3%%internal",neighbor →
$$update-source=1 update-source-key=1;interface="loop65@local" - →
ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2. →
29 --config=myConfig

1/1553-CNA 403 2979 Uen AV | 2020-12-07 503

 ENM CLI

cmedit create "MeContext=r2_65,ManagedElement=1,contexts=1,conte →

xt=local,router=1,bgp=65001,neighbor=3.3.3.3%%internal",neighbor →
$$address-family=1 address-family-key=1 -ns="urn:rdns:com:ericss →
on:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,contexts=1,conte →

xt=local,router=1,bgp=65001,neighbor=3.3.3.3%%internal,address-f →
amily=1",neighbor$$address-family$$ipv4=1 ipv4-key=1 -ns="urn:rd →
ns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --confi →
g=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,contexts=1,conte →

xt=local,router=1,bgp=65001,neighbor=3.3.3.3%%internal,address-f →
amily=1,ipv4=1",neighbor$$address-family$$ipv4$$vpn=1 vpn-key=1 →
-ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2 →
.29 --config=myConfig

4) Configure VPN context

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01 context-name=MBH_VPN01;vpn-rd="2.2.2.2:22" -ns="urn: →
rdns:com:ericsson:oammodel:ericsson-context-ipos" -v=2015.12.7 - →
-config=myConfig

4.1) Configure IP Forwarding interface and ip address under context

MBH_VPN01

cmedit create MeContext=r2_65,ManagedElement=1,interfaces=1,inte →

rfaces$$interface=1 name="toR1@MBH_VPN01";type="ipForward" -ns=" →
urn:ietf:params:xml:ns:yang:ietf-interfaces" -v=2014.5.8 --confi →
g=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR1@MBH_VPN01",l3-interface=1 l3-interface-key=1;context →
=MBH_VPN01 -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfac →
es-ext-ipos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR1@MBH_VPN01,l3-interface=1",ip=1 ip-key=1 -ns="urn:rdn →
s:com:ericsson:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12 →
.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR1@MBH_VPN01,l3-interface=1,ip=1",ip$$address=1 address →

504 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-key=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-interfaces-e →
xt-ipos" -v=2015.12.7 --config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=toR1@MBH_VPN01,l3-interface=1,ip=1,address=1",addr-primar →
y=1 addr-primary-key=1;addr="10.1.12.2/24" -ns="urn:rdns:com:eri →
csson:oammodel:ericsson-interfaces-ext-ipos" -v=2015.12.7 --conf →
ig=myConfig

4.2) Configure OSPF protocol under context MBH_VPN01

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1 router-key=1 -ns="urn:rdns:com:ericsson:oam →
model:ericsson-context-ipos" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,router$$ospf=1 ospf=1;router-id="2.2.2.2" - →
ns="urn:rdns:com:ericsson:oammodel:ericsson-ospf-ipos" -v=2015.1 →
2.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,ospf=1,area="0.0.0.0" area="0.0.0.0" -ns="u →
rn:rdns:com:ericsson:oammodel:ericsson-ospf-ipos" -v=2015.12.7 - →
-config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,contexts=1,conte →

xt=MBH_VPN01,router=1,ospf=1,area=0.0.0.0",interface=1 interface →
="toR1@MBH_VPN01" -ns="urn:rdns:com:ericsson:oammodel:ericsson-o →
spf-ipos" -v=2015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,ospf=1,ospf$$redistribute=1 redistribute-ke →
y=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-ospf-ipos" -v=2 →
015.12.7 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,ospf=1,redistribute=1,bgp=65001 bgp=65001;t →
ag=10 -ns="urn:rdns:com:ericsson:oammodel:ericsson-ospf-ipos" -v →
=2015.12.7 --config=myConfig

4.3) Configure BGP protocol under context MBH_VPN01

1/1553-CNA 403 2979 Uen AV | 2020-12-07 505

 ENM CLI

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn bgp=vpn -ns="urn:rdns:com:ericsson: →
oammodel:ericsson-bgp-ipos" -v=2016.2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,bgp$$address-family=1 address-famil →
y-key=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" - →
v=2016.2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,bgp$$address-famil →
y$$ipv4=1 ipv4-key=1 -ns="urn:rdns:com:ericsson:oammodel:ericsso →
n-bgp-ipos" -v=2016.2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,bgp$$addres →
s-family$$ipv4$$unicast=1 unicast-key=1 -ns="urn:rdns:com:ericss →
on:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,unicast=1,i →
pv4$$unicast$$export=1 export-key=1;route-target=["2.2.2.2:200"] →
-ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016. →
2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,unicast=1,i →
pv4$$unicast$$import=1 import-key=1;route-target=["3.3.3.3:300"] →
-ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016. →
2.29 --config=myConfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,unicast=1,i →
pv4$$unicast$$redistribute=1 redistribute-key=1 -ns="urn:rdns:co →
m:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2.29 --config=myC →
onfig

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,unicast=1,r →
edistribute=1,ipv4$$unicast$$redistribute$$connected=1 connected →
-key=1 -ns="urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v →
=2016.2.29 --config=myConfig

506 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

cmedit create MeContext=r2_65,ManagedElement=1,contexts=1,contex →

t=MBH_VPN01,router=1,bgp=vpn,address-family=1,ipv4=1,unicast=1,r →
edistribute=1,ipv4$$unicast$$redistribute$$ospf=1 ospf-id=1 -ns= →
"urn:rdns:com:ericsson:oammodel:ericsson-bgp-ipos" -v=2016.2.29 →
--config=myConfig

5)Configure physical ethernet interface 1/1 and binding it to interface

toR1@MBH_VPN01

cmedit create MeContext=r2_65,ManagedElement=1,interfaces=1,inte →

rfaces$$interface=1 name="1/1";type="ethernetCsmacd";enabled=fal →
se -ns="urn:ietf:params:xml:ns:yang:ietf-interfaces" -v=2014.5.8 →
--config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=1/1",ethernet=1 ethernet-key=1 -ns="urn:rdns:com:ericsson →
:oammodel:ericsson-ethernet-ext-ipos" -v=2015.12.7 --config=myCo →
nfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=1/1,ethernet=1",bind-interface=1 bind-interface-key=1;int →
f-name="toR1@MBH_VPN01";intf-ctx=MBH_VPN01 -ns="urn:rdns:com:eri →
csson:oammodel:ericsson-ethernet-ext-ipos" -v=2015.12.7 --config →
=myConfig

6)Configure physical ethernet interface 1/2 and binding it to interface

toR3@local

cmedit create MeContext=r2_65,ManagedElement=1,interfaces=1,inte →

rfaces$$interface=1 name="1/2";type="ethernetCsmacd";enabled=fal →
se -ns="urn:ietf:params:xml:ns:yang:ietf-interfaces" -v=2014.5.8 →
--config=myConfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=1/2",ethernet=1 ethernet-key=1 -ns="urn:rdns:com:ericsson →
:oammodel:ericsson-ethernet-ext-ipos" -v=2015.12.7 --config=myCo →
nfig

cmedit create "MeContext=r2_65,ManagedElement=1,interfaces=1,int →

erface=1/2,ethernet=1",bind-interface=1 bind-interface-key=1;int →
f-name="toR3@local";intf-ctx=local -ns="urn:rdns:com:ericsson:oa →
mmodel:ericsson-ethernet-ext-ipos" -v=2015.12.7 --config=myConfi →
g

config activate -s myConfig

1/1553-CNA 403 2979 Uen AV | 2020-12-07 507

 ENM CLI

config delete myConfig

2.7.4 View the History of Changes to the Live Configuration

Prerequisites

— Changes have been made to the live configuration.

This tutorial describes the steps to view the history of changes to the live
configuration.

Changes made by Bulk CM Import towards the Live configuration will be

displayed.

The number of rows will be limited and only the most recent rows will be
displayed. It is recommended to save the response to a file.

If a change was attempted to an attribute which already had the same value,
that change would not have been applied to the live configuration. Therefore that
change will not be displayed.

Actions are not supported for history of Live.

Steps

1. View the changes to the live configuration

config history

The command returns the changes (if any) made to the live configuration as
in the following example:

Configuration history

Node name Change type FDN Time User name Additional

information

ERBS1 MIB root MeContext=E 2015-08-23T1 enmUser Application:Ac

created RBS1 2:03:30 tivate,JobID:1
3,Configuratio
n:reduceCellPo
wer

ERBS1 Attribute MeContext=E 2015-08-23T1 enmUser Application:Ac

modification RBS1 2:03:30 tivate,JobID:1
3,Configuratio

508 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Node name Change type FDN Time User name Additional

information
n:reduceCellPo
wer

LTE02ERBS0 MO created MeContext= 2016-09-28 enmUser Applicatio

0004 LTE02ERBS0 T19:16:46 n:Import,J
0004,Manag obID:1
edElement=
1,ENodeBFu
nction=1,E
UtranCellT
DD=LTE02ER
BS00004-1

3 change(s)

2. Use the verbose option to get more detail

config history --verbose

Configuration history

Node Change FDN Time User Additional Supplied Original

name type name informatio argument attributes
n s

ERBS1 MIB root MeContex 2015-08- enmUser Applicatio {MeConte {}

created t=ERBS1 23T12:03: n:Activate xtId=ERB
30 ,JobID:13, S1,
Configura platformT
tion:reduc ype=CPP,
eCellPowe neType=E
r RBS}

ERBS1 Attribute MeContex 2015-08- enmUser Applicatio {userLabe {userLabe

modificati t=ERBS1 23T12:03: n:Activate l=newLab l=oldLabel
on 30 ,JobID:13, elValue} Value}
Configura
tion:reduc
eCellPowe
r

{physicalL {}
LTE02E MO cre MeCont 2016-0 enmUse Applic
ayerSubC
RBS000 ated ext=LT 9-28T1 r ation:
ellId=2,eU
04 E02ERB 9:16:4 Import
tranCellF
S00004 6 ,JobID
DDId=test
,Manag :1
cell5,earfc
edElem

1/1553-CNA 403 2979 Uen AV | 2020-12-07 509

 ENM CLI

Node Change FDN Time User Additional Supplied Original

name type name informatio argument attributes
n s
ent=1, nul=1800
ENodeB 1,cellId=9
Functi 7,physical
on=1,E LayerCellI
UtranC dGroup=1,
ellTDD tac=1,earf
=LTE02 cndl=1}
ERBS00
004-1

3 change(s)

Results
Result 1: Where the amount of changes to the live configuration is 35,000 or less
all changes are returned.

Result 2: Where the amount of changes to the live configuration is 35,000 or

more the most recent 35,000 changes are returned.

2.7.5 View the History of Changes to the Live Configuration made by a Specific
Import

Prerequisites

— Changes have been made to the live configuration via import to live

This tutorial describes the steps to view the history of changes to the live
configuration made by a specific import.

If a change was attempted to an attribute which already had the same value,
that change would not have been applied to the live configuration. Therefore that
change will not be displayed.

Actions are not supported for history of Live.

Steps

1. View the changes to the live configuration

config history --importjob 15

510 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

The command returns the changes (if any) made to the live configuration by
the Bulk CM import job with job ID 15 as in the following example:

Configuration history

Node name Change type FDN Time User name Additional

information

ERBS2 MIB root c MeContext= 2016-08-10 enmUser Applicatio

reated ERBS2 T12:03:30 n:Import,J
obID:15

ERBS2 Attribute MeContext= 2016-08-10 enmUser Applicatio

modificati ERBS2 T12:03:30 n:Import,J
on obID:15

2 change(s)

2. Use the verbose option to get more detail

config history --importjob 15 --verbose

Configuration history

Node Change FDN Time User Additional Supplied Original

name type name informatio argument attributes
n s

ERBS2 MIB ro MeCont 2016-0 enmUse Applic {MeCon {}

ot cre ext=ER 8-10T1 r ation: textId
ated BS2 2:03:3 Import =ERBS2
0 ,JobID , plat
:15 formTy
pe=CPP
, neTy
pe=ERB
S}

ERBS2 Attrib MeCont 2016-0 enmUse Applic {userL {userL

ute mo ext=ER 8-10T1 r ation: abel=n abel=o
difica BS2 2:03:3 Import ewLabe ldLabe
tion 0 ,JobID lValue lValue
:15 } }

2 change(s)

1/1553-CNA 403 2979 Uen AV | 2020-12-07 511

 ENM CLI

Results
Result 1: Where the specified import made changes to the live configuration
those changes are displayed.

Result 2: Where the specified import made no changes to the live configuration 0
changes are displayed.

Result 3: Where the specified import made changes to the live configuration but
not all history was stored a message indicating incomplete history along with the
stored changes is displayed.

2.7.6 Undo changes executed towards the live configuration via CM Bulk Import

Prerequisites

Changes have been made to the live configuration by importing to live

This tutorial describes the steps required to undo changes made to the live
configuration by importing to live.

The default value for the optional file type parameter depends on the Dynamic
CM Value Package license. If the Dynamic CM Value Package license is not
installed, the default value is 3GPP. If the Dynamic CM Value Package license is
installed, the default value is dynamic.

Steps

1. Select import job to undo

The purpose of this step is to determine which bulk import job should be
selected to revoke.

cmedit import --status

The command returns a list of all import jobs as shown in the following
example. To save the response to a file Hit Ctrl+Enter. This makes it easier to
search for jobs using an offline text editor.

Job Status

512 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Job Stat Start End Elap Nod Nod Man Man Man Acti Failu File Conf
ID us date date sed es es age age age ons re Nam igur
/ / Tim copi not d d d perf Infor e atio
time time e ed copi obje obje obje orm mati n
ed cts cts cts ed on
crea upd dele
ted ated ted

1 COM 201 201 0h 0 0 2 0 3 0 imp Live

PLE 6-10 6-10 0m ortT
TED -27T -27T 3s oLiv
10:1 10:1 e.xm
7:06 7:09 l

2 COM 201 201 0h 0 0 0 1 0 0 imp Live

PLE 6-10 6-10 0m ortT
TED -27T -27T 2s oLiv
11:4 11:4 eTw
2:06 2:08 o.xm
l

Retrieved import job details successfully

Select the correct Bulk import job to be revoked. Using the job ID of this job,
use the following tutorial to check the history of this job to confirm that it
contains the intended operations to be revoked

View the History of Changes to the Live Configuration made by a Specific

Import
Result : The correct Bulk Import job to undo has been identified. The job
contains the operations to be revoked.

2. Create an undo import file for the chosen import job

The purpose of this step is to create a bulk import file which contains the
operations required to undo the job selected in step 1

config undo --importjob 2

The command begins an undo job. A successful message is displayed with a

job ID as shown in the following example:

Undo job started with job ID 81

Result : The bulk import file to revoke the selected job has been created.

3. Check the status of the undo job

The purpose of this step is to check that the undo job has been completed,
and contains all required changes.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 513

 ENM CLI

Note : Some operations are not supported by undo. If unsupported

operations are in the selected Bulk Import job, there will be a difference
between the "Total operations" and "Undo operations" columns. Refer to the
description of "Undo operations" below.

config undo --status --job 81

The command in this example returns the status of an undo job with the job
ID 81 as shown in the following example:

Job Status

Job ID Status Start End Elapsed Total Undo User File Additio
date/ date/ time operati operati name name nal
time time ons ons informa
tion

81 COMPL 2016-1 2016-1 0h 0m 1 1 enmUs / Applica

ETED 0-27T1 0-27T1 3s er ericsso tion:Im
2-12-5 2-12-5 n/ port,Jo
4 7 batch/ bID:80
undo/
undo_2
016-10
-27T12
-12-54
_81.xml

— The Total operations field lists the number of operations applied to the
network due to the import job. Exact details of those operations can be
displayed using the config history command for the live configuration.

— The Undo operations field lists the number of operations included in the
undo file. This number can be less than the Total operations field, since
some operations are not currently supported. The supported operations
are Managed Object creation, MIB root creation, attribute modification
and Managed Object deletion on NRM (Network Resource Model)
Managed Objects. Attribute modification on Topology Model Managed
Objects is also supported, but only with Dynamic File Format. The
deletion of system created Managed Objects is not supported. The
deletion of child Managed Objects where the relationship between
parent and child is marked 'not deletable' is not supported. More
information can be found in the "Context Description" section of config
undo. For unsupported operations,
'totalExcludedUnsupportedOperations' counter is incremented in the
logs. The log entry for an undo job can be found in Log Viewer by
searching for the label CM_REVOCATION. The log entry contains the
counters that identify the number of excluded unsupported operations
and the number of excluded Managed Objects. These counters are

514 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

'totalExcludedUnsupportedOperations', 'totalExcludedNonNrmMos',
'totalExcludedSystemCreatedMos', and 'totalExcludedNotDeletableMos'.

— The File name describes the name and location of the undo file. In this
example the dynamic license is not active therefore the filetype is 3GPP.
This is denoted by the file's XML extension.

— The Additional information field lists the application source of the

original changes for which this undo job is generating the undo file.
Undo of Bulk CM import is supported.

— The Additional information field also includes the reason for failure, for
undo jobs that have failed.

— For undo jobs where all operations have been excluded, the job is
considered failed. The Additional information field includes 'No
operations to undo' as the reason for failure. The undo file is not
available for download.

— If a job fails with Failure Reason:Incomplete History data available for

job, this could indicate that the specified import job is not yet complete.
Wait for the import job to complete and retry the command.

4. Download the undo file and add to the workspace

The purpose of this step is to download the undo file and add it to the
workspace so that it can be used in a bulk import job.

config undo --download --job 81

The command downloads the undo file to the local client as displayed:

downloading...

Note : The downloaded file can be viewed to confirm it contains the required
changes.

Move the undo file to the workspace by dragging and dropping onto the
client browser, the following confirmation message is displayed:

undo_2016-10-27T12-12-54_81.xml added to workspace

5. Import the file into the live configuration

The purpose of this step is to apply the undo operations to the Live
configuration.

cmedit import -f file:<undoFileName> -ft <fileType>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 515

 ENM CLI

The command begins an import job and returns a successful message with a
job ID as displayed:

Import started with job ID 2

6. Check the status of the import job

The purpose of this step is to check that the import job has been completed,
and contains all required changes.

cmedit import --status --job 2 --verbose

The command in this example returns the status of an import job with the
job ID 2 as displayed:

Job Status

Job Stat Start End Elap Nod Nod Man Man Man Acti Failu File Conf
ID us date date sed es es age age age ons re Nam igur
/ / Tim copi not d d d perf Infor e atio
time time e ed copi obje obje obje orm mati n
ed cts cts cts ed on
crea upd dele
ted ated ted

2 COM 201 201 0h 0 0 0 1 0 0 und Live

PLE 6-10 6-10 0m o_2
TED -27T -27T 2s 016-
12:2 12:2 10-2
0:06 0:08 7T1
2-12
-54_
81.x
ml

Job Operation Details

Import status message Operation Type Update Time FDN

SUCCESS UPDATE 2016-10-27T12:20:08 MeContext=LTE02ERB

S00069,ManagedElem
ent=1,ENodeBFunction
=1

Retrieved import job details successfully

Result : If the Bulk Import job completes successfully, the changes are
applied to the live configuration. If the the Bulk Import job has failed due to

516 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Instance Validation, there are incompatible with the Live configuration. For
example if the Bulk Import is trying to create a child MO for a parent MO that
has been deleted since the Bulk Import selected in step 1 was applied. In this
case review the changes that have failed using

cmedit import --status --job 2 --verbose

If the failure reason is found in the "Failure Information" column, if these are
now unnecessary due to changes in the Live configuration, rerun the import
command with the following parameters

cmedit import -f file:<undoFileName> -ft <fileType> -t Live - →

-validate noinstance --error operation

7. Remove the undo job with job ID 81

config undo --remove --job 81

The command removes the undo job with a message as in the following
example:

Undo job was successfully removed.

Results
The changes made by the selected import job in the live configuration are
undone.

2.7.7 Remove an Undo Job

Prerequisites

— Undo jobs exist

This tutorial describes the steps to remove a undo job.

Steps

1. Remove the undo job with job ID 81

config undo --remove --job 81

The command removes the undo job with a message as in the following
example:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 517

 ENM CLI

Undo job was successfully removed.

Results
The undo job with job ID 81 is removed.

2.7.8 config history

< Back To Config

Syntax

Syntax to get the history of configuration management changes

config history [options]

Command syntax is case sensitive.

Options

-v or --verbose

Adds additional detail to the response.

The verbose option shows the original attributes in addition to the supplied
arguments.

For "MO created" and "MIB Root created" operations, the supplied arguments will
not display attributes with values equal to the default value.

For "MO deleted" operations, the original attributes will not display attributes
with values equal to the default value.

-ij or --importjob

List changes made by execution of a bulk CM import with the specified job
number.

518 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Context Description

Display CM data changes made by a CM Bulk Import job to the live configuration.

History tutorials.

Prerequisites

— Requires a user with one of the following roles:

• Cmedit_Administrator

• Cmedit_Operator

• Custom role with the capability: Resource: cm_config, Operation: read

Command Consequences

— No consequences.

Examples

Get the history of changes made to the live configuration

config history

Response

The command will return all changes made to the live configuration by execution
of CM Bulk Import jobs.

The maximum number of rows will be limited and only the most recent rows will
be displayed.

Get the history of changes made to the live configuration by a specific import
to live.

config history --importjob 6

Response

The command will return all changes made to the live configuration by execution
of CM Bulk Import job with ID 6.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 519

 ENM CLI

Tutorials
— View the History of Changes to the Live Configuration.

— View the History of Changes to the Live Configuration made by a Specific

Import.

2.7.9 config undo

< Back To Config

Syntax

Syntax to run an undo on an import job

config undo --importjob <importJobID> [-ft | --filet →

ype]

Syntax to get the status of undo job(s)

config undo --status [-j | --job]

Syntax to download an undo import file

config undo --download --job <undoJobID>

Syntax to remove a undo job

config undo --remove --job <undoJobID>

Command syntax is case sensitive.

Options

520 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

-ij or --importjob

Generate an import file to undo the changes made by a specific import job to the
live configuration.

This option is incompatible with --status.

-ft or --filetype

The format of the file generated by undo command and containing all needed
statements to undo changes applied to the network by the specified job. The
following file formats are supported:

— 3GPP - 3GPP file format

— dynamic - Ericsson Dynamic file format

Default value for --filetype depends on the presence (or not) of the Dynamic CM
Value Package license; if the license is not present, the default value is 3GPP;
otherwise it is dynamic.

-j or --job

The job ID of a specific job.

This option is incompatible with --importjob.

-st or --status

Get the status of undo jobs.

This option is only compatible with the --job option.

-dl or --download

1/1553-CNA 403 2979 Uen AV | 2020-12-07 521

 ENM CLI

Download a specified undo import file.

This option is only compatible with the --job option.

-rm or --remove

Remove a specified undo job.

This option is only compatible with the --job option.

Context Description
— The feature supports revocation of Configuration Management changes
which have been applied to the network where the source of the changes is
an import to the live configuration.

— The command will generate a file in the required format which will contain
the necessary operations to reverse the changes originally applied to the
network due to the specified job.

— The generated file can be downloaded to the client browser.

— The format of the generated file can be specified in the command using the
optional --filetype <file-type> field. If --fileype option is not present the
default value depends on the presence (or not) of the Dynamic CM Value
Package license; if the license is not present, the default value is 3GPP;
otherwise it is dynamic.

— The file can be imported and applied to the network using cmedit import
command

— Revocation of create/delete operations to non-NRM MOs is not supported.

— Revocation of Action operations is not supported.

— If the generated file size exceeds the limits specified in Import File Size Limit,
then split the file into smaller files for attempting import.

— Revocation of operations to ER6000 Family nodes is not supported.

— Treat-as means that ENM has the ability to manage a node as a different
version to the actual version of that node. An unknown node version is
managed (or treated) as a known node version. If a node is being managed
using Treat-as, it is possible that the node has attribute values outside the
range allowed for by the ENM version. Revocation of changes to these
attributes is not supported. In this case the import of the undo file will fail.

522 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Generate an import file which can be used to undo the configuration

management changes resulting from the import to live operations.

Undo tutorials.

Prerequisites

— Requires a user with one of the following roles:

• Cmedit_Operator

— An import to live job has completed and has applied changes to the network.

Command Consequences

— An import file is created containing undo operations.

Examples

Generate an undo file for a specific Bulk CM import job

config undo --importjob 3 --filetype dynamic

Response

An import file is generated in the Ericsson Dynamic file format with the reverse
operations that were applied to the live configuration by the import with job ID 3

Get the status of all stored undo jobs

config undo --status

Response

The command returns a list of all stored undo jobs statuses

Get the status of a specific undo job

config undo --status --job 4

1/1553-CNA 403 2979 Uen AV | 2020-12-07 523

 ENM CLI

Response

The command returns the status of the specified job.

Download a specific undo job import file

config undo --download --job 4

Response

The undo file for undo job 4 is downloaded to the client browser.

Remove a specific undo job

config undo --remove --job 4

Response

The undo job with ID 4, and its associated undo file is deleted from the system.

Tutorials
— Undo Changes to the Live Configuration made by Import to Live

— Remove an Undo Job

2.8 credm
< Back To Command Sets

Content
List of Tutorials

List of Commands

Notes

Summary of Error Codes and Messages

524 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Tutorials

Reissue

List ENM and 3PP Services

Lock Certificate and Entity Profiles

Unlock Certificate and Entity Profiles

Commands

Reissue

List

Lock

Unlock

Notes
The credm command set manages security configuration and administrationfor
the ENM services.

Summary of Error Codes and Messages for credm Commandset

The following table lists all the possible credm error codes for the credm
commandset and the consequent actions.

Error Code Error Message Solution/Action Required

14001 Refer to the online help for the
Command syntax error correct syntax

14004 Target Service must refer to an

Invalid argument: Target Se existing Service entity name
rvice does not exist

14005 Target Service must refer to an

Invalid argument: Target Se existing Service entity name
rvice name is empty

14006 CA name must refer to an existing

Invalid argument: Certifica Certificate Authority
te Authority does not exist

14010 Check file format

Invalid File Format

1/1553-CNA 403 2979 Uen AV | 2020-12-07 525

 ENM CLI

2.8.1 Tutorial: Reissue

< Back To Credm

Start an Enrollment Job to Provide Certificates to the Services

In the example the credm reissue command revokes the certificate issued for the
ENM AutoProvisioning service and issues a new certificate for the same subject.

Example of Command

credm reissue -s APServ_svc-1-apserv

Example of Command Response:

Successfully started a job to reissue certificate.

Check logs for details and results.

Reissue job started successfully. Run 'credm list' command for d →

etails about the status

Notes
— The "APServ_svc-1-apserv" is only an example for the <enm-service-name-
value> argument.

2.8.2 Tutorial: List ENM and 3PP Services

< Back To Credm

Retrieve the List of all the ENM and the 3PP Services
In this example the credm list command returns the list of all the ENM and 3PP
services.

Example of Command

credm list

Example of Command Response:

526 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Retrieve the Full List of all the ENM and the 3PP Services
In this example the credm list command returns the full (verbose mode) list of
all the ENM and 3PP services.

Example of Command

credm list -v

Example of Command Response:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 527

 ENM CLI

Return the list of all the ENM services and 3PPs managed by security and
trusting a trustCA.
In this example the credm list command returns the list of all the ENM and 3PP
services trusting 'VC_Root_CA_A1' with their status and the used EntityProfile.

Example of Command

credm list -tca VC_Root_CA_A1

Example of Command Response:

Return the list of all the ENM services and 3PPs managed by security and
trusting a trustCA, with all information.
In this example the credm list command returns the full (verbose mode) list of
all the ENM and 3PP services trusting 'VC_Root_CA_A1' with all realted
information.

Example of Command

credm list -v -tca VC_Root_CA_A1

Example of Command Response:

528 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Returns the list of all the ENM services and 3PPs managed by security with
related status.
In this example the credm list command returns the full (verbose mode) list of
all the ENM and 3PP services managed by security containing the string httpd in
its name, the Service Entity Status ans the used EntityProfile.

Example of Command

credm list -v -s httpd

Example of Command Response:

2.8.3 Tutorial: Lock Certificate and Entity Profiles

< Back To Credm

Lock the Certificate Profile

In this example, the credm lock command locks the given Certificate Profile.

Example of Command

credm lock --profile CMPRA_CP --type certificate

Example of Command Response

Job Lock started successfully

1/1553-CNA 403 2979 Uen AV | 2020-12-07 529

 ENM CLI

Lock the Entity Profile

In this example, the credm lock command locks the given Entity Profile.

Example of Command

credm lock --profile SecGw_SAN_EP --type entity

Example of Command Response:

Job Lock started successfully

2.8.4 Tutorial: Unlock Certificate and Entity Profiles

< Back To Credm

Unlock the Certificate Profile

In this example, the credm unlock command unlocks the given Certificate
Profile.

Example of Command

credm unlock --profile CMPRA_CP --type certificate

Example of Command Response

Job Unlock started successfully

Unlock the Entity Profile

In this example, the credm unlock command unlocks the given Entity Profile.

Example of Command

credm unlock --profile SecGw_SAN_EP --type entity

Example of Command Response

Job Unlock started successfully

2.8.5 credm reissue

< Back To Credm

530 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Syntax
The credm reissue commandset is described with the following EBNF
grammar:

"credm" "reissue" " " [ TARGET_SERVICE | INPUT_FILE ] " "

TARGET_SERVICE ::= ( "-s" | "--service" ) " " SERVICE_NAME

SERVICE_NAME ::= <enm-service-name-value> | <3pp-name-value>

INPUT_FILE ::= ( "-fn" | "--filename" ) " file:"<filename>

Examples
For a list of examples see the following tutorial:

— Reissue

Context Description
The credm reissue commandset starts a job to re-issue certificates to services
with new keys. After this the old certificates is revoked.

Prerequisites

— The credm reissue command requires a certificate previously and

automatically issued by the CA for the service.

Notes
Service Name:

— <enm-service-name-value> argument requires the name of a ENM service

entity

— <3pp-name-value> argument requires the name of a Third Party Product

(3PP) installed with the ENM.

Input File Name: it is a text file containing a list of service names separated by:

— comma

— <TAB>

— <SPACE>

— <CR>

1/1553-CNA 403 2979 Uen AV | 2020-12-07 531

 ENM CLI

2.8.6 credm list

< Back To Credm

Syntax
The credm list commandset is described with the following EBNF grammar:

"credm" "list" [ VERBOSE ] [ TRUSTCA | SERVICE ]

VERBOSE ::= ( "-v" | "--verbose" )

TRUSTCA ::= ( "-tca" | "--trustCA" ) <ca-name-value>

SERVICE ::= ( "-s" | "--service" ) <service-name>

Examples
For a list of examples see the following tutorial:

— List Service Tutorial

Context Description
The credm list command allows retrieving the list of the ENM and the 3PP
services.

2.8.7 credm lock

< Back To Credm

Syntax
The credm lock command set is described with the following EBNF grammar:

"credm" "lock" PROFILENAME ENTITY_TYPE

PROFILENAME ::= ( "-p" | "--profile" ) <profile-name>

ENTITY_TYPE ::= ( "-t" | "--type" ) ( "certificate" | "entity" )

Examples
For a list of examples, see the following tutorial:

— Lock Service Tutorial

532 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Context Description
The credm lock command changes the ismodifiable attribute of the profile to
false, so that the profile cannot be modified further.

2.8.8 credm unlock

< Back To Credm

Syntax
The credm unlock command set is described with the following EBNF grammar:

"credm" "unlock" PROFILENAME ENTITY_TYPE

PROFILENAME ::= ( "-p" | "--profile" ) <profile-name>

ENTITY_TYPE ::= ( "-t" | "--type" ) ( "certificate" | "entity" )

Examples
For a list of examples, refer to the following tutorial:

— Unlock Service Tutorial

Context Description
The credm unlock command changes the ismodifiable attribute of the profile to
true, so that the profile can be updated using CLI/UI.

2.9 dhcp
< Back To Command Sets

List of Tutorials

List of Commands

Notes

Summary of Error Codes and Messages

Tutorials

Start DHCP Server

1/1553-CNA 403 2979 Uen AV | 2020-12-07 533

 ENM CLI

Stop DHCP Server

Configure Ericsson MAC Address Filtering

Configure DHCP Server Interface

View DHCP Server Status

Add DHCP Network Configuration

Update DHCP Network Configuration

Delete DHCP Network Configuration

View DHCP Network Configuration

Add ip range to DHCP Network Configuration

Delete ip range from DHCP Network Configuration

Add New DHCP Client

Delete DHCP Client

View DHCP Client(s) Configuration

Start DHCP Monitor Session

Stop DHCP Monitor Session

Delete DHCP Monitor Message(s)

View DHCP Monitor Session(s) and Message(s)

Command sets

Start

Stop

Status

Network

Range

534 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Client

Monitor

Configure

Notes
The DHCP command set is used to start, stop, configure and monitor the DHCP
server in ENM. The DHCP CLI commands can be used to do the following:

— Managing DHCP Server (start, stop and status)

— Managing DHCP Server Configuration (network and range)

— Managing DHCP Client Configuration (add, delete and view)

— Managing DHCP Monitor Session (start, stop, delete and view)

The DHCP command set performs various DHCP supported use cases from CLI.

Role Privileges
DHCP_Administrator — Start/Stop DHCP server and view server
status.

— Create/View/Update/Delete configuration.

— Start/Stop/View monitor session and

Delete/View monitor message.
DHCP_Service_Operator — View server status.

— Create/View/Update/Delete configuration.

— Start/Stop/View monitor session and

Delete/View monitor message.
DHCP_Operator — View server status.

— View configuration.

— View monitor session and monitor message.

Summary of Error Codes and Messages for DHCP Command Set

The following table lists the possible dhcp error codes for the DHCP command set
and the consequent actions:

Error Code Error Message Solution/Action Required

23001 Refer to the Online Help for correct
Command syntax error syntax.

23102 — Validation of client failed. Correct the input parameters of

Details: client is too long the command.
in size.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 535

 ENM CLI

Error Code Error Message Solution/Action Required

— Validation of hostname
failed. Details: hostname
is too long in size.

— Validation of IP address
failed. Details: Address is
outside network.

— Validation of IP address
failed. Details: IP address
with all zeros is
unacceptable.

— Validation of Client fixed

address failed. Details:
Range overlap fixed IP
address of associated
Client.

— Validation of uto failed.

Details: Parameter
Universal Time Offset is
not supported for IPv6.

— Validation of IP version
failed. Details: IP version
is inconsistent with
configured client data.

— Validation of MAC
address filtering failed.
MAC address filtering is
not supported for IPv6.

— Validation of interface
failed. Specified network
interface is invalid.
23103 Check already defined networks.
Network configuration alrea
dy exists.

23104 — Client identifier is not — Try use different identifier.

unique.
— Try use different IP
— Client IP is not unique. address.

— Hostname is not unique. — Try use different

hostname.
23105 Stop the monitor session and try
Monitor session for client again later.
is in progress.

23106 Do not repeat the stop action.

Stop of monitor session for
client is in progress.

23501 — Could not perform this — Try again later or contact

action right now due to your administrator.
database issue
— Check provided subnet.
— Network configuration
not found. — Check provided client
identifier.
— Client configuration not
found. — Check provided client
identifier.
— Monitor session not
found.
23510 Refer to security documentation or
You don't have the required contact your administrator.
privileges to execute DHCP
CLI command

536 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Error Code Error Message Solution/Action Required

23511 Refer to security documentation or
You don't have the required contact your administrator.
privileges to perform this
action

2.9.1 Start DHCP Server

Prerequisites

— You have DHCP_Administrator role assigned.

— DHCP server is stopped.

Objective

This tutorial describes the steps required to execute start command for DHCP4
server or/and DHCP6 server.

It allows you to manage services of DHCP4 and DHCP6 server (over IPv4 and
IPv6 accordingly) through ENM DHCP CLI commands.

Outline

1. Start DHCP4 Server

2. Start DHCP6 Server

Steps

1. Start DHCP4 Server

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the start DHCP4 server
command:

Command Syntax

"dhcp" "start" "--ipv4" | "-4" [ --interface <interface> ] [ →

--macfilter <enable|disable> ]

Learn more about the dhcp start command

Command Example

dhcp start --ipv4 --interface eth1 --macfilter enable

1/1553-CNA 403 2979 Uen AV | 2020-12-07 537

 ENM CLI

Command Result

DHCP over IP version 4 started successfully.

2. Start DHCP6 Server

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the start DHCP6 server
command:

Command Syntax

"dhcp" "start" "--ipv6" | "-6" [ --interface <interface> ]

Learn more about the dhcp start command

Command Example

dhcp start --ipv6 --interface eth0

Command Result

DHCP over IP version 6 started successfully.

Results
The start command is executed for DHCP4 or DHCP6 server.

2.9.2 Stop DHCP Server

Prerequisites

— You have DHCP_Administrator role assigned.

— DHCP server is started.

Objective

538 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

This tutorial describes the steps required to execute Stop command for DHCP4
server or/and DHCP6 server.

It allows you to manage services of DHCP4 and DHCP6 server (over IPv4 and
IPv6 accordingly) through ENM DHCP CLI commands.

Outline

1. Stop DHCP4 Server

2. Stop DHCP6 Server

Steps

1. Stop DHCP4 Server

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the stop DHCP4 server
command:

Command Syntax

"dhcp" "stop" "--ipv4" | "-4"

Learn more about the dhcp stop command

Command Example

dhcp stop --ipv4

Command Result

DHCP over IP version 4 stopped successfully.

2. Stop DHCP6 Server

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the stop DHCP6 server
command:

Command Syntax

1/1553-CNA 403 2979 Uen AV | 2020-12-07 539

 ENM CLI

"dhcp" "stop" "--ipv6" | "-6"

Learn more about the dhcp stop command

Command Example

dhcp stop --ipv6

Command Result

DHCP over IP version 6 stopped successfully.

Results
The stop command is executed for DHCP4 or DHCP6 server.

2.9.3 View DHCP Server Status

Prerequisites

You have DHCP_Administrator, DHCP_Service_Operator or DHCP_Operator role

assigned.
Objective

This tutorial describes the steps required to execute status command for DHCP
server. It allows you to view the status of DHCP through ENM DHCP CLI
commands.

Outline

1. View DHCP Server Status

Steps

1. View DHCP Server Status

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute DHCP server status command:

Command Syntax

540 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

"dhcp" "status" "--ipv4" | "-4" | "--ipv6" | "-6"

Learn more about the dhcp status command

Command Example

dhcp status --ipv4

Command Result

Server: DHCP4
Status: Running
Interface: eth2
MAC Address Filtering: Enabled
Last Update Time: 2019-08-05 12:03:20

Command Example

dhcp status --ipv6

Command Result

Server: DHCP6
Status: Running
Interface: eth1
Last Update Time: 2019-08-05 12:04:01

Results
The DHCP server status is displayed.

2.9.4 Add DHCP Network

Prerequisites

You must have DHCP_Administrator or DHCP_Service_Operator role assigned.

Objective

1/1553-CNA 403 2979 Uen AV | 2020-12-07 541

 ENM CLI

This tutorial describes the steps required to execute add command for DHCP
IPv4 network and DHCP IPv6 network through ENM DHCP CLI commands.

Outline

1. Add DHCP Network Configuration for IPv4

2. Add DHCP Network Configuration for IPv6

Steps

1. Add DHCP Network Configuration for IPv4

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to execute the adding DHCP IPv4 network
Command:

Command Syntax

dhcp network add [ --subnet | -s ] <subnet> --netmask | -n <n →

etmask>
[ --defaultrouter | -d <default router> ]
[ --broadcast | -b <broadcast> ]
[ --aiws | -a <aiws> ]
[ --ntp <ntp servers> ]
[ --dns <domain name servers> ]
[ --domainname | --dn <domain name> ]
[ --range | -r <ip ranges> ]
[ --securitygateway | -g <security gateway> →
]
[ --uto <universal time offset> ]
[ --noreload ]

Note:

a. <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).
b. <domain name servers> specifies one or more DNS server(s). Multiple
servers are separated by comma (“,”).
c. <ip ranges> specifies one or more IP range(s). Multiple ranges are
separated by comma (“,”), for example, <ip 1>-<ip 2>,<ip 3>-<ip 4>.

Learn more about the dhcp network add command

Command Example Command Example

542 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

dhcp network add --subnet 193.11.1.0 --netmask 255.255.255.0 →

--defaultrouter 193.11.1.4 --broadcast 193.11.1.255 --aiws 19 →
2.168.0.186 --ntp 10.10.10.10,10.10.10.11 --dns 4.4.4.4,6.6.6 →
.6,8.8.8.8 --dn example.com --range 193.11.1.1-193.11.1.8 --s →
ecuritygateway 193.11.1.1 --uto 3000

Command Result

Network updated successfully.

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address: 193.11.1.255
Domain name servers: 4.4.4.4, 6.6.6.6, 8.8.8.8
Domain name: example.com
NTP servers: 10.10.10.10, 10.10.10.11
Default router: 193.11.1.4
IP ranges: 193.11.1.1-193.11.1.8
Security gateway: 193.11.1.1
AIWS: 192.168.0.186
Time offset: 3000

Or

2. Add DHCP Network Configuration for IPv6

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to execute the adding DHCP IPv6 network
Command:

Command Syntax

dhcp network add [ --subnet | -s ] <subnet> --netmask | -n <n →

etmask>
[ --defaultrouter | -d <default router> ]
[ --broadcast | -b <broadcast> ]
[ --aiws | -a <aiws> ]
[ --ntp <ntp servers> ]
[ --dns <domain name servers> ]
[ --domainname | --dn <domain name> ]
[ --range | -r <ip ranges> ]
[ --securitygateway | -g <security gateway> →
]
[ --uto <universal time offset> ]
[ --noreload ]

Note:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 543

 ENM CLI

a. <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).
b. <domain name servers> specifies one or more DNS server(s). Multiple
servers are separated by comma (“,”).
c. <ip ranges> specifies one or more IP range(s). Multiple ranges are
separated by comma (“,”), for example, <ip 1>-<ip 2>,<ip 3>-<ip 4>.

Learn more about the dhcp network add command

Command Example

dhcp network add --subnet fe80:ffff:6ec3:17ff:fe3f:ad80:: --n →

etmask ffff:ffff:ffff:ffff:ffff:ffff:: --defaultrouter fe80:f →
fff:ff14:d0ab:dd:c4a:ff00:1 --broadcast fe80:ffff:6ec3:17ff:f →
e3f:ad80:1:ffff --aiws fe80:ffff:6ec3:17ff:fe3f:ad80:f:f0c -- →
ntp fe80:ffff:6ec3:17ff:fe3f:ad80:fa:f0c --dns fe80:ffff:6ec3 →
:17ff:fe3f:ad80:f0b:f0c --dn example.com --range fe80:ffff:6e →
c3:17ff:fe3f:ad80:ff:0-fe80:ffff:6ec3:17ff:fe3f:ad80:ff:ff -- →
securitygateway fe80:ffff:6ec3:17ff:fe3f:13:33:ffff

Command Result

Network added successfully.

Subnet: fe80:ffff:6ec3:17ff:fe3f:ad80:0:0
Netmask: ffff:ffff:ffff:ffff:ffff:ffff:0:0
Broadcast address: fe80:ffff:6ec3:17ff:fe3f:ad80:1:ffff
Domain name servers: fe80:ffff:6ec3:17ff:fe3f:ad80:f0b:f0c
Domain name: example.com
NTP servers: fe80:ffff:6ec3:17ff:fe3f:ad80:fa:f0c
Default router: fe80:ffff:ff14:d0ab:dd:c4a:ff00:1
IP ranges: fe80:ffff:6ec3:17ff:fe3f:ad80:ff:0-fe80:ffff:6ec3: →
17ff:fe3f:ad80:ff:ff
Security gateway: fe80:ffff:6ec3:17ff:fe3f:13:33:ffff
AIWS: fe80:ffff:6ec3:17ff:fe3f:ad80:f:f0c
Time offset:

Results
A new DHCP network with the specified configuration is added.

The DHCP configuration is reloaded automatically, if "--noreload" parameter is

not used.

544 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.9.5 Update DHCP Network

Prerequisites

— You must have DHCP_Administrator or DHCP_Service_Operator role

assigned.

— DHCP network must be configured.

Objective

This tutorial describes the steps required to execute update command for DHCP
IPv4 network or DHCP IPv6 network through ENM DHCP CLI commands.

Outline

1. Update DHCP Network Configuration for IPv4

2. Update DHCP Network Configuration for IPv6

Steps

1. Update DHCP Network Configuration for IPv4

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to update DHCP IPv4 network
configuration:

Command Syntax

dhcp network update [ --subnet | -s ] <subnet>

[ --netmask | -n <netmask> ]
[ --defaultrouter | -d <default router> ]
[ --broadcast | -b <broadcast> ]
[ --aiws | -a <aiws> ]
[ --ntp <ntp servers> ]
[ --dns <domain name servers> ]
[ --domainname | --dn <domain name> ]
[ --range | -r <ip ranges> ]
[ --securitygateway | -g <security gatewa →
y> ]
[ --uto <universal time offset> ]
[ --noreload ]

Note:

a. <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).

1/1553-CNA 403 2979 Uen AV | 2020-12-07 545

 ENM CLI

b. <domain name servers> specifies one or more DNS server(s). Multiple

servers are separated by comma (“,”).
c. <ip ranges> specifies one or more IP range(s). Multiple ranges are
separated by comma (“,”), for example, <ip 1>-<ip 2>,<ip 3>-<ip 4>.

Learn more about the dhcp network update command

Command Example

dhcp network update --subnet 193.11.1.0 --uto 3600

Command Result

Network updated successfully.

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:
Default router:
IP ranges:
Security gateway:
AIWS: 192.168.0.186
Time offset: 3600

Or

2. Update DHCP Network Configuration for IPv6

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to update DHCP IPv6 network
configuration:

Command Syntax

dhcp network update [ --subnet | -s ] <subnet>

[ --netmask | -n <netmask> ]
[ --defaultrouter | -d <default router> ]
[ --broadcast | -b <broadcast> ]
[ --aiws | -a <aiws> ]
[ --ntp <ntp servers> ]
[ --dns <domain name servers> ]
[ --domainname | --dn <domain name> ]
[ --range | -r <ip ranges> ]
[ --securitygateway | -g <security gatewa →
y> ]

546 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

[ --uto <universal time offset> ]

[ --noreload ]

Note:

a. <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).
b. <domain name servers> specifies one or more DNS server(s). Multiple
servers are separated by comma (“,”).
c. <ip ranges> specifies one or more IP range(s). Multiple ranges are
separated by comma (“,”), for example, <ip 1>-<ip 2>,<ip 3>-<ip 4>.

Learn more about the dhcp network update command

Command Example

dhcp network update --subnet fe80:ffff:6ec3:17ff:fe3f:ad80:: →

--ntp 20:1b:82:13b::1fff

Command Result

Network updated successfully.

Subnet: fe80:ffff:6ec3:17ff:fe3f:ad80:0:0
Netmask: ffff:ffff:ffff:ffff:ffff:ffff:0:0
Broadcast address:
Domain name servers:
Domain name:
NTP servers: 20:1b:82:13b:0:0:0:1fff
Default router:
IP ranges:
Security gateway:
AIWS: 2001:1b70:82a1:103:0:0:0:172
Time offset:

Results
An existing DHCP network with the specified configuration is updated and all
specified optional parameters values are overwritten.

The DHCP configuration is reloaded automatically, if "--noreload" parameter is

not used.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 547

 ENM CLI

2.9.6 Delete DHCP Network

Prerequisites

— You must have DHCP_Administrator or DHCP_Service_Operator role

assigned.

— DHCP network must be configured.

Objective

This tutorial describes the steps required to execute delete command for DHCP
network through ENM DHCP CLI commands.

Outline

1. Delete DHCP Network Configuration

Steps

1. Delete DHCP Network Configuration

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to execute the deleting DHCP Network
Command:

Command Syntax

dhcp network delete --subnet | -s <subnet> [ --noreload ]

Learn more about the dhcp network delete command

Command Example

dhcp network delete --subnet 193.11.1.0

Command Result

Network deleted successfully.

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:
Default router:
IP ranges:

548 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Security gateway:
AIWS: 192.168.0.186
Time offset:

Results
A DHCP network with the specified configuration is deleted.

The DHCP configuration is reloaded automatically if "--noreload" parameter is

not used.

2.9.7 View DHCP Network(s) Configuration

Prerequisites

— You must have DHCP_Administrator, DHCP_Service_Operator or

DHCP_Operator role assigned.

— DHCP network must be configured.

Objective

This tutorial describes the steps required to execute view command for DHCP
network configuration through ENM DHCP CLI commands.

Outline

1. View DHCP Network Configuration for Specified Subnet

2. View all DHCP Network Configurations

Steps

1. View DHCP Network Configuration for Specified Subnet

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to view a DHCP network configuration
with specified subnet command:

Command Syntax

dhcp network view --subnet | -s <subnet>

Learn more about the dhcp network view command

Command Example

1/1553-CNA 403 2979 Uen AV | 2020-12-07 549

 ENM CLI

dhcp network view --subnet 193.11.1.0

Command Result

Network(s) configuration:

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address: 193.11.1.255
Domain name servers: 4.4.4.4, 6.6.6.6, 8.8.8.8
Domain name: example.com
NTP servers: 10.10.10.10, 10.10.10.11
Default router: 193.11.1.4
IP ranges: 193.11.1.1-193.11.1.8
Security gateway: 193.11.1.1
AIWS: 192.168.0.186
Time offset: 3000

Or

2. View all DHCP Network Configurations

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to view all DHCP network configurations
command:

Command Syntax

dhcp network view [--table|-t]

Learn more about the dhcp network view command

Command Example

dhcp network view --table

Command Result

Results
The DHCP networks with the specified configuration is displayed.

550 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

2.9.8 Add DHCP Range

Prerequisites

— You must have DHCP_Administrator or DHCP_Service_Operator role

assigned.

— DHCP network must be configured.

Objective

This tutorial describes the steps required to execute add ip range to DHCP
network through ENM DHCP CLI commands.

Outline

1. Add Range to DHCP Network Configuration

Steps

1. Add Range to DHCP Network Configuration

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to execute the add range to DHCP
Network Command:

Command Syntax

dhcp range add --subnet | -s <subnet> -r | --range <iprange> →

[ --noreload ]

Learn more about the dhcp range add command

Command Example for ipv4

dhcp range add --subnet 193.11.1.0 --range 193.11.1.2-193.11. →

1.49

Command Result

Network updated successfully.

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 551

 ENM CLI

Default router:
IP ranges: 193.11.1.2-193.11.1.49
Security gateway:
AIWS: 192.168.0.186
Time offset:

Or

Command Example for ipv6

dhcp range add --subnet fe80:ffff:6ec3:17ff:fe3f:ad80:: --ran →

ge fe80:ffff:6ec3:17ff:fe3f:ad80:ff:0-fe80:ffff:6ec3:17ff:fe3 →
f:ad80:ff:ff

Command Result

Network updated successfully.

Subnet: fe80:ffff:6ec3:17ff:fe3f:ad80:0:0
Netmask: ffff:ffff:ffff:ffff:ffff:ffff:0:0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:
Default router:
IP ranges: fe80:ffff:6ec3:17ff:fe3f:ad80:ff:0-fe80:ffff:6ec3: →
17ff:fe3f:ad80:ff:ff
Security gateway:
AIWS: 2001:1b70:82a1:103:0:0:0:172
Time offset:

Results
The IP range is added to the DHCP network with specified subnet.

DHCP configuration is reloaded automatically if "--noreload" parameter is not

used.

2.9.9 Delete DHCP Range

Prerequisites

— You must have DHCP_Administrator or DHCP_Service_Operator role

assigned.

— DHCP network must be configured.

Objective

552 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

This tutorial describes the steps required to execute delete ip range from DHCP
network through ENM DHCP CLI commands.

Outline

1. Delete Range from DHCP Network Configuration

Steps

1. Delete Range from DHCP Network Configuration

a. Launch [unresolved external reference] (CLI)

b. Enter the following command to execute the delete range from DHCP
Network Command:

Command Syntax

dhcp range delete --subnet | -s <subnet> -r | --range <iprang →

e> [ --noreload ]

Learn more about the dhcp range delete command

Command Example

dhcp range delete --subnet 193.11.1.0 --range 193.11.1.2-193. →

11.1.49

Command Result

Network updated successfully.

Subnet: 193.11.1.0
Netmask: 255.255.255.0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:
Default router:
IP ranges:
Security gateway:
AIWS: 192.168.0.186
Time offset:

Or

Command Example for ipv6

1/1553-CNA 403 2979 Uen AV | 2020-12-07 553

 ENM CLI

dhcp range delete --subnet fe80:ffff:6ec3:17ff:fe3f:ad80:: -- →

range fe80:ffff:6ec3:17ff:fe3f:ad80:ff:0-fe80:ffff:6ec3:17ff: →
fe3f:ad80:ff:ff

Command Result

Network updated successfully.

Subnet: fe80:ffff:6ec3:17ff:fe3f:ad80:0:0
Netmask: ffff:ffff:ffff:ffff:ffff:ffff:0:0
Broadcast address:
Domain name servers:
Domain name:
NTP servers:
Default router:
IP ranges:
Security gateway:
AIWS: 2001:1b70:82a1:103:0:0:0:172
Time offset:

Results
The IP range is deleted from the DHCP network with specified subnet.

The DHCP configuration is reloaded automatically if "--noreload" parameter is

not used.

2.9.10 Add New DHCP Client

Prerequisites

— You have DHCP_Administrator or DHCP_Service_Operator role assigned.

— The DHCP client subnet must exist and be configured.

Objective

This tutorial describes the steps required to execute add command for DHCP
IPv4 client or DHCP IPv6 client through ENM DHCP CLI commands.

Outline

1. Add DHCP IPv4 Client

2. Add DHCP IPv6 Client

554 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Steps

1. Add DHCP IPv4 Client

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the adding DHCP IPv4 client
Command:

Command Syntax

dhcp client add [--client|-c] <clientIdentifier> --host|-h <h →

ostname> --ip|-i <ipAddress> --subnet|-s <subnet> [ --aiws | →
-a <aiws server> ] [ --ntp <ntp servers> ] [ --uto | -u <univ →
ersal_time_offsets_in_seconds> ] [ --noreload ]

Note: <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).

Learn more about the dhcp client add command

Command Example

dhcp client add --client D16Q698818 --host D16Q698818 --ip 19 →

2.168.1.20 --subnet 192.168.0.0 --aiws 192.168.1.100 --ntp 19 →
2.168.1.101,192.168.1.102 --uto 8

Command Result

Client added successfully.

Identifier: D16Q698818
Hostname: D16Q698818
Fixed IP: 192.168.1.20
Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101, 192.168.1.102
Time offset: 8

Or

2. Add DHCP IPv6 Client

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the adding DHCP IPv6 client
Command:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 555

 ENM CLI

Command Syntax

dhcp client add [--client|-c] <clientIdentifier> --host|-h <h →

ostname> --ip|-i <ipAddress> --subnet|-s <subnet> [ --aiws | →
-a <aiws server> ] [ --ntp <ntp servers> ] [ --noreload ]

Note: <ntp servers> specifies one or more NTP server(s). Multiple servers are
separated by comma (“,”).

Learn more about the dhcp client add command

Command Example

dhcp client add --client D16Q698818 --host D16Q698818 --ip 20 →

:1b:82:13b::4f --subnet 20:1b:82:13b:: --aiws 20:1b:82:13b::1 →
111 --ntp 20:1b:82:13b::1fff,20:1b:82:13b::1eee

Command Result

Client added successfully.

Identifier: D16Q698818
Hostname: D16Q698818
Fixed IP: 20:1b:82:13b:0:0:0:4f
Subnet: 20:1b:82:13b:0:0:0:0
AIWS: 20:1b:82:13b:0:0:0:1111
NTP servers: 20:1b:82:13b:0:0:0:1fff, 20:1b:82:13b:0:0:0:1eee
Time offset:

Results
A new DHCP client with the specified configuration is added.

DHCP configuration is reloaded automatically unless the "--noreload" parameter

has been used.

2.9.11 Delete DHCP Client

Prerequisites

— You have DHCP_Administrator or DHCP_Service_Operator role assigned.

— DHCP client must be configured and exist.

556 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Objective

This tutorial describes the steps required to execute delete command for DHCP
client through ENM DHCP CLI commands.

Outline

1. Delete DHCP Client

Steps

1. Delete DHCP Client

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the deleting DHCP Client
Command:

Command Syntax

dhcp client delete [--client|-c] <clientIdentifier> [ --norel →

oad ]

Learn more about the dhcp client delete command

Command Example

dhcp client delete --client D16Q698818

Command Result

Client deleted successfully.

Identifier: D16Q698818
Hostname: D16Q698818
Fixed IP: 192.168.1.20
Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101
Time offset: 8

1/1553-CNA 403 2979 Uen AV | 2020-12-07 557

 ENM CLI

Results
A DHCP client with the specified configuration is deleted.

DHCP configuration is reloaded automatically unless the "--noreload" parameter

has been used.

2.9.12 View DHCP Client(s) Configuration

Prerequisites

— You have DHCP_Administrator, DHCP_Service_Operator or DHCP_Operator

role assigned.

— DHCP client must be configured and exist.

Objective

This tutorial describes the steps required to execute view command for DHCP
client configuration through ENM DHCP CLI commands.

Outline

1. View a DHCP Client Configuration with Specified Client Identifier

2. View a DHCP Client Configuration with Specified Client Hostname

3. View a DHCP Client Configuration with Specified Client IP Address

4. View the DHCP Client(s) Configuration with Specified Subnet

5. View all DHCP Client(s) Configuration

Steps

1. View a DHCP Client Configuration with Specified Client Identifier

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the viewing a DHCP client
configuration with specified client identifier command:

Command Syntax

dhcp client view [--client|-c] <clientIdentifier>

Learn more about the dhcp client view command

558 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Command Example

dhcp client view --client D16Q698818

Command Result

Client(s) configuration:

Identifier: D16Q698818
Hostname: D16Q698818
Fixed IP: 192.168.1.20
Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101
Time offset: 8

Or

2. View a DHCP Client Configuration with Specified Client Hostname

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the viewing a DHCP client
configuration with specified client hostname command:

Command Syntax

dhcp client view --host|-h <hostname>

Learn more about the dhcp client view command

Command Example

dhcp client view --host D16Q698818

Command Result

Client(s) configuration:

Identifier: D16Q698818
Hostname: D16Q698818

1/1553-CNA 403 2979 Uen AV | 2020-12-07 559

 ENM CLI

Fixed IP: 192.168.1.20

Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101
Time offset: 8

Or

3. View a DHCP Client Configuration with Specified Client IP Address

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the viewing a DHCP client
configuration with specified client IP address command:

Command Syntax

dhcp client view --ip|-i <ipAddress>

Learn more about the dhcp client view command

Command Example

dhcp client view --ip 20:1b:82:13b::4f

Command Result

Client(s) configuration:

Identifier: D16Q698821
Hostname: D16Q698821
Fixed IP: 20:1b:82:13b:0:0:0:4f
Subnet: 20:1b:82:13b:0:0:0:0
AIWS: 20:1b:82:13b:0:0:0:1111
NTP servers: 20:1b:82:13b:0:0:0:1fff
Time offset:

Or

4. View the DHCP Client(s) Configuration with Specified Subnet

a. Launch [unresolved external reference] (CLI).

560 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

b. Enter the following command to execute the viewing the DHCP client(s)
configuration with specified subnet command:

Command Syntax

dhcp client view --subnet|-s <subnet> [--table|-t]

Learn more about the dhcp client view command

Command Example

dhcp client view --subnet 192.168.0.0

Command Result

Client(s) configuration:

Identifier: D16Q698818
Hostname: D16Q698818
Fixed IP: 192.168.1.20
Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101
Time offset: 8

Identifier: D16Q698822
Hostname: D16Q698822
Fixed IP: 192.168.1.118
Subnet: 192.168.0.0
AIWS: 192.168.1.100
NTP servers: 192.168.1.101
Time offset: 6

2 item(s)

Or

5. View all DHCP Client(s) Configuration

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute the viewing all DHCP client(s)
configuration command:

1/1553-CNA 403 2979 Uen AV | 2020-12-07 561

 ENM CLI

Command Syntax

dhcp client view [--table|-t]

Learn more about the dhcp client view command

Command Example

dhcp client view --table

Command Result

Results
DHCP client(s) with the specified configuration is displayed.

2.9.13 Start DHCP Monitor Session

Prerequisites

— You have DHCP_Administrator or DHCP_Service_Operator role assigned.

— No active monitor session for the client exists.

Objective

This tutorial describes the steps required to execute start DHCP monitor session
command through ENM DHCP CLI commands.

Outline

1. Start DHCP Monitor Session for All Clients on Selected IP Version

2. Start DHCP Monitor Session with Specified Client Identifier

562 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Steps

1. Start DHCP Monitor Session for All Clients on Selected IP Version

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute start DHCP monitor session for
all clients on selected IP version command:

Command Syntax

dhcp monitor start [--ipv4|-4|--ipv6|-6]

Learn more about the dhcp monitor start command

Command Example

dhcp monitor start --ipv6

Command Result

DHCP monitor over IP version 6 started successfully for all V →

6 clients.

Or

2. Start DHCP Monitor Session with Specified Client Identifier

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute start DHCP monitor session
with specified client identifier command:

Command Syntax

dhcp monitor start [--client|-c] <clientIdentifier> [--ipv4|- →

4|--ipv6|-6]

Learn more about the dhcp monitor start command

Command Example

1/1553-CNA 403 2979 Uen AV | 2020-12-07 563

 ENM CLI

dhcp monitor start --client D16Q698821 --ipv4

Command Result

DHCP monitor over IP version 4 started successfully for D16Q6 →

98821.

Results
A DHCP monitor session is started.

2.9.14 Stop DHCP Monitor Session

Prerequisites

— You have DHCP_Administrator or DHCP_Service_Operator role assigned.

— DHCP monitor session is started.

Objective

This tutorial describes the steps required to execute stop DHCP monitor session
command through ENM DHCP CLI commands.

Outline

1. Stop DHCP Monitor Session for All Clients on Selected IP Version

2. Stop DHCP Monitor Session with Specified Client Identifier

Steps

1. Stop DHCP Monitor Session for All Clients on Selected IP Version

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute stop DHCP monitor session for
all clients on selected IP version command:

Command Syntax

dhcp monitor stop [--ipv4|-4|--ipv6|-6]

Learn more about the dhcp monitor stop command

564 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Command Example

dhcp monitor stop --ipv6

Command Result

DHCP monitor over IP version 6 stopped successfully for all V →

6 clients.

Or

2. Stop DHCP Monitor Session with Specified Client Identifier

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute stop DHCP monitor session
with specified client identifier command:

Command Syntax

dhcp monitor stop [--client|-c] <clientIdentifier>

Learn more about the dhcp monitor stop command

Command Example

dhcp monitor stop --client D16Q698821

Command Result

DHCP monitor over IP version 4 stopped successfully for D16Q6 →

98821.

Results
A DHCP monitor session is stopped.

1/1553-CNA 403 2979 Uen AV | 2020-12-07 565

 ENM CLI

2.9.15 Delete DHCP Monitor Message(s)

Prerequisites

— You have DHCP_Administrator or DHCP_Service_Operator role assigned.

— No active monitor session for the client is running.

Objective

This tutorial describes the steps required to execute delete DHCP monitor
message(s) command through ENM DHCP CLI commands.

Outline

1. Delete DHCP Monitor Message(s)

Steps

1. Delete DHCP Monitor Message(s)

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute delete DHCP monitor
message(s) command:

Command Syntax

dhcp monitor delete [--client|-c] <clientIdentifier>

Learn more about the dhcp monitor delete command

Command Example

dhcp monitor delete --client D16Q698822

Command Result

566 1/1553-CNA 403 2979 Uen AV | 2020-12-07

 Command Sets

Results
DHCP monitor message(s) for the specified client is deleted.

2.9.16 View DHCP Monitor Session(s) and Message(s)

Prerequisites

You have DHCP_Administrator, DHCP_Service_Operator or DHCP_Operator role

assigned.
Objective

This tutorial describes the steps required to execute view DHCP monitor
command through ENM DHCP CLI commands.

Outline

1. View DHCP Monitor Session(s)

2. View DHCP Monitor Message(s)

3. View DHCP Monitor Message(s) with Specified Client Identifier

Steps

1. View DHCP Monitor Session(s)

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute view DHCP monitor session(s)
command:

Command Syntax

dhcp monitor view --session [--active]

1/1553-CNA 403 2979 Uen AV | 2020-12-07 567

 ENM CLI

Learn more about the dhcp monitor view command

Command Example

dhcp monitor view --session --active

Command Result

Or

2. View DHCP Monitor Message(s)

a. Launch [unresolved external reference] (CLI).

b. Enter the following command to execute view DHCP monitor
message(s) command:

Command Syntax

dhcp monitor view

Learn more a