Contents

1   Introduction

This User Guide provides an overview of the Ericsson Command-Line Interface (ECLI). The ECLI is a terminal-based CLI, through which the Managed Element (ME) is monitored and managed. It is based on industry de facto standard patterns for easy management of the system.

The ECLI enables interaction with the Management Information Base (MIB) through common, generic-purpose commands.

Note:  

For the node name, NODE06ST is used as an example in this document.

1.1   Related Information

For a complete description about the ECLI, including descriptions of all commands, key combinations, error messages, character support, and examples, refer to Interwork Description Ericsson Command-Line Interface.

For information on the Managed Object Model (MOM), Managed Object Classes (MOCs), Managed Objects (MOs), and related concepts mentioned in this document, refer to Managed Object Model User Guide.

1.2   Key Features of ECLI

The key features of the ECLI are described in Table 1.

2   ECLI Modes

The ECLI provides the following two modes:

• Exec mode – Displays the status of the ME. In this mode, enter commands to monitor the ME, display its configuration, and execute actions.
• Config mode – Used to change the ME configuration. In this mode, start a configuration transaction to the MIB, enter commands to change the ME configuration, and commit the changes.

As shown in Figure 1, when initiating an ECLI session, always enter Exec mode, which is the default mode.

Some of the basic ECLI commands are described in Table 2.

3   Start an ECLI Session

To start an ECLI session:

1. Use a terminal and start the SSH session.

   Example of logon with OpenSSH client:

   ssh -A <user>@<target_host> -p 2022

   The options are as follows:

   • <user> – Username.
   • <target_host> – The OAM virtual IP address of the ME.
   • -p (port number) – TCP port 2022 is default.

   Root user access is denied.

2. Wait for the session to start.

4   Use ECLI Online Features

The ECLI provides online and context-sensitive help. It enables access to information about the commands, the MIB, and the MOM.

4.1   Static Help

Command help provides static help about the ECLI, see Table 3.

4.2   Information Model Help

Command help also provides information model help, see Table 4.

4.3   Context-Sensitive Help

Request context-sensitive help on the ECLI commands and MOM elements (MOCs, attributes, and actions) by pressing the ? key. The returned output depends on the input, the ECLI mode, and the ECLI position. Online help is only available for commands and model elements that can be auto-completed in the current ECLI mode.

The following examples show how to use the ? key to trigger context-sensitive help:

>show?

show    Command
Display information

>show ?

--moc                 Option to select a specific child
                      MOC under the current DN
--recursive           Display all information
--sort                Sort the MO instances in
                      numerical/alphabetical order
--verbose             Display verbose information
-m                    Option to select a specific child
                      MOC under the current DN
-r                    Display all information
-s                    Sort the MO instances in
                      numerical/alphabetical order
-v                    Display verbose information
+ManagedElement       The top-level class in the Common
                      Information Model is Managed Element
                      root Managed Object Class

>show -v -?

--recursive           Display all information
-r                    Display all information

(config-ManagedElement=NODE06ST)>userLabel?

userLabel       String  [optional]
A freetext string for additional information to assist
Managed Element identification.

4.4   Auto-Completion

The Tab key can be used at any point on the command line to either autocomplete the line or (if more than one option for completion exists) display all the valid options matching what has been typed so far, for example:

>dn ManTab
>dn ManagedElement=NODE06ST

>dn ManagedElement=NODE06ST,Tab

CSCF-Application=CSCF
CscfDomainRoutingApplication=CscfDomainRouting
CscfEosApplication=CscfEos
DIA-CFG-Application=DIA
DNS-Application=DNS
ExtNetSel-Application
LdapClientApplication=LdapClientApplication
NumberNormalisation=NumberNormalisation
SigComp-Subsystem=SigComp
SystemFunctions=1
Transport=1

>dn ManagedElement=NODE06ST,

>dn ManagedElement=NODE06ST,cscfTab

CSCF-Application=CSCF
CscfDomainRoutingApplication=CscfDomainRouting
CscfEosApplication=CscfEos

>dn ManagedElement=NODE06ST,cscf

5   Navigate in MIB

Navigation allows changing the ECLI position without changing the configuration.

The commands described in Table 5 are used to navigate in the MIB.

Note:  

In Config mode, command <RDN> creates the corresponding MO if it does not exist.

6   Display ME Status

The commands described in Table 6 are used to display the ME status.

7   Change ME Configuration

Change the ME configuration by explicitly creating MOs, updating MOs (setting and changing MO attributes), and deleting MOs.

Attention!

Risk of data loss or data corruption.

Ensure to commit the changes to make them effective.

The commands described in Table 7 are used to change the ME configuration and can only be used in Config mode.

8   Execute MO Actions

An MO action is a command that is used only when the ECLI is positioned at the proper MO. Actions are used to trigger MO-specific operations.

Attention!

Risk of data loss or data corruption.

Unless stated otherwise, only execute actions in Exec mode to minimize the risk to misconfigure the system.

The command syntax to execute actions is described in Table 8.

If <action_name> is conflicting with any command name, give the action request as '.,<action_name>' if the action must be executed from the current Distinguished Name.