STN Command Descriptions COMMAND DESCRIPTION
Dec 26, 2015
STN Command Descriptions
COMMAND DESCRIPTION
Copyright
© Copyright Ericsson AB 2007–2008. All rights reserved.
Disclaimer
No part of this document may be reproduced in any form without the writtenpermission of the copyright owner.
The contents of this document are subject to revision without notice due tocontinued progress in methodology, design and manufacturing. Ericsson shallhave no liability for any error or damage of any kind resulting from the useof this document.
2/190 82-LZA 701 0001 Uen D 2008-05-16
Contents
Contents
1 Introduction 1
1.1 Target Groups 1
1.2 Typographic Conventions 1
1.3 Revision Information 2
2 General Format Definition 2
2.1 Command Line 2
2.2 Invalid Keywords 2
2.3 Command Response 3
3 User Login 3
3.1 Local User Login 3
3.2 Remote User Login 4
4 Listing of Commands 5
4.1 Generic Commands 5
4.2 Subscriptions 5
4.3 Basic CM 5
4.4 Bulk CM 6
4.5 Performance Management 6
4.6 SW Upgrade 7
5 Command Descriptions 7
5.1 AbortSessionOperation 7
5.2 AbortSWSessionOperation 8
5.3 Activate 9
5.4 ActivateSW 10
5.5 ChangePWD 12
5.6 CheckConsistency 13
5.7 Commit 14
5.8 CreateMO 16
5.9 DeleteMO 16
5.10 Download 17
5.11 DownloadSW 19
5.12 EndSession 20
2/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.13 EndSWSession 21
5.14 EndTransaction 21
5.15 GenerateKey 22
5.16 GetAlarmList 23
5.17 GetContainment 24
5.18 GetIRPVersion 25
5.19 GetMOAttribute 26
5.20 GetPendingConfiguration 28
5.21 GetRBSMode 29
5.22 GetSessionIds 29
5.23 GetSessionStatus 30
5.24 GetSubscriptionIds 31
5.25 GetSubscriptionStatus 32
5.26 GetSWSessionIds 33
5.27 GetSWSessionStatus 34
5.28 GetTransactionId 35
5.29 GetTransactionStatus 36
5.30 ResetToFactorySetting 37
5.31 Restart 38
5.32 ResumePMMeasurements 39
5.33 ResumeSubscription 40
5.34 SetMOAttribute 41
5.35 SetRBSMode 42
5.36 SimplePing 43
5.37 StartSession 44
5.38 StartSWSession 45
5.39 StartTransaction 46
5.40 Subscribe 47
5.41 SuspendPMMeasurements 48
5.42 SuspendSubscription 49
5.43 Unsubscribe 50
5.44 Upload 51
2/190 82-LZA 701 0001 Uen D 2008-05-16
Introduction
1 Introduction
This document describes the commands in the Site Transport Node (STN)Command Line Interface (CLI). The CLI is available on the physical interfacefor operation and maintenance.
The following apply to the physical interface for operation and maintenance:
• Local access is achieved through the configuration port, using a PCequipped with a Telnet client. The configuration port is a standard Ethernetport (RJ-45).
• Remote access is achieved through the Ethernet port, using Secure Shell(SSH) over IP. The STN connects to the Operations Support System (OSS),using Secure File Transfer Protocol (SFTP) for file transfers, for example,downloading software archives and uploading Performance Management(PM) data. The STN also sends Simple Network Management Protocol(SNMP) events to an SNMP agent in the OSS.
All commands are available on both interface variants. In the local operationstate, only the local terminal can be used.
Note: The STN does not prevent the use of the local terminal and an SSHconnection from the OSS at the same time. The outcome of conflictingchanges cannot be guaranteed.
Note: The generic command help lists commands of which some are notdescribed in this document. These commands are not supported forcustomer use and must only be used by Ericsson personnel.
1.1 Target Groups
This document is for the following people:
• RBS installation and integration personnel
• Site engineers
• Network engineers
1.2 Typographic Conventions
The typographic conventions used in the CLI examples are as follows:
CommandToBeEnteredExaclyAsWritten InputParameterValuesSuppliedByTheUser
Output parameter values displayed by the system
12/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
1.3 Revision Information
Other than editorial changes, this document has been revised as follows:
• Information regarding getIRPVersion updated
• Information that SWSessions are for both upgrading and downgradingadded
2 General Format Definition
2.1 Command Line
Commands specified on the command line have the following syntax:
Command ParameterValue1 ParameterValue2 ...
Entities on the command line are separated from each other by a space. Allentities are case insensitive unless otherwise stated for the command. Allentities are not used in all commands.
Parameter names are not used in the CLI. The values for parameters are givenin 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 ofparameters in the tables of the command descriptions.
The maximum number of characters in the command line is 512.
2.2 Invalid Keywords
The STN restricts the use of keywords in the parameters transactionId,sessionId, sessionIdSW, instanceId and password. The parameters cannotconsist of the following restricted keywords:
• Managed Object (MO) names
• Commands (including commands with the prefix test)
• Defined strings such as, forcedCommit, autoRollback, delayed,useNewConfiguration
• Constant strings true, false, enable, disable (not case sensitive)
2 2/190 82-LZA 701 0001 Uen D 2008-05-16
User Login
2.3 Command Response
When a command has been successfully received and processed, the STNresponds with the following status:
OperationSucceeded
Some commands result in a response with more parameters. The tables foreach command shows all output parameters.
3 User Login
This section describes the operations and parameters to perform a login tothe STN CLI.
3.1 Local User Login
The following operations allows clients to perform a local user login to theSTN-CLI using authentication based on a username and a password.
The login must take place from a local terminal through the configuration porton which a Telnet client is executing.
3.1.1 Input Parameters
Table 1 Input Parameters
Parameter Name Description
telnet <IP address> The user login is initiated by typingtelnet followed by an IP address. The STNrequests for a username and a password.
username/password The user issues a username and a password.The STN validates the user and presents theSTN-CLI prompt after a successful login.
exit This operation exits the session and logs theuser out.
3.1.2 Output Parameters
None.
32/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
3.1.3 Example 1
telnet 192.168.1.1
STN requests for a username and a password
smith 123abc
The STN presents the STN-CLI prompt
3.2 Remote User Login
The following operations allows SSH clients to perform a login to the STN-CLIusing authentication based on a username and a password.
3.2.1 Input Parameters
Table 2 Input Parameters
Parameter Name Description
ssh username@IPaddress bound to theSTN WAN port
The user login is initiated by typing ssh followedby username@IP_address. The STNrequests for a password.
password The user issues the password. The STNvalidates the password and presents theSTN-CLI prompt after a successful login.
exit This operation exits the session and logs theuser out.
3.2.2 Output Parameters
None.
3.2.3 Example 1
STN requests for a password
123abc
The STN presents the STN-CLI prompt
4 2/190 82-LZA 701 0001 Uen D 2008-05-16
Listing of Commands
4 Listing of Commands
In this section commands are grouped in different domains. Each domain has asubsection in which related commands are listed.
4.1 Generic Commands
This section lists generic commands related to the functionality and securityof the STN.• getIRPVersion• changePWD• generateKey• simplePing• resetToFactorySetting• restart• setRBSMode• getRBSMode• getAlarmList
4.2 Subscriptions
This section lists commands related to subscriptions to alarms and notifications.Subscribers are SNMP managers in network management systems such asthe OSS.
• subscribe• unsubscribe• getSubscriptionIds• getSubscriptionStatus• suspendSubscription• resumeSubscription
4.3 Basic CM
This section lists basic Configuration Management (CM) commands. Basic CMis used to change attribute values in the Managed Information Model (MIM).Basic CM transactions ensure that data changes in the MIM are performedconsistently.
Several attributes can be changed in a transaction by including asetMOAttribute command for each attribute to change. Each command
52/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
performed in a transaction is validated immediately and executed when thecommit command is received. The transaction is persistent at ordered commit.
Basic CM commands:
• checkConsistency
• getContainment
• startTransaction
• setMOAttribute
• getMOAttribute
• getTransactionId
• getTransactionStatus
• commit
• endTransaction
• createMO
• deleteMO
4.4 Bulk CM
The commands listed in this section are related to the downloading anduploading of configuration files and the activation of new configurations. Theconfiguration files hold configuration data for the MIB. Files for download tothe STN are generated by the OSS. Files are uploaded to be processed bythe OSS.
• startSession
• getSessionIds
• download
• upload
• getSessionStatus
• abortSessionOperation
• activate
• endSession
• getPendingConfiguration
4.5 Performance Management
This section lists basic Performance Management (PM) commands used tocollect performance data, for example, counters. The PM data is collected foreach MO instance and periodically saved and uploaded to a file repository.• suspendPMMeasurements
• resumePMMeasurements
6 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
4.6 SW Upgrade
The commands listed in this section are related to the downloading of softwarefiles and the activation of new software.
The downloading and the activation of software are performed in a softwaresession.
• startSWSession
• getSWSessionIds
• downloadSW
• getSWSessionStatus
• abortSWSessionOperation
• activateSW
• endSWSession
5 Command Descriptions
This section describes the function of and parameters for each command onthe STN CLI.
5.1 AbortSessionOperation
This command interrupts the uploading or downloading of bulk CM files. Anydownloaded data is discarded. No uploaded data is deleted.
5.1.1 Input Parameters
Table 3 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
72/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.1.2 Output Parameters
Table 4 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.1.3 Example
abortSessionOperation bcm1
OperationSucceeded
The sessionId is bcm1.
5.2 AbortSWSessionOperation
This command interrupts software downloading. After the interruption thedownloaded software is erased from the STN and the backup software store isnot affected by the download.
5.2.1 Input Parameters
Table 5 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
5.2.2 Output Parameters
Table 6 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
8 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.2.3 Example
abortSWSessionOperation s1
OperationSucceeded
The sessionId is s1.
5.3 Activate
This command activates requested changes of attribute values downloadedwith command download. In case any changed attribute requires a restart,then any established traffic connections are closed down and the STN restarts.The restart also clears performance management data and terminates O&Mtraffic in progress.
The command line does not return until the restart is completed, which cantake several minutes.
5.3.1 Input Parameters
Table 7 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
delayed (optional) If set, the downloaded file is only storedpersistently. The activation of the downloadedfile will be performed when the SWSessionis activated with the optional parameteruseNewConfiguration set.
If not set, the downloaded file will be activatedimmediately.
The parameter is not possible to use in thesame session as the parameter autoRollback.
autoRollback (optional) If set, the STN will restart on the old configurationif not endSession or endSWsession have beenreceived in specified time.
autoRollbackTimer(optional)
Specifies a time in minutes before anautoRollback will occur.
92/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.3.2 Output Parameters
Table 8 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.3.3 Example 1
activate bcm1
OperationSucceeded
5.3.4 Example 2
activate bcm1 delayed
OperationSucceeded
The sessionId is bcm1, delayed is included if the activation of thedownloaded file should be performed within a SWSession with the optionalparameter useNewConfiguration set.
5.3.5 Example 3
activate bcm1 autoRollback 10
OperationSucceeded
The sessionId is bcm1, autoRollback is included to restart the STN onthe old configuration, if not endSession or endSWSession have been receivedbefore autoRollbackTimer has expired. The autoRollbackTimer is 10,specified in minutes.
5.4 ActivateSW
This command closes any established traffic connections and restarts the STNwith the latest downloaded software. The restart also clears performancemanagement data and terminates O&M traffic and telnet/ssh session inprogress.
The command line does not return until the software activation is completed,which can take several minutes.
10 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.4.1 Input Parameters
Table 9 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
useNewConfiguration(optional)
If the useNewConfiguration parameter isset, the STN will activate both the latestdownloaded software and Bulk CM file. Therequirement is that a Bulk CM session existsin ACTIVATION_IN_PROGRESS state andthat it has been entered through the activatecommand and with the parameter delayedset. If the requirement is not fulfilled, then theactivateSW command is rejected.
If the useNewConfiguration parameter isnot set, the STN will only activate the latestdownloaded software after a restart.
autoRollback (optional) If the parameter is set, the STN will restart onthe old software if not endSWSession has beenreceived in specified time.
autoRollbackTimer(optional)
Specifies a time in minutes before anautoRollback will occur.
5.4.2 Output Parameters
Table 10 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.4.3 Example 1
activateSW s1
OperationSucceeded
The sessionId is s1.
112/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.4.4 Example 2
activateSW s1 useNewConfiguration
OperationSucceeded
The sessionId is s1, useNewConfiguration is included if the STN shouldactivate both the latest software and Bulk CM File.
5.4.5 Example 3
activateSW s1 autoRollback 10
OperationSucceeded
The sessionId is s1, autoRollback is included to restart the STNon the old configuration, if not endSWSession has been received beforeautoRollbackTimer has expired. The autoRollbackTimer is 10, specified inminutes.
5.5 ChangePWD
This command changes the password for a user. Only one default super useris supported. The username of the super user is admin.
The user needs to use the password to log on to the STN through a telnet orSSH connection.
The password is case sensitive and must consist of 5–8 characters. Allowedcharacters are A–Z, a–z, and 0–9.
5.5.1 Input Parameters
Table 11 Input Parameters
Parameter Name Description
oldPassword Password currently valid for the SSH sessionuser.
newPassword New password for the SSH user.
verifyPassword New password duplicated for verification.
12 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.5.2 Output Parameters
Table 12 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.5.3 Example
changePWD aBc123 xyZ6789 xyZ6789
OperationSucceeded
The oldPassword is aBc123, the newPassword and the verifyPassword isxyZ6789.
5.6 CheckConsistency
This command checks the validity and consistency of an updated configuration.The check is useful before a commit command is performed to verify that theconfiguration contains a complete set of MOs and attributes.
5.6.1 Input Parameters
Table 13 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
132/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.6.2 Output Parameters
Table 14 Output Parameters
Parameter Name Description
consistent This parameter contains the result of theconsistency check. The result is consistent ornot consistent.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.6.3 Example
checkConsistency t1
consistent
OperationSucceeded
The transactionId is t1.
5.7 Commit
This command commits all configuration requests in the transaction. Therequests are performed with one or more setMOAttribute, createMO anddeleteMO commands issued before commit. Data regarding the transactionare stored persistently.
5.7.1 Input Parameters
Table 15 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
14 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
Parameter Name Description
forcedCommit (optional) If this optional parameter is set , then theSTN restarts if attributes requiring a restartare changed. All traffic is closed down duringrestart.
If the parameter is excluded, and attributesrequiring a restart are changed, then the STNrejects the commit command.
autoRollback (optional) If the parameter is set, the STN will restart onthe old software if not endTransaction has beenreceived in specified time.
autoRollbackTimer(optional)
Specifies a time in minutes before anautoRollback will occur.
5.7.2 Output Parameters
Table 16 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.7.3 Example
commit t1 forcedCommit
OperationSucceeded
The transactionId is t1, forcedCommit is included if an attribute requestsa node restart.
5.7.4 Example
commit t1 autoRollback 10
OperationSucceeded
The transactionId is t1, autoRollback is included to restart the STNon the old configuration, if not endTransaction has been received beforeautoRollbackTimer has expired. The autoRollbackTimer is 10, specified inminutes.
152/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.8 CreateMO
This command creates a new MO. The command must be used within atransaction and does not support setting of attribute(s). The new MO will nottake affect until a commit command is executed.
For further information, see STN Managed Object Model.
5.8.1 Input Parameters
Table 17 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
managedObjectInstance Baseobject in a containment hierarchy for thenew MO.
5.8.2 Output Parameters
Table 18 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.8.3 Example
createMO t1 STN=0,E1T1Interface=0
OperationSucceeded
The transactionId is t1, the managedObjectInstance isSTN=0,E1T1Interface=0.
5.9 DeleteMO
This command deletes a MO identified by the baseObjectInstance. ChildMOs are automatically deleted. The deletion of the MOs will not take affectuntil a commit command is executed.
16 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
For further information, see STN Managed Object Model.
5.9.1 Input Parameters
Table 19 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
baseObjectInstance Baseobject in a containment hierarchy fromwhere the deletion will be performed.
5.9.2 Output Parameters
Table 20 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.9.3 Example
deleteMO t1 STN=0,E1T1Interface=0
OperationSucceeded
The transactionId is t1, the baseObjectInstance isSTN=0,E1T1Interface=0.
5.10 Download
This command orders the downloading of a bulk CM XML configuration filefor STN configuration. When the complete file has been downloaded, therequested attribute values are stored in RAM.
All new attribute values that have not been stored in flash with commandactivate or command endSession, are lost at power off, spontaneousrestart, push button reset, or any command causing a reset.
172/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.10.1 Input Parameters
Table 21 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
downloadDataFileReference
Specifies a globally unique file reference fromwhich the data is retrieved and downloaded.
The addressing of the file source must followthe syntax:
sftp://username:password@host/filepath
where host specifies the IP address of the filesource host.
progressInterval (optional) Defines a time in seconds after which the STNsends software download progress messagesto the SNMP manager.
Possible values: 0 and 15–900
When set to 0 or not set, no notifications will besent.
5.10.2 Output Parameters
Table 22 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.10.3 Example
download bcm1 sftp://smith:[email protected]/STNCFG/stn82_synch.xml 15
OperationSucceeded
The sessionId is bcm1. The downloadDataFileReference issftp://smith:[email protected]/STNCFG/stn82_synch.xml and theprogressInterval is 15.
18 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.11 DownloadSW
This command orders the downloading of new software for the STN.The downloaded software is stored in the STN RAM until it is activatedwith the activateSW command or until the session is ended with theendSWSession command. Any restart of the STN or abortion with theabortSWSessionOperation command during software downloading, erasesthe downloaded software.
5.11.1 Input Parameters
Table 23 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
downloadDataFileReference
Specifies a globally unique file reference fromwhich the data is retrieved and downloaded.
The addressing of the file source must followthe syntax:
sftp://username:password@host/filepath
where host specifies the IP address of the filesource host.
progressInterval (optional) Defines a time in seconds after which theSTN shall send software download progressmessages to the SNMP manager.
Possible values: 0 and 15–900
When set to 0 or not set, no notifications will besent.
5.11.2 Output Parameters
Table 24 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
192/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.11.3 Example
downloadSW s1 sftp://smith:[email protected]/STNSW/STN_sw.tar 30
OperationSucceeded
The sessionId is s1. The downloadDataFileReference issftp://smith:[email protected]/STNSW/stn_sw.tar and theprogressInterval is 30.
5.12 EndSession
This command ends a bulk CM session. Operations in progress related tothe bulk CM session are terminated.
5.12.1 Input Parameters
Table 25 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
5.12.2 Output Parameters
Table 26 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.12.3 Example
endSession bcm1
OperationSucceeded
The sessionId is bcm1.
20 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.13 EndSWSession
This command ends a software upgrading or downgrading session. Operationsin progress related to the software session are terminated. Downloadedsoftware remains in flash regardless of whether it has been activated or not.
5.13.1 Input Parameters
Table 27 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
5.13.2 Output Parameters
Table 28 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.13.3 Example
endSWSession s1
OperationSucceeded
The sessionId is s1.
5.14 EndTransaction
This command ends a basic CM transaction.
When endTransaction is performed before commit, then all changes in thetransaction are lost.
212/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.14.1 Input Parameters
Table 29 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
5.14.2 Output Parameters
Table 30 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.14.3 Example
endTransaction t1
OperationSucceeded
The transactionId is t1.
5.15 GenerateKey
This command generates a new host key, which is used for security andencrypts the communication with clients. Clients using SSH need the new hostkey to connect to the STN. At the point in time when the host key is changedin the STN, the clients need to be configured to change host key on requestfrom the STN. To maintain IP security this command must be executed atleast once a year.
5.15.1 Input Parameters
None.
22 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.15.2 Output Parameters
Table 31 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) New key successfully generated.
(b) Operation failed because of specified orunspecified reasons.
5.15.3 Example
generateKey
New key successfully generated
The status is New key successfully generated.
5.16 GetAlarmList
This command returns all active alarms in the STN.
5.16.1 Input Parameters
None.
5.16.2 Output Parameters
Table 32 Output Parameters
Parameter Name Description
alarmInformationList This parameter contains a list of all existingalarms in the STN.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.16.3 Example
getalarmlist
232/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
STN=0,TGTransport=p2;
alarmId= 1;
eventTime= 1970-01-01 T00:00:42;
eventType= "communicationsAlarm(2)";
perceivedSeverity= "critical(1)";
probableCause= "m3100ConnectionEstablishmentError(22)";
specificProblem= "STN-to-BSC Link Down";
additionalText= "The Primary Control Connection to the BSCis disconnected.";
OperationSucceeded
5.17 GetContainment
This command retrieves all MO instances in a specific MO containmenthierarchy under and including the baseObjectInstance .
5.17.1 Input Parameters
Table 33 Input Parameters
Parameter Name Description
transactionId (optional) Unique transaction identifier.
Possible values: a string of up to 10 characters.
baseObjectInstance Baseobject in a containment hierarchy.
5.17.2 Output Parameters
Table 34 Output Parameters
Parameter Name Description
containment All managed object instances included in thespecified containment hierarchy including theMO defined in the baseObjectInstance.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
24 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.17.3 Example
getContainmentt1 STN=0
STN=0;
STN=0,Equipment=0;
STN=0,EthernetInterface=0;
STN=0,IPInterface=0;
STN=0,Synchronization=0;
STN=0,MeasurementDefinition=0;
STN=0,E1T1Interface=0;
STN=0,TGTransport=p2;
STN=0,TGTransport=p2,SuperChannel=0;
OperationSucceeded
The transactionId is t1, the baseObjectInstance is STN=0.
5.18 GetIRPVersion
This command displays the version number of the Integration Reference Point(IRP) used between the STN and the OSS.
5.18.1 Input Parameters
None.
5.18.2 Output Parameters
Table 35 Output Parameters
Parameter Name Description
currentVersionNumber Shows the IRP version currently used.
252/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
Parameter Name Description
versionNumberSet List of IRP versions supported by the STN.Ericsson's versionNumberSet attributebehaviour differs from that specified in the3GPP specification.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.18.3 Example
getIRPVersion
3.0 3.2,3.1,3.0
OperationSucceeded
The currentVersionNumber is 3.0 (leftmost), and the versionNumberSet is 3.2,3.1,3.0. Only one IRP version is supported in this example.
5.19 GetMOAttribute
This command displays Managed Object (MO) attribute values.
For more information on definitions of MOs, attributes, and attribute values, andthe attributes that can be displayed with this command, see STN ManagedObject Model.
26 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.19.1 Input Parameters
Table 36 Input Parameters
Parameter Name Description
transactionId (optional) Unique transaction identifier.
Optional parameter used when the commandis executed in a transaction (betweenthe commands startTransaction andendTransaction). The value returned whenused in a transaction is the value stored inthe RAM which might not be the same as thecurrently used value. Changing MO attributeswith the setMOAttribute command createsa temporary copy of the MO model in the RAM.The values in the RAM are used after the nextcommit command.
This parameter is not used when the commandis executed outside a transaction. The returnedvalue when executed outside a transaction isthe currently used value stored in the flashmemory.
baseObjectInstance MO instance that is read.
attributeListIn (optional) Identifies the attribute list to be returned.
5.19.2 Output Parameters
Table 37 Output Parameters
Parameter Name Description
attributeListOut Values for the MO instance attribute listspecified as the input parameter.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.19.3 Example 1
getMOAttribute t1 STN=0,IPInterface=0 primaryIP_Address
STN=0,IPInterface=0;primaryIP_Address=192.168.59.64
OperationSucceeded
272/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
The transactionId is t1, the baseObjectInstance is STN=0,IPInterface=0and the attributeListIn is primaryIP_Address.
The attributeListOut (the IP address of the STN) is 192.168.59.64. If thevalue has been changed in the current transaction, then the new value fromthe not commited MO model is returned. A changed value will be in use afterexecution of the command commit.
5.20 GetPendingConfiguration
This command is used to determine if there is a bulk CM download file ready tobe activated with a activesw command together with the SW. If a file exists afilename and MIM version is returned.
5.20.1 Input Parameters
None.
5.20.2 Output Parameters
Table 38 Output Parameters
Parameter Name Description
mimVersion Specifies the MIM version from the bulk CM fileheader.
fileName Specifies the filename of the bulk CM fileexcluding the directory information.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.20.3 Example 1
getpendingconfiguration
3.0 stn82_CM.xml
OperationSucceeded
28 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.21 GetRBSMode
This command is only applicable for RBS 2409 and is used to retrieve the RBSmode operation (master, extension or calibration) the RBS is set to.
5.21.1 Input Parameters
None.
5.21.2 Output Parameters
Table 39 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.21.3 Example
getrbsmode
Master
OperationSucceeded
5.22 GetSessionIds
This command returns the identity of existing bulk CM sessions.
5.22.1 Input Parameters
None
292/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.22.2 Output Parameters
Table 40 Output Parameters
Parameter Name Description
sessionIdList This parameter is a list of a sessionId
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.22.3 Example
getSessionIds
bcm1
OperationSucceeded
The sessionIdList is bcm1.
5.23 GetSessionStatus
This command returns the status of a specific bulk CM session.
5.23.1 Input Parameters
Table 41 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
30 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.23.2 Output Parameters
Table 42 Output Parameters
Parameter Name Description
sessionState Indicates state of bulk CM session.
Possible values: Idle, UploadInProgress,UploadFailed, UploadCompleted,DownLoadInProgress, DownloadFailed,DownloadCompleted, ActivationInProgress,ActivationFailed, ActivationCompleted.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.23.3 Example
getSessionStatus bcm1
DownLoadInProgress
OperationSucceeded
The sessionId is bcm1. The sessionState is DownLoadInProgress.
5.24 GetSubscriptionIds
This command returns all subscriptions existing in the STN.
5.24.1 Input Parameters
None.
312/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.24.2 Output Parameters
Table 43 Output Parameters
Parameter Name Description
subscriptionIdSet This parameter is a list of subscriptionIdsexisting in the STN.
No existing subscriptionIds will be indicatedwith --.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.24.3 Example
getSubscriptionIds
1 2 3
OperationSucceeded
The set of existing subscriptionIds are 1, 2 and 3.
5.25 GetSubscriptionStatus
This command returns the characteristics of subscriptions.
5.25.1 Input Parameters
Table 44 Input Parameters
Parameter Name Description
subscriptionId This parameter is the subscriptionId for whichcharacteristics will be returned.
Possible values: 1–10
32 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.25.2 Output Parameters
Table 45 Output Parameters
Parameter Name Description
subscriptionState Specifies if this subscription is active (notsuspended) or suspended.
timeTick Time interval between heartbeat notifications,expressed in units of whole minutes. If the valueis set to 0, then the heartbeat is turned off.
managerReference Specifies the IP address of the SNMP managerto which notifications are sent (the subscriber)when this subscription is active.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.25.3 Example
getSubscriptionStatus 1
notSuspended 2 192.168.59.62
OperationSucceeded
The subscriptionId is 1.The subscriptionState is notSuspended, the timeTick is 2, themanagerReference is 192.168.59.62.
5.26 GetSWSessionIds
This command returns the identity of existing software sessions.If no sessionexists, then this is indicated by two consecutive hyphens (--).
5.26.1 Input Parameters
None
332/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.26.2 Output Parameters
Table 46 Output Parameters
Parameter Name Description
sessionIdList List of sessionIds
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.26.3 Example
getSWSessionIds
s1
OperationSucceeded
The sessionIdList is s1.
5.27 GetSWSessionStatus
This command returns the status of a specific software upgrading ordowngrading session.
5.27.1 Input Parameters
Table 47 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
34 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.27.2 Output Parameters
Table 48 Output Parameters
Parameter Name Description
sessionState Indicates state of software upgrading session.
Possible values: Idle, DownLoadInProgress,DownloadFailed, DownloadCompleted,ActivationInProgress, ActivationFailed,ActivationCompleted.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.27.3 Example
getSWSessionStatus s1
DownLoadInProgress
OperationSucceeded
The sessionId is s1. The sessionState is DownLoadInProgress.
5.28 GetTransactionId
This command returns the identity of the transaction (transactionId).
5.28.1 Input Parameters
None.
352/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.28.2 Output Parameters
Table 49 Output Parameters
Parameter Name Description
transactionId Unique transaction identifier.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.28.3 Example
getTransactionId
t1
OperationSucceeded
The transactionId is t1.
5.29 GetTransactionStatus
This command returns the status of the transaction, and is only possibleto perform within a transaction. If the command is executed outside thetransaction, then it returns OperationFailed.
5.29.1 Input Parameters
Table 50 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
36 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.29.2 Output Parameters
Table 51 Output Parameters
Parameter Name Description
transactionState The transaction state is idle whenstartTransaction is performed but commitis not yet performed (for example while severalsetMOAttribute commands are performed).
Possible values: Idle, CommitFailed,CommitCompleted
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.29.3 Example
getTransactionStatus t1
Idle
OperationSucceeded
The transactionId is t1. The transactionState is Idle.
5.30 ResetToFactorySetting
This command resets the STN to default factory settings. MIB content is erasedand persistent data including security and synchronization data is cleared.Software archives are not affected by this command.
5.30.1 Input Parameters
None.
372/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.30.2 Output Parameters
Table 52 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.30.3 Example
resetToFactorySetting
Note: A warning will appear asking for acknowledge if this command reallyshould be executed.
OperationSucceeded
5.31 Restart
This command initializes a reset of the STN. All connections to the STN arereset as part of the operation. The restart also clears performance managementdata. If a subscription exists, the STN resumes sending heartbeat notificationswhen the restart is completed.
The command line does not return until the restart is completed, which cantake up to 1 minute.
5.31.1 Input Parameters
None.
5.31.2 Output Parameters
Table 53 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
38 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.31.3 Example
restart
OperationSucceeded
5.32 ResumePMMeasurements
This command initiates/enables PM data uploading and specifies details of thefile store destination.
5.32.1 Input Parameters
Table 54 Input Parameters
Parameter Name Description
PMMeasurementInstance Instance of PM measurement MO. The value isalways STN=0,MeasurementDefinition=0.
fileStore An SFTP URI, including authenticationinformation, that defines where the STN uploadsthe PM reports. The addressing of the filedestination must follow the syntax:
sftp://username:password@host/filepath
where host specifies the IP address of the filedestination host and filepath is the directorystructure specified from the root.
Note that in addition to the filepath, asubdirectory named PM must exist at the filestore destination.
5.32.2 Output Parameters
Table 55 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
392/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.32.3 Example
resumePMMeasurements STN=0,MeasurementDefinition=0sftp://jones:[email protected]/home/jones/ARCHIVE/STN95
OperationSucceeded
The PMMeasurementInstance is STN=0,MeasurementDefinition=0 and thefileStore issftp://jones:[email protected]/home/jones/ARCHIVE/STN95.
5.33 ResumeSubscription
This command activates a defined but suspended subscription. The result isalarms and notifications being sent.
5.33.1 Input Parameters
Table 56 Input Parameters
Parameter Name Description
subscriptionId The subscriptionId for the subscription toresume.
Possible values: 1–10
5.33.2 Output Parameters
Table 57 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.33.3 Example
resumeSubscription 2
OperationSucceeded
The subscriptionId is 2.
40 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.34 SetMOAttribute
This command sets MO attribute values. One attribute value for one MOinstance can be defined in each command. The command must be used withina transaction.
Changing one or more MO attributes with the setMOAttribute commandcreates a temporary copy of the MO model that includes all the changes. Acommit command is required to activate this temporary version of the MOmodel and make it the currently used and persistent MO model.
For more information on definitions of MOs, attributes, and attribute values, andthe attributes that can be set with this command, see document STN ManagedObject Model.
5.34.1 Input Parameters
Table 58 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
baseObjectInstance The MO instance that is modified.
attribute This parameter identifies the attribute whosevalue is to be modified.
attributeValue The value to be used in the modification of theattribute.
5.34.2 Output Parameters
Table 59 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.34.3 Example 1
setMOAttribute t1 STN=0 wakeUpRegistration 192.168.59.62
OperationSucceeded
412/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
The command line defines the address to which the STN sends the wake-upevent. The transactionId is t1, the baseObjectInstance is STN=0,the attribute is wakeUpRegistration, and the attributeValue is192.168.59.62.
5.34.4 Example 2
setMOAttribute t1 STN=0,EthernetInterface=0 mode auto
OperationSucceeded
The command line defines that the auto mode shall be used on the Ethernetinterface. The transactionId is t1, the baseObjectInstance is STN=0,EthernetInterface=0, the attribute is mode, and the attributeValue isauto.
5.35 SetRBSMode
This command is only applicable for RBS 2409 and is used to set up a master,extension or calibration operation.
5.35.1 Input Parameters
Table 60 Input Parameters
Parameter Name Description
rbsmode This parameter sets the current RBS mode toone of the following modes:
• master
• extension
• calibration
The RBS will revert back to a stored mode(master or extension) after a restart has beenperformed.
42 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.35.2 Output Parameters
Table 61 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.35.3 Example
setrbsmode master
OperationSucceeded
The input parameter for setting RBS mode is master.
5.36 SimplePing
This command tests whether the STN could reach a defined destination IPaddress by sending three echo requests from a source IP address throughthe IP network. The test checks the IP network connectivity and is useful atinstallation prior to taking the STN into service.
5.36.1 Input Parameters
Table 62 Input Parameters
Parameter Name Description
sourceIPaddress Specifies the IP address from which the echorequests are sent to a defined destinationIP address. The source IP address mustbe the primary IP address or one of thesecondary IP addresses defined in the attributedepIP_interface
of MO STN, for the operation to succeed.
destinationIPaddress Specifies the IP address of the host to whichthe three echo requests are sent to test theconnectivity. Time between send requests is107 milliseconds and the packet size is 56 databytes.
432/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.36.2 Output Parameters
Table 63 Output Parameters
Parameter Name Description
response This parameter is a list of the responses. TheSTN waits up to 1 second for each response.
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.36.3 Example 1
simpleping 192.168.59.62 192.168.69.152
3/3 received OK
OperationSucceeded
The 192.168.59.62 is the source IP address, the 192.168.69.152 is thedestination IP address.
5.37 StartSession
This command starts a bulk CM session. A Bulk CM session can be used inparallel with a software upgrading session but cannot be used in parallel with abasic CM transaction. Only one bulk CM session can be active at the time.
5.37.1 Input Parameters
Table 64 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
managerReference(optional)
This parameter specifies the IP address of theSNMP Manager to which notifications are sent.
44 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.37.2 Output Parameters
Table 65 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.37.3 Example
startSession bcm1 192.168.59.62
OperationSucceeded
The sessionId is bcm1, the managerReference is 192.168.59.62.
5.38 StartSWSession
This command starts a software upgrading or downgrading session. One basicCM transaction or one bulk CM session can be used in parallel with a softwaresession. Only one software session can be active at the time.
5.38.1 Input Parameters
Table 66 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
managerReference(optional)
This parameter specifies the IP address of theSNMP Manager to which notifications are sent.
452/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.38.2 Output Parameters
Table 67 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.38.3 Example
startSWSession s1 192.168.59.62
OperationSucceeded
The sessionId is s1, the managerReference is 192.168.59.62.
5.39 StartTransaction
This command starts a basic CM transaction. Basic CM transactions can beused in parallel with software upgrading sessions but cannot be used in parallelwith bulk CM sessions. Only one basic CM transaction can be active at the time.
Basic CM commands can be executed within a Basic CM transaction. Eachcommand performed in a transaction is validated immediately and executedwhen the commit command is received. The transaction is persistent atordered commit.
5.39.1 Input Parameters
Table 68 Input Parameters
Parameter Name Description
transactionId Unique transaction identifier.
Possible values: a string of up to 10 characters.
managerReference(optional)
This parameter specifies the IP address of theSNMP Manager to which notifications are sent.
46 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.39.2 Output Parameters
Table 69 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.39.3 Example
startTransaction t1 192.168.59.62
OperationSucceeded
The transactionId is t1, the managerReference is 192.168.59.62.
5.40 Subscribe
This command defines the IP address of an SNMP manager and the timeinterval between heartbeat notifications. When the command is issued, theSTN sends all alarms and notifications to the SNMP manager, which is an OSSapplication. There can be up to 10 active subscriptions.
5.40.1 Input Parameters
Table 70 Input Parameters
Parameter Name Description
managerReference This parameter specifies the IP address of theSNMP manager to which notifications are sent.
timeTick Time interval between heartbeat notifications,expressed in units of whole minutes. When thevalue is set to 0, then the heartbeat is turned off.
Range: 0–10
472/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.40.2 Output Parameters
Table 71 Output Parameters
Parameter Name Description
subscriptionId The identity of the subscription assigned by thesystem.
Possible values: 1–10
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.40.3 Example
subscribe 192.168.59.62 2
1
OperationSucceeded
The managerReference IP address is set to 192.168.59.62 and thetimeTick is set to every 2 minutes. The subscriptionId is 1.
5.41 SuspendPMMeasurements
This command stops/disables PM data collection and PM data upload.
5.41.1 Input Parameters
Table 72 Input Parameters
Parameter Name Description
PMMeasurementInstance The instance of the PM measurement MO. Thevalue is always STN=0,MeasurementDefinition=0.
48 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.41.2 Output Parameters
Table 73 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.41.3 Example
suspendPMMeasurements STN=0,MeasurementDefinition=0
OperationSucceeded
The PMMeasurementInstance is STN=0,MeasurementDefinition=0.
5.42 SuspendSubscription
This command disables or stops the sending of alarms and notifications.
5.42.1 Input Parameters
Table 74 Input Parameters
Parameter Name Description
subscriptionId The subscriptionId for the subscription tosuspend.
Possible values: 1–10
5.42.2 Output Parameters
Table 75 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
492/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.42.3 Example
suspendSubscription 2
OperationSucceeded
The subscriptionId is 2.
5.43 Unsubscribe
This command disables or stops the sending of alarms and notifications andremoves the subscription. When unsubscribe is performed for the last definedsubscription, and wakeUpRegistration is defined, then the STN startssending wakeUpMessages instead of alarms and notifications.
5.43.1 Input Parameters
Table 76 Input Parameters
Parameter Name Description
subscriptionId This parameter specifies the subscriptionId.
Possible values: 1–10
5.43.2 Output Parameters
Table 77 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.43.3 Example
unsubscribe 1
OperationSucceeded
The subscriptionId is 1.
50 2/190 82-LZA 701 0001 Uen D 2008-05-16
Command Descriptions
5.44 Upload
This command orders the uploading of a bulk CM XML configuration file to thedestination file specified. If the specified file already exists, it will be replaced bythe new file.
5.44.1 Input Parameters
Table 78 Input Parameters
Parameter Name Description
sessionId Unique session identifier
Possible values: a string of up to 10 characters.
uploadDataFileReference Specifies a globally unique destination for theupload.
The addressing of the file source must followthe syntax:
sftp://username:password@host/filepath
where host specifies the IP address of thedestination host, and filepath specifies thedirectory structure and filename.
fileContent Defines which data from the MIB that shouldbe uploaded.
Possible values: CM
Value CM results in uploading of configurationdata from all MOs except MeasuredMOClass.
progressInterval (optional) Defines a time in seconds after which theSTN shall send software download progressmessages to the SNMP manager.
Possible values: 0 and 15–900
When set to 0 or not set, no notifications will besent.
512/190 82-LZA 701 0001 Uen D 2008-05-16
STN Command Descriptions
5.44.2 Output Parameters
Table 79 Output Parameters
Parameter Name Description
status Indicates either of the following:
(a) Operation successful.
(b) Operation failed because of specified orunspecified reasons.
5.44.3 Example
upload bcm1 sftp://smith:[email protected]/STNCFG/stn82_CM.xml CM 30
OperationSucceeded
The sessionId is bcm1. The uploadDataFileReference issftp://smith:[email protected]/STNCFG/stn82_CM.xml,fileContent is CM, and the progressInterval is 30.
52 2/190 82-LZA 701 0001 Uen D 2008-05-16