Command Description

SCU 09 01 Node, Ericsson Site Controller Node

Description

22/1551-LZA 701 6016/1 Uen N

Copyright

© Ericsson AB 2017, 2021–2022, 2024. 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.

Trademark List

All trademarks mentioned herein are the property of their respective owners.
These are shown in the document Trademark Information.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Contents

Contents

1 Introduction 1
1.1 Target Groups 1

2 General Information 2
2.1 Typographic Conventions 2
2.1.1 Command Line 2
2.1.2 Command Response 3
2.2 Terminology 3

3 User Login and Logout 5

3.1 User Login 5
3.2 User Logout 6

4 Command Listing 7

5 Generic Commands 11
5.1 help 11
5.2 changePWD 14
5.3 clearAlarmList 16
5.4 exit 17
5.5 getAlarmHistoryLog 18
5.6 getAlarmList 19
5.7 last 20
5.8 restart 22
5.9 uptime 23
5.10 ping 23

6 Subscription Commands 26
6.1 subscribe 26
6.2 unsubscribe 28
6.3 getSubscriptionIds 28
6.4 getSubscriptionStatus 29
6.5 suspendSubscription 30
6.6 resumeSubscription 31

7 Basic CM Commands 33
7.1 Transaction Management Commands 33

22/1551-LZA 701 6016/1 Uen N | 2024-06-25

Command Description

7.1.1 startTransaction 34
7.1.2 checkConsistency 35
7.1.3 commit 36
7.1.4 endTransaction 38
7.1.5 getTransactionId 39
7.1.6 getTransactionStatus 39
7.2 MO Management Commands 40
7.2.1 createMO 41
7.2.2 setMOAttribute 42
7.2.3 getMOAttribute 44
7.2.4 deleteMO 45
7.2.5 action 46
7.2.6 getContainment 47
7.2.7 findMO 49
7.2.8 deleteMOAttributeValue 50

8 Bulk CM Commands 52
8.1 startSession 53
8.2 upload 54
8.3 download 56
8.4 activate 58
8.5 abortSessionOperation 59
8.6 endSession 60
8.7 getSessionIds 61
8.8 getSessionStatus 62

9 Performance Management Commands 64

9.1 suspendPMMeasurements 64
9.2 resumePMMeasurements 65

10 Software Upgrade Commands 67

10.1 startSWSession 67
10.2 downloadSW 68
10.3 activateSW 71
10.4 endSWSession 72
10.5 getSWSessionIds 73
10.6 getSWSessionStatus 74
10.7 abortSWSessionOperation 75

11 License Commands 76
11.1 setULN 76
11.2 activateLicense 77

22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Contents

11.3 getULN 78
11.4 setEmergencyMode 79

12 Removed and Renamed Commands 80

22/1551-LZA 701 6016/1 Uen N | 2024-06-25

Command Description

22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Introduction

1 Introduction

This document describes how to handle all commands in the Command Line
Interface (CLI) of a ESC or SCU node. The CLI is accessible through a Secure
Shell (SSH) client. The purpose of this document is to support the user to
configure ESC or SCU nodes.

The ESC or SCU node connects to the ENM using Secure File Transfer Protocol
(SFTP) or FTP through a TLS server for file transfers. The SFTP server must
be set to use port 115. The TLS server for FTP must be set to use port 21.
SFTP is used for downloading software archives and uploading Performance
Management (PM) data. The ESC or SCU node also sends Simple Network
Management Protocol (SNMP) traps to an SNMP agent in the ENM. In addition,
O&M support for configuring ESC or SCU nodes is available, based on the
Ericsson Common Information Model (ECIM).

1.1 Target Groups

This document is for the following people:

— Site engineers

— Network engineers

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 1

 Command Description

2 General Information

This section explains the typography used in this document and explains some
terms that must be understood to comprehend the text.

2.1 Typographic Conventions

This section describes the typographic conventions used in the CLI examples of
this document.

2.1.1 Command Line

Commands specified on the command line have the following syntax:

command ParameterValue1 [OptionalParameterValue2] ...

Entities on the command line are separated from each other by one or more
spaces. All entities are case insensitive unless otherwise stated for the command.
All entities are not used in all commands.

The values for parameters are given in a specific order. The order defines the
parameter for which the value applies. The specific order of parameters for each
command corresponds to the order of parameters in the tables of the command
descriptions.

The maximum number of characters in the command line is by default 512. If

more characters are required in the command line, the following methods are
available:

— At the end the line, type a back-slash character: (\) and press Enter to make
the command line continue on the next line.

— Press Ctrl+J to make the command line continue on the next line.

Input Typography
The following example describes the input data to be given in a command and
also how the commands are reproduced in this document:

commandExactlyAsWritten parameterValue1 parameterValue2 [optionalP →

arameterValue3] [optionalParameterValue4]...

2 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 General Information

The CLI is case insensitive. However, for clarity all input commands and
parameters given in this document are written as in the example above. When
typing a command, the user may omit the case handling without consequences.

2.1.2 Command Response

When a command has been successfully received and processed, the node
responds with the following status:

OperationSucceeded

When a command could not be successfully received and processed, the node
responds with the following status:

OperationFailed

Some commands result in a response with more data. The tables for each
command give all output data.

Output Typography
The following example describes the output given as a response to a command
and also how the output data are reproduced in this document:

Output data displayed by the system

2.2 Terminology
The following are brief explanations of concepts that are used in this document:

Alarm Persistent indication of a fault.

Event Something that happens which may be of interest. A

fault, a change in status, crossing a threshold, or an
external input to the system, for example.

Fault Lasting error or warning condition.

Managed Object Class

Abstract view of a functionality that is subject to
management. An MO Class is defined in terms of
the attributes it possesses, operations it may perform,
notifications it may issue, and interactions it may have
with other MO Classes.

Managed Object Instance of an MO Class. An MO provides storage for

the attributes of the MO Class. It is only MOs that
can perform the operations, issue notifications and have

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 3

 Command Description

interactions with other MOs according to the definitions

of the MO Class the MO belongs to.

MOs are manipulated with a limited set of operations

(create, delete, get, and set). They can also issue
notifications. An MO behavior is the way in which the
object, attributes, notifications, relations and actions
interact with the actual resources they model and how
objects interact with each other.

Notification Unsolicited transmission of management information.

Transaction Type of data transaction that is guaranteed to completely

perform all contained steps or none at all.

4 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 User Login and Logout

3 User Login and Logout

This section describes login and logout to the node CLI.

3.1 User Login

The following operations allows SSH clients to perform a login to the node CLI
using authentication based on a username and a password.

Login Syntax

ssh oss@IP_address
oss@IP_address's password:
>

The user login is initiated by typing ssh followed by oss@IP_address. The node
requests for a password.

Entering the wrong password five consecutive times locks the account for 15
minutes. Every subsequent attempt to connect during this period extends the
locked state of the account with another 15 minutes.

Input

Input Data Description Remark

ssh Command
oss User name. Cannot be changed. Mandatory
IP_address The IP address bound to the node WAN port. Mandatory
password The defined password of the SSH client. Mandatory
The password is set during the first user
login. The password can be changed with the
changePWD command, see changePWD on page
14.

Output Data

Output Description
hostname> The CLI command prompt is presented if the login is successful.
Access denied This message is given if the password is incorrect
oss@<IP_address>'s
password: Note:

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 5

 Command Description

Output Description
or The declining login response will vary depending on the SSH client used.
Two examples are given here.
Permission denied
(publickey,password,k
eyboard-interactive).

Example

ssh [email protected]
[email protected]'s password:
esc01-ki09>

In this example the user logs in as [email protected] and after entering

default as password, the ESC responds with a command prompt >.

3.2 User Logout

This section describes how to logout from the node CLI.

Logout Syntax
> exit

Input

Input Data Description Remark

exit This operation exits the SSH session and logs Mandatory
the user out.

6 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Command Listing

4 Command Listing

This section lists all available commands. The table contains the following
information:

Literal Command The command as it must be typed on

the command line.
Command in Plain English This information is given for better
readability. Do not use for entering a
command.
Command Group Reference to the section where the
command is described.

Literal Command Command in Plain English Command Group

abortSessionOperation on Abort session operation Bulk CM Commands on page
page 59 52
abortSWSessionOperation on Abort software session Software Upgrade Commands
page 75 operation on page 67
action on page 46 Action MO Management Commands
on page 40
activate on page 58 Activate Bulk CM Commands on page
52
activateLicense on page 77 Activate license License Commands on page
76
activateSW on page 71 Activate software Software Upgrade Commands
on page 67
changePWD on page 14 Change password Generic Commands on page
11
checkConsistency on page 35 Check consistency Transaction Management
Commands on page 33
clearAlarmList on page 16 Clear alarm list Generic Commands on page
11
commit on page 36 Commit Transaction Management
Commands on page 33
createMO on page 41 Create Managed Object MO Management Commands
on page 40
deleteMO on page 45 Delete Managed Object MO Management Commands
on page 40

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 7

 Command Description

Literal Command Command in Plain English Command Group

deleteMOAttributeValue on Delete Managed Object MO Management Commands
page 50 Attribute value on page 40
download on page 56 Download Bulk CM Commands on page
52
downloadSW on page 68 Download software Software Upgrade Commands
on page 67
endSession on page 60 End session Bulk CM Commands on page
52
endSWSession on page 72 End software session Software Upgrade Commands
on page 67
endTransaction on page 38 End transaction Transaction Management
Commands on page 33
exit on page 17 Exit Generic Commands on page
11
findMO on page 49 Find Managed Object MO Management Commands
on page 40
getAlarmHistoryLog on page Get alarm history log Generic Commands on page
18 11
getAlarmList on page 19 Get alarm list Generic Commands on page
11
getContainment on page 47 Get containment MO Management Commands
on page 40
getMOAttribute on page 44 Get Managed Object attribute MO Management Commands
on page 40
getSessionIds on page 61 Get session IDs Bulk CM Commands on page
52
getSessionStatus on page 62 Get session status Bulk CM Commands on page
52
getSWSessionIds on page 73 Get software session IDs Software Upgrade Commands
on page 67
getSWSessionStatus on page Get software session status Software Upgrade Commands
74 on page 67
getSubscriptionIds on page Get subscription IDs Subscription Commands on
28 page 26
getSubscriptionStatus on page Get subscription status Subscription Commands on
29 page 26

8 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Command Listing

Literal Command Command in Plain English Command Group

getTransactionId on page 39 Get transaction ID Transaction Management
Commands on page 33
getTransactionStatus on page Get transaction status Transaction Management
39 Commands on page 33
getULN on page 78 Get Unique Logical Name License Commands on page
76
help on page 11 Help Generic Commands on page
11
last on page 20 Last Generic Commands on page
11
ping on page 23 Ping Generic Commands on page
11
restart on page 22 Restart Generic Commands on page
11
resumePMMeasurements on Resume Performance Performance Management
page 65 Management measurements Commands on page 64
resumeSubscription on page Resume subscription Subscription Commands on
31 page 26
setEmergencyMode on page Set emergency mode License Commands on page
79 76
setMOAttribute on page 42 Set Managed Object attribute MO Management Commands
on page 40
setULN on page 76 Set Unique Logical Name License Commands on page
76
startSession on page 53 Start session Bulk CM Commands on page
52
startSWSession on page 67 Start software session Software Upgrade Commands
on page 67
startTransaction on page 34 Start transaction Transaction Management
Commands on page 33
subscribe on page 26 Subscribe Subscription Commands on
page 26
suspendPMMeasurements on Suspend Performance Performance Management
page 64 Management measurements Commands on page 64
suspendSubscription on page Suspend subscription Subscription Commands on
30 page 26

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 9

 Command Description

Literal Command Command in Plain English Command Group

unsubscribe on page 28 Unsubscribe Subscription Commands on
page 26
upload on page 54 Upload Bulk CM Commands on page
52
uptime on page 23 Uptime Generic Commands on page
11

10 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

5 Generic Commands

This section describes generic commands related to the functionality and security
of the node.

The following commands are described in this section:

— help

— changePWD

— clearAlarmList

— exit

— getAlarmHistoryLog

— getAlarmList

— last

— restart

— uptime

— ping

5.1 help
The help command can be used in three ways:

— help The output lists all available commands and MO classes. No input
parameter is given.

— help [command]

The output is a brief description of the command and a declaration of

parameters used with this command.

— help [moClass]

The output is a brief description of the moClass.

Command Syntax

help

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 11

 Command Description

help [command]

help [moClass]

Input Data

Parameter Description Remark

command The name of the command for which the user Optional
wants a description.
moClass The name of the MO class for which the user Optional
wants a description.

Output Data

Data Type Description

Command and MO A list of all available commands and MO classes. The list is presented if
class list no input parameter is given with the help command.
Command description A brief command description. It is presented if the input parameter
<command> is given with the help command.
MO class description A list of parameters used for the MO class given and a short description
for each parameter. It is presented if the input parameter <moClass> is
given with the help command.

Example 1

help
Available commands:
abortsessionoperation
abortswsessionoperation
activate
activatelicense
activatesw
changepwd
...
uptime
Available MO-classes:
ACMeter
ACPhase
AirConditioner
AlarmEntry
AlarmOutputPort
AlarmPort

12 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

...
WindPower

In this example the help command is used without giving any parameter. The
response is a list of all available commands and MO classes.

Example 2

help commit
Commit a transaction

Usage:
commit <transactionID> <forcedCommit> <autoRollback> <minutes>

Description:
The operation commits all configuration changes in a transactio →
n (operations setMOAttribute, createMO and deleteMO).
If <forcedCommit> is set (default: false), the site node can per →
form a node restart if required because of changed attributes. I →
f not set and a node restart is required because of changed attr →
ibutes, then the site node rejects the commit operation.

If <autoRollback> is set, the site node restarts with the

old configuration if endTransaction is not received in specifie →
d time (minutes).

In this example, help is requested for the MO class commit. The response is a brief
description of the command commit and a declaration of parameters that can be
used with this command.

Example 3

help Equipment
Description of MO Class Equipment
SDN
+-SerialPort
+-Modbus
+-Equipment SDN
+-ECBus
+-Equipment
MO Modbus packet counters
this MO is created by the system

Attribute Descriptions
productName:
Product name of connected equipment
productNumber:

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 13

 Command Description

Product number of connected equipment

serialNumber:
Serial number of connected equipment
productRevision:
Product revision of connected equipment
manufacturingDate:
Manufacturing date of connected equipment
swProductNumber:
Primary software product number
swProductRevision:
Primary software product revision
identifier:
A unique human readable representation of the address o →
n the interface or
an empty string if address is not needed
timeLastSeen:
The time the equipment was last seen. For internal equip →
ment, this is
always the current time.
connectedTo:
A MO-DN reference to the interface or bus where the uni →
t was found.
For internal equipment, this is always the empty string
userLabel:
Label for free use.

In this example, help is requested for the MO class Equipment. The response is a
brief description of the MO class Equipment.

5.2 changePWD
This command changes the password for the oss or oss-security user, which are
the only users in the system that use password authentication.

The user must use the password to log on to the node through an SSH
connection.

The following restrictions on the password are mandatory (default values from
the PasswordPolicy MO):

— Must contain minimum 10 characters

— Must contain at least one lowercase character (a-z)

— Must contain at least one uppercase character (A-Z)

— Must contain at least one digit (0-9)

— Must contain at least one special character (for example, @;!$.)

14 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

— Must not contain dictionary words or strings of characters that represents

words

— Must not contain only whitespaces

— Must not contain the user name

— Must not contain monotonic character sequences

— Password must not exist in the list of last 10 passwords used

The following restrictions on the password are recommended but disabled by

default:
— Characters must not be repeated consecutively more than twice.

— The same character must not be used more than three times total.

— Minimum five characters must be different from the last password.

Command Syntax

changePWD old_password new_password new_password

changePWD [user username] old_password new_password new_password

changePWD [user oss-security delete]

Input Parameters

Parameter Description Remark

username oss or oss-security Optional
old_password Password currently valid for the user. Mandatory
new_password New password for the user. Mandatory
delete Deletes the current password of the oss- Optional
security user.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 15

 Command Description

Example

changePWD aBc_12345678 xyZ6789@1234 xyZ6789@1234

OperationSucceeded

In this example, to change the password, the user first types the old password,
aBc_12345678, then changes it to xyZ6789@1234 and verifies it again to be
xyZ6789@1234.

changePWD user oss-security aBc_12345678 xyZ6789@1234 xyZ6789@123 →

4
OperationSucceeded

In this example, to change the password for the oss-security user, the user first
types the username oss-security, then the old password, aBc_12345678, then
changes it to xyZ6789@1234 and verifies it again to be xyZ6789@1234.

changePWD user oss-security delete

OperationSucceeded

In this example, to delete the password for the oss-security user, the user first
types the username oss-security, then the command parameter delete.

5.3 clearAlarmList
This command can be used in two modes:

— clearAlarmList

Clears all active alarms in the node. No input parameter is given.

— clearAlarmList [alarmId]

Clears the alarm with the given alarmId.

Command Syntax
clearAlarmList

clearAlarmList [alarmId[, alarmId ...]]

16 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

Input Parameters

Data Type Description Remark

alarmId Identification numbers of the specific alarms to Optional
be cleared.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

clearAlarmList
Operation successful

In this example all alarms have been cleared.

Example 2

clearAlarmList 33, 49
Operation successful

In this example, the alarms with identification number 33 and 49 have been
cleared.

5.4 exit
This command is used to logout from the node CLI.

Logout Syntax
> exit

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 17

 Command Description

Input

Input Data Description Remark

exit This operation exits the SSH session and logs Mandatory
the user out.

5.5 getAlarmHistoryLog
This command returns the last 50 alarm events.

Command Syntax
getAlarmHistoryLog

Input Parameters
None.

Output Data

Data Type Description

Alarm history log A list of the last 50 alarm events is
given.
Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of

specified or unspecified reasons.

Example

getAlarmHistoryLog
Feb 27 15:50:09 MO: ManagedElement=1,SystemFunctions=1,LogM=1,Lo →
g=SecurityLog TYPE: new SEVERITY: warning ID: 3 SPECIFIC: Log Ex →
port Service Unavailable ADD TEXT:
Feb 27 15:40:34 MO: SDN=0,EthernetInterface=NORTHBOUND-ETH TYPE →
: clear SEVERITY: cleared ID: 1 SPECIFIC: Link down ADD TEXT:
Feb 27 15:40:32 MO: SDN=0 TYPE: new SEVERITY: warning ID: 2 SPEC →
IFIC: Post Installation Notice ADD TEXT: Node security is weak
Feb 27 15:40:09 MO: SDN=0,EthernetInterface=NORTHBOUND-ETH TYPE →
: new SEVERITY: minor ID: 1 SPECIFIC: Link down ADD TEXT:
OperationSucceeded

In this example, a list of all alarm events from node installation is given in the
following order:

18 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

1. The alarm with specific problem Link down was raised.

2. The alarm with the specific problem Post Installation Notice was
raised.
3. The alarm with the specific problem Link down was cleared.

4. The alarm with the specific problem Log Export Service Unavailable
was raised.

5.6 getAlarmList
This command can be used in two modes:

— getAlarmList

Lists all the alarms divided by a new line. No input parameter is given.

— getAlarmList [formatted]

Lists all the alarms in the form of a table.

Command Syntax
getAlarmList

getAlarmList [formatted]

Input Parameters

Parameter Description Remark

formatted Current alarms are given in the form of a table. Optional

Output Data

Data Type Description

Alarm list A list of all existing alarms in the node is given. The list includes several
parameters that are used for troubleshooting and repair.
Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of specified or unspecified reasons.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 19

 Command Description

Example 1

getAlarmList
ManagedElement=1,SystemFunctions=1,LogM=1,Log=SecurityLog;
alarmId=98;
eventTime=2024-03-15 T15:41:32;
eventType="qualityOfServiceAlarm";
severity="critical";
probableCause="x733ConfigurationOrCustomizationError";
specificProblem="Log Export Service Unavailable";
additionalText="Old log entries will be lost";
OperationSucceeded

In this example, a critical quality of service alarm was issued: the Log Export
Service Unavailable.

Example 2

getAlarmList formatted
|MOName |alId |eventTime |severity |specificProblem |additiona →
lText |
|================================================================================================= →
========|
|SDN=0 |2 |2024-02-27|warning |Post Installation|Node secu →
rity is |
| | |T15:40:32 | |Notice |wea →
k |
|------------------------------------------------------------------------------------------------- →
--------|
|ManagedElement=1,SystemFunctions=1 |3 |2024-02-27|warning |Log Export →
| |
|,LogM=1,Log=SecurityLog | |T15:50:09 | |Service →
| |
| | | | |Unavailable →
| |
|------------------------------------------------------------------------------------------------- →
--------|
OperationSucceeded

In this example, the following two alarms are active on the node at the moment
of command execution:
— Post installation notice that node security is weak.

— Log export service is unavailable.

The output is given in the form of a table.

5.7 last
This command is used to print the last logins on a system.

20 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

Command Syntax
last

Input Parameters
None.

Output Data

Data Type Description

Last logins A list of last logins on a system.
Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of

specified or unspecified reasons.

Example

last
oss pts/1 10.44.29.174 Tue Apr 9 12:31 - 12:31 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:29 - 12:29 (0+00:00)
oss pts/0 10.40.138.143 Tue Apr 9 12:29 still logged in
oss pts/0 10.44.29.174 Tue Apr 9 12:27 - 12:27 (0+00:00)
oss pts/0 10.44.29.174 Tue Apr 9 12:25 - 12:25 (0+00:00)
oss pts/0 10.44.29.174 Tue Apr 9 12:23 - 12:23 (0+00:00)
oss pts/0 10.44.29.174 Tue Apr 9 12:22 - 12:22 (0+00:00)
oss pts/0 10.44.29.174 Tue Apr 9 12:19 - 12:19 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:17 - 12:17 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:15 - 12:15 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:13 - 12:13 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:11 - 12:11 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:09 - 12:09 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:07 - 12:07 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:05 - 12:05 (0+00:00)
oss pts/1 10.44.29.174 Tue Apr 9 12:03 - 12:03 (0+00:00)
wtmp begins Mon Apr 8 23:48:57 2024
OperationSucceeded

In this example, the last logins are listed. The output is displayed in the following
columns:

First Column Second Column Third Column Fourth Column

Name of the How the user From where the When the login
logged-in user. connected to the user connected. activity occurred.
system, for The value can be
example, through the following:
a pseudo-terminal
(pty). — A hostname

— An IP address

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 21

 Command Description

First Column Second Column Third Column Fourth Column

— Kernel version

— Empty value

— An
application-
specific value

5.8 restart
This command initializes a restart of the node. All connections to the node
are reset as part of the operation. The restart does not clear performance
management data. If a subscription exists, the node resumes sending heartbeat
notifications when the restart is completed.

It is not possible to log in again until the restart is completed, this can take up to
1 minute.

Command Syntax

restart

Input Parameters
None.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

restart
OperationSucceeded

In this example, the user restarts the node.

22 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

5.9 uptime
This command returns the system uptime in days, hours, minutes and seconds.

Command Syntax
uptime

Input Parameters
None.

Output Data

Data Type Description

System uptime Information on the system's uptime.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

uptime
3 days, 12:20:30
OperationSucceeded

In this example, the command system's uptime is 3 days, 12 hours, 20 minutes

and 30 seconds. If the system has been up less than one day the number of days
will not be shown.

5.10 ping
This command tests if the node can reach a defined destination IP address by
sending three echo requests from a source IP address through the IP network.
The test checks the IP network connectivity and is useful at installation before
taking the node into service.

The ping operation is used to test if the site node can reach a particular
destination through the IP network from a particular source address. The source
address is optional. If given, it must be one of the configured IP addresses. The
source address must be the primary IP address or one of the MO IP Interfaces.
The site node sends three echo requests to the defined destination address. The
time between the echo requests is 1 second. The site node waits 1 second for an
echo response.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 23

 Command Description

Command Syntax

ping destinationIP [sourceIP]

Input Parameters

Parameter Description Remark

destinationIP Specifies the IP address of the host to which Mandatory
the three echo requests are sent to test the
connectivity.
sourceIP Specifies the IP address from which the echo Optional
requests are sent to a defined destination IP
address.

Output Data

Data Type Description

Response This parameter is a list of the responses. The node waits up to 1 second
for each response.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

ping 192.168.69.152
"3/3 received OK"
OperationSucceeded

In this example, the source IP address is not given. The ESC then selects a
suitable interface as the source based on the routing table. The destination IP
address is 192.168.69.152. The output string "3/3 received OK" indicates
that 3 out of 3 pings have been successful.

Example 2

ping 192.168.69.152 192.168.59.62

"3/3 received OK"
OperationSucceeded

24 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Generic Commands

In this example, the source IP address 192.168.59.62 is the IP address of the

node and 192.168.69.152 is the destination IP address. The output string "3/3
received OK" indicates that 3 out of 3 pings have been successful.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 25

 Command Description

6 Subscription Commands

This section describes commands related to subscriptions to alarms and other

SNMP traps. Subscribers are SNMP managers in network management systems
such as the ENM that receive alarms and other SNMP traps. Subscribers can
temporarily suspend SNMP traps.

All subscribers get a heartbeat trap that notifies that the node is active. The
heartbeat interval can be set to 1–10 minutes. If set to 0, no heartbeats will be
issued.

If there are no subscriptions, the node send wakeUpMessage SNMP traps to

a pre-defined IP address (wakeUpRegistration attribute in MO SDN) with an
interval (wakeUpEventInterval attribute in MO SDN). If wakeUpRegistration
has not been set, no wakeUpMessage SNMP traps are sent.

Alarms are sent to nodes with active subscriptions.

The following commands are described in this section:

— subscribe

— unsubscribe

— getSubscriptionIds

— getSubscriptionStatus

— suspendSubscription

— resumeSubscription

6.1 subscribe
This command adds or updates a subscriber to the node, that is, a receiver of
notification messages.

Command Syntax

subscribe managerReference [timeInterval]

subscribe managerReference [managerType] [timeInterval]

26 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Subscription Commands

Input Parameters

Parameter Description Remark

managerReference This parameter specifies the IP address to send Mandatory
notifications to
Example IPv4: 192.168.1.1
Example IPv6: [fe87:abcd::1]
managerType This parameter specifies which manager type is Optional
used. SDN is set if ENM is used.
timeInterval Time interval between heartbeat notifications, Optional
expressed in units of whole minutes.
— Range: 1–10

— 0 = heartbeat is turned off

Output Data

Data Type Description

subId The identity of the subscription assigned by the system.
Possible values: A valid subscription Id.
Operation status Indicates either of the following:
— Operation successful

— Operation failed for specified or unspecified reasons

Example 1

subscribe 192.168.59.62 2
1
OperationSucceeded

In this example, the managerReference IP address is set to 192.168.59.62 and

the timeInterval is set to every 2 minutes. In the response the subscriber ID is
set to 1.

Example 2

subscribe [fe87:abcd::1] SDN 7

2
OperationSucceeded

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 27

 Command Description

In this example, the managerReference IP address is set to fe87:abcd::1. The

managerType is set to SDN and the timeInterval is set to every 7 minutes. In
the response the subscriber ID is set to 2.

6.2 unsubscribe
This command disables or stops the sending of alarms and notifications to a
specified user and removes the subscription. When unsubscribe is performed for
the last defined subscription, the node stops sending alarms and other traps. If
wakeUpRegistration is defined, then the node starts sending wakeUpMessages.

Command Syntax

unsubscribe subId

Input Parameters

Parameter Description Remark

subId This parameter specifies the subscriber Mandatory
Possible values: A valid subscription Id.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

unsubscribe 1
OperationSucceeded

In this example, the subscriber listed with the subscriber ID = 1 is removed from
the subscription list.

6.3 getSubscriptionIds
This command returns all subscriptions existing in the node.

28 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Subscription Commands

Command Syntax

getSubscriptionIds

Input Parameters
None.

Output Data

Parameter Name Description

Subscription IDs set This parameter is a list of subscription IDs existing in the node.
If no subscription IDs exist, this will be indicated with --.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

getSubscriptionIds
1,3,2
OperationSucceeded

In this example, the set of existing subscription IDs are 1, 3 and 2.

Example 2

getSubscriptionIds
--
OperationSucceeded

In this example, there is no existing subscription ID.

6.4 getSubscriptionStatus
This command returns the characteristics of a specified subscription.

Command Syntax

getSubscriptionStatus subId

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 29

 Command Description

Input Parameters

Parameter Description Remark

subId This parameter specifies the subscription for Mandatory
which characteristics will be returned.
Possible values: A valid subscription Id.

Output Data

Data Type Description

Subscription state Specifies if this subscription is notSuspended (active) or suspended
(inactive).
Time tick Time interval between heartbeat notifications, expressed in units of
whole minutes. If the value is 0, then the heartbeat is turned off.
Manager reference This parameter specifies the IP address to send notifications to.
Manager type This parameter specifies which manager type is used. SDN or SN is set if
ENM is used.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getSubscriptionStatus 1
notSuspended 2 192.168.59.62 SN
OperationSucceeded

In this example, the user requests the subscription status for a subscriber with
subscription ID = 1. The response gives the following information:

— The subscriber is not suspended

— The interval between heartbeats (time tick) is two minutes

— The IP address of the subscriber (managerReference) is 192.168.59.62

— The manager of the subscriber (managerType) is SN.

6.5 suspendSubscription
This command disables or stops the sending of alarms and notifications.

30 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Subscription Commands

Command Syntax

suspendSubscription subId

Input Parameters

Parameter Description Remark

subId The subscription ID to suspend. Mandatory
Possible values: A valid subscription Id.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

suspendSubscription 2
OperationSucceeded

In this example, the subscriber with subscription ID 2 is suspended from

subscription.

6.6 resumeSubscription
This command activates a defined but suspended subscription. Upcoming alarms
and notifications will be sent to the subscriber.

Command Syntax

resumeSubscription subId

Input Parameters

Parameter Description Remark

subId The subscription ID for the subscription to Mandatory
resume.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 31

 Command Description

Parameter Description Remark

Possible values: A valid subscription Id.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

resumeSubscription 2
OperationSucceeded

The subscription to subscriber with subscription ID 2 is resumed.

32 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

7 Basic CM Commands

Basic Configuration Management (CM) commands comprises Transaction

management commands and MO management commands. See sections below.

7.1 Transaction Management Commands

This section describes basic CM commands. Basic CM commands are used to
change MO. Basic CM transactions ensure that these changes are performed
atomically.

Basic CM transactions can be used in parallel with software upgrade sessions but
cannot be used in parallel with bulk CM sessions. Only one basic CM transaction
can be active at the time.

The MO configuration change requests are performed with one or more

setMOAttribute, createMO and deleteMO commands. When the candidate
configuration update is complete and valid, it can be committed which means
that it is saved as the running configuration. This takes effect immediately and
the transaction is persistent at ordered commit.

All changes within transaction affects a candidate configuration. The

commands take immediate effect on the candidate configuration. The candidate
configuration does not affect the operation of the node.

It is also possible to discard the candidate configuration without saving it.

Figure 1 illustrates the command flow in a standard transaction. To discard

the candidate configuration, omit the commit command, and enter the
endTransaction command. Commands that are not connected to the flow can
be given at any time.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 33

 Command Description

start

startTransaction

getTransactionId
MO management
commands
getTransactionStatus

checkConsistency

commit

endTransaction

mandatory command
end optional command
P022129A

Figure 1 Transaction Flow

The following commands are described in this section:

— startTransaction

— checkConsistency

— commit

— endTransaction

— getTransactionId

— getTransactionStatus

7.1.1 startTransaction
This command starts a basic CM transaction. For more information see
Transaction Management Commands on page 33.

34 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Command Syntax

startTransaction transactionId [managerReference]

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier Mandatory
Possible values: a string of up to 10 characters
managerReference This parameter specifies the IP address of the Optional
SNMP Manager to which notifications are sent

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

startTransaction t1
OperationSucceeded

In this example, a transaction is started with the transaction ID t1.

7.1.2 checkConsistency
This command checks the validity and atomicity of an updated configuration.
This command can be used, before a commit command is performed, to verify
that the configuration contains a complete set of MOs and attributes.

Command Syntax

checkConsistency transactionId

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 35

 Command Description

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier Mandatory
Possible values: a valid transaction ID.

Output Data

Data Type Description

Consistency The result of the consistency check
Possible value: consistent. If the transaction is inconsistent, the output
will contain OperationFailed followed by the fault reason.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

checkConsistency t1
consistent
OperationSucceeded

In this example, the configuration is found to be consistent. The transaction ID is

t1.

7.1.3 commit
This command commits all configuration change requests in the transaction. For
more information see Transaction Management Commands on page 33.

Command Syntax

commit transactionId
commit transactionId [forcedCommit]
commit transactionId [autoRollback] [minutes]

36 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier. Mandatory
Possible values: a valid transaction ID.
forcedCommit This parameter is meant to be used to restart Optional
the node if attributes requiring a restart are
changed. However, there are no attributes that
require a restart when changed, therefore this
parameter has no effect in the node
Note:
The parameter is not possible to use in the
same session as the parameters autoRollback
and minutes.
autoRollback If this parameter is set, the node will restart Optional parameter
using the old software in case endTransaction pair
has not been received in specified time.
Note:
Note:
These parameters but
The parameter is not possible to use in the must be present in
same session as the parameter forcedCommit. a pair. If only one
of the parameters in
minutes Specifies a time in minutes before an this pair is defined the
autoRollback will occur.
command fails.
Note:
The parameter is not possible to use in the
same session as the parameter forcedCommit.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

commit t1
OperationSucceeded

In this example, the transactionId is t1.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 37

 Command Description

Example 2

commit t1 autoRollback 10
OperationSucceeded

In this example, the transactionId is t1, autoRollback is included to restart

the node on the old configuration, if not endTransaction has been received
before minutes has expired. The minutes is 10.

7.1.4 endTransaction
This command ends a basic CM transaction.

— If the command endTransaction is given before commit, then all changes in

the transaction are lost.

— If the command endTransaction is given after commit, but before the

rollback is performed, then the transaction is finally confirmed and no auto
rollback will occur.

The command End transaction must be given before a new transaction is started.
For more information see Transaction Management Commands on page 33.

Command Syntax

endTransaction transactionId

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier. Mandatory
Possible values: a valid transaction ID.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

38 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Example

endTransaction t1
OperationSucceeded

In this example, the transaction with ID t1 is ended.

7.1.5 getTransactionId
This command returns the identity of the transaction.

Command Syntax

getTransactionId

Input Parameters
None.

Output Data

Data Type Description

transaction ID Unique transaction IDentifier.
If no transaction ID exists, this will be indicated with --.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getTransactionId
t1
OperationSucceeded

In this example, the inquired transaction ID is t1.

7.1.6 getTransactionStatus
This command returns the status of the transaction, and is only possible
to perform within a transaction. If the command is executed outside the
transaction, then it returns OperationFailed.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 39

 Command Description

Command Syntax

getTransactionStatus transactionId

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier. Mandatory
Possible values: a valid transaction ID.

Output Data

Data Type Description

Transaction state The transaction state is idle when startTransaction is performed
but commit is not yet performed (for example, when several
setMOAttribute commands are performed).
Possible values: Idle, CommitFailed, CommitCompleted
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getTransactionStatus t1
Idle
OperationSucceeded

In this example, the user requests the Transaction status for the transaction with
transaction ID t1. The Transaction state is Idle.

7.2 MO Management Commands

MO management commands require that a transaction is started with the
startTransaction command. How MO management commands are used in the
transaction flow is illustrated in Figure 1.

Several attributes can be changed in a transaction by including a

setMOAttribute command for each attribute to change. Each command
performed in a transaction is validated immediately and executed when the
commit command is received. The transaction is persistent at ordered commit.

The following commands are described in this section:

40 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

— createMO

— setMOAttribute

— getMOAttribute

— deleteMO

— action

— getContainment

— findMO

— deleteMOAttributeValue

7.2.1 createMO
This command creates a new MO. The command must be used within a
transaction, and setting of attributes is supported. The new MO will not take
effect until a commit command is executed.

Command Syntax

createMO tId MO-DN

createMO tId MO-DN [attribute attributeValue [attribute attribute →
Value]...]
createMO tId MO-DN [attribute=attributeValue [attribute=attribute →
Value]...]

Input Parameters

Parameter Description Remark

tId Unique transaction IDentifier Mandatory
Possible values: a valid transaction ID.
MO-DN The name of the new MO Mandatory
attribute This parameter identifies the attribute that is to Mandatory parameter
be modified pair
attributeValue The value to be used in the modification of the Note:
attribute
These parameters
must be present in
a pair. If only one
of the parameters in

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 41

 Command Description

Parameter Description Remark

this pair is defined the
command fails.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

createMO t1 SDN=0,IPInterface=0
outputData
OperationSucceeded

In this example, a new MO SDN=0,IPInterface=0 is created in transaction t1.

7.2.2 setMOAttribute
This command sets MO attribute values in the candidate configuration. Multiple
attribute values for one MO instance can be defined in each command. The
command must be used within a transaction. Changing an MO attribute with
the setMOAttribute command creates a temporary copy of the MO model that
includes all the changes.

Command Syntax

setMOAttribute tid MOinstance attribute attributeValue [attribut →

e attributeValue...]

setMOAttribute tid MOinstance attribute=attributeValue [attribute →

=attributeValue...]

Input Parameters

Parameter Description Remark

tid Unique transaction IDentifier Mandatory
Possible values: a valid transaction ID.

42 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Parameter Description Remark

MOinstance The MO instance that is modified. Mandatory
attribute This parameter identifies the attribute that is to Mandatory parameter
be modified pair
attributeValue The value to be used in the modification of the Note:
attribute
These parameters but
must be present in
a pair. If only one
of the parameters in
this pair is defined the
command fails.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

setMOAttribute t1 SDN=0 wakeUpRegistration 192.168.59.62

OperationSucceeded

In this example, the command line defines the address to which the node sends
the wake-up event.

Explanations
setMOAttribute command
t1 software session ID
SDN=0 base object instance
wakeUpRegistration attribute that is to be modified
192.168.59.62 attribute value

Example 2

setMOAttribute t1 SDN=0,EthernetInterface=0 mode auto

OperationSucceeded

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 43

 Command Description

or

setMOAttribute t1 SDN=0,EthernetInterface=0 mode=auto

OperationSucceeded

In this example, the command line defines that the auto mode shall be used on
the Ethernet interface.

Explanations
setMOAttribute command
t1 transaction ID
SDN=0,EthernetInterface=0 base object instance
– SDN=0 – equipment number
– EthernetInterface=0 – interface number
mode attribute that is to be modified
auto attribute value

7.2.3 getMOAttribute
This command displays MO attribute values.

When the command is executed in a transaction (between the commands

startTransaction and endTransaction), the value returned is the value stored
in RAM, which might not be the same as the currently used value. Changing MO
attributes with the setMOAttribute command creates a temporary copy of the
MO model in the RAM. The values in the RAM are used after the next commit
command.

When the command is executed outside a transaction, the returned value is the
currently used value stored in flash memory.

Command Syntax

getMOAttribute [transactionId] MO-DN [attribute]

Input Parameters

Parameter Description Remark

tId Unique transaction identifier. Optional
This parameter is only used when the
command is executed in a transaction.

44 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Parameter Description Remark

MO-DN MO instance that is read. Mandatory
attribute Identifies the attribute list to be returned. Optional

Output Data

Data Type Description

Attribute out Value for the MO instance attribute specified as the input parameter.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getMOAttribute t1 SDN=0,IPInterface=0 primaryIPAddress

SDN=0,IPInterface=0;primaryIPAddress="192.168.59.64"
OperationSucceeded

In this example, the user requests the attribute Primary IP address of a

transaction.

If the value has been changed in the current transaction, then the new value from
the not committed MO model is returned. A changed value will be in use after
execution of the command commit.

Explanations
getMOAttribute command
t1 transaction ID
SDN=0,IPInterface=0 base object instance
– SDN=0 – equipment number
– IPInterface=0 – interface number
primaryIPAddress requested IP address
192.168.59.64

7.2.4 deleteMO
This command deletes the MO identified by the parameter baseObjectInstance.
The deletion of the MO will not take effect until a commit command is executed.
Child MOs are automatically deleted.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 45

 Command Description

Command Syntax

deleteMO transactionId MO-DN

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier Mandatory
Possible values: a valid transaction ID.
MO-DN The name of the MO to be deleted Mandatory

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

deleteMO t1 SDN=0,IPInterface=0
OperationSucceeded

In this example, the MO SDN=0,IPInterface=0 is deleted in transaction t1.

7.2.5 action
The command invokes the action method of an MO, see the description of each
MO class for details on which actions are available.

Command Syntax

action MO-DN [actionmethod]

Input Parameters

Parameter Description Remark

MO-DN MO distinguished name. Mandatory

46 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

action SDN=0,PowerManager=1,Battery=1 start

OperationSucceeded

In this example, the action method start of the MO with distinguished name
SDN=0,PowerManager=1,Battery=1 is invoked.

Example 2

action SDN=0,Equipment=CSM2,Equipment=CMBW clear

OperationSucceeded

In this example, the action method clear of the MO with distinguished name
SDN=0,Equipment=CSM2,Equipment=CMBW is invoked.

7.2.6 getContainment
This command retrieves all MO instances in a specific MO containment hierarchy
under and including the baseObjectInstance.

Command Syntax

getContainment [transactionId] [MO-DN]

Input Parameters

Parameter Description Remark

transactionId Unique transaction identifier Optional within a
transaction
Possible values: a valid transaction ID.
MO-DN Base object in a containment hierarchy. Optional

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 47

 Command Description

When a transaction is open (startTransaction until endTransaction), the

optional transaction parameter transactionId can be used to display the state
of the candidate configuration, for example when creating and deleting objects
using the commands createMO and deleteMO.

If the parameter transactionId is not given, then the output will display the
state of the committed configuration.

Output Data

Data Type Description

Containment All managed object instances included in the specified containment
hierarchy, including the MO defined in the baseObjectInstance.
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

getContainment t1
SDN=0;
SDN=0,Equipment=0;
SDN=0,EthernetInterface=0;
SDN=0,IPInterface=0;
SDN=0,MeasurementDefinition=0;
SDN=0,RadioInterface=1;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_LOST;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_PIN;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_PUK;
OperationSucceeded

In this example, the transaction ID of the open transaction is t1. The response
shows the candidate configuration MOs in the transaction.

Example 2

getContainment t1 SDN=0 RadioInterface=1

SDN=0,RadioInterface=1;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_LOST;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_PIN;
SDN=0,RadioInterface=1,AlarmEntry=RADIO_PUK;
OperationSucceeded

48 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

In this example, the transaction ID of the open transaction is t1 and the Base
object is SDN=0. The response shows the candidate configuration MOs in the
sub-tree that starts with SDN=0,RadioInterface=1.

7.2.7 findMO
This command displays all MO classes that matche the class name and the
attributes listed.

Command Syntax
findMO moClass [attribute=attributeValue [attribute=attributeValue]...]

Input Parameters

Parameter Description Remark

moClass The class name of the MO Mandatory
attribute=attributeVal The MO attributes and value Optional
ue

Output Data

Data Type Description

MO classes The MO classes that matche the class name and the attributes listed
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

findMO EthernetInterface
SDN=0,EthernetInterface=NORTHBOUND-ETH
SDN=0,EthernetInterface=2
SDN=0,EthernetInterface=3
SDN=0,EthernetInterface=4
SDN=0,EthernetInterface=5
SDN=0,EthernetInterface=6
SDN=0,EthernetInterface=7
SDN=0,EthernetInterface=8
OperationSucceeded

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 49

 Command Description

In this example, the MO classes that match the class name EthernetInterface
are displayed.

Example 2

findMO EthernetInterface portNumber=2 operationalState=enabled

SDN=0,EthernetInterface=2
OperationSucceeded

In this example, the MO classes that match the class name EthernetInterface
and the attributes portNumber and operationalState with the values 2 and
enabled are displayed.

7.2.8 deleteMOAttributeValue
This command deletes an MO attribute value in the candidate configuration. The
command must be executed within a transaction. Deletion will not take effect
until a commit command is executed.

This command is applicable only for writable attributes that can be set to empty
values.

Command Syntax

deleteMOAttributeValue tid MOinstance attribute

Input Parameters

Parameter Description Remark

tid Unique transaction IDentifier Mandatory
Possible values: a valid transaction ID.
MOinstance The MO instance that is modified. Mandatory
attribute This parameter identifies the attribute that is to Mandatory parameter
be modified pair
Note:
These parameters but
must be present in
a pair. If only one
of the parameters in
this pair is defined the
command fails.

50 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Basic CM Commands

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

deleteMOAttributeValue t1 ManagedElement=1,SystemFunctions=1,SecM= →
1,UserManagement=1 userLabel
OperationSucceeded

In this example, the value of the UserManagement.userLabel attribute is

deleted.

Explanations
deleteMOAttributeValue command
t1 transaction ID
ManagedElement=1,SystemFunctio base object instance
ns=1,SecM=1,UserManagement=1
userLabel attribute that is to be modified

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 51

 Command Description

8 Bulk CM Commands

The commands described in this section are related to the downloading and
uploading of configuration files and the activation of new configurations. The
configuration files hold configuration data for the Management Information Base
(MIB). Files for download to the node are generated by the ENM. Files are
uploaded to be processed by the ENM.

The flow chart below illustrates the command flow in a session. Commands that
are not connected to the flow can be given at any time.

start

startSession
getSessionIds

download upload
getSessionStatus

activate
getPendingConfiguration

endSession
abortSessionOperation

end
mandatory command
optional command
P022130A

The following commands are described in this section:

— startSession

— upload

— download

— activate

— abortSessionOperation

— endSession

52 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

— getSessionIds

— getSessionStatus

8.1 startSession
This command starts a bulk CM session. A bulk CM session can be used in parallel
with a software upgrading session but cannot be used in parallel with a basic CM
transaction. Only one bulk CM session can be active at a time.

Command Syntax

startSession sessionId [managerReference]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a string of up to 10 characters.
managerReference This parameter specifies the IP address of the Optional
SNMP Manager to which notifications are sent.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

startSession bcm1 192.168.59.62

OperationSucceeded

In this example, a session is created with ID bcm1. The IP address of the SNMP
Manager is 192.168.59.62.

Example 2
IPv4

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 53

 Command Description

startSession id 10.0.0.1:1062

or:

startSession 10.0.0.1

IPv6

startSession id [2001:abcd::1]:1062

or:

startSession 2001:abcd::1

In this example, syntax for starting bulk CM session with or without SNMP port
is specified. Where SNMP Manager IPv6 address is used, and SNMP port is
specified, square brackets need to be added.

8.2 upload
This command orders the uploading of a bulk CM XML configuration file from the
node to an SFTP server. If the specified file already exists, it is replaced by the
new file.

Command Syntax

upload sessionId uploadDataFileReference fileContent [progressInt →

erval]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid session ID.
uploadDataFileRefere Specifies a globally unique destination for the Mandatory
nce upload.
The addressing of the file source must follow
the syntax:
IPv4:
sftp://<user>:<pass>@ipv4address/
filepath

54 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

Parameter Description Remark

or
sftp://<user>:<pass>@ipv4address:port/
filepath
IPv6:
sftp://
<user>:<pass>@[ipv6address]:port/
filepath
or
sftp://<user>:<pass>@[ipv6address]/
filepath
Where host specifies the IP address of the
destination host, and filepath specifies the
directory structure and filename.
fileContent Defines which data from the MIB that should Mandatory
be uploaded.
Possible values: CM, BAT and DG
The value:
— CM results in uploading of
configuration data from all MOs except
MeasuredMOClass.

— BAT results in uploading of the battery log.

— DG results in uploading of the diesel

generator log.
progressInterval sftp://Defines a time in seconds after which Optional
the node shall send software upload progress
messages to the SNMP manager.
Possible values: 0 and 15–900
When set to 0 or not set, no notifications will be
sent.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 55

 Command Description

Example

upload bcm1 sftp://smith:[email protected]/SDNCFG/sdn82_CM.xm →

l CM 30
OperationSucceeded

In this example, the user has requested an upload with the following parameters:

Explanations
upload command
bcm1 session ID
sftp:// file source reference for IPv4
smith:[email protected]
9.152/SDNCFG/
sdn82_CM.xml
sftp:// file source reference for IPv6
smith:123abc@[2001:abc
d::1]/SDNCFG/
sdn82_CM.xml
CM file content
30 progress interval

8.3 download
This command orders the downloading of, for example

— a bulk CM XML configuration file for node hardware configuration

— a License Key File (LKF)

When the complete file has been downloaded, the requested attribute values are
stored in a temporary file in flash memory.

Command Syntax

download sessionId downloadDataFileReference [progressInterval]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory

56 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

Parameter Description Remark

Possible values: a valid session ID.
downloadDataFileRef Specifies a globally unique file reference from Mandatory
erence which the data is retrieved and downloaded.
The addressing of the file source must follow
the syntax:
IPv4:
sftp://<user>:<pass>@ipv4address/
filepath
or
sftp://<user>:<pass>@ipv4address:port/
filepath
IPv6:
sftp://
<user>:<pass>@[ipv6address]:port/
filepath
or
sftp://<user>:<pass>@[ipv6address]/
filepath
Where host specifies the IP address of the file
source (the host).
progressInterval Defines a time interval in seconds with which Optional
the node sends software download progress
messages to the SNMP trap manager.
Possible values: 0-32767
When set to 0 or not set, no notifications will be
sent.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

download bcm1 sftp://smith:[email protected]/SDNCFG/sdn82_syn →

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 57

 Command Description

ch.xml 15
OperationSucceeded

In this example, the user has requested a download with the following
parameters:

— Session ID: bcm1

— File reference: sftp://smith:[email protected]/SDNCFG/

sdn82_synch.xml

— Progress interval: 15 s

8.4 activate
This command activates the configuration changes in a downloaded bulk CM file.
See activateLicense on page 77 for activation of a downloaded LKF file. If the
delayed parameter is not set, the downloaded file is activated immediately.

The SSH terminal connection is reset in the case of a restart. Connection must be
reinitialized after the node restarted.

Command Syntax

sessionId [autoRollback] [minutes]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid session ID.
autoRollback If set, the node restarts on the old configuration Optional parameter
if endSession or endSWsession is not received pair
in specified time.
Note:
minutes Specifies a time in minutes after which an
auto rollback occurs, unless endSession or These parameters
endSWSession is received in specified time. must be present in
a pair. If only one
of the parameters in
this pair is defined the
command fails.

58 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

activate bcm1
OperationSucceeded

In this example, the downloaded attribute changes are activated without delay.
The session ID is bcm1.

Example 2

activate bcm1 autoRollback 10

OperationSucceeded

The sessionId is bcm1, autoRollback is included to restart the node on the

old configuration, if endSession or endSWSession is not received before minutes
expires. The minutes is 10, specified in minutes.

8.5 abortSessionOperation
This command interrupts any session in progress, that is the uploading or
downloading of bulk CM files. Any downloaded data is discarded. No uploaded
data is deleted.

Command Syntax

abortSessionOperation sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid session ID.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 59

 Command Description

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

abortSessionOperation bcm1
OperationSucceeded

In this example, the user aborts the session with ID bcm1.

8.6 endSession
This command ends a bulk CM session. Operations in progress related to the bulk
CM session are terminated.

Command Syntax

endSession sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid session ID.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

60 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

Example

endSession bcm1
OperationSucceeded

In this example, the user requests the session with ID bcm1 to be terminated.

The sessionId is bcm1.

8.7 getSessionIds
This command returns the identity of the present bulk CM session.

Command Syntax

getSessionIds

Input Parameters
None

Output Data

Data Type Description

Session ID list The ID of the present session
Note:
Despite the command name getSessionIds, only one session can be
open at a time and only one session ID will be displayed in the session
ID list.

If no session ID exists, this will be indicated with --.

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getSessionIds
bcm1
OperationSucceeded

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 61

 Command Description

The ID of the present session is bcm1.

8.8 getSessionStatus
This command returns the status of a specific bulk CM session.

Command Syntax

getSessionStatus sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid session ID.

Output Data

Data Type Description

Session state Indicates state of bulk CM session.
Possible values:
— UploadInProgress

— UploadFailed

— UploadCompleted

— DownLoadInProgress

— DownloadFailed

— DownloadCompleted

— ActivationInProgress

— ActivationFailed

— ActivationCompleted
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

62 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Bulk CM Commands

Example

getSessionStatus bcm1
DownLoadInProgress
OperationSucceeded

In this example, the user has requested the session status for session bcm1. The
response displays the state DownloadInProgress.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 63

 Command Description

9 Performance Management Commands

This section describes basic Performance Management (PM) commands used to

collect performance data, for example, counters.

The PM data is collected for most MO instances and periodically saved and
uploaded to ENM where the PM data can be viewed and analyzed for 24 hours.
After 24 hours ENM transfers the PM data to another service, such as ENIQ. The
collected PM data concern different predefined features in the node.

The following commands are described in this section:

— suspendPMMeasurements

— resumePMMeasurements

9.1 suspendPMMeasurements
This command stops/disables PM data collection and PM data upload.

Command Syntax

suspendPMMeasurements PMMeasurementInstance

Input Parameters

Parameter Description Remark

PMMeasurementInsta In theory, there might be several Mandatory
nce measurement configurations. However, nodes
provide all PM data through a single
measurement MO. The value is always
SDN=0,MeasurementDefinition=0.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

64 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Performance Management Commands

Example

suspendPMMeasurements SDN=0,MeasurementDefinition=0
OperationSucceeded

In this example, the PM data collection and PM data upload are disabled. The
parameter PMMeasurementInstance is SDN=0,MeasurementDefinition=0.

9.2 resumePMMeasurements
This command initiates or enables PM data uploading and specifies details of the
file storage destination.

Command Syntax

resumePMMeasurements PMMeasurementInstance fileStore

Input Parameters

Parameter Description Remark

PMMeasurementInsta In theory, there might be several Mandatory
nce measurement configurations. However, nodes
provide all PM data through a single
measurement MO. The value is always
SDN=0,MeasurementDefinition=0.
fileStore An SFTP Universal Resource Identifier (URI), Mandatory
including authentication information, that
defines where the node uploads the PM reports.
The addressing of the file destination must
follow the syntax:
IPv4:
sftp://<user>:<pass>@ipv4address/
filepath
or
sftp://<user>:<pass>@ipv4address:port/
filepath
IPv6:
sftp://
<user>:<pass>@[ipv6address]:port/
filepath
or

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 65

 Command Description

Parameter Description Remark

sftp://<user>:<pass>@[ipv6address]/
filepath
Where host specifies the IP address of the
file destination and filepath is the directory
structure specified from the root.
Note:
In addition to the file path, a subdirectory
named PM must exist at the file storage
destination.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

resumePMMeasurements SDN=0,MeasurementDefinition=0 sftp://jones:ab →

[email protected]/home/jones/ARCHIVE/SDN95
OperationSucceeded

In this example, the user initiates or resumes a PM measurement.

The parameter PM measurement instance is standardized and always
SDN=0,MeasurementDefinition=0.

The PM measurements are stored at sftp://jones:[email protected]/

home/jones/ARCHIVE/SDN95.

66 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Software Upgrade Commands

10 Software Upgrade Commands

The commands described in this section are related to the downloading of

software files and the activation of new software.

Once software is ordered for the node, it can be downloaded from https://
swgateway.ericsson.net/.

The downloading and the activation of software are performed in software

sessions.

— startSWSession

— downloadSW

— activateSW

— endSWSession

— getSWSessionIds

— getSWSessionStatus

— abortSWSessionOperation

10.1 startSWSession
This command starts a software upgrading session. One basic CM transaction or
one bulk CM session can be used in parallel with a software session. Only one
software session can be active at a time.

Command Syntax

startSWSession sessionId [managerReference]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a string of up to 10 characters.
managerReference This parameter specifies the IP address of the Optional
SNMP Manager to which notifications are sent.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 67

 Command Description

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

startSWSession s1 192.168.59.62
OperationSucceeded

In this example, a software session with ID s1 is started. Notifications will be

sent to the SNMP manager with IP address 192.168.59.62.

10.2 downloadSW
This command orders the downloading of new software for the node
hardware. The downloaded software is temporarily stored in the node until
it is activated with the activateSW command or until the session is ended
with the endSWSession command. Restarting the node or aborting with the
abortSWSessionOperation command during software downloading, erases the
downloaded software.

Command Syntax

downloadSW sessionId MO-DN downloadDataFileReference [progressInt →

erval]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.
MO-DN Specifies the equipment to download software Mandatory
to for example the ESC, see Example 1, or the
CSM, see Example 2.
downloadDataFileRef Specifies a globally unique file reference from Mandatory
erence which the data is retrieved and downloaded.
The addressing of the file source must follow
the syntax:

68 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Software Upgrade Commands

Parameter Description Remark

IPv4:
sftp://<user>:<pass>@ipv4address/
filepath
or
sftp://<user>:<pass>@ipv4address:port/
filepath
IPv6:
sftp://
<user>:<pass>@[ipv6address]:port/
filepath
or
sftp://<user>:<pass>@[ipv6address]/
filepath
Where host specifies the IP address of the file
source host.
progressInterval Defines a time in seconds after which the node Optional
sends software download progress messages to
the SNMP manager.
Possible values: 0 and 15–900
If set to 0 or not set, no notifications are sent.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

downloadSW sw1 SDN=0 sftp://smith:[email protected]/SDNSW/NEW →

_IMG node_sw.img 30
OperationSucceeded

Explanations
downloadSW command
sw1 software session ID

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 69

 Command Description

Explanations
SDN=0 the equipment to download software to
sftp:// sftp command
smith:[email protected]
– Secured File Transfer Protocol
9.152/SDNSW/NEW_IMG
node_sw.img – username
– sftp – password
– smith – IP address of the source host
– 123abc – file path
– 192.168.69.152 – file to be downloaded
- /SDNSW/NEW_IMG
– node_sw.img
30 notification interval in seconds

Example 2

downloadSW sw1 SDN=0,Equipment=CSM1,Equipment=CMBW sftp://smith:1 →

[email protected]/SDNSW/NEW_IMG node_sw.img 30
OperationSucceeded

Explanations
downloadSW command
sw1 software session ID
SDN=0,Equipment=CSM1,E the equipment to download software to
quipment=CMBW
sftp:// sftp command
smith:[email protected]
– Secured File Transfer Protocol
9.152/SDNSW/NEW_IMG
node_sw.img – username
– sftp – password
– smith – IP address of the source host
– 123abc – file path
– 192.168.69.152 – file to be downloaded
- /SDNSW/NEW_IMG
– node_sw.img
30 notification interval in seconds

70 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Software Upgrade Commands

10.3 activateSW
This command closes all established traffic connections, including O&M traffic
and SSH sessions, and restarts the node with the latest downloaded software.

All SSH terminal connections are reset in the case of a restart. The connection
must be reinitialized after the initial restart timeout.

Command Syntax

activateSW sessionId [autoRollback] [minutes]

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.
autoRollback If the parameter is set, the node restarts Optional parameter
on the old software unless the command pair
endSWSession is given in specified time, that
is, the parameter minutes. Note:

minutes Specifies a time in minutes before an auto These parameters

rollback occurs. must be present in
a pair. If only one
of the parameters in
this pair is defined the
command fails.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example 1

activateSW sw1
OperationSucceeded

In this example, the downloaded software is activated. The session ID is sw1.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 71

 Command Description

Example 2

activateSW sw1 autoRollback 10

OperationSucceeded

In this example, the downloaded software is activated. Auto rollback is specified

to make sure that the node can work properly on old software in case something
is wrong with the new.

Explanations
activateSW command
sw1 software session ID
autoRollback autoRollback feature utilized in the command
10 autoRollback time limit in minutes

10.4 endSWSession
This command ends a software upgrading session. Operations in progress related
to the software session are terminated. Downloaded software remains in flash
memory regardless of whether it has been activated or not.

Using the endSWsession command will confirm activation of the previously

downloaded software. The auto rollback function will be canceled if pending.

Command Syntax

endSWSession sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

72 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Software Upgrade Commands

Data Type Description

— Operation failed because of specified or unspecified reasons

Example

endSWSession sw1
OperationSucceeded

In this example, the open software session sw1 is closed.

10.5 getSWSessionIds
This command returns the identity of existing software sessions.

Command Syntax

getSWSessionIds

Input Parameters
None

Output Data

Data Type Description

Session ID list List of software session IDs
Note:
In theory, multiple SW sessions are possible. However, RMS nodes only
support one simultaneous SW session.

If no software session ID exists, this is indicated with --.

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getSWSessionIds
s1
OperationSucceeded

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 73

 Command Description

A software session is open with ID s1.

10.6 getSWSessionStatus
This command returns the status of a software upgrading session.

Command Syntax

getSWSessionStatus sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.

Output Data

Data Type Description

Session state Indicates state of software upgrading session.
Possible values:
— Idle

— DownLoadInProgress

— DownloadFailed

— DownloadCompleted

— ActivationInProgress

— ActivationFailed

— ActivationCompleted
Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

getSWSessionStatus s1

74 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 Software Upgrade Commands

DownLoadInProgress
OperationSucceeded

In this example, the user requests the status of the software upgrading session
s1. The response displays the status DownLoadInProgress

10.7 abortSWSessionOperation
This command interrupts software downloading. After the interruption, the
downloaded software is erased from the node.

Command Syntax

abortSWSessionOperation sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful

— Operation failed because of specified or unspecified reasons

Example

abortSWSessionOperation sw1
OperationSucceeded

In this example, the software session with ID sw1 is aborted.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 75

 Command Description

11 License Commands

All features in the ESC or SCU node are subjects for licensing. A customer can buy
a license key file to unlock node features. To unlock the features, the file must be
downloaded to the node and activated.

A license key file is coupled to one specific node, through the Unique Logical
Name (ULN). To be able to activate the file, the ULN of the file must be identical
to the ULN of the node.

When configuring a previously unused node, the user can set the node ULN,
download the license key file to the node, and activate the file. When the license
key file is activated, the ULN of the node can only be reset by performing a
factory reset. When the license key file is activated, the fingerprintUpdateable
attribute under MO ManagedElement=1,SystemFunctions=1,Lm=1 in ENM
Topology Browser is set to false, which means that the fingerprint that
represents the ULN in ECIM model cannot be changed anymore.

When updating a node license, the user must download the file to the node and
activate the file.

The following commands are related to the activation of licenses:

— setUln

— activateLicense

— getUln

— setEmergencyMode

11.1 setULN
This command sets the ULN of a specific node.

Command Syntax

setULN ULNname

Input Parameters

Parameter Description Remark

ULNname Unique logical name Mandatory
Possible values: a string of up to 30 characters.

76 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 License Commands

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of specified or unspecified reasons.

Example

setULN box1
OperationSucceeded

In this example, the ULN of the node is set to box1.

11.2 activateLicense
This command activates a new LKF, downloaded with the command download.
If successful, the current LKF is replaced with the new one and all the new license
keys are applied. If the activation fails, the old LKF is retained.

Command Syntax

activateLicense sessionId

Input Parameters

Parameter Description Remark

sessionId Unique session identifier Mandatory
Possible values: a valid SW session ID.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of specified or unspecified reasons.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 77

 Command Description

Example

activateLicense s1
OperationSucceeded

In this example the downloaded LKF is activated. The sessionId is s1.

Example of License Download and Activation

setULN site1
startSession s
download s sftp://<address to XML license file>
activateLicense s
endSession s

In this example the ULN is set, a session is started, and the LKF is downloaded
and activated. The session ID is s. The setULN command is not required when
updating a license file.

11.3 getULN
This command gets the Unique Logical Name (ULN) for a specific node.

Command Syntax

getULN

Input Parameters
None.

Output Data

Data Type Description

ULN Unique logical name
Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of specified or unspecified reasons.

78 22/1551-LZA 701 6016/1 Uen N | 2024-06-25

 License Commands

Example

GetULN
box1
OperationSucceeded

In this example the ULN for the node is requested. The retrieved ULN is box1.

11.4 setEmergencyMode
setEmergencyMode sets the license handling in emergency mode. This enables
all features for a limited period of seven days. At the end of the time period, the
license handling reverts to the old license.

setEmergencyMode can be used twice, then it is locked. It can only be reused

again after an emergencyReset license key has been ordered and installed on
the node.

Command Syntax

setEmergencyMode

Input Parameters
None.

Output Data

Data Type Description

Operation status Indicates either of the following:
— Operation successful.

— Operation failed because of specified or unspecified reasons.

Example

setEmergencyMode
OperationSucceeded

In this example, the license handling is set in emergency mode.

22/1551-LZA 701 6016/1 Uen N | 2024-06-25 79

 Command Description

12 Removed and Renamed Commands

The following commands are no longer supported:

— createAvailableMOs

— getIRPVersion

80 22/1551-LZA 701 6016/1 Uen N | 2024-06-25