Ericsson Command-Line Interface

USER GUIDE

8/1553-CXA 118 03/5 Uen A

Copyright

© Ericsson AB 2016-2018. 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.

Abstract

This document describes the basic usage of the Ericsson Command-Line Interface
(ECLI) for an operator.

8/1553-CXA 118 03/5 Uen A | 2018-01-22

 Contents

Contents

1 General 1
1.1 Revision Information 1
1.2 Concepts 1
1.3 Scope 1
1.4 Introduction 1

2 How to Use 3
2.1 ECLI Basic Aspects 3
2.2 AXE Operations using ECLI 10
2.3 Support Functions 57
2.4 Action on Alarms 84

3 Configuration 85

Glossary 87

Reference List 89

8/1553-CXA 118 03/5 Uen A | 2018-01-22

Ericsson Command-Line Interface

8/1553-CXA 118 03/5 Uen A | 2018-01-22

 General

1 General

1.1 Revision Information

Changes in APG43L 3.5

Other than editorial changes, this document has been revised as follows:
— 8/1553-CXA 118 03/5 Uen
• Rev. A
— Document number changed from 8/1553-CXA 118 03/4 Uen.
— Updated printouts in Section 2.2.4.7 on page 19.
— Updated printouts of Example 11 in Section 2.3.2 on page 58.

Changes in APG43L 3.4

Other than editorial changes, this document has been revised as follows:
— 8/1553-CXA 118 03/4 Uen
• Rev. B
— Updated printouts of examples 2-6 in Section 2.2.4 on page 14 and
printouts of examples 1-10 in Section 2.2.9 on page 49.
• Rev. A
— Document number changed from 8/1553-CXA 118 03/3 Uen.
— Added Section 2.2.9 on page 49 for multiple user configure sessions.

1.2 Concepts
This document assumes the user is familiar with the concepts described in User
Guide Managed Object Model.

Root Position The Root Position is the highest part of the whole tree
of Managed Objects (MOs). It contains one instance of
Managed Object Class (MOC) ManagedElement.

1.3 Scope
The scope of this document is to describe how to use the ECLI to operate AXE
nodes with APG43L.

1.4 Introduction
The ECLI is a terminal-based CLI, which allows monitoring and managing an AXE
based Managed Element (ME). It is based on industry de-facto standard patterns
to make it easy to learn how to manage a system.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 1

 Ericsson Command-Line Interface

The ECLI enables interacting the ME through common, generic-purpose

commands aiming to operate on the instance model of Managed Object Model
(MOM) AXE; refer to User Guide Managed Object Model for more information
on instance model and model items.

This document describes the ECLI and focuses on its usage with APG43L.

2 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

2 How to Use

2.1 ECLI Basic Aspects

The following chapters describe the most important aspects and concepts needed
to do configuration management using ECLI. The ECLI is available on APG43L by
opening an AP session.

Refer to User Guide How to Access an AXE for details.

Users opening an AP session are implicitly opening an ECLI session.

Disconnecting from the AP session is implicitly closing the ECLI session.

Consequently in the remainder of this document, the term ECLI session is replaced
by the term AP session.

In addition to the ECLI commands, the AP session supports a set of AP commands

which can be used to display or change the APG configuration; anyhow both ECLI
and AP commands are generally called as AP commands. This document focuses
only on the ECLI for interaction with the MOM.

For a rapid and correct usage of ECLI, the user should have as reference also
the official CPI documentation (Alex library) that shows all items, MOCs, MOs,
attributes, actions, etc., part of the MOM AXE in HTML format.

2.1.1 ECLI Modes

The ECLI supports two modes:

Exec Mode For displaying information, navigating MOs and executing

actions.

Config Mode For configuring MOs that means create or delete MOs,
change attribute values and execute actions.

Change between the two modes is possible with commands:

— configure to enter Config Mode.

— end to exit Config Mode and get back to Exec Mode.

The default mode after opening an AP session is the Exec Mode.

The required mode for APG43L configuration is the Config Mode.

The ECLI prompt changes according to the selected ECLI mode.

In Exec Mode, the prompt is ">".

8/1553-CXA 118 03/5 Uen A | 2018-01-22 3

 Ericsson Command-Line Interface

When configure command is given, the prompt changes to:

(config)>

While navigating to a MO (see Section 2.2.3 on page 10), the prompt changes to:

(config-<RDN>)>

2.1.2 ECLI Commands

The ECLI supports a number of ECLI commands, mainly to:

— Display ECLI version

— Navigate through the structure of MOs

— List MOs, their attributes and attribute values

— Create new MOs

— Set or change the values of MO attributes

— Delete existing MOs

— Execute actions on MOs

— Offer support in using the CLI

Many ECLI commands are context-based and have an effect depending on the
current ECLI position or actual MO position. See also Section 2.1.4 on page 5.

All commands and the MOM items inside an AP session are subject to access
control via authorization. Each user only has access to those commands and
MOM items that are authorized by associated role. For details refer to User Guide
User Management.

2.1.3 ECLI Version

The ECLI version is described using three sequence numbers:<major>.<mino

r>.<revision>:

— The major number is incremented when a significant and non-backward

compatible change is made, for instance, when a command is deleted, or
when the syntax or behavior of a command is changed.

— The minor number is incremented when a significant but backward

compatible change is made, for instance, when a new command is added or
when new options are added to an existing command.

— The revision number is incremented when a minor change that does not
affect the described behavior is made, for instance, when a fault that made a
documented function unusable is corrected.

4 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

The version number is meant to inform CLI users, including scripts and programs,
about what behavior to expect from the ECLI commands. Usability enhancing
features, like auto-completion and help, are not considered in the version number.

The ECLI version is displayed using version command; see Section 2.2.2 on page
10 for more details.

2.1.4 ECLI Position and Navigation

The ECLI is an interface to configure and list MOs and their attributes. It provides
access to the whole tree of MOs belonging to the ME that represents the node.

The ECLI supports operations on the MOs in absolute and in context-based

fashion. The ECLI allows navigating through the MOs by using Distinguished
Name (DN), and saves the current position.

After navigation to a specific MO, further operations can be expressed in a relative

context-based manner from that position.

After opening an AP session the ECLI position is at Root Position.

Navigation by changing the ECLI position is possible both in Exec Mode and in
Config Mode.

After entering Config Mode, the ECLI is at the same position as in Exec Mode.

It can be changed by navigation operations:

— Navigate by specifying the complete DN or MOC/MO using command dn.

— Navigate by specifying the RDN to an existing MO from the currently selected

MO (current ECLI position).

— Navigate one level up in the tree by using command up or ..

— Navigate back to the Root Position by using command top.

— Navigates back to the previous position in the MO tree by using command

back.

After navigating to a particular MO, most ECLI commands are used in a

context-based manner, omitting specification of the DN to MOs attributes and
actions and using relative DN instead.

Section 2.2.3 on page 10 describes in detail how to navigate through the MOs.

2.1.5 Show Managed Objects, Attributes and Actions

The ECLI can display MOs, their attributes and attribute values, actions and
contained other MOs.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 5

 Ericsson Command-Line Interface

To display this information, command show and ? are used.

Chapter 2.2.4 describes in detail how to display different levels of data.

The show and ? commands can be used both in Exec Mode and Config Mode.

2.1.6 Transactions
The configuration of the APG43L can be changed by the following operations:

— Create new MOs.

— Set or modify values of MO attributes.

— Delete existing MOs.

These operations are always performed in an atomic way in so-called transactions.

Transactions allow preparation of a sequence of MO changes as listed above

without actually applying them immediately.

They are instead collected and then applied all at once in an atomic way when
the transaction is committed.

If the transaction commitment fails or if it is aborted, the prepared changes are all
discarded and none take effect.

In this way, transactions secure consistency of the MOs.

A transaction is implicitly started by entering the Config Mode.

The user can then initiate changes to attribute values and create or delete MOs.

The changes done in this way can fail due to an interference in multiple user
configure sessions which is further explained in Section 2.2.9 on page 49.

The changes done in this way do not take effect before the transaction is
committed, using command commit.

Command commit validates the transaction and, on success, commits the changes
and return to Exec Mode keeping the current ECLI position. Command commit
with the -s or --stay argument validates the transaction and, on success,
commits the changes and starts a new transaction. The ECLI mode is unchanged.

Committing can fail due to various reasons which are further explained in later
chapters. In this case, all changes prepared within the current transaction are lost,
ECLI mode remains in Config Mode and a new transaction is started.

Transactions can be aborted using command abort. This results in termination of

the current transaction without applying any changes to the real configuration,
returning to Exec Mode keeping the current ECLI position.

6 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Command abort with -s or --stay arguments abort the changes remaining in

Config Mode and a new transaction is started.

In case of no transactional changes, command end changes the ECLI mode from
Config Mode to Exec Mode with the same ECLI position. In case of transactional
changes, command end gives an error message and it is required to use either
commit or abort to leave the Config Mode.

Transactions are automatically aborting one hour after being started. The effect
is similar to command abort.

It is recommended to keep the session concise which means to save the changes
via commit at regular intervals.

Command exit closes the AP session. This command is valid in the Exec Mode
only.

Below is the figure describing the possible states of a transaction:

Figure 1 ECLI State Machine

Note: When any changes are committed with the command commit the alarm
APG BACKUP NOT CREATED is raised. See Section 2.4.1 on page 84
for details.

2.1.7 Actions

MOs can contain actions that allow invoking multiple operations on objects.

Depending on the action, this can result in a sequence of changes of the MO

attribute values.

Actions on MOs can be executed both in Exec Mode and Config Mode.

In general, actions are atomic and do not need any explicit commitment but there
is one exception that is the action that removes a file.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 7

 Ericsson Command-Line Interface

Actions can be classified into two categories for example synchronous actions and
asynchronous actions.

For details see Section 2.2.8 on page 44.

Like transactions, also actions can fail for various reasons. Such failures are
indicated by error messages.

2.1.8 Authorization
All MOM items and ECLI commands are subject of authorization and access
control.

Refer to User Guide User Management for further details on this subject.

If a ECLI user has no permission to access a MO, an attribute, an action, a ECLI

command then operation behave like in case of a non-existing item.

2.1.9 ECLI Error Handling

The AP session provides different levels of error handling for all MOM operations
and AP commands.

The conditions for successful operations and commands execution are checked
in multiple steps:

— The user has the proper authorization.

— The operation complies with ECLI syntax rules.

— The operation complies with the constraints defined in the MOM.

— The operation complies with semantic rules, that is, the system state must be
valid after the operation completion.

— Error messages have a generic part and in some cases also the specific part.

If the MOM operation and command completes with success, no printout is

provided.

If the operation fails, an error message is displayed.

The specific error messages for each MOM operation and ECLI command are
shown in the relevant chapter in this document.

2.1.10 ECLI Help

The AP session supports the user with context-sensitive help on all the available
MOM operations and ECLI commands.

8 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

ECLI Help is context-sensitive and depends on

— The current ECLI mode (Exec Mode or Config Mode).

— The current ECLI position.

— The completely typed MOM operation and ECLI command.

Four different types of help is provided:

— Static Help. For further details see Section 2.3.1 on page 58.

— Brief Help. For further details see Section 2.3.2 on page 58.

— Verbose Help. For further details see Section 2.3.3 on page 60.

— Information Model Help. For further details see Section 2.3.4 on page 61.

2.1.11 ECLI Auto-Completion

The ECLI supports entering operations by an auto-completion functions which

can be accessed at any time.

Auto-completion either shows all possible continuations of an already typed

operation fragment, or automatically completes the operation fragment if there
is only one possibility.

See Section 2.3.5 on page 64 for further details.

2.1.12 ECLI Escaping of Special Characters

The ECLI supports the US-ASCII character set. In both input and output strings,
escape sequences are used to represent non-printable characters, non-US-ASCII
and characters with a special meaning in the ECLI.

See Section 2.3.7 on page 72 for further details.

2.1.13 ECLI Comments

It is possible to include comments in ECLI input. The comment delimiter # and

the rest of the input line on which it appears is considered as comment and is
discarded before the line is executed. An input line that only consists of a comment
is ignored, as if it had been a blank line.

ECLI command completion and context sensitive help cannot be used after the
# character. Pressing the Tab key has no effect, and pressing the ? key will add
the character to the comment.

If a # character is escaped as described in Section 2.1.12 on page 9, or if it appears

inside a quoted string, it is treated as a normal string character.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 9

 Ericsson Command-Line Interface

2.2 AXE Operations using ECLI

The following chapters describe the most common Operation and Maintenance
(OaM) operations performed in the AXE Operational Instructions, mapping each
common formulation to concrete ECLI commands and actions.

2.2.1 Open AP Session

Before any operation can be performed, users need to open an AP session by

connecting to the APG43L.

For details refer to User Guide How to Access an AXE .

After successful authentication, an AP session is started, which implicitly starts a

ECLI session.

The session is initially in Exec Mode at Root Position.

Any further access is determined by the earlier provided user credentials and the
roles associated with the user.

In Exec Mode, the AP session can be closed using command exit, which implicitly
closes the opened ECLI session.

In Config Mode, the AP session can be closed first using command end, then
using command exit.

Multiple sessions can exist at a time. The maximal number of parallel sessions is
256.

2.2.2 Display ECLI Version

Command version displays the ECLI version:
>version
Ericsson CLI 1.4.0
>

2.2.3 Navigation and Addressing

As indicated in Section 2.1.4 on page 5, it is possible to navigate in the MOs tree,
changing the ECLI position.

MOs are addressed by indicating, from ECLI prompt, their DN or RDN.

The DN specifies the absolute full path from the Root Position to an existing MO,
as follows:
ManagedElement=<node_name>, <class_name>=<key_value>,<clas
s_name>=<key_value>...This absolute addressing always starts with
ManagedElement=<node_name>. See an example in Section 2.2.3.1 on page 12.

10 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Also the “actions” belonging to an existing MO can be addressed and executed in

an absolute manner using DN:
ManagedElement=<node_name>,<class_name>=<key_value>,<class_name>=
<key_value>...,<action_name>In similar way, the attributes of an existing MO
can be reached and modified using the absolute path:
ManagedElement=<node_name>, <class_name>=<key_value>,<class_name>=<key_value

Note: To display an attribute value, the show command has to be used. This
command, valid also in Exec Mode, is explained with details in Section
2.2.4 on page 14.

Alternatively, it is possible to change the ECLI position in the MO tree in order to

allow relative addressing using RDN and performing a step-by step navigation. By
entering RDNs, the ECLI position can only be changed to direct or indirect child
MO instances, not to parent MO instances, because RDNs are interpreted relative
to the ECLI position. See an example in Section 2.2.3.2 on page 12.

Faster navigation is possible by using the command dn. See an example in Section
2.2.3.3 on page 13.

Navigation is also possible:

— By typing .. or up, to move the ECLI position to the superior MO in the tree.

For example, to change the current location to the parent MO instance in

Exec Mode:
(SystemFunctions=1)>up
(ManagedElement=<node_name>)>The .. element can be part of the RDN
navigation command, in Exec Mode for example:
(SysM=1)>..,Fm=1
(Fm=1)>
By typing .. or up, to move the ECLI position to the superior MO in the tree.

For example, to change the current location to the parent MO instance in

Config Mode:
(config-SystemFunctions=1)>up
(config-ManagedElement=<node_name>)>The .. element can be part of
the RDN navigation command, in Config Mode for example:
(config-SysM=1)>..,Fm=1
(config-Fm=1)>

— By typing top to change the ECLI Position to the Root Position, in Exec Mode
for example:
(SystemFunctions=1)>top
>And in the Config Mode:
(config-SystemFunctions=1)>top
(config)>

— By typing back to navigate back to the previous location in the MO tree, in

Config Mode for example:
(config-SecM=1)>back

8/1553-CXA 118 03/5 Uen A | 2018-01-22 11

 Ericsson Command-Line Interface

(config-Snmp=1)>

Access to other MOs, attributes or actions via ECLI commands (such as show or
change) are context-sensitive and depend on the ECLI position. Consequently,
navigation simplifies usage of the ECLI commands by removing the need to
always specify a complete DN from the Root Position.

Addressing can then be performed in a relative manner by using RDNs from the
current ECLI position as follows:

<attribute_name> to address an attribute of the current MO

<action_name> to address an action of the current MO

<contained_class_name>=<key_value> to address a contained MO

..,<attribute_name> to address an attribute of the parent MO

To address attributes, actions and further containments of contained classes, use:

<contained_class_name>=<key_value>,<attribute_name>
<contained_class_name>=<key_value>,<action_name>
<contained_class_name>=<key_value>,
<contained_contained_class_name>=<key_value>,[...]

Note: The space behind the comma is always optional. Multiple spaces are
allowed, and DNs can be also specified without spaces between the
key-value pairs and the commas.

2.2.3.1 Example - DN Usage

This example shows how to address the MO named as NbiFoldersM using DN

in Exec Mode:
>ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHandling
(NbiFoldersM=1)>

The same applies in Config Mode.

2.2.3.2 Example - Step by Step

This example shows how to address an MO named as ElectronicKey using RDN,

navigating step by step in Exec Mode:
>ManagedElement=<node_name>
(ManagedElement=<node_name>)>SystemFunctions=1
(SystemFunctions=1)>AxeFunctions=1
(AxeFunctions=1)>Sy
SystemComponentHandling=1
SystemHandling=1
(AxeFunctions=1)>SystemHandling=1
(SystemHandling=1)>LicenseM=1
(LicenseM=1)>
(LicenseM=1)>ElectronicKey=

12 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

CXC4011121/0003
CXC4011121/0004
CXC4011121/0013
CXC4011121/110
CXC4011121/200
CXC4011121/201
CXC4011121/202
CXC4011121/203
CXC4011121/204
(LicenseM=1)>ElectronicKey=CXC4011121/2
CXC4011121/200
CXC4011121/201
CXC4011121/202
CXC4011121/203
CXC4011121/204
(LicenseM=1)>ElectronicKey=CXC4011121/200
(ElectronicKey=CXC4011121/200)>The same applies in Config Mode.

After this navigation, all further navigation and addressing operations are
context-based from this MO.

2.2.3.3 Example - Command dn

The command dn allows to navigate the MO tree in a very fast way; see Section
2.3.8 on page 74 for a detailed description of all available command options.

The command can be used to reach a specified DN from whatever ECLI position
by specifying the related DN. For example:

(Snmp=1)dn ManagedElement=<node_name>,SystemFunctions=1,SecM=1
(SecM=1)>

Or it can be used to reach a unique existing instance of a MOC, by using the option
-m | --moc, like shown into below example in Config Mode (same applies in
Exec Mode):
(config)>dn --moc SwM
ManagedElement=<node_name>,SystemFunctions=1,SwM=1
(config-SwM=1)>
In case there are more than one instance of an existing MOC the error message
ERROR: Multiple MO instances found: is printed and all MOs instances are
listed:
>dn -m MessageStore
ERROR: Multiple MO instances found:
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHand

8/1553-CXA 118 03/5 Uen A | 2018-01-22 13

 Ericsson Command-Line Interface

>The option -c |--condition can be also used to define selection criteria on the
base of a specific attribute value. For example:
>dn -m MessageStore -c messageStoreName="CHS"
ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,DataOutputHandling=
(MessageStore=CHS)>

2.2.4 Print, List or Display

A common operation when performing OaM activities on AXE via AP session is
to display MOs and attributes.

The AXE Operational Instructions usually refer to these operations as follows:

Print/List/Display all objects and attributes in MO <MOC_Name>=<key_value>.

ECLI command show is used to list or display MOs and attributes.

The command works context-based and therefore depends on the current ECLI
position.

The command can be used both in Exec Mode and in Config Mode. If used in Exec
Mode, the DN from the Root Position needs to be specified.

Different variants of show commands are mentioned below which are used for
displaying the MOs and their attributes:

1. A single MO can be displayed by show [--verbose|-v][RDN].

2. A single MO and its child MOs can be displayed by

show -r [--verbose|-v][RDN] or
show --recursive --verbose|-v][RDN].

3. One single valued attribute can be displayed by

show [--verbose|-v][RDN,] <attribute_name>.

Note: Without options, only those attributes are displayed that have a value
assigned and not a default value.

4. Command show-config displays the output in configuration format.

show-config also automatically enables the all parameter.

5. Attributes defined as structure can be displayed by

show[--recursive|-r ][--verbose|-v][RDN,]<attribute_name>

6. Structure members can be displayed by

show [--recursive|-r ][--verbose|-v][RDN,]
<attribute_name>,<structure_member_name>

7. Command show-mib displays the list of instance information without their

contents.

It displays MO instance name recursively.

14 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Syntax : show-mib [-v|--verbose] [DN]

8. Command show-dn displays the current location in the MOM.

9. Command show-table displays the show verbose information without

metadata in the table format. When using the –r | --recursive parameter,
a recursive search is done for the MO class. See Section 2.3.8 on page 74 for a
detailed description of all available command options.

10. Command show [-v] [<DN>],<noKeyStructSequence> displays verbose

information for all the elements of a keyless structure multivalue.

11. Command show [-v] [<DN>],<noKeyStructSequence>[@<N>] displays

verbose information for the nth-element of a keyless structure multivalue.

12. A single attribute in an unique MO can be displayed by show [-m|--moc]

<MOC_Name> [-p|--property] <attribute_name> .

According to the concepts of Navigation and Addressing described in 2.2.2, the

operation can be performed in different ways:

— By using absolute addressing and specifying the complete DN of the target

MO as <MO_RDN>, starting with ManagedElement=<node_name>.

— By navigating to the target MO and using show [--verbose|-v][RDN,]<att

ribute_name>. omitting <MO_RDN>.

— By using relative addressing from any current ECLI position to the target MO,
specifying <MO_RDN> as RDN from that current ECLI position.

2.2.4.1 Summary on Displayed MO Properties

A summary on the elements displayed by different display options is provided in

Table 1.

Table 1 Show MO Instance Matrix

Model Proper show <RDN> show --recu show-config show --ver show-config
ty rsive <RDN> <RDN> bose <RDN> --verbose
or show -r or show -v <RDN> or
<RDN> <RDN> show-config
-v <RDN>
System Yes Yes Yes Yes Yes
created child
MOs
Child MOs No Yes Yes No Yes
recursively

8/1553-CXA 118 03/5 Uen A | 2018-01-22 15

 Ericsson Command-Line Interface

Table 1 Show MO Instance Matrix

Model Proper show <RDN> show --recu show-config show --ver show-config
ty rsive <RDN> <RDN> bose <RDN> --verbose
or show -r or show -v <RDN> or
<RDN> <RDN> show-config
-v <RDN>
Read-write Yes Yes Yes Yes Yes
attribute with
value that is
not defaultV
alue
Read-only Yes Yes No Yes No
or restricted
attribute with
value that is
not defaultV
alue
(1)
Restricted No No No Yes No
attribute with
value that is
not defaultV
alue
Attribute with No No No Yes Yes
value equal to
defaultValu
e
Attributes No No No Yes Yes
without
(2)
value
Action names No No No No No
(1) This is present in the show attribute printout.
(2) That is, optional or nillable attributes with no values assigned

The command is atomic and does not include non-committed changes in other
transactions.

Newly created and not yet committed MOs are displayed by show in general, but
not with the show-config parameter. In this case show-config returns error
message ERROR: Show configuration not valid during provisioning of
new object or structure.

2.2.4.2 Example 1

This example lists the output of command show for a single valued attribute.
Example 1
>show ManagedElement=tp218ap1,userLabel
userLabel=[]

16 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

>

2.2.4.3 Example 2

This example lists the output of command show for the MO BrmBackupManage
r=SYSTEM_DATA.
(BrM=1)>show BrmBackupManager=SYSTEM_DATA
BrmBackupManager=SYSTEM_DATA
autoExportUri=""
backupDomain="BRM_SYSTEM_DATA"
backupType="BRM_SYSTEM_DATA"
progressReport
actionId=0
actionName="CREATE"
additionalInfo
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Init
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Succ
progressInfo=""
progressPercentage=100
result=SUCCESS
resultInfo="tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55 was created suc
state=FINISHED
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"
timeOfLastStatusUpdate="2017-10-09T05-26-02"
BrmBackup=tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55
BrmFailsafeBackup=SYSTEM_DATA

2.2.4.4 Example 3

This example lists the output of command show for the MO BrM=1,BrmBackupMa
nager=SYSTEM_DATA.
(SystemFunctions=1)>show BrM=1,BrmBackupManager=SYSTEM_DATA
BrmBackupManager=SYSTEM_DATA
autoExportUri=""
backupDomain="BRM_SYSTEM_DATA"
backupType="BRM_SYSTEM_DATA"
progressReport
actionId=0
actionName="CREATE"
additionalInfo
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Init
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Succ
progressInfo=""
progressPercentage=100
result=SUCCESS
resultInfo="tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55 was created suc
state=FINISHED
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"

8/1553-CXA 118 03/5 Uen A | 2018-01-22 17

 Ericsson Command-Line Interface

timeOfLastStatusUpdate="2017-10-09T05-26-02"
BrmBackup=tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55
BrmFailsafeBackup=SYSTEM_DATA

2.2.4.5 Example 4

This example lists the output of command show -v for the MO

BrmBackupManager=SYSTEM_DATA.
(BrM=1)>show -v BrmBackupManager=SYSTEM_DATA
BrmBackupManager=SYSTEM_DATA
autoExport=DISABLED <default>
autoExportPassword=[] <empty>
autoExportUri=""
backupDomain="BRM_SYSTEM_DATA" <read-only>
backupType="BRM_SYSTEM_DATA" <read-only>
brmBackupManagerId="SYSTEM_DATA"
asyncActionProgress=[] <empty> <read-only> <deprecated>
progressReport <read-only>
actionId=0 <read-only>
actionName="CREATE" <read-only>
additionalInfo <read-only>
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Initial
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Succeed
progressInfo="" <read-only>
progressPercentage=100 <read-only>
result=SUCCESS <read-only>
resultInfo="tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55 was created succes
state=FINISHED <read-only>
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"
timeOfLastStatusUpdate="2017-10-09T05-26-02" <read-only>
BrmBackup=tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55
BrmFailsafeBackup=SYSTEM_DATA

2.2.4.6 Example 5

This example lists the output of command show -r from an MO named as

BrmBackupManager=SYSTEM_DATA.
(BrM=1)>show -r BrmBackupManager=SYSTEM_DATA
BrmBackupManager=SYSTEM_DATA
autoExportUri=""
backupDomain="BRM_SYSTEM_DATA"
backupType="BRM_SYSTEM_DATA"
progressReport
actionId=0
actionName="CREATE"
additionalInfo
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Initial
"Create Backup for tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55: Succeed
progressInfo=""

18 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

progressPercentage=100
result=SUCCESS
resultInfo="tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55 was created suc
state=FINISHED
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"
timeOfLastStatusUpdate="2017-10-09T05-26-02"
BrmBackup=tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55
backupName="tp218ap1-43L-3_4_0-R5A-2017-10-09T05-24-55"
creationTime="2017-10-09T05:32:41"
status=BRM_BACKUP_COMPLETE
progressReport
actionId=99
actionName=""
progressInfo=""
progressPercentage=0
result=NOT_AVAILABLE
resultInfo=""
state=FINISHED
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"
timeOfLastStatusUpdate="2017-10-09T05-26-02"
swVersion
description="APG43L SW Version"
productionDate="09-21-2017"
productName="APG43L"
productNumber="3.4.0"
productRevision="R5A"
type=""
BrmFailsafeBackup=SYSTEM_DATA
backupName=""
timeRemaining=1200
usageState=IDLE
progressReport
actionId=99
actionName=""
progressInfo=""
progressPercentage=0
result=NOT_AVAILABLE
resultInfo=""
state=FINISHED
timeActionCompleted="2017-10-09T05-26-02"
timeActionStarted="2017-10-09T05-24-55"
timeOfLastStatusUpdate="2017-10-09T05-26-02"
(BrM=1)>

2.2.4.7 Example 6

This example lists the output of command show-table to show information about
all instances of MOC SwVersion, the -s or --sort option parameter is provided

8/1553-CXA 118 03/5 Uen A | 2018-01-22 19

 Ericsson Command-Line Interface

in order to sort MO instances according to their instance names. The command is

launched from MO SwInventory=1, that is the parent of SwVersion MOs .
(config-SwInventory=1)>show-table -m SwVersion -s
===============================================================================
| swVersionId | userLabel | timeOfInstallation | timeOfActivation |
===============================================================================
| APG43L-3.5.0-R6A02 | | 2017-12-21T18:39:36 | 2017-12-21T18:39:36 |
===============================================================================
(config-SwInventory=1)>This example lists the output of command
show-table to show information about all instances of MOC SwVersion. The
command is launched from MO SystemFunctions=1 that has no SwVersion MO
direct children.
(config-SystemFunctions=1)>show-table -m SwVersion -s
ERROR: Class SwVersion is not a direct child of SystemFunctions. Add the -r/--r
(config-SystemFunctions=1)>This example lists the output of the above
command adding the -r | --recursive option to perform a recursive search for
the MOC. The command is launched from MO SystemFunctions=1.
(config-SystemFunctions=1)>show-table -m SwVersion -s -r
ManagedElement=tp140ap1,SystemFunctions=1,SwInventory=1
===============================================================================
| swVersionId | userLabel | timeOfInstallation | timeOfActivation |
===============================================================================
| APG43L-3.5.0-R6A02 | | 2017-12-21T18:39:36 | 2017-12-21T18:39:36 |
===============================================================================
(config-SystemFunctions=1)>

2.2.4.8 Example 7

This example shows the usage of the show-dn command.

(SwM=1)>show-dn
ManagedElement=<node_name>,SystemFunctions=1,SwM=1
(SwM=1)>

2.2.4.9 Example 8

This example shows the usage of the show command with the option -m and -p to
show an attribute of an unique MOC.

(SystemFunctions=1)>show -m MmlAuthorizationM -r -p mmlAuthorizationMId

ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,SecurityHandling=1,
mmlAuthorizationMId="1"
(SystemFunctions=1)>

2.2.4.10 Error Indication when Displaying MO Information

If a command that displays information from multiple MO instances fails to

retrieve information from a certain MO instance, or group of MO instances, an
error message is displayed. Then, the command continues to display information

20 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

from the following MO instances, if any. After the last MO instance has been
displayed, an final error message is also displayed.

The error messages are always displayed left aligned, independent of how deep
in the MO hierarchy the affected MO instance is. The example below shows how
the error messages from show command is displayed.
(SysM=1)>show -m Schema
ManagedElement=<node_name>,SystemFunctions=1,SysM=1,Schema=ECIM_CommonLibrary
baseModelIdentifier="ECIM_CommonLibrary"
baseModelVersion="1.2"
identifier="ECIM_CommonLibrary"
version="1.2"
ManagedElement=<node_name>,SystemFunctions=1,SysM=1,Schema=ComTop
ERROR: Failed to get attribute value(s) for ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,
Schema=ComTop
ManagedElement=<node_name>,SystemFunctions=1,SysM=1,Schema=ComSecM
baseModelIdentifier="ECIM_Security_Management"
baseModelVersion="2.0"
identifier="ComSecM"
version="11.0.1"
ManagedElement=<node_name>,SystemFunctions=1,SysM=1,Schema=ComLocalAuthorization
ERROR: Failed to get attribute value(s) for ManagedElement=NODE06ST,SystemFunctions=1,SysM=1,
Schema=ComLocalAuthorization
ManagedElement=<node_name>,SystemFunctions=1,SysM=1,Schema=ComLdapAuthentication
baseModelIdentifier="ECIM_LDAP_Authentication"
baseModelVersion="2.0"
identifier="ComLdapAuthentication"
version="11.0.0"
ERROR: Failed to read instances of class Schema under ManagedElement=1,SystemFunctions=1,SysM=1
ERROR: Failed to retrieve all requested information
(SysM=1)>

The show-table command is an exception. It always displays any error messages

after the table. See below example.
(BrM=1)>show-table -m BrmBackupManager
=============================================================================
| brmBackupManagerId | backupType | backupDomain | manualBackupName |
=============================================================================
| SYSTEM_DATA | BRM_SYSTEM_DATA | BRM_SYSTEM_DATA | |
=============================================================================
ERROR: Failed to get attribute value(s) fo ManagedElement=<node_name>,SystemFunctions=1,BrM=1,BrmBackupManager=SYS
ERROR: Failed to read instances of class manualBackupName under ManagedElement=<node_name>,SystemFunctions=1,BrM=1
ERROR: Failed to retrieve all requested information
(BrM=1)>

2.2.5 Set, Modify or Change

This chapter describes how to perform the common operation to set, modify or
change attributes of a MO.

The AXE Operational Instructions usually refer to these operations as follows:

— “Modify the attributes of MO <MOC_Name> and commit the changes.”

— "Set the attribute <attribute_name> under MO <MOC_Name> and commit

the change.”

— "Set the attribute <attribute_name> to <attribute_value> under MO

<MOC_Name> and commit the change.”

MO attributes can be changed in Config Mode only.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 21

 Ericsson Command-Line Interface

If the changes are entered without error, that is, no error printout is provided, then
the change is added to the transaction. Multiple attributes can be set or changed
within the same transaction.

To do that such changes can be performed before committing.

The changes are applied after successful commit of the transaction (read more
about transactions in chapter 2.1.5) .

Following data types attribute are considered:

— Single-valued attribute.

— Single-valued attribute value deletion.

— Sequence.

— Structure (or briefly called struct).

— Passwords.

— MO reference.

2.2.5.1 Changing Single-valued Attribute:

Changing of a single-valued attribute is performed by

[<RDN>, ]<attribute_name>=<attribute_value>As a result, if no printout is
provided, the operation is verified against the data type specific rules defined in
the model, and the attribute change is added to the transaction.

An error printout is displayed if the operation fails, model specific error information
can be shown as well. See table at the end of this chapter for a summary of errors
on setting attribute values.

The changes are applied after the commit operation.

Note: If commit fails for any reason, all attribute values entered during the failed
transaction are discarded. Consequently, the instructions in this chapter
need to be repeated to change the attributes.

The input syntax for the attribute data types is identical to the printout syntax as
described in 2.2.3, with the following exceptions:

— Strings can be entered with or without double quotation marks (”). A string
including characters with a special meaning in the ECLI ([ ,=[]"]) must be
entered with quotation marks.

— Booleans are interpreted in case-insensitive way (for example, "TRUE", "true",

and "True") but are displayed in lower case.

The table below shows possible error messages when setting a single-valued
attribute.

22 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Table 2 Error messages when setting a single-valued attribute

Error Message Semantics Data Type
ERROR: String too The string length of the String
short: new value is below the
minimal length defined
<attribute_name>="<n for the attribute.
ew_value>"
ERROR: String too The string length of the String
long: new value exceeds the
maximal length defined
<attribute_name>="<n for the attribute.
ew_value>"
ERROR: Invalid The string content does String
derived-str regex: not match the regular
expression defined for
<attribute_name> =~ the attribute.
"<regular_expression
>"
ERROR: Mandatory The mandatory attribute Any Data Type
attribute <attrib must be set or needs to
ute_name> does not have a default value.
have default value,
must navigate to This message is shown
containing object after the commit
before reset. operation and indicates
unsuccessful commit.
ERROR: Unmatched Unmatched derived String
derived-string string.
(expects "<regula
r-expression>"):
<attribute_name> =
<attribute_value>
ERROR: No set The user has read Any Data Type
permission for permission but not
<DN_or_attribute> change permission.
ERROR: Command not The user has neither read Any Data Type
found permission nor change
permission.
ERROR: Invalid The specified value is out int8, int16, int32, int64,
argument, expected of range for the specific uint8, uint16, uint32,
[<min>, <max>] integer type. uint64

8/1553-CXA 118 03/5 Uen A | 2018-01-22 23

 Ericsson Command-Line Interface

ERROR: Attribute The attribute is read only Any Data Type

'<attribute_name>' and cannot be changed.
is read-only.
ERROR: Attribute The attribute is a key String
'<attribute_name> is attribute and cannot be
a key attribute. changed.

2.2.5.1.1 Example

This example lists the fully structure of MOC item BrmBackupManager.

(BrmBackupManager=SYSTEM_DATA)>show --verbose
BrmBackupManager=SYSTEM_DATA
backupDomain="BRM_SYSTEM_DATA" <read-only>
backupType="BRM_SYSTEM_DATA" <read-only>
brmBackupManagerId="SYSTEM_DATA"
manualBackupName=""
asyncActionProgress=[] <empty> <read-only> <deprecated>
progressReport <read-only>
actionId=99 <read-only>
actionName="" <read-only>
additionalInfo=[] <empty> <read-only>
progressInfo="" <read-only>
progressPercentage=0 <read-only>
result=NOT_AVAILABLE <read-only>
resultInfo="" <read-only>
state=FINISHED <read-only>
timeActionCompleted="1970-01-01T06:00:00" <read-only>
timeActionStarted="1970-01-01T06:00:00" <read-only>
timeOfLastStatusUpdate="1970-01-01T06:00:00" <read-only>
BrmBackupHousekeeping=SYSTEM_DATA
BrmBackupScheduler=SYSTEM_DATA
BrmFailsafeBackup=SYSTEM_DATA
(BrmBackupManager=SYSTEM_DATA)>

2.2.5.1.2 Example

This example lists an unsuccessful transaction as the attribute named as

backupDomain, is a read-only attribute.
(config-BrmBackupManager=SYSTEM_DATA)>show --verbose
BrmBackupManager=SYSTEM_DATA
backupDomain="BRM_SYSTEM_DATA" <read-only>
backupType="BRM_SYSTEM_DATA" <read-only>
brmBackupManagerId="SYSTEM_DATA"
manualBackupName=""
asyncActionProgress=[] <empty> <read-only> <deprecated>
progressReport <read-only>
actionId=99 <read-only>
actionName="" <read-only>
additionalInfo=[] <empty> <read-only>

24 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

progressInfo="" <read-only>
progressPercentage=0 <read-only>
result=NOT_AVAILABLE <read-only>
resultInfo="" <read-only>
state=FINISHED <read-only>
timeActionCompleted="1970-01-01T06:00:00" <read-only>
timeActionStarted="1970-01-01T06:00:00" <read-only>
timeOfLastStatusUpdate="1970-01-01T06:00:00" <read-only>
BrmBackupHousekeeping=SYSTEM_DATA
BrmBackupScheduler=SYSTEM_DATA
BrmFailsafeBackup=SYSTEM_DATA
(config-BrmBackupManager=SYSTEM_DATA)>
(config-BrmBackupManager=SYSTEM_DATA)>backupDomain=Domain01
ERROR: Attribute 'backupDomain' is read-only.
(config-BrmBackupManager=SYSTEM_DATA)>

2.2.5.1.3 Example

This example lists an unsuccessful transaction for changing an attribute named as

logicalMgmtId, as it a key attribute.
>show
ManagedElement=<node_name>
>dn ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,SystemCompon
(config-LogicalMgmt=1)>logicalMgmtId="2"
ERROR: Attribute 'logicalMgmtId' is a key attribute.

2.2.5.2 Changing Single-valued Attribute by Deletion

Deleting an attribute value is performed by no [<RDN>,]<attribute_name>

After deletion, the attribute is treated as not set. If an attribute with a default
value is deleted, the attribute becomes empty.

The table below shows possible error messages when setting a single-valued
attribute.

Table 3 Error messages when setting a single-valued attribute

Error Message Semantics
ERROR: Attribute <attribute_ A read-only attribute cannot be
name> is read-only (can't be deleted.
deleted).

8/1553-CXA 118 03/5 Uen A | 2018-01-22 25

 Ericsson Command-Line Interface

ERROR: Delete only works A delete operation can be performed

for attribute and object only on attributes and object types.
types, type unrecognized for
("<unknownType>")
ERROR: Attribute '<attribute_ A mandatory attribute cannot be
name>' is mandatory (can't be deleted.
deleted).

2.2.5.2.1 Example

This example lists the successful deletion of a single-valued attribute named

userlabel.
(config-ManagedElement=<node_name>)>show
ManagedElement=<node_name>
networkManagedElementId="<node_name>"
userLabel="xyz"
SystemFunctions=1
Transport=1
(config-ManagedElement=<node_name>)>no userLabel
(config-ManagedElement=<node_name>)>commit -s
(config-ManagedElement=<node_name>)>show
ManagedElement=<node_name>
networkManagedElementId="<node_name>"
SystemFunctions=1
Transport=1
(config-ManagedElement=<node_name>)>show userLabel
userLabel=[]
(config-ManagedElement=<node_name>)>

2.2.5.2.2 Example

This example lists the unsuccessful deletion of an attribute named SystemType as

the attribute is read-only.
(config-AxeFunctions=1)>show -v
AxeFunctions=1
ap=AP1 <default> <read-only>
apgOamAccess=FRONTCABLE <default> <read-only>
apgShelfArchitecture=SCX <read-only>
axeApplication=BSC <read-only>
axeFunctionsId="1"
systemType=SINGLE_CP_SYSTEM <read-only>
DataOutputHandling=1
SecurityHandling=1
SupervisionHandling=1
SystemComponentHandling=1
SystemHandling=1"
(config-AxeFunctions=1)>no SystemType
ERROR: Attribute 'systemType' is read-only (can't be deleted).
(config-AxeFunctions=1)>

26 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

2.2.5.3 Changing Attributes defined as Sequence

Note: The large brackets [ ] in the code printouts below have to be specified
in the command, and do not have the usual special meaning of optional
arguments.

Initializing a sequence is performed by

[<RDN>, ]<sequence_name>=[<sequenceElement1>,<sequenceElement2>,...]

Adding an element to the end of an initialized sequence is performed by

[<RDN>, ]<sequence_name>=<additionalElement>
or
[<RDN>, ]<sequence_name>'['@<index>']'=<new_value>
where <index> is one greater than the current number of values in the sequence

Inserting an element before an existing element of an initialized sequence is

performed by
insert [<RDN>, ]<sequence_name>=[<insertBeforeElementValue>]
<additionalElement>

Inserting an element at a specific position into an initialized sequence is performed

by

insert <sequence_name>'['@<index>']'=<new_value>
The positional index starts from 1. The index must address an existing position in
the sequence; it is not possible to add values after the last existing values.

Changing an element of an initialized sequence is performed by

[<RDN>, ]<sequence_name> [<insertTargetElement>]=<newElementValue>

or
[<RDN>, ]<sequence_name>'['@<index>']'=<sequence_element_value>

Removing an element of an initialized sequence is performed by

no [<RDN>, ]<sequence_name>=<removeElementValue>
or
no [<RDN>, ]<sequence_name>'['@<index>']'

Removing all elements from an initialized sequence and therefore setting it back
to uninitialized status is performed by

no [<RDN>, ]<sequence_name>

The table below shows the possible error messages when changing sequence
attributes.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 27

 Ericsson Command-Line Interface

Table 4 Error messages when changing attributes

Error Message Semantics
ERROR: Value must be unique The sequence elements are set to
be unique, that is, the nonUnique
property is not present
ERROR: Multiplicity of the The sequence element maxLength
attribute ("<attribute_name>") property is set and the number of
at max limit elements exceed this limit
ERROR: Multiplicity of the The sequence element minLength
attribute ("<attribute_name>") property is set and the number of
at minimum limit elements is lower than this limit
ERROR: Invalid index The index value is too large.
'<invalid_index>' to access
a sequence containing
<no_of_set_values> values. Use
an index <= <no_of_set_values>
ERROR: Invalid index An index value larger than 1 is used to
'<invalid_index>' to access address a non-sequence attribute.
a sequence containing 1 values.
Use an index = 1
ERROR: Invalid index The index value is too large. It must
'<invalid_index>' to access address either an existing value, or
a sequence containing the index after the last existing value.
<no_of_set_values> values. Use In the latter case, a value can be
an index <= <no_of_set_values> appended to the sequence.
for replace or use an index =
<no_of_set_values+1> for append
ERROR: Invalid index The index value is too large for an
'<invalid_index>' to access attribute having only one value. It
a sequence containing 1 values. must address either an existing value,
Use an index = 1 for replace or or the index after the last existing
use an index = 2 for append. value. In the latter case, a value can
be appended to the sequence.
ERROR: Invalid index The index value is too large. It
'<invalid_index>' to access must address an existing value. No
a sequence containing further values can be appended to the
<no_of_set_values> values. Use sequence.
an index <= <no_of_set_values>
for replace

28 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

ERROR: Invalid index An index value larger than 1 is used to

'<invalid_index>' to access address a non-sequence attribute.
a sequence containing 1 values.
Use an index = 1 for replace
ERROR: Invalid index An index value larger than 1 is used to
'<invalid_index>' to access address a non-sequence attribute.
a sequence containing 1 values.
Use an index = 1 for append

2.2.5.3.1 Example 1

This example shows how to initialize the sequence attribute initiatingDestina

tionSet with two elements Ind and Ita.
dn ManagedElement=<node_name>,SystemFunctions=1,AxeFunc
tions=1,DataOutputHandling=1,DataTransferM=1,FileTransf
erManager=1,FileTransferQueue=1
(config-FileTransferQueue=1)>initiatingDestinationSet=[Ind,Ita]
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Ind"
"Ita"

2.2.5.3.2 Example 2

This example shows how to add another element in the already existing sequence
attribute. Here, USA has been added to the initiatingDestinationSet which is
a sequence attribute.
(config-FileTransferQueue=1)>initiatingDestinationSet=USA
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Ind"
"Ita"
"USA"
(config-FileTransferQueue=1)>

2.2.5.3.3 Example 3

This example shows how to add another element in the already

existing sequence attribute using index. Here, USA is added to the
initiatingDestinationSet which is a sequence attribute, using index 3 that is
one greater than the current number of values.
(config-FileTransferQueue=1)>initiatingDestinationSet[@3]=USA
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Ind"

8/1553-CXA 118 03/5 Uen A | 2018-01-22 29

 Ericsson Command-Line Interface

"Ita"
"USA"
(config-FileTransferQueue=1)>

2.2.5.3.4 Example 4

This example lists the deletion of an element, for instance USA, from a sequence
attribute named asinitiatingDestinationSet.
(config-FileTransferQueue=1)>no initiatingDestinationSet=USA
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Ind"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.3.5 Example 5

This example lists the deletion of an element, for instance USA , having index 3,
from a sequence attribute named asinitiatingDestinationSet, by using the
index of the element..
(config-FileTransferQueue=1)>no initiatingDestinationSet[@3]
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Ind"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.3.6 Example 6

This example lists how to insert an element at a specific position using

insert command. Here Swe has been added above the element Indin the
sequence attribute named as initiatingDestinationSet.
(config-FileTransferQueue=1)>insert initiatingDestinationSet =>
["Ind"]=Swe
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Swe"
"Ind"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.3.7 Example 7

This example lists how to insert an element at a specific position identified by

index, using insert command. Here Fra is added at position 2in the sequence
attribute named as initiatingDestinationSet.

30 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

(config-FileTransferQueue=1)>insert initiatingDestinationSet[@2]=Fra
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Swe"
"Fra"
"Ind"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.3.8 Example 8

This example lists the replacement of an element named Ind by another element
named Jap in the sequence.
(config-FileTransferQueue=1)>initiatingDestinationSet["Ind"]=Jap
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Swe"
"Fra"
"Jap"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.3.9 Example 9

This example lists the replacement of an element at the specific position identified
by index 3 by another element named Jap in the sequence.
(config-FileTransferQueue=1)>initiatingDestinationSet[@3]=Jap
(config-FileTransferQueue=1)>show
FileTransferQueue=1
initiatingDestinationSet
"Swe"
"Fra"
"Jap"
"Ita"
(config-FileTransferQueue=1)>

2.2.5.4 Changing Attributes defined as Struct

Attributes defined as struct can be changed by:

[<RDN>, ]<struct_name>,<struct_element>=<struct_element_value>

The table below shows possible error messages when changing struct attributes.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 31

 Ericsson Command-Line Interface

Table 5 Error messages when changing struct attributes

Error Message Semantics
ERROR: Failed to set struct key The key value is not unique.
attribute '<attribute_name>' to
'<attribute_value>'. Key must
be unique.

2.2.5.4.1 Example

This example lists to change the values of the elements of a struct attribute
productIdentity.
(config-ManagedElement=<node_name>)>productIdentity="MyProd"
(config-productIdentity)>show verbose
productIdentity="MyProd"
productDesignation=[] <empty>
productNumber="MyProd" <key>
productRevision=[] <empty>
(config-productIdentity=MyProd)>productDesignation=xyz
(config-productIdentity=MyProd)>productRevision=1.1
(config-productIdentity=MyProd)>commit -s
(config-productIdentity=MyProd)>show
productIdentity="MyProd"
productDesignation="xyz"
productRevision="1.1"
(config-productIdentity=MyProd)>

2.2.5.5 Changing Attributes defined as Passwords

Change of an attribute defined as password is handled in a special way, as follows:

Password can be assigned in encrypted format:

[<RDN>, ]<attribute_name> = <attribute_value>

Password can be assigned in clear text adding the “cleartext” keyword :

[<RDN>, ]<attribute_name> = <attribute_value> cleartext

A password entered in a clear text form is stored in encrypted format.

This is a one-way operation, since passwords cannot be displayed in clear text,

but in encrypted form.

2.2.5.5.1 Example

This example lists that when cleartext is mentioned in the command with
password then the password is encrypted by the system.

32 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

dn ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,
DataOutputHandling=1,DataTransferM=1,FileTransferManager=1

(config-FileTransferManager=1)>InitiatingDestinationSet=Ita

(config-InitiatingDestinationSet=Ita)> =>
SecondaryInitiatingDestination=CHS1S

(config-SecondaryInitiatingDestination=CHS1S)>ipAddress=1.2.3.4

(config-SecondaryInitiatingDestination=CHS1S)> =>
transferProtocol=SFTPV2

(config-SecondaryInitiatingDestination=CHS1S)>username="abc"

(config-SecondaryInitiatingDestination=CHS1S)>password=mormor =>
cleartext

(config-SecondaryInitiatingDestination=CHS1S)>show
SecondaryInitiatingDestination=CHS1S
ipAddress="1.2.3.4"
password="1:BDFN49Td/4C5gSbmbIbbXc6CFvRDbMkU"
transferProtocol=SFTPV2
username="abc"
(config-SecondaryInitiatingDestination=CHS1S)>abort -s

2.2.5.6 Changing Element in Sequence of Struct without Key

If an attribute is defined as a sequence of structure and the structure has no key

member, then a sequence element can be identified using the positional index.
Thus, an element in the sequence can be modified by addressing that element
with the positional index. The positional index is supported only for sequence of
keyless structures. The positional index is identified by the "@" character for all
the struct elements in the sequence. The index numbering starts from 1.

2.2.5.6.1 Example

Changing Element in Sequence of Struct without Key.

(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
host="1.1.1.1"
port=26343
agentAddress[@2]
host=”2.2.2.2”
port=23154
(config-Snmp=1)>agentAddress[@2],host=4.4.4.4 port=4444
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
host="1.1.1.1"

8/1553-CXA 118 03/5 Uen A | 2018-01-22 33

 Ericsson Command-Line Interface

port=26343
agentAddress[@2]
host="4.4.4.4"
port=4444

2.2.5.7 Adding a New Keyless Struct Element to the Sequence

A new element can be appended to the end of the sequence:

— Without specifying positional index

[<DN>,]<noKeyStructSequence> .

— Setting member without specifying positional index

[<DN>,]<noKeyStructSequence>,member_Name=<member_value>

— Specifying positional index

[<DN>,]<noKeyStructSequence>[@<N>]

— Setting member by specifying positional index

[<DN>,]<noKeyStructSequence>[@<N>],member_Name=<member_value>

A new struct instance is added to the end of the sequence and the user navigates
to the newly created instance, if the multiplicity for the attribute has not reached
the maximum value. If the struct members are set as part of the append operation,
then the specified values are set to the struct members. The command and
printout syntax for above cases are shown in following examples.

2.2.5.7.1 Example

Adding a new keyless struct element to the sequence without index.

(config-Snmp=1)>agentAddress
(config-agentAddress[@2])>up
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
host="0.0.0.0"
port=26343
agentAddress [@2]

2.2.5.7.2 Example

Adding a new keyless struct element to the sequence with index.

(config-Snmp=1)>agentAddress
(config-agentAddress[@2])>up
(config-Snmp=1)>show -v agentAddress
agentAddress[@1]
host="0.0.0.0"

34 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

port=26343
agentAddress [@2]

2.2.5.7.3 Example

Adding a new struct element to the sequence by setting struct 6 adding a new
struct element member, without index.
(config-Snmp=1)>agentAddress,port=999
(config-Snmp=1)>show agentAddress
agentAddress
host="0.0.0.0"
port=26343
agentAddress
port=999

2.2.5.7.4 Example

Adding a new struct element to the sequence by setting struct member, with index.
(config-Snmp=1)>agentAddress[@3],host=9.9.9.9
(config-Snmp=1)>show agentAddress
agentAddress
host="0.0.0.0"
port=26343
agentAddress
port=999
agentAddress
host="9.9.9.9"

2.2.5.7.5 Example

Adding a new keyless struct element to the sequence with invalid positional index.
(config-Snmp=1)>agentAddress[@5]
ERROR: Invalid index '5' for a sequence containing 1
values. Use an index <=2

2.2.5.8 Changing Attribute Defined as MO Reference

Changing an attribute of MO reference type is the same as changing a

single-valued attribute with the following special handling:

— The MO reference attribute value is a string that contains the DN of the

referred MO.

The DN needs to start with ManagedElement=<apg_name>.

— The referred MO must exist.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 35

 Ericsson Command-Line Interface

— The class of the referred MO must be as defined for the MO reference attribute
in the model.

2.2.5.9 Modify Command

Command modify <modification_operations> is a pipe extension command

that can be used in Config mode, together the show command, to perform the
same update operations on a set of selected MO instances.

The modify command receives LDNs of MO instances as pipe input, and the
operations as parameters (to generate a set of LDNs of MO instances, command
show combined with its search parameters is used):

show [-r|--recursive] [-m|--moc] <MO_class_name> [[-c|--condition]

<condition>] [-p|-–property] | modify <modification_operations>

The modify command applies the following modifications to each MO instance

that is piped to the command.

Syntax for attribute modification:

modify <attribute_name>=<attribute_value>
modify <attribute_name>'['@<index>']'=<attribute_value>
modify <attribute_name>='['<attribute_value>']'
modify <attribute_name>'['<old_attribute_value>']'=<new_attribute_value>
modify <attribute_name>'['@<index>']'=<new_attribute_value>

Many attribute operations can be combined, see Example 1.

modify attribute1=xx attribute2=[yy,zz]

Example 1 Combination of Attribute Operations

Syntax for struct modification:

struct ::= <struct_attribute_name> | <struct_attribute_name>=<key_value> |

<struct_attribute_name>'['@<index>']']
modify <struct>
modify <struct>,<member_name>=<member_value>
modify <struct>,<member_name>'['@index']'=<new_member_value>
modify <struct>,<member_name>='['<member_values>']'
modify <struct>,<member_name>'['<old_member_value>']'=<new_member_value>

Many struct member operations can be combined, see Example 2.

modify aStruct=key,member1=xx member2[@1]=yy

modify aStruct=[@1],member1=xx member2[@1]=yy
Example 2 Combination of struct Member Operations

When the modify command is executed, the operations performed on each MO

instance are echoed.

36 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

For an example of a set of an attribute in all SwItem objects that match a specific
condition, see Example 3.

(config)>show -r -m SwItem -p -c swItemId=~PRC |

modify userLabel="test"
ManagedElement=<node_name>,SystemFunctions=1,SwInventory=1,SwItem=ERIC-ACS_A
ManagedElement=<node_name>,SystemFunctions=1,SwInventory=1,SwItem=ERIC-ACS_P

Example 3 Set the userLabel attribute to "test" on all SwItem objects with the
string "PRC" in the swItemId attribute

2.2.6 Define or Create MO

This chapter describes how to perform the common operation to create or define a
new MO.

The AXE Operational Instructions usually refer to these operations as follows:

“Create/Define a new MO <MOC_ClassName>."

MO instances can be created in an atomic way in transaction, that is, in Config

Mode only (see chapter 2.1.1). As a consequence, the configuration changes
are not applied by entering the changes, but after successful commit of the
transaction.

To create an MO, perform the following steps:

Open an AP session and entering Config Mode:

configure

The prompt changes to

(config)>

Navigate to the parent MO (see chapter 2.2.3), the prompt changes to :

(config-<RDN>)>

where <RDN> expresses the RDN of the MO at the current ECLI position.

Check if the MO instance already exists:

show <RDN_NewMO>

Note: This step is needed, because the ECLI command for MO creation is
identical to the ECLI command for changing the ECLI position to an
existing MO. The success of both operations is indicated in the same way,
by providing no printout.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 37

 Ericsson Command-Line Interface

The following error message should be displayed to indicate the MO does not
exist yet.

ERROR: Specific element not found

To create the new MO, enter the RDN to new MO, including its name according to
the MO naming rules.

<RDN_NewMO>

An error message is provided if verification fails against any available constraint.

In this case of error, modify the RDN to comply with the constraints. See table at
the end of this chapter for a summary of constraints and corresponding errors
on creation.

If no error printout is provided, then the operation succeeded and the ECLI
position is changed to the new MO.

The MO creation might required setting of mandatory attributes. If they are not
the commit operation fails.

Note: If the MO is created and the value for a mandatory attribute is not yet
assigned, then any further ECLI position change is rejected by an error
indication which lists the names of the mandatory attributes.

At this stage, it can be useful to use the Help and the Auto-Completion functions
of the AP session, which are further described in Section 2.3 on page 57.

The TAB key can be used to invoke the Auto-Completion and to list the available
optional and mandatory attributes to be set for the new MO.

To display Verbose Help for a specific attribute of the new MO, <attribute_name>
? can be used.

To print all attributes with their current values, the show verbose comand can
be used.

Attributes that have associated default values will have those values after
creation of a new MO.

Once mandatory and optional attributes have been set as needed, than the
transaction can be performed with the following commands:

— commit: This command commits the transaction and changes the ECLI Mode
to Exec Mode.

If the MO creation succeeded, no result message is printed and the ECLI

Position is in the new MO position in Exec Mode.

— commit -s: This command commits the transaction and leaves the ECLI
Mode to Config Mode.

38 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

If the MO creation succeeded, no result message is printed, the ECLI Position

is in the new MO position in Config Mode, and a new transaction is started
automatically.

If the MO creation failed an error message is printed.

Note: If commit fails for any reason, the ECLI discards all entered attribute
values.

Table 6 Error message when MO creation fails

Error Message Semantics
ERROR: Parent '<parent_DN>' The parent DN does not exist.
does not exist
ERROR: Can not instantiate Instantiation of system-created
system created object objects is not allowed.
ERROR: Cardinality is at An MO instance cannot be created due
upper limit for class to a restriction on cardinality.
(<MO_class_name>), cannot
create object
ERROR: MO creation failed for Implementation-specific error cases
classname: <MO_class_name>, are shown like this.
error code: <error_code>
ERROR: No create permission for The user has read permission but not
'<DN>' create permission
ERROR: Command not found The user has neither read nor write
permission.
ERROR: Unable to commit Mandatory attributes for the MO are
incomplete object not set. Set the mandatory attribute
and then execute the command again.
ERROR: Invalid value The entered value cannot be accepted
for the attribute.

2.2.6.1 Example

This example list how to create an MO named as RespondingDestinationSet=

RDEST1 with possible errors.

>configure
(config)>show
ManagedElement=<node_name>
(config)>dn ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,Data
(config-FileTransferManager=1)>show
FileTransferManager=1
InitiatingDestinationSet=ALOGSET

8/1553-CXA 118 03/5 Uen A | 2018-01-22 39

 Ericsson Command-Line Interface

InitiatingDestinationSet=PDSSET
InitiatingDestinationSet=STSSET
InitiatingDestinationSet=Y00SET1
InitiatingDestinationSet=Y00SET2
FileTransferQueue=ALOGTQ
FileTransferQueue=GOHSTDEST1
FileTransferQueue=PDSFILE
FileTransferQueue=RELCMDHDF
FileTransferQueue=STSCOMMONMPQ
FileTransferQueue=YATSI00
RespondingDestinationSet=RESPSET
(config-FileTransferManager=1)> =>
RespondingDestinationSet=RESPSET

(config-FileTransferManager=1)>RespondingDestinationSet=RDEST1
(config-RespondingDestinationSet=RDEST1)>up
ERROR: Current cardinality of 0 for class-instance of =>
AdvancedRespondingParameters is < 1 (lower-limit) for =>
RespondingDestinationSet.

(config-RespondingDestinationSet=RDEST1)> =>
PrimaryRespondingDestination=RDEST1
(config-PrimaryRespondingDestination=RDEST1)>up
(config-RespondingDestinationSet=RDEST1)>up
ERROR: Current cardinality of 0 for class-instance of =>
AdvancedRespondingParameters is < 1 (lower-limit) for =>
RespondingDestinationSet.

(config-RespondingDestinationSet=RDEST1)>commit -s
ERROR: Current cardinality of 0 for class-instance of =>
AdvancedRespondingParameters is < 1 (lower-limit) for =>
RespondingDestinationSet.
(config-RespondingDestinationSet=RDEST1)> =>
AdvancedRespondingParameters=RDEST1
(config-AdvancedRespondingParameters=RDEST1)>commit -s
(config-AdvancedRespondingParameters=RDEST1)>show
AdvancedRespondingParameters=RDEST1
(config-AdvancedRespondingParameters=RDEST1)>up
(config-RespondingDestinationSet=RDEST1)>show -r
RespondingDestinationSet=RDEST1
respActiveDestination="RDEST1"
AdvancedRespondingParameters=RDEST1
PrimaryRespondingDestination=RDEST1
(config-RespondingDestinationSet=RDEST1)>up
(config-FileTransferManager=1)>show
FileTransferManager=1
InitiatingDestinationSet=ALOGSET
InitiatingDestinationSet=PDSSET
InitiatingDestinationSet=STSSET
InitiatingDestinationSet=Y00SET1
InitiatingDestinationSet=Y00SET2

40 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

FileTransferQueue=ALOGTQ
FileTransferQueue=GOHSTDEST1
FileTransferQueue=PDSFILE
FileTransferQueue=RELCMDHDF
FileTransferQueue=STSCOMMONMPQ
FileTransferQueue=YATSI00
RespondingDestinationSet=RDEST1
RespondingDestinationSet=RESPSET
(config-FileTransferManager=1)>

2.2.7 Delete MO
This chapter describes how to delete or remove a MO.

The AXE Operational Instructions usually refer to these operations as follows:

“Delete MO <MOC_Name> and commit the change.”

The MO can be deleted in Config Mode only (see chapter 2.1.1).

The configuration changes are not applied by entering the changes, but after a
successful commit of the transaction.

To delete an MO, the following steps can be performed:

Open an AP session and entering Config Mode:

configure

The prompt changes to

(config)>

Parent MO should be navigated (see chapter 2.2.3), so that the prompt changes to:

(config-<RDN>)>where <RDN> expresses the RDN of the MO at the current ECLI

position.

The MO can be deleted by executing command no with the RDN of the MO

as argument.

no <RDN_Target_MO>

If the operation succeeded, no printout is provided.

An error message is provided if verification failed against any available constraint.

See Table 7 for a summary of constraints and corresponding errors on deletion.

The transaction initiating the deletion can be committed with one of the following
commands:

8/1553-CXA 118 03/5 Uen A | 2018-01-22 41

 Ericsson Command-Line Interface

— commit: This command commits the transaction and changes the ECLI Mode
to Exec Mode.

If the MO deletion succeeds, no result message is printed and the ECLI

Position is in the parent MO position in Exec Mode.

— commit -s: This command commits the transaction and leaves the ECLI
Mode to Config Mode.

If the MO deletion succeeds, no result message is printed, the ECLI Position is

in the parent MO position in Config Mode, and a new transaction is started
automatically.

Note: An MO can be deleted even if it is pointed by an MO reference.

Table 7 Error messages at MO Deletion

Error Message Semantics
ERROR: Cardinality is at The object cannot be deleted due to
lower limit for class cardinality constraint.
("<MO_class_name>"), cannot
delete object.
ERROR: Can not delete system Deletion of system-created object is
created object not allowed.
ERROR: No delete permission for The user has read permission but not
'<DN>' delete permission.
ERROR: Command not found The user has neither read nor write
permission.

2.2.7.1 No Command

Command no [<modification operation>] is a pipe extension command

that can be used in Config mode, together the show command, to remove a set
of selected MO instances, or values inside a set of selected MO instances. The
command receives LDNs of MO instances as pipe input, and any contents as
parameter.

To generate a set of LDNs of MO instances, command show combined with its

search parameters is typically used, as described in Section 2.2.5.9 on page 36.

The command applies a ‘‘no command’’ to each MO LDN that is piped to the
command.

Syntax for deleting MO instances:

no

Syntax for deleting attributes values:

42 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

no <attribute_name>
no <attribute_name>=<attribute_value>
no <attribute_name>'['@<index>']'

Syntax for deleting struct member values:

struct ::= <struct_attribute_name> | <struct_attribute_name>=<key_value> |

<struct_attribute_name>'['@<index>']']
no <struct>,<member_name>
no <struct>,<member_name>'['@<index>']
no <struct>,<member_name>=<member_value>

An example of unsetting a struct member is shown in Example 4.

no aStruct[@1],aMember
Example 4 Unset a struct Member

An example of removing a value from a struct member is shown in Example 5.

no aStruct=aKey,aMember=aValue
Example 5 Remove a Value From a Struct Member

When executed, the resulting operations performed on each MO instance are

echoed.

For examples of remove operations, see Example 6 and Example 7.

(config)>show -r -m ExclusionItem -p | no
no ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,SecurityHandling=1,AuditLoggingM=1,ExclusionItem=2
no ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,SecurityHandli
ng=1,AuditLoggingM=1,ExclusionItem=1

Example 6 Remove all ExclusionItem objects

(config)>show -r -m FileGroupPolicy -c maxNumberFiles>0 | no maxFileGroupSize
no ManagedElement=NODE06ST,SystemFunctions=1,FileM=1,FileGroupPolicy=1,maxFileGroupSize
no ManagedElement=NODE06ST,SystemFunctions=1,FileM=1,FileGroupPolicy=10,maxFileGroupSize

Example 7 Remove Maximum File Group Size Limitation in All File Group Policies Having a
Maximum Number of Files Limitation

2.2.7.2 Example

This example lists how to delete an MO named as PdsIPClient=AD-900.

>configure
(config)>show
ManagedElement=<node_name>
(config)>dn ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1,Data
(config-FileTransferManager=1)>show
FileTransferManager=1
InitiatingDestinationSet=ALOGSET
InitiatingDestinationSet=PDSSET

8/1553-CXA 118 03/5 Uen A | 2018-01-22 43

 Ericsson Command-Line Interface

InitiatingDestinationSet=STSSET
InitiatingDestinationSet=Y00SET1
InitiatingDestinationSet=Y00SET2
FileTransferQueue=ALOGTQ
FileTransferQueue=GOHSTDEST1
FileTransferQueue=PDSFILE
FileTransferQueue=RELCMDHDF
FileTransferQueue=STSCOMMONMPQ
FileTransferQueue=YATSI00
RespondingDestinationSet=RDEST1
RespondingDestinationSet=RESPSET
(config-FileTransferManager=1)>no RespondingDestinationSet=RESP1
(config-FileTransferManager=1)>commit -s
(config-FileTransferManager=1)>show
FileTransferManager=1
InitiatingDestinationSet=ALOGSET
InitiatingDestinationSet=PDSSET
InitiatingDestinationSet=STSSET
InitiatingDestinationSet=Y00SET1
InitiatingDestinationSet=Y00SET2
FileTransferQueue=ALOGTQ
FileTransferQueue=GOHSTDEST1
FileTransferQueue=PDSFILE
FileTransferQueue=RELCMDHDF
FileTransferQueue=STSCOMMONMPQ
FileTransferQueue=YATSI00
RespondingDestinationSet=RESPSET
(config-FileTransferManager=1)>

2.2.8 Execute Action

This chapter describes how to execute actions on a MO.

The AXE Operational Instructions usually refer to these operation in one of the
following ways:

— “Request action execution of <action_name> in MO <MOC_Name>".

— “Execute action <action_name>".

— “Execute action <action_name> in MO <MOC_Name>".

Actions are executed in Config Mode and Exec Mode on existing MOs.

Actions do only operate on committed data.

Any attribute changes that are not yet committed are ignored during action
execution.

Actions are of two types:

44 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

— Synchronous actions

— Asynchronous actions

Synchronous actions wait for the response from the transaction process before
starting another one, whereas asynchronous actions do not wait for the
transaction process to finish and initiates another transaction if required.

For asynchronous actions, progress has to be checked manually.

To execute an action, the following steps should be performed:

— Open an AP session, the prompt in Exec Mode is:

>

— If the action is removeFile under the File Management function MOM

(FileM is the root MOC), enter Config Mode (otherwise, skip this step):

configure

The prompt changes to

(config)>

— Parent MO should be navigated (see Section 2.2.3 on page 10), so that the
prompt changes to:(<RDN>)> or (config-<RDN>)> in Config Mode

where <RDN> expresses the RDN of the MO at the current ECLI position.

— The action execution can be requested by command <actionName>

[--<action_parameter_name><action_parameter_value>].

Optional parameters are supported with this format.

A parameter can be considered as optional if the parameter has a default

value.

Values must be specified for all the parameters that are not optional.

If an action request is completed without error a printout is provided depending

on action return type.

No printout is provided if the action return type is defined as void.

Otherwise, a printout is provided according to the action return type. The action
printout format is identical to the printout of command show on attributes of the
same data type.

If the action request is completed with error, then the error reason is indicated
in printout ERROR : <error_text>.

See Table 8 for a summary of error messages on actions.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 45

 Ericsson Command-Line Interface

Actions start either immediately after entering the action request. Only the action
removeFile into File Management function MOM requires command commit to
start.

Most actions on APG43L start executing immediately.

Available actions that can be executed on a MO can be listed by using command

"?".

For the action semantics and start conditions, see the action description in the
ECLI Help or in the CPI for the MOM.

Table 8 Error Messages on Actions

Error Message Semantics
ERROR: No execute permission The user has no execute permissions
for action '<action_name>' but the action is visible for the user.
ERROR: Too many arguments for The number of parameters are higher
action (<action_name>) that than expected.
takes <number_of_ parameters>
parameters <paramname1,
paramname2, ...>
ERROR: Too few arguments for The number of parameters are fewer
action (<action_name>) that than expected.
takes <number_of_ parameters>
parameters <paramname1,
paramname2, ...>
ERROR: Command not found The entered command does not exist.
Note: this error message might be
printed for some ECLI commands
entered with too many or too few
arguments.
ERROR: Call command failed, Other implementation-specific cases.
error code <error_code>

2.2.8.1 Action Command

Command action <action_name> ('--'<param_name> <param_value>) is a

pipe extension command that can be used in Config mode, together the show
command, to execute the same action on a set of selected MO instances.

The action command receives LDNs of MO instances as pipe input, and the
action as parameter (to generate a set of LDNs of MO instances, command show
combined with its search parameters is used):

show [-r|--recursive] [-m|--moc] <MO_class_name> [[-c|--condition]

<condition>] [-p|-–property] | action <action_name>
('--'<param_name> <param_value>)

46 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

The action command starts the action on each MO instance that is piped to the
command.

When executed, the resulting operation performed on each MO instance, and

the result, are echoed.

For an example of delete all blob files from statistics directories in File
Management, see Example 8.
(config)>show -r -m FileGroup -c fileGroupId=~".*statistics$" -p
| action removeFile --file blob
ManagedElement=NODE06ST,SystemFunctions=1,FileM=1,FileGroup=linkstatistics,removeFile --file blob
true
ManagedElement=NODE06ST,SystemFunctions=1,FileM=1,FileGroup=loadstatistics,removeFile --file blob
false

Example 8 Delete All Blob Files from Statistics Directories in File Management

2.2.8.2 Example

This example lists the available actions for the MO named as

BrmBackupManager.
(config-BrmBackupManager=SYSTEM_DATA)>?
cancelCurrentAction() Cancels the current
action.
createBackup() Creates a new backup
of the backupType and
backupDomain managed by
the BackupManager.
deleteBackup() Delete a backup specified
by its name and of the
backupType and nbackupDomain
managed by this BackupManager.
+BrmBackup Represents one backup of
the type and domain specified
by the BrmBackupManager in
which it is contained.
+BrmBackupHousekeeping Provides optional support
for automated housekeeping
of manually created backups.
+BrmBackupScheduler Provides optional support for
scheduling of backup creation.

2.2.8.3 Synchronous Action

This example lists the successful completion of an action named

updateTranslationTable.

(config-TranslationTable=1)>show -v
TranslationTable=1
lastUpdate="2013-12-03 03:05:30"

8/1553-CXA 118 03/5 Uen A | 2018-01-22 47

 Ericsson Command-Line Interface

<read-only>
translationTableId="1"
(config-TranslationTable=1)>updateTranslationTable
(config-TranslationTable=1)>show -v
TranslationTable=1
lastUpdate="2013-12-03 07:30:05"
<read-only>
translationTableId="1"
(config-TranslationTable=1)>)

2.2.8.4 Asynchronous Action

This example lists how to perform an action named createbackup and check its
progress with the attribute progressReport.
(config-BrmBackupManager=SYSTEM_DATA)>createBackup testBackup_1
true
(config-BrmBackupManager=SYSTEM_DATA)>show
BrmBackupManager=SYSTEM_DATA
backupDomain="BRM_SYSTEM_DATA"
backupType="BRM_SYSTEM_DATA"
asyncActionProgress
actionId=0
actionName="CREATE"
progressInfo="PERMIT_PHASE is completed"
progressPercentage=25
result=NOT_AVAILABLE
resultInfo=""
state=RUNNING
timeActionCompleted="1970-01-01T05:00:00"
timeActionStarted="2013-12-03T07:35:45"
timeOfLastStatusUpdate="2013-12-03T07:35:48"
progressReport
actionId=0
actionName="CREATE"
progressInfo="PERMIT_PHASE is completed"
progressPercentage=25
result=NOT_AVAILABLE
resultInfo=""
state=RUNNING
timeActionCompleted="1970-01-01T05:00:00"
timeActionStarted="2013-12-03T07:35:45"
timeOfLastStatusUpdate="2013-12-03T07:35:48"
BrmBackup=testBackup_1
BrmBackupHousekeeping=SYSTEM_DATA
BrmBackupScheduler=SYSTEM_DATA
(config-BrmBackupManager=SYSTEM_DATA)>

48 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

2.2.8.5 Example of error message for action returning void

This example lists the failure scenario of the action reset.

(config-OtherBlade=0)>reset NORMAL
ERROR: Call command failed, error code: ComFailure
Messages from transaction participants:
Action not allowed for this Functional Board Name (FBN)
(config-OtherBlade=0)>

2.2.8.6 Example of error message for action returning a value

This example lists the failure scenario of an action named connectionVerify.

(config-PrimaryRespondingDestination=RESPDEST)>connectionVerify
false
Messages from transaction participants:
Error connecting to remote system

2.2.8.7 Example

This example lists the failure scenario when a invalid argument value is specified
for the action exportCpFile.

(config-CpFileSystemM=1)>exportCpFile TO TO TO to
ERROR: Invalid value 'TO' for enum parameter
'mode' : ' OVERWRITE APPEND CLEAR NORMAL' is expected!

2.2.8.8 Example

This example lists the failure scenario when too many arguments are specified
for the action exportCpFile.

(config-CpFileSystemM=1)>exportCpFile TO TO TO to as
ERROR: Too many arguments for action (exportCpFile)
that takes 4 parameters < sourceCpFile dest mode toZip >

2.2.9 Multiple User Configure Sessions

Many users (e.g. user A and user B) start concurrent transactions by entering
the Config Mode.

When user A performs configuration changes on a MO, this MO and its child MOs if
applicable are locked on transaction level and only released until user A performs
either commit command or abort command.

During this locking period, user B is unable to perform any configuration changes
on that MO and its child MOs if applicable until the lock is released by user A.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 49

 Ericsson Command-Line Interface

When user A has performed commit successfully, a notification (either case 1

or case 2 below) is reported to user B to specify that another user (user A) has
changed the database and the expectation for user B's session has been changed
which could lead the failure when user B performs commit. Inconsistency happens
and in some cases, user B potentially aborts and restarts the configure session.

— Case 1:

The notification is reported directly when user B performs some kinds of

activities in ECLI session, for example show command. See Section 2.2.9.9
on page 53.

— Case 2:

The notification is reported when user B performs commit or validate. See

Section 2.2.9.10 on page 53.

2.2.9.1 Example 1

This example shows user B is unable to modify the attribute on MO

MessageStore=CHS, when user A is modifying the attribute on the same MO
MessageStore=CHS:

Table 9 Example 1
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFuncti
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config-MessageStore=CHS)>numberOfFiles
(config-MessageStore=CHS)>numberOfFiles
= 100 = 200
(config-MessageStore=CHS)> ERROR: Set attributes failed for 'numberOfFil
(config-MessageStore=CHS)>

2.2.9.2 Example 2

This example shows user B is unable to delete the MO FileTransferQueue=STS,

when user A is modifying the attribute on the same MO FileTransferQueue=STS:

Table 10 Example 2
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFuncti
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config-FileTransferQueue=STS)>initiatingDestinationSet=-
(config-FileTransferQueue=STS)>up
(config-FileTransferQueue=STS)> (config-FileTransferManager=1)>no FileTransfe
ERROR: Delete object failed, error code: ComO
(config-FileTransferManager=1)>

50 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

2.2.9.3 Example 3

This example shows user B is unable to modify the attribute on MO

MessageStore=CHS, when user A is creating child MO FileBasedJob=TEST on the
same MO MessageStore=CHS:

Table 11 Example 3
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutpu
(config)>ManagedElement=tp218ap1,SystemFun
(config-MessageStore=CHS)>numberOfFiles =
(config-MessageStore=CHS)>FileBasedJob=TEST
(config-FileBasedJob=TEST)> ERROR: Set attributes failed for 'numberOf
(config-MessageStore=CHS)>

2.2.9.4 Example 4

This example shows user B is unable to create child MO FileBasedJob=TESTB on

MO MessageStore=CHS, when user A is creating child MO FileBasedJob=TESTA on
the same MO MessageStore=CHS:

Table 12 Example 4
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutpu
(config)>ManagedElement=tp218ap1,SystemFun
(config-MessageStore=CHS)>FileBasedJob=TES
(config-MessageStore=CHS)>FileBasedJob=TESTA
(config-FileBasedJob=TESTA)> ERROR: MO creation failed for classname: F
(config-MessageStore=CHS)>

2.2.9.5 Example 5

This example shows user B is unable to create child MO FileBasedJob=TEST on

MO MessageStore=CHS, when user A is modifying the attribute on the same MO
MessageStore=CHS:

Table 13 Example 5
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutpu
(config)>ManagedElement=tp218ap1,SystemFun
(config-MessageStore=CHS)>FileBasedJob=TES
(config-MessageStore=CHS)>numberOfFiles = 100
(config-MessageStore=CHS)> ERROR: MO creation failed for classname: F
(config-MessageStore=CHS)>

8/1553-CXA 118 03/5 Uen A | 2018-01-22 51

 Ericsson Command-Line Interface

2.2.9.6 Example 6

This example shows user B is unable to modify the attribute on MO

FileTransferQueue=STS, when user A is deleting the same MO
FileTransferQueue=STS:

Table 14 Example 6
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config)>ManagedElement=tp218ap1,SystemFuncti
(config-FileTransferQueue=STS)>up (config-FileTransferQueue=STS)>initiatingDest
(config-FileTransferManager=1)>no ERROR: Set attributes failed for 'initiatingD
FileTransferQueue=STS
(config-FileTransferManager=1)> (config-FileTransferQueue=STS)>

2.2.9.7 Example 7

This example shows user B is able to create child MO FileTransferQueue=Healt

hCheck on MO FileTransferManager=1, after user A performs commit command
so that this MO FileTransferManager=1 is released:

Table 15 Example 7
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config)>ManagedElement=tp218ap1,SystemFuncti
(config-FileTransferManager=1)>FileTransferQu
(config-FileTransferManager=1)>FileTransferQueue=STS
ERROR: MO creation failed for classname: File
(config-FileTransferQueue=STS)>initiatingDestinationSet=-
(config-FileTransferManager=1)>FileTransferQu
(config-FileTransferQueue=STS)>AdvancedFileTransferQueueInfo = TEST
(config-FileTransferQueue=HealthCheck)>
(config-AdvancedFileTransferQueueInfo=TEST)>commit -s
(config-AdvancedFileTransferQueueInfo=TEST)>

2.2.9.8 Example 8

This example shows user B is able to create child MO FileTransferQueue=Healt

hCheck on MO FileTransferManager=1, after user A performs abort command
so that this MO FileTransferManager=1 is released:

Table 16 Example 8
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFuncti
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config-FileTransferManager=1)>FileTransferQueue=STS
(config-FileTransferManager=1)>FileTransferQu
(config-FileTransferQueue=STS)>initiatingDestinationSet=-
ERROR: MO creation failed for classname: File
(config-FileTransferQueue=STS)>AdvancedFileTransferQueueInfo = TEST
(config-FileTransferManager=1)>FileTransferQu
(config-FileTransferQueue=HealthCheck)>
(config-AdvancedFileTransferQueueInfo=TEST)>abort
WARNING: New cursor location: ManagedElement=tp218ap1,SystemFunctions=1,AxeFun
(FileTransferManager=1)>

52 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

2.2.9.9 Example 9

This example shows the notification is reported directly when user B performs
some kinds of activities in ECLI session, e.g. show command, after user A has
performed commit successfully:

Table 17 Example 9
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutpu
(config)>ManagedElement=tp218ap1,SystemFun
(config-FileTransferQueue=STS)>up (config-FileTransferQueue=STS)>initiatingD
(config-FileTransferManager=1)>no ERROR: Set attributes failed for 'initiati
FileTransferQueue=STS
(config-FileTransferManager=1)>commit -s
(config-FileTransferQueue=STS)>show
(config-FileTransferManager=1)> ERROR: Invalid location. Cursor points to
New cursor location: ManagedElement=tp218a
(config-FileTransferManager=1)>

2.2.9.10 Example 10

This example shows the notification is reported when user B performs commit or
validate, after user A has performed commit successfully:

8/1553-CXA 118 03/5 Uen A | 2018-01-22 53

 Ericsson Command-Line Interface

Table 18 Example 10
User A - Configure Session 1 User B - Configure Session 2
>configure >configure
(config)>ManagedElement=tp218ap1,SystemFunctions=1,AxeFunctions=1,DataOutputHa
(config)>ManagedElement=tp218ap1,SystemFuncti
(config-FileBasedJob=TEST)>up (config-FileBasedJob=TEST)>show -v
(config-MessageStore=CHS)>no FileBasedJob=TEST
FileBasedJob=TEST
(config-MessageStore=CHS)>commit -s cdrCounterFlag=DISABLE <default>
(config-MessageStore=CHS)> fileBasedJobId="TEST"
fileSize=1024 <default>
fixedFileRecordsFlag=VARIABLE <default>
hashKey=[] <empty>
holdTime=300 <default>
minFileSize=0 <default>
paddingChar=0 <default>
recordlength=2048 <default>
transferQueue="HealthCheck"
(config-FileBasedJob=TEST)>cdrCounterFlag=ENA
(config-FileBasedJob=TEST)>commit -s
ERROR: Unable to commit incomplete object (Fi
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
Minimum multiplicity of 1 is violated for att
(config-FileBasedJob=TEST)>abort
WARNING: New cursor location: ManagedElement=
(MessageStore=CHS)>

2.2.10 Scripting Mode

When an AP session starts, the help, auto-completion, case correction and page
break functions are enabled by default.

In case a machine to machine communication requires to disable them for

scripting purposes, the command scriptmode can be used with parameter on.

Parameter off can be used to enable again such above functions.

Command scriptmode without any parameter shows the status of scripting mode.

2.2.10.1 Example 1

This example lists how to disable help, auto-completion, case correction and page
break functions in Exec Mode.

54 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

(ManagedElement=<node_name>)>scriptmode --on
(ManagedElement=<node_name>)>

2.2.10.2 Example 2

This example lists how to disable help, auto-completion, case correction and page
break functions in Config Mode.

>configure
(config)>scriptmode --on
(config)>

2.2.10.3 Example 3

This example lists how to enable help, auto-completion, case correction and page
break functions in Exec Mode.

>scriptmode --off
>

2.2.10.4 Example 4

This example lists how to enable help, auto-completion, case correction and page
break functions in Config Mode.

(config-ManagedElement=<node_name>)>scriptmode --off
(config-ManagedElement=<node_name>)>

2.2.10.5 Example 5

This example lists how to print scripting mode status.

(ManagedElement=<node_name>)>scriptmode
scriptmode off
(ManagedElement=<node_name>)>

2.2.11 Deprecated Syntax for Actions Execution

The below shown syntax for actions execution is deprecated, in the sense that it is
still supported but it will be discontinued from next release onwards so the new
way described in previous chapter is the recommended one.

[<RDN>]<action>[<action_parameter_value>
[<action_parameter_value>]*]

Auto-completion and help text for the above syntax is not supported.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 55

 Ericsson Command-Line Interface

2.2.12 Deprecated Options

The options all and verbose are deprecated, and are replaced by new options
--recursive or -r and --verbose or -v respectively.

The option configuration is now replaced by a new command show-config.

The functionality of new options is the same as the deprecated options.

Auto-completion and help request for the deprecated options is not supported
but command execution works.

A single MO and its child MOs can be displayed by -recursive or -r.

A single MO and all its attributes can be displayed by -verbose or -v.

show-config displays the output in configuration format.

Next examples show deprecated options.

>show al TAB
>show config?

Example 9 Auto-Completion and help request of deprecated option is not

supported.

>show verbose
ManagedElement=1

Example 10 Command execution for deprecated option

2.2.13 Filter Command

The filter command is a pipe extension command to filter the output of any
command or action.

Filter Command Syntax

<command/Action> | filter [-i | --ignore] [-v | --invert] [{-A | --after} <valu

Table 19 Filter Command Parameters

ECLI Element Printout Syntax
-I or --ignore Ignore case distinctions in both the
pattern and the input.
-v or --invert Invert the sense of matching, to select
non-matching lines.

56 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

-A or --after Print number of lines of trailing

context after matching lines.
-B or --before Print number of lines of leading context
before matching lines.
Single-valued attribute, The value for number lines to be printed
structure member after leading/trailing context.
<pattern> The text to be filtered and displayed
from the output of a command/action.

2.2.13.1 Example 1

This example shows how to filter the output of show command matching all MO
having m in the name.

(config-SystemFunctions=1)>show | filter m
SystemFunctions=1
Fm=1
Pm=1

2.2.13.2 Example 2

This example shows how to filter the output of show command matching all MO
having s or S in the name.

(config-SystemFunctions=1)>show | filter -i s
SystemFunctions=1
SecM=1
SysM=1

2.2.13.3 Example 3

This example shows how to filter the output of show command by printing the 2
lines after the one matching the string Fm.

(config-SystemFunctions=1)>show | filter --after 2 Fm

Fm=1
SecM=1
SysM=1

2.3 Support Functions

The following chapters describe more in detail the supporting functions inside
the AP session:

8/1553-CXA 118 03/5 Uen A | 2018-01-22 57

 Ericsson Command-Line Interface

— Static Help

— Brief Help

— Verbose Help

— Information Model Help

— Auto-Completion

2.3.1 Static Help

The command help can be used to retrieve generic information regarding the way
to use the AP session in both Exec Mode or Config Mode.
It is a context-sensitive command providing:

— Brief ECLI description.

— ECLI state machine, see Figure 1.

— Key bindings.

— List of ECLI commands classified per categories, GENERAL, NAVIGATION,

CONFIGURATION and TRANSACTION, see Table 25. The list of CONFIGURATION
and TRANSACTION commands is shown only in Config Mode.

2.3.2 Brief Help

A description on the Brief Help printout content and format is provided in the
table below.

Table 20 Brief Help Printouts

ECLI Element Printout Syntax
Action <action_name>()<spaces><truncat
ed_action_description>
Action parameter <parameter_name><spaces><trunca
ted_parameter_description>
Class +<class_name><spaces><truncated
_action_description>
ECLI operation parameter <parameter_name><spaces><parame
ter_description>
Single-valued attribute, structure <attribute_name><spaces><trunca
member ted_attribute_description>
Structure, multi-valued attribute <attribute_name>[]<spaces><trun
cated_attribute_description>

58 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Note: The description of a ECLI element is truncated till the first dot present into
related HTML Alex documentation.

By pressing the ? in the ManagedElement=<node_name> ECLI position in Config

Mode, the Brief Help information on the ManagedElement_<node_name> MO
attributes and the child are displayed as in the following examples.

(SwM=1)>?
cancel() Stops the operation and restores
the (consistent) state present
before the long lasting operation was started.
createUpgradePackage()
Creates a new UpgradePackage MO representing an
UP stored remotely in the sftp server or locally
in the file system of the ME.
removeSoftwareVersion() Removes a SW version as completely
as possible without disturbing node functionality.
removeUpgradePackage()
Removes an UpgradePackage.

Example 11 Brief help in Exec Mode

<configManagedElement=<node_name>)>?
dnPrefix
It provides naming context allowing
the managed objects to be partitioned
into logical domains.
networkManagedElementId
Replaces the value component of the RDN
in the COM Northbound Interface.
siteLocation
A freetext attribute describing
the geographic location of a Managed Element.
userLabel
A freetext string for additional information
to assist Managed Element identification.
productIdentity[]
Contains product information for the
Managed Element and its Managed Function(s).
SystemFunctions
This model has a structural purpose
to group the management of the system functions
of the Managed Element.
TestRootMoc
Root of ECLI test tree.
Example 12 Brief help in Config Mode

8/1553-CXA 118 03/5 Uen A | 2018-01-22 59

 Ericsson Command-Line Interface

(config-CallableThing=1)>addNumbers<space><?>
--num1 Number one
--num2 Number two
Example 13 Brief help on Action Parameter in Config Mode

ECLI help is available in any position of the ECLI command, except for the position
in key values of the RDN.

For example, no ECLI help is provided in the following cases:

— On an attribute in show-config<RDN>,<attribute_name> command if the

attribute is defined as read-only or restricted.

— On a MOC in show-config<RDN>,<class_name> command if the class is

defined as system-created and has no MO instance created.

— On a MOC in show <RDN>,<class_name> command if the class is defined as

not system-created and has no MO instance created.

The class, attribute, and action descriptions in the printout are displayed in a
truncated form (first sentence only).

Truncation is not indicated in the printout.

The text-formatting characters (tab, new line) are removed from the description
printouts.

2.3.3 Verbose Help

A description of the Verbose Help printout content and format is provided in the
table below:

Table 21 Verbose Help Printouts

ECLI Element Printout Syntax
Action <action_name>() [Return
Type]<action_description>
Action parameter <parameter_name><parameter_type
> [optional/default=<default_va
lue>] <parameter_description>

60 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Class <class_name> MO type

[singleton][optional]

<class_description>

Note:The [singleton] class specifier

is present if exactly one instance of
this class can exist as a child MO of its
actual parent.
The [optional] class specifier is present
if zero is the minimal number of
instances of this class as a child MO of
its actual parent.
ECLI operation <ECLI_operation_name>() Command

<operation_description>
ECLI operation parameter <parameter_name>

<parameter_description>
Single-valued attribute, structure <attribute_name><attribute_type
member > optional/readonly/default=<de
fault_value>/exclusive]<attribu
te_description>

The descriptions of class, attribute, and action in the printout are displayed in a
complete form without truncating the text and the text formatting characters
(tab, new line) are kept.

2.3.4 Information Model Help

Information model help is provided with the following commands:

— Command help -t|--tree [-m|--moc <moc_name>] displays the MOC

tree.

Without a MOC parameter, the whole MOC tree from the top level MOC
ManagedElement is displayed. With a MOC parameter, only the subtree
beneath the specified MOC is displayed. If a MOC can occur in multiple
locations in the tree, all subtrees are displayed. If a MOC can be nested
beneath itself, only the top location is displayed.

— Command help -m|--moc <moc_name> [-p|--property] displays detailed

information on a certain MOC, similar to how MOCs are documented in the
online MOM descriptions.

The output displays the locations where a MOC can occur, its cardinality,
and if it can be created and deleted by users. All possible child MOCs are
listed, followed by the textual description of the MOC. Finally, all actions and

8/1553-CXA 118 03/5 Uen A | 2018-01-22 61

 Ericsson Command-Line Interface

attributes belonging to the MOC are listed. The list of actions and attributes
can be suppressed by adding a property parameter without arguments.

— Command help -m|--moc <moc_name> [-p|--property

<property_name> [,<property_name>]...]] displays detailed
information on one or more actions or attributes belonging to a MOC.

For actions, the output displays the textual description, the return type, and
the parameters and their multiplicities and types. For attributes, the output
displays their multiplicity, the textual description, and type information.
>help -t
ManagedElement
|-- SystemFunctions
| |-- AxeFunctions
| | |-- DataOutputHandling
| | | |-- DataTransferM
| | | | |-- BlockTransferManager
| | | | | |-- BlockDestinationSet
| | | | | | |-- AdvancedBlockDestSetInfo
| | | | | | |-- PrimaryBlockDestination
| | | | | | `-- SecondaryBlockDestination
| | | | | `-- BlockTransferQueue
| | | | `-- FileTransferManager
| | | | |-- InitiatingDestinationSet
| | | | | |-- AdvancedInitiatingParameters
| | | | | |-- PrimaryInitiatingDestination
| | | | | `-- SecondaryInitiatingDestination
| | | | |-- FileTransferQueue
| | | | | `-- AdvancedFileTransferQueueInfo
| | | | `-- RespondingDestinationSet
| | | | |-- AdvancedRespondingParameters
| | | | |-- PrimaryRespondingDestination
| | | | `-- SecondaryRespondingDestination
. . .
. . .
. . .

Example 14 Display the whole MOC class tree

>help -t -m DataTransferM
ManagedElement,SystemFunctions,AxeFunctions,DataOutputHandling,DataTransferM [1..1] <creatable> <de
|-- BlockTransferManager
| |-- BlockDestinationSet
| | |-- AdvancedBlockDestSetInfo
| | |-- PrimaryBlockDestination
| | `-- SecondaryBlockDestination
| `-- BlockTransferQueue
`-- FileTransferManager
|-- InitiatingDestinationSet
| |-- AdvancedInitiatingParameters
| |-- PrimaryInitiatingDestination
| `-- SecondaryInitiatingDestination
|-- FileTransferQueue
| `-- AdvancedFileTransferQueueInfo
`-- RespondingDestinationSet
|-- AdvancedRespondingParameters
|-- PrimaryRespondingDestination
`-- SecondaryRespondingDestination

Example 15 Display a specific MOC class tree

62 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

>help -m AuditLoggingM
ManagedElement,SystemFunctions,AxeFunctions,SecurityHandling,AuditLoggingM [1..1]
+-ExclusionItem [0..32767]

Represents the root MOC for ALOG function MOM.

It is created by the system and allows activating ALOG function, deactivating ALOG function,

This MOC in particular allows setting the following parameters:

- Status of the ALOG function.

- Capability to log MML command and MML session identification in the audit log.
- Capability to skip events with size greater than 1 Mbytes.
- Name of the TQ used by ALOG.
- Template format to be used by ALOG when generating the file names of the "audit log files"
It also provides information about:
- Reference to TQ MO in Data Transfer Management function MOM.

The events are stored in folder /audit_logs of the APG file system and the AP command alogfin
The setting of the name of the TQ used by ALOG (transferQueue attribute) fails if the specifi
The setting of the status of the ALOG function (alogAdmState attribute) to LOCKED value (deac
system" is shown.
The setting of the template format of "audit log files" and "protected audit log files" (temp
already configured" is shown.

ATTRIBUTES
alogAdmState Specifies the status of the Audit Log function.
auditLoggingMId Holds the name used when identifiyng the MO.
commandAndSessionAdmState Specifies the status of the "MML command/session identification" lo
largeEventDataSkipped Specifies if events (having size) bigger than 1MByte are truncated.
templateFormat Specifies the filename template format for "audit log files" and "p
transferQueue Specifies the identifier of TQ defined in ALOG function. Only file
transferQueueDn Specifies the DN for the MO representing the TQ used by ALOG functi

Example 16 Display a detailed information about a specific MOC

>help -m AuditLoggingM -p
ManagedElement,SystemFunctions,AxeFunctions,SecurityHandling,AuditLoggingM [1..1]
+-ExclusionItem [0..32767]

Represents the root MOC for ALOG function MOM.

It is created by the system and allows activating ALOG function, deactivating ALOG function,

This MOC in particular allows setting the following parameters:

- Status of the ALOG function.

- Capability to log MML command and MML session identification in the audit log.
- Capability to skip events with size greater than 1 Mbytes.
- Name of the TQ used by ALOG.
- Template format to be used by ALOG when generating the file names of the "audit log files"
It also provides information about:
- Reference to TQ MO in Data Transfer Management function MOM.

The events are stored in folder /audit_logs of the APG file system and the AP command alogfin
The setting of the name of the TQ used by ALOG (transferQueue attribute) fails if the specifi
The setting of the status of the ALOG function (alogAdmState attribute) to LOCKED value (deac
system" is shown.
The setting of the template format of "audit log files" and "protected audit log files" (temp
already configured" is shown.

Example 17 Display a detailed information about a specific MOC suppressing

the information about attributes and actions

8/1553-CXA 118 03/5 Uen A | 2018-01-22 63

 Ericsson Command-Line Interface

>help -m AuditLoggingM -p templateFormat

templateFormat = AUDIT [1..1]
Specifies the filename template format for "audit log files" and "protected audit log files".
The change of a format does not affect previous generated audit files.
TYPE Enumerated TemplateFormatType
Lists the possible filename template formats for "audit log files" and "protected audit log file

LITERALS
AUDIT
AUDIT template format.
When such template format is in use:
- the file names generated for "audit log files" have the format:
audit.yyyymmdd-HHMMSS
- the file names generated for "protected audit log files" have the format:
paudit.yyyymmdd-HHMMSS.zip
yyyy
indicates the year in four digits.
mm
indicates the month in two digits.
dd
indicates the day in two digits.
HH
indicates the hour (00-23) in two digits.
MM
indicates the minutes in two digits.
SS
indicates the seconds in two digits.
LOGFILE
LOGFILE template format.
When such template format is in use:
- the file names generated for "audit log files" have the format:
LOGFILE-yyyy-mm-dd-HHMM
- the file names generated for "Protected audit log files" have the format:
PLOGFILE_yyyy_mm_dd_HHMM.zip
yyyy
indicates the year in four digits.
mm
indicates the month in two digits.
dd
indicates the day in two digits.
HH
indicates the hour (00-23) in two digits.
MM
indicates the minutes in two digits.

Example 18 Display a detailed information about a specific MOC's attribute

>help -m BrmBackupManager -p createBackup
createBackup()
Creates a new backup of the backupType and backupDomain managed by the BackupManager. This is an

TYPE Boolean <true|false> [1..1]

PARAMETERS
name [0..1]
The name of the backup to create.
If specified, input name validation is done by the implementation to forbid illegal names. Bac
etc.
If not specified, the implementation will generate a backup name automatically with format def

TYPE String

Example 19 Display a detailed information about a specific MOC's action

2.3.5 Auto-Completion

Auto-completion can be performed at any position of the ECLI command and

can be requested on all possible continuations of the ECLI command and
model-defined elements the user is authorized to.

64 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Depending on the entered command, the response can be as shown in the table
below:

Table 22 Auto-Completion

8/1553-CXA 118 03/5 Uen A | 2018-01-22 65

 Ericsson Command-Line Interface

Scenario Response
A multiple valid continuation exists All valid continuations of the ECLI
command are printed in Completion
Possibility List with the following
content and listing order:
• ECLI operation name, for example,
show or history.

• ECLI operation parameter name,

for example, -v or --verbose for
operation show.
• MOC name.
• Attribute name and structure
member name.
• Action name.
• Action Parameter Names.
• Value of key attribute of existing
MOs.
• <new> indicates, in Config Mode,
that a key attribute value of a new
MO (not systemCreated) can be
specified.
• <value>indicates, in Config Mode,
that a new value for an attribute (not
readOnly) can be specified.
• " indicates in Config Mode that a
string attribute (not readOnly) value
can be specified in quotation marks.
• Comma (,) indicates that the MO
identified by the RDN can have an
attribute, a child MO, or an action.
• [ indicates in Config Mode that a
sequence attribute’s (not readOnly)
values can be specified within square
brackets.
• <cr> indicates that the entered
ECLI command is valid by itself,
and command execution can be
requested by pressing the CR key or
Enter key.
• <space> indicates that a space can
be entered after an action parameter
name or the value.

66 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Exactly one valid continuation (unique Auto-completion automatically

match) exists adds them, including the following
elements:
• Equal sign (=), comma (,) and space
(" ") characters.
• MOC and action names.
• Attribute names.
• Action Parameter names.
• Value of single-valued attributes
(enumeration, string, integer, and
boolean).
• Structure member names.
• Struct member names in sequence
of struct if the struct has the key
member.
• Enum structure member values.
The entered ECLI command is invalid Neither auto-completion nor a
completion possibility list is provided.

Auto-completion is provided only for valid ECLI commands the user is authorized
to, in a context-sensitive way, for example, as follows:

— Completion is provided for DNs as parameter of the show operation if the MO

exists and the user has read privilege to the MO.

— Completion is provided for attribute names as parameter of the show operation

if the attribute has a value assigned and the user has read privilege to the
attribute.

— Completion is provided for an attribute name in an attribute value change

operation if the attribute is not defined as read-only or restricted, and if the
user has write privileges to the attribute.

— Completion is provided for an attribute name in an attribute value change

operation if the attribute is not defined as read-only or restricted, and if the
user has write privileges to the attribute.

— Read-only and restricted attributes are not auto-completed as parameter

of show-config.

— Auto-completion of multiple MOs is not supported.

— Completion is provided when multiple attributes or struct members are set on

the same line, in the same way it is supported when only a single attribute or
struct member is set.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 67

 Ericsson Command-Line Interface

Keys Activating Auto-Completion

The keys shown in the table below activate auto-completion in the listed contexts
if the entered partial name uniquely identifies the name of the command or its
parameter.

Table 23 Key activating Auto-Completion

Key Description
Enter (CR) Completes operation, attribute, action
names, and DNs and then executes the
completed command, if there is a unique
match. Completes DN and attribute
names if they can be followed by an
= character.
Tab Provides auto-completion or a
completion possibility list.

2.3.5.1 Example of Completion Possibility List

An example of a completion possibility list is shown in Example 20 to Example 23.

(config)>show TAB
show-config
show-dn
show-mib
show-table
<cr>
<space>
Example 20 Completion Possibility List of show without space

(config-CallableThing=1)>add TAB
addNumbers
addNumbers_defValues
addNumbersNameClash
addsoc
Example 21 Completion Possibility List for Actions

config-CallableThing=1)>addNumbers --nTAB
--num1
--num2
Example 22 Completion Possibility List for Action Parameters

68 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

(config)>show TAB
--moc
--recursive
--verbose
-m
-r
-v
ManagedElement=<node_name>
<cr>
Example 23 Completion Possibility List of show with space

2.3.5.2 Examples of Auto-Completion

This section provides examples of auto-completion.

2.3.5.2.1 Unique Match for DN with Tab

Action: Press Tab after show M

Result: Triggers auto-completion to show ManagedElement=<node_name>

2.3.5.2.2 Unique Match for Partial DN with Tab

Action: Press Tab after >show ManagedElement=<node_name>,SystemFunction

s=1,FileM=1,LogicalFs=1,FileGroup=SysMMimSchemas,FileInformation=C

Result: Triggers auto-completion to show ManagedElement=<node_name

>,SystemFunctions=1,FileM=1,LogicalFs=1,FileGroup=SysMMimSc
hemas,FileInformation=Com if the FileInformation=ComFm.xml and
FileInformation=ComFileM.xml MOs exist

2.3.5.2.3 Unique Match for Operation Name with Enter

Action: Press Enter after c in Exec mode

Result: Triggers config operations

2.3.5.2.4 Unique Match for DN with Enter

Action: Press Enter after show m

Result: Triggers auto-completion to and execution of show ManagedElement=

<node_name>

2.3.5.2.5 Unique Match for DN with Enter

Action: Press Enter with empty command line in Config mode in Root position

8/1553-CXA 118 03/5 Uen A | 2018-01-22 69

 Ericsson Command-Line Interface

Result: Results in navigation to ManagedElement=<node_name>

2.3.5.2.6 Multiple matches for Parameter names of an Action with Tab

Action: Press Tab after addNumbers with space

Result: Triggers auto-completion to (config-CallableThing=<node_name>)

>addNumbers

--num1

--num2

2.3.5.2.7 Unique match for value of a parameter of an Action with Tab

Action: Press Tab after addNumbers --num1

Result: Triggers auto-completion to (config-CallableThing=1)>addNumbers

--num1

<value>

2.3.5.2.8 Unique match for Parameter name of an Action with Tab

Action: Press Tab after addNumbers --num1 20 with space

Result: Triggers auto-completion to (config-CallableThing=1)>addNumbers

--num1 10

--num2

2.3.5.2.9 Multiple matches for <space>, <cr> & <value> of a parameter with value of an
action with Tab

Action: Press Tab after addNumbers --num1 20

Result: Triggers auto-completion to (config-CallableThing=1)>addNumbers_

defValues --num1 23

<value>

<space>

<cr>

2.3.6 Auto-Completion of MO Reference Type

ECLI supports the completion of MO reference, when TAB is issued, on attribute
of type MO reference.

70 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

To activate the auto-completion for MO reference is necessary that the input

is quoted. The suggested MO references are: the root MO, the parent MO and
children MOs. The relative path is always relative to the ECLI position.

2.3.6.1 Example 1

This example describes auto-completion on the value of reference attribute. The

current ECLI position is the MO for which the attribute is to be set.
(config-NetconfTls=1)>nodeCredential=" TAB
"ManagedElement=<node_name>
"..
(config-NetconfTls=1)>nodeCredential="Suggested MO references are the
root MO ManagedElement=<node_name> and parent MO .. .

2.3.6.2 Example 2

This example describes auto-completion on the value of reference attribute. The

current ECLI position is SystemFunctions=1 MO.
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential=" TAB
"AxeFunctions=1
"BrM=1
"FileM=1
"Fm=1
"HealthCheckM=1
"ManagedElement=<node_name>
"Pm=1
"SecM=1
"SwInventory=1
"SwM=1
"SysM=1
"..
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="S
uggested MO references are the root MO ManagedElement=<node_name>, parent
MO .. and children MOs of current ECLI position SystemFunctions=1.

2.3.6.3 Example 3

This example describes auto-completion on the value of reference attribute

when several characters are provided by the user. The current ECLI position is
SystemFunctions=1 MO.
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="Man TAB
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElemen
"ManagedElement=<node_name>"
"ManagedElement=<node_name>,
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElemen
(config-SystemFunctions=1)>
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="S TAB
"SecM=1
"SwInventory=1
"SwM=1

8/1553-CXA 118 03/5 Uen A | 2018-01-22 71

 Ericsson Command-Line Interface

"SysM=1
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="SecM=1 TAB
"SecM=1"
"SecM=1,
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="SecM=1"
(config-SystemFunctions=1)>Suggested MO references are the ones starting
with the provided characters.

2.3.6.4 Example 4

This example describes auto-completion on the value of reference attribute to

navigate to a MO. The current ECLI position is SystemFunctions=1 MO.
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="Man TAB
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElement=<
"ManagedElement=<node_name>"
"ManagedElement=<node_name>,
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElement=<
"ManagedElement=<node_name>,SystemFunctions=1
"ManagedElement=<node_name>,Transport=1
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElement=<
"ManagedElement=<node_name>,SystemFunctions=1,AxeFunctions=1
"ManagedElement=<node_name>,SystemFunctions=1,BrM=1
"ManagedElement=<node_name>,SystemFunctions=1,FileM=1
"ManagedElement=<node_name>,SystemFunctions=1,Fm=1
"ManagedElement=<node_name>,SystemFunctions=1,HealthCheckM=1
"ManagedElement=<node_name>,SystemFunctions=1,Pm=1
"ManagedElement=<node_name>,SystemFunctions=1,SecM=1
"ManagedElement=<node_name>,SystemFunctions=1,SwInventory=1
"ManagedElement=<node_name>,SystemFunctions=1,SwM=1
"ManagedElement=<node_name>,SystemFunctions=1,SysM=1
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElement=<
"ManagedElement=<node_name>,SystemFunctions=1,SysM=1"
"ManagedElement=<node_name>,SystemFunctions=1,SysM=1,
(config-SystemFunctions=1)>SysM=1,NetconfTls=1,nodeCredential="ManagedElement=<
(config-SystemFunctions=1)>

2.3.7 Escaping of Special Characters

Table 24 Escape Sequences in Strings

Escape Sequence Description
\n New line
\r Carriage return
\t Tab
\" Quotation mark
\\ Escape character

72 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

\? Question mark (this character does not

need to be escaped in quoted input
strings)
\! Exclamation mark (this character does
not need to be escaped in quoted input
strings)
\# Hash (this character does not need to
be escaped in quoted input strings)
\xNN Any character in hexadecimal format
(2 hexadecimal digits)

NN is any character "0" through "9" or

"A" through "F" or "a" through "f".

The sequence \x00, which translates

to the string termination character
in C is not allowed. Non US-ASCII
characters are not allowed (NN is
greater than \x7F).
\NN In MO instance names only:
Any character in hexadecimal format
(2 hexadecimal digits).

NN is any character "0" through "9" or

"A" through "F" or "a" through "f".

This format is mandated by 3GPP TS

32.300, Naming convention for MO.
This escaping format is always used
when DNs are displayed.

Entered escape sequences are internally converted into the characters they
represent before being stored. When a string value is printed by the ECLI,
characters are escaped when needed. For example, a quotation character within
a string is printed as \". The exception is DNs, where an escape sequence is only
converted into the character it represents when the character is allowed according
to 3GPP TS 32.300. Otherwise escaping is translated to the \NN format (as
mandated by 32.300).

2.3.7.1 Examples of use of Special Characters

(config-ManagedElement=<node-name>)>userLabel=hello\nworld
(config-ManagedElement=<node-name>)>show userLabel
userLabel="hello\nworld"
(config-ManagedElement=<<node-name>)>
Example 24 Set String Attribute with Special Character

8/1553-CXA 118 03/5 Uen A | 2018-01-22 73

 Ericsson Command-Line Interface

(config-aSimpleStruct)>str1=hello\!world
(config-aSimpleStruct)>show str1
str1="hello!world"
(config-aSimpleStruct)>
Example 25 Set struct Member with Special Character

2.3.8 List of ECLI Commands

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
? Yes Yes Displays context-sensitive help on GENERAL
available ECLI command elements.
abort No Yes Discards changes entered in the TRANSACTIO
current transaction, closes the N
transaction, and creates a new one.
action <actio Yes Yes Invoke the same action on a set PIPE
n_name> ('-- of selected MO instances. The
'<param_name> command is a pipe extension
<param_value>)* command that has to be used
together the show command.
For details, see Section 2.2.8.1 on
page 46.
back [-h | Yes Yes Without parameter, navigates back NAVIGATION
--history] to the previous position in the MO
tree.
• --history or -h – lists the previous
positions in the MO tree without
changing the current position.
The root position in the navigation
history is not stored in the navigation
history because the top command
can be used to navigate there.
Only the last 10 positions are kept in
this navigation history.
commit No Yes Commits configuration changes TRANSACTIO
of the current transaction and N
automatically starts a new
transaction.
configure Yes No Changes the ECLI mode to TRANSACTIO
configuration. N

74 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
dn<DN> Yes Yes Navigates to any existing location in NAVIGATION
the MOM.
or
• --moc | -m – Specify the MO class
dn -m | --moc to navigate to.
<moc-name>[
--condition | • -c or --condition –can be used
-c <condition>] to define criteria for the MO to
navigate to. This can be used if
there are more than one instances
of the selected MO class. See
Section 2.3.8.1 on page 81 for
details.
end No Yes Command end changes the ECLI TRANSACTIO
mode to Exec Mode, if there are no N
changes in the current transaction.
exit Yes No Exits the AP session. GENERAL
help [-m|--moc] Yes Yes Without parameter, provides help GENERAL
<moc_name> on the current ECLI mode and the
[-p|--property available commands in this mode.
<property_name With parameters, provides help on
>[,<property_nam the information model. For details,
e>]...]] see Section 2.3.1 on page 58, Section
2.3.2 on page 58, Section 2.3.3 on
help -t|-tree
page 60 and Section 2.3.4 on page
[–m|--moc
61.
<moc_name>]
history [-s|--si Yes Yes Without parameter, prints the GENERAL
ze] command history of the current
[<number>] AP session in chronological order
in the format <sequence_number>
<date> <time> <command>.

Parameter–s or –-size specifies the

size .
Parameter number is the number of
lines to be displayed. Default is 100.
insert No Yes Inserts a sequence element to a CONFIGURAT
sequence (multi-valued) before the ION
specified element.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 75

 Ericsson Command-Line Interface

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
length [<Length Yes Yes Without parameter, displays the GENERAL
>] number of ECLI output rows printed
until --More-- is printed and print
is suspended.
The printout is continued by pressing
Space or Enter.
Parameter Length is a number in
the range 0–1410065407. Default
is zero, which indicates no output
break.
modify <modifica Yes Yes Modify attributes or struct members, PIPE
tion_operations> it performs the same update
operations on a set of selected MO
instances. The command is a pipe
extension command that has to be
used together the show command.
For details, see Section 2.2.5.9 on
page 36.
no<RDN> No Yes Deletes an MO instance, an attribute, CONFIGURAT
or an element from a sequence. A ION
or sequence element can be selected
no [<RDN>,]
either by its value or by its positional PIPE
[<attribute_
index (starting from 1). If an
name>[=<attri
attribute with a default value is
bute_value> |
deleted, the attribute becomes
'['@<index>']']
empty.
The command can be used as a a
pipe extension command that has to
be used together the show command.
For details, see Section 2.2.7.1 on
page 42.
prompt [<prompt_ Yes Yes Customizes the prompt using GENERAL
specifier>] variables $default, $dn, $mode,
$nodename, $rdn, and $user or
any desired string or combination
of these for the lifetime of the AP
session.
<RDN> Yes Yes Changes the ECLI position to the NAVIGATION
RDN. If the MO does not exist, the
MO is created in Config Mode.

76 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
[<RDN>] <action_ Yes Yes Requests action execution. CONFIGURAT
name> [--<action ION
_parameter_name>
<action_paramete
r_value>]*
[<RDN>] <attribu No Yes Assigns value to an attribute. CONFIGURAT
te_name>=<attrib ION
ute_value>
scriptmode [on | Yes Yes Without parameter, prints the GENERAL
off] present state of the scriptmode in
the ongoing AP session.
Parameter on is used to turn on
scriptmode, in which help function,
auto-completion, case correction
and page break is disabled in
ongoing AP session if not done.
Parameter off is used to turn off
scriptmode, in which help function,
auto-completion, case correction
and page break is enabled back
in ongoing AP session if not done
already.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 77

 Ericsson Command-Line Interface

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
show [--recu Yes Yes Displays the system configuration GENERAL
rsive | -r] and state information as MO
[--verbose | -v] properties with the following
[[ <RDN> [,<attr options:
ibute_name>['['@
<index>']']] | • --recursive or -r – Displays
[<attribute_name child MO instances in a recursive
>]] manner.

or • --verbose or -v – Displays
attributes that are not set and
show [RDN] --moc attribute set to their default values.
| -m <moc-name>
[--property | -p • RDN – The RDN to the MO instance
<attribute_name> relative to the ECLI position. The
[,<attribut current position is used if no DN is
e_name>]*] specified.
[--condition |
-c <condition>]
• index – Specifies a sequence
element in a sequence attribute.
The index starts from 1.
• --moc|-m – Specify the MO name
whose instances have to be filtered.
• -c or --condition –can be used
to define criteria for the MO to
navigate to. This can be used if
there are more than one instances
of the selected MO class. See
Section 2.3.8.1 on page 81 for
details.
• Without options, only those
attributes are displayed that have
a value assigned and not a default
value.
show-config Yes Yes Displays the output in configuration GENERAL
[--verbose | -v] format. Configuration also
[<RDN>] automatically enables the all
parameter.

78 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
show-table[--r Yes Yes Displays the show verbose GENERAL
ecursive | -r] information without metadata
[RDN] -m | --moc in table format.
<moc-name> [-p
| --property • --recursive or -r – implies
<attribute_name> that the displayed instances can
[:<column be anywhere below the current
width>][,<at position.
tribute_name>
• --moc|-m – Specify the MOC name
[:<column
whose instances to be displayed.
width>]]*] [-c
| --condition • -c or --condition can be used
<condition>] to define criteria for the MO to
navigate to. This can be used if
there are more than one instances
of the selected MO class. See
Section 2.3.8.1 on page 81 for
details.
show-dn Yes Yes Displays the current location of the NAVIGATION
user in the MOM.
show-mib Yes Yes Displays MO instance information. GENERAL
[--verbose | -v] For more details.
[<RDN>]
top Yes Yes Changes the ECLI position to the NAVIGATION
root position.
up Yes Yes Changes the ECLI position to the NAVIGATION
parent MO.
validate No Yes Validates the configuration changes TRANSACTIO
in a transaction. Returns validation N
error or message Transaction is
valid!.
version Yes Yes Displays the ECLI version. GENERAL
The ECLI version is described using
three sequence numbers:
<maior>.<minor>.<revision>

8/1553-CXA 118 03/5 Uen A | 2018-01-22 79

 Ericsson Command-Line Interface

Table 25 ECLI Commands

ECLI Command Exec Config Description Category
Mode Mode
width [{-s | Yes Yes Without parameter, displays the GENERAL
--size} <Width>] number of ECLI output characters
printed on a line until the line is
broken.
The parameter Width is a number in
the range 0–1410065407. Default
is zero, which indicates no line
break for non-tabular output, and
that tabular output uses the actual
terminal window size.
The Width command is primarily
intended for informing the ECLI
about the actual terminal width
when the ECLI cannot determine it
by itself. Setting the width to a value
other than the actual terminal width
is not recommended.
<command/Action> Yes Yes Displays the lines that match the GENERAL
| filter [-i | specified pattern with the following
--ignore] [-v options.
| --invert]
[{-A | --after} • -i | --ignore : Ignore case
<value>] [{-B distinctions in both the pattern and
| --before} the input.
<value>]
• -v | --invert : Invert the
<pattern>
sense of matching, to select
non-matching lines.
• -A | --after : Print number
of lines of trailing context after
matching lines.
• -B | --before : Print number
of lines of leading context before
matching lines.
• <value> : The value for number
lines to be printed after leading /
trailing context.
• <pattern> : The text used
for filtering the output of a
command/action.

80 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Note: In case of wrong usage some commands return the error message ERROR:
Command not found.

2.3.8.1 Syntax for --condition Option

There can be a maximum of two conditions that can be specified for this option.
The type of attributes that can be used as part of the condition are: integer, string,
boolean and enum. If the attribute used in the condition is of the type string, then
the value specified for that attribute must be quoted, otherwise an error message
saying Condition String not quoted is shown.
The syntax for condition is [Condition]=[<attribute><operator><value>].
The valid operators are:

— =or = for left hand side is equal to the right hand side.

— >= for left hand side is greater than or equal to the right hand side.

— <= for left hand side is less than or equal to the right hand side

— <> for left hand side is greater or less than (not equal) the right hand side.

— < for left hand side is smaller than the right hand side.

— > for left hand side is greater than the right hand side.

In case of multiple conditions to be specified, the conditions must be separated by

logical "OR (||)" or the logical "AND (&&)" operator.
An expression can be preceded by a NOT predicate to negate the expression.
Parentheses can be used for grouping of expressions.
The multiple condition syntax is as follows:
[Condition]=((condition)&&(condition))[
[Condition]=((condition)||(condition))[
[Condition]=NOT(condition)[

2.3.8.2 Generic Error Messages

Table 26 Examples of Generic Error Messages

Error Message Error Semantics
ERROR: Command not found Indicates that the syntax of the command is not
valid.

8/1553-CXA 118 03/5 Uen A | 2018-01-22 81

 Ericsson Command-Line Interface

Table 26 Examples of Generic Error Messages

Error Message Error Semantics
ERROR: Call command failed, error Depending on the command and the MO
code: <error_reason> instance, as described in the product-specific
documentation, the error reason can be one of
the following:
- ComAborted
- ComAlreadyExist
- ComCommitFailed
- ComFailure
- ComInvalidArgument
- ComNoResources
- ComNotActive
- ComNotExist
- ComObjectLocked
- ComPrepareFailed
- ComTimeOut
- ComTryAgain
- ComValidationFailed
- Unknown return code
ERROR: Unable to authenticate the user User is not allowed to perform the command.

2.3.9 Command Key Sequences

Table 27 Command Key Sequences
Key Combination Action
Ctrl+B or Left arrow Move the cursor back one character
Esc+B or Alt+B Move the cursor back one word
Ctrl+F or Right arrow Move the cursor forward one
character
Esc+F or Alt+F Move the cursor forward one word
Ctrl+A Move the cursor to the beginning of
the command line
Ctrl+E Move the cursor to the end of the
command Line
Ctrl+H Delete the character before the
cursor

82 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 How to Use

Ctrl+D Delete the character at the cursor

When the cursor is within the line it
deletes the cursor character. When
invoked at the end of the line it
displays all possible completions
then redisplays the line. When
invoked on an empty line, it
terminates the session.
Ctrl+K Delete all characters from the
cursor to the end of the line
Ctrl+U Delete the whole line
Esc+Backspace or Alt+Backspace Delete the word before the cursor
Ctrl+W Delete the characters between the
last mark that was set, and the
cursor.
Esc+D or Alt+D Delete the word after the cursor
Ctrl+Y Insert the most recently deleted
text at the cursor
Ctrl+P or Up arrow Scroll backward through the
command history
Ctrl+N or Down arrow Scroll forward through the
command history
Esc+C Capitalize the word at the cursor,
that is, make the first character
uppercase and the rest of the word
lower case
Esc+L Convert all the characters of the
word which follows the cursor to
lower case.
Esc+U Convert all the characters of the
word which follows the cursor to
upper case
Ctrl+C Abort a command or clear line
Ctrl+L Clear the terminal, then redisplay
the current line
Ctrl+T Swap the character under the
cursor with the character just
before the cursor
Ctrl+R Redisplay the line

8/1553-CXA 118 03/5 Uen A | 2018-01-22 83

 Ericsson Command-Line Interface

2.4 Action on Alarms

2.4.1 APG BACKUP NOT CREATED

The observation alarm APG BACKUP NOT CREATED, severity O1, is raised when
a configuration change is performed and committed in an AP session. It indicates
that an APG backup is necessary to avoid loosing performed change(s) in case a
restore is ordered.
It is automatically ceased as soon as a new APG backup is created. Refer to User
Guide Backup and Restore Management for more information on how to take
an APG backup.

84 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 Configuration

3 Configuration

8/1553-CXA 118 03/5 Uen A | 2018-01-22 85

 Ericsson Command-Line Interface

86 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 Glossary

Glossary

CLI
Command-Line Interface

DN
Distinguished Name

ECLI
Ericsson Command-Line Interface

ME
Managed Element

MO
Managed Object

MOC
Managed Object Class

MOM
Managed Object Model

OaM
Operation and Maintenance

RDN
Relative Distinguished Name

8/1553-CXA 118 03/5 Uen A | 2018-01-22 87

 Ericsson Command-Line Interface

88 8/1553-CXA 118 03/5 Uen A | 2018-01-22

 Reference List

Reference List

[1] How to Access an AXE

USER GUIDE

[2] Managed Element Management

USER GUIDE

[3] Managed Object Model

USER GUIDE

[4] User Management

USER GUIDE

8/1553-CXA 118 03/5 Uen A | 2018-01-22 89