Classes for

Managed Object Model

for virtual MRF

Managed Information Model (MIM) identity
     Name   : MrfMOM
     Version : 2
     Release : 4
     Correction : 0
    

All PM Counters

Contents

AmrService
AmrWbService
Announcements
AnnouncementService
ArwaConfiguration
AudioMixingService
AutonomousMode
BasicAnnouncement
BasicAnnouncements
CapacityKey
CertM
CertMCapabilities
CliSsh
CliTls
ComputeResource
CustomRole
CustomRule
DtmfReceiverService
DtmfSenderService
EmergencyUnlock
EnrollmentAuthority
EnrollmentServer
EnrollmentServerGroup
Equipment
EricssonFilter
EvsConfData
EvsService
FeatureKey
FileGroup
FileGroupPolicy
FileInformation
FileM
FileMConfigData
Filter
Fm
FmAlarm
FmAlarmModel
FmAlarmType
G722Service
G729Service
IntegrationUnlock
JitterHandlingService
KeyFileInformation
KeyFileManagement
Ldap
LdapAuthenticationMethod
Legacy
Lm
LocalAuthorizationMethod
LogicalFs
ManagedElement
ManagedObject
MeasurementReader
MeasurementType
MediaResourceFunction
MrfConfiguration
MrfData
MrfH248Control
MrfH248Interface
MrfInstance
MrfMediaInterface
MrfNextHop
MrfResource
MsProcessing
NeLSConfiguration
NetconfSsh
NetconfTls
NodeCredential
NtpServer
PcmService
Pm
PmGroup
PmJob
PmMeasurementCapabilities
PmThresholdMonitoring
Role
RoleUpgrade
RtpRtcpService
Rule
Schema
SctpEndpoint
SctpProfile
SecM
Snmp
SnmpTargetV1
SnmpTargetV2C
SnmpTargetV3
SnmpTargetV3Dtls
SnmpViewV1
SnmpViewV2C
SnmpViewV3
Ssh
SwInventory
SwItem
SwM
SwVersion
SwVersionMain
SysM
SystemFunctions
ThresholdMonitoring
Tls
ToneSenderService
Transport
TrustCategory
TrustedCertificate
UpFhService
UpgradePackage
UserManagement
VariableAnnouncement
VariableAnnouncements

 

class AmrService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-AmrService

This MO models the Adaptive Multi Rate (AMR) Service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
AmrService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
amrServiceId
The value component of the RDN.

  class AmrService  

 

class AmrWbService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-AmrWbService

This MO represents Adaptive Multi Rate Wideband (AMR-WB) Service.

This MO models the AMR-WB Service in the node. The service is used to provide a better speech quality.

The Relative Distinguished Name (RDN) for this MO type is:
AmrWbService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
amrWbServiceId
The value component of the RDN.

  class AmrWbService  

 

class Announcements

ManagedElement
+-MediaResourceFunction
+-Announcements
+-BasicAnnouncements [1..1]
+-VariableAnnouncements [1..1]

This MO is a container for all MRF announcements data.

The Relative Distinguished Name (RDN) for this MO type is:
Announcements=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
announcementsId
The value component of the RDN.
string[0..1]
defaultLanguageCode = en-GB [ 0..128 ]
The default Language code of the announcements.

Language code has the format of an RFC 5646 language tag.

The default language code is used as language code for the basic and variable announcements in case the H.248 (or SIP) message doesn’t contain any language code for the requested announcement.

Example: en-GB

  class Announcements  

 

class AnnouncementService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-AnnouncementService

This MO represents the Announcement player Service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
AnnouncementService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
announcementServiceId
The value component of the RDN.

  class AnnouncementService  

 

class ArwaConfiguration

ManagedElement
+-SystemFunctions
+-Lm
+-ArwaConfiguration

Enables configuration of the Arwa server connection properties.

This MO is created by the system.

Deprecated: Arwa is no longer supported since LM6.0

Actions
boolean
connectToArwa ( );
connectToArwa will provide the action id result if the invocation is successful.

Note: This action is only supported in LM deployments with an intermittent connection to Arwa.
boolean
installCustomerMetadataFile ( string uri , EcimPasswordString password );
Initiates the installation of the Client Metadata file defined by the URI given as parameter.

e.g. installClientMetadataFile file:///tmp/clientMetadata.xml

Return value is TRUE in case the initiation succeeded or FALSE otherwise.


installClientMetadataFile /tmp/clientMetaData.xml

Parameters

Name: uri
Description: The URI of the metadata file that is to be installed.

The URI may refer to a local (e.g., file:///data/dir/subdir/rbs006.xml) or to a remote (e.g., sftp://myuser@myhostname.ericsson.local/dir/subdir/rbs006.xml) file.

If user name is needed to access the referenced file then the URI shall include the user name.

The URI must not contain password.

The generic URI syntax is defined by RFC 2396.

sftp support is reserved for future use.



Name: password
Description: Password to access the referenced file.

If authentication is not password based, this parameter will be ignored.

This parameter is reserved for future use.


Attributes
string
key
mandatory
noNotification
restricted
arwaConfigurationId
Holds the name used when identifying the MO.
string[0..1]
readOnly
customerName
Name of the current customer (eg. Customer1)
DateTime[0..1]
readOnly
licenseServerLastSuccessfulConnectTime
Last time of successful connection.

i.e. Fri, Dec 19, 2014 12:41:39 PM

Note: This attribute is only applicable to LM deployments with an intermittent connection to Arwa.
DateTime[0..1]
readOnly
licenseServerPlannedConnectEvent
Next Schedule for a planned connection to the Arwa server.
NULL if it is PERMANENT connection.

Note: This attribute is only applicable to LM deployments with an intermittent connection to Arwa.
AsyncActionProgress[0..1]
readOnly
reportProgress
Reports if the Arwa connection was successful or not.

  class ArwaConfiguration  

 

class AudioMixingService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-AudioMixingService

This MO models the Audio Mixing Service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
AudioMixingService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
audioMixingServiceId
The value component of the RDN.

  class AudioMixingService  

 

class AutonomousMode

ManagedElement
+-SystemFunctions
+-Lm
+-AutonomousMode

Autonomous Mode state information.

This MO is created by the system.

Attributes
LmActivationState
readOnly
activationState
Autonomous Mode activation state.
string
key
mandatory
noNotification
restricted
autonomousModeId
The value component of the RDN.
DateTime
readOnly
expiration
Expiry date and time of Autonomous Mode.

The value is NULL if the activation state is INACTIVE.

  class AutonomousMode  

 

class BasicAnnouncement

ManagedElement
+-MediaResourceFunction
+-Announcements
+-BasicAnnouncements
+-BasicAnnouncement

This MO represents MRF basic announcement data.

Attributes
uint16
mandatory
noNotification
restricted
announcementId
An identity for the basic announcement.
The combination of the announcementId and languageCode attributes form a unique identity for the basic announcement.
string
key
mandatory
noNotification
restricted
basicAnnouncementId
The value component of the RDN.
uint16
duration = 0
The amount of time the announcement is to be played.
If the specified duration is greater than the overall length of the announcement, the announcement is repeated until the duration is elapsed.

The playing time is also dependent on the value of the iteration attribute. The selected playing time is always the shortest possible alternative.

= 0: Play until requested to stop (infinite)
> 0: Play x Milliseconds

Note that the value received in H.248 ( or SIP) for this parameter overrides this attribute.


Unit: 1 ms
string
mandatory
fileName
The name of the announcement file.
string
mandatory
filePath
The relative file path to the directory where the announcement file is stored.
The value of this attribute is relative to the announcement_storage_server_path in deployment template.
Recommended value: basic/<languageCode>/

Example: basic/en-GB/
uint16
iteration = 0
The number of times the announcement is repeated when played to the user.

Please note that the playing time is also dependent on the value of the duration attribute. The selected playing time is always the shortest possible alternative.

= 0: Infinite loop
> 0: Repeat x Times

Note that the value received in H.248 ( or SIP) for this parameter overrides this attribute.
string
mandatory
noNotification
restricted
languageCode [ 0..128 ]
Language code of the basic announcement.

Language code has the format of an RFC 5646 language tag.

The combination of the announcementId and languageCode attributes form a unique identity for the basic announcement.

Example: en-GB


Valid values: [a-zA-Z]{1,8}([-_][a-zA-Z0-9]{1,8})*|^$
string[0..1]
userLabel [ 0..128 ]
Label for free use.

  class BasicAnnouncement  

 

class BasicAnnouncements

ManagedElement
+-MediaResourceFunction
+-Announcements
+-BasicAnnouncements
+-BasicAnnouncement [0..4096]

This MO is a container for all MRF basic announcements data.

The Relative Distinguished Name (RDN) for this MO type is:
BasicAnnouncements=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
basicAnnouncementsId
The value component of the RDN.

  class BasicAnnouncements  

 

class CapacityKey

ManagedElement
+-SystemFunctions
+-Lm
+-CapacityKey

Key of a licensed capacity that is available for the Managed Element.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
capacityKeyId
The value component of the RDN.
string
readOnly
capacityUnit
The licensed capacity measuring unit.
DateTime[0..1]
readOnly
expiration
The key expiry date and time.

For perpetual keys, the value is NULL.
int32
readOnly
grantedCapacityLevel
The capacity level currently granted by the License Manager.

The attribute value is based on requests and releases of capacity units made by License Users. If such requests and releases are not made by License Users, the value of the attribute defaults to the licensed capacity limit. Note: The value of the attribute is not based on Performance Management data.
string[0..1]
readOnly
keyId
Identity of the feature under license control.

E.g., CXC4011234, FAT1021234
LmCapacityValue
readOnly
licensedCapacityLimit
Licensed capacity limit as defined in the installed key file.

For LM deployments that connect to Arwa, the licensed capacity limit is defined in the Arwa License Server.

For LM deployments that connect to NeLS, the licensed capacity limit is the capacity limit value granted by NeLS.
boolean
readOnly
licensedCapacityLimitReached
Indicates whether or not current capacity usage reaches the licensed capacity limit.

Note: This attribute is not applicable for LM deployments that connect to NeLS.
string
readOnly
name
The name of the feature represented by the key.
string[0..1]
readOnly
productType
Identifier of the type of product to which the capacity is related.

This attribute is used only in systems where the different applications use separate key files to identify which application or product the capacity belongs to, e.g. SASN, GSN_GGSN, SSR 8000.
boolean[0..1]
readOnly
shared = false
Indicates whether the key is shared among Managed Elements or dedicated to the Managed Element.

A key is dedicated to the Managed Element if the key can be used only by the Managed Element. This is always the case when the ELIM format is used. A key can be shared among multiple Managed Elements if it is installed on a License Server to which multiple Managed Elements connect.
DateTime
readOnly
validFrom
The date and time from which the key is valid.
string[0..1]
readOnly
version
Version of licensed feature.

  class CapacityKey  

 

class CertM

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-CertMCapabilities [1..1]
+-EnrollmentAuthority [0..]
+-EnrollmentServerGroup [0..]
+-NodeCredential [0..]
+-TrustCategory [0..]
+-TrustedCertificate [0..]

The top class of the Certificate Management model.

Certificate management encompasses management of node credentials and trusted certificates.


This MO is created by the system.

References to:
TrustedCertificate;
Actions
boolean
cancel ( );
Cancels an ongoing action on this MO.

Can be invoked during execution of an action.
boolean
installTrustedCertFromUri ( string uri , EcimPasswordString uriPassword , Fingerprint fingerprint );
Installs a trusted certificate from the specified Uniform Resource Identifier (URI).

The action can be invoked if no other action in progress on this MO.
The action returns immediately after invocation. The progress of the action can be tracked via the reportProgress attribute.

The action returns with TRUE after successful invocation, otherwise it returns with FALSE.

The generic URI syntax is defined by RFC 3986.
Example: sftp://myuser@myhostname.ericsson.local/dir/subdir/certificate
Example: http://myhostname.ericsson.local/dir/subdir/certificate

Parameters

Name: uri
Description: This parameter contains a URI assumed to point to the certificate file.

The generic URI syntax is defined by RFC 3986.
Example: sftp://myuser@myhostname.ericsson.local/dir/subdir/certificate
The URI must not contain any password. The password shall be provided in the second parameter of this action.
The URI may be local relative (e.g. data/dir/subdir/file), or local absolute (e.g. file:///data/dir/subdir/file), or remote (e.g. sftp://user@hostname/dir/subdir/file) or remote relative (e.g. sftp://user@hostname/~/cert.pem).
If the URI is local relative, the file is expected to be under the directory path indicated by the localFileStorePath attribute in the CertM MO.



Name: uriPassword
Description: The password section of the URI.

If a password is not required, the 'NULL' string must be provided.



Name: fingerprint
Description: The Secure Hash Algorithm (SHA) fingerprint of the certificate to be installed.

The fingerprint is checked against the fingerprint calculated on the installed file. If fingerprint verification is not required, the 'NULL' string has to be provided. The hash must be calculated by the SHA algorithm indicated in fingerprintSupport of the CertMCapabilities MO.


boolean
removeTrustedCert ( TrustedCertificate trustedCert );
Removes a trusted certificate.

Parameters

Name: trustedCert
Description: The DN of the TrustedCertificate MO to be removed.

Attributes
string
key
mandatory
noNotification
restricted
certMId
The value component of the RDN.
string[0..1]
readOnly
localFileStorePath
Contains a file sytem path for locally stored certificates.

The default directory path on the ME file system where certificates or credential containers are stored. It may store locally generated files or files generated after push download.
AsyncActionProgress[0..1]
readOnly
reportProgress
Reports the progress of the ongoing action on this MO.
string[0..1]
userLabel
An additional descriptive text.

  class CertM  

 

class CertMCapabilities

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-CertMCapabilities

Contains the certificate management capabilities of the ME.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
certMCapabilitiesId
The value component of the RDN.
EnrollmentSupport[1..] nonUnique
noNotification
readOnly
enrollmentSupport
Indicates the enrollment methods supported by the ME.
FingerprintSupport[0..1]
noNotification
readOnly
fingerprintSupport
The secure hash algorithm the ME supports for fingerprint calculation.

The attributes and parameters in the CertM model taking a fingerprint must be provided by calculating the fingerprint using the indicated algorithm.

  class CertMCapabilities  

 

class CliSsh

ManagedElement
+-SystemFunctions
+-SysM
+-CliSsh

Represents the CLI configuration management service over Secure Shell.

This MO is created by the system.

Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the CLI target.
When LOCKED all on-going CLI connections will immediately be terminated.

NOTE: Setting the administrativState to LOCKED for all Netconf and CLI interfaces disables O&M access to the ME. Refer to product specific troubleshooting instructions to resolve such a scenario.
string
key
mandatory
noNotification
restricted
cliSshId
The value component of the RDN.

  class CliSsh  

 

class CliTls

ManagedElement
+-SystemFunctions
+-SysM
+-CliTls

Represents the CLI configuration management service over Transport Layer Security (TLS).

This MO is created by the system.

References to:
ManagedObject;
Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the CLI target.
When LOCKED all on-going cli connections will immediately be terminated.

NOTE: Setting the administrativState to LOCKED for all Netconf and CLI interfaces disables O&M access to the ME. Refer to product specific troubleshooting instructions to resolve such a scenario.
string
key
mandatory
noNotification
restricted
cliTlsId
The value component of the RDN.
ManagedObject[0..1]
nodeCredential
The credential used for the CLI service.
Specifies the DN of a NodeCredential MO in Certificate Management.
ManagedObject[0..1]
trustCategory
The set of certificates trusted by the CLI service.
Specifies the DN of a TrustCategory MO in Certificate Management.

  class CliTls  

 

class ComputeResource

ManagedElement
+-Equipment
+-ComputeResource

Represents a compute resource (virtual or physical) that is allocated to the managed element.
This resource can be a piece of hardware or a VM provided by a virtualization infrastructure management system.



This MO is created by the system.

References from:
MrfInstance;
Attributes
string
key
mandatory
noNotification
restricted
computeResourceId
The value part of the RDN.
string[1..]
noNotification
readOnly
macAddress
The MAC address(es) of the resource.
string[0..1]
noNotification
readOnly
uuid
Universally unique identifier of the resource.

  class ComputeResource  

 

class CustomRole

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthorizationMethod
+-CustomRole

Authorization roles defined by the MS that may be assigned to users.

CustomRole MO instances are associated to CustomRule MO instances, which define the access controls to objects.

References from:
CustomRule;
References to:
CustomRule;
Attributes
string
key
mandatory
noNotification
restricted
customRoleId
The value component of the RDN.
string
mandatory
restricted
roleName
The role name a user may have.

The name must match a role name retrieved from the user information store.
CustomRule[1..] nonUnique
mandatory
rules
The rules of the role created by the MS.

Contains the Distinguished Names of CustomRule MO instances.
string[0..1]
userLabel
An additional descriptive text.

  class CustomRole  

 

class CustomRule

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthorizationMethod
+-CustomRule

The rules created by the MS that define the access control to objects.

The CustomRule MO instances are associated with CustomRole MO instances, which may be then applied to users.

References from:
CustomRole;
References to:
CustomRole;
Attributes
string
key
mandatory
noNotification
restricted
customRuleId
The value component of the RDN.
PermissionType
mandatory
permission
Permission is the access right the rule provides on a target specified by the ruleData attribute.
CustomRole[0..] nonUnique
noNotification
readOnly
reservedByRoles
The roles to which this rule is associated.

Indicates the Distinguished Names of CustomRole MO instances that refer to this CustomRule MO.
RuleDataType
mandatory
ruleData
Defines the model elements for which the permission is applicable.
string[0..1]
ruleName
The rule name.
string[0..1]
userLabel
An additional descriptive text.

  class CustomRule  

 

class DtmfReceiverService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-DtmfReceiverService

This MO represents the Dual-tone multifrequency (DTMF) receiver service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
DtmfReceiverService=1


This MO is created by the system.

Attributes
DtmfDetectionMode
detectionMode = PAUSE_BEFORE_OR_AFTER_PULSE
Defines the selection of the tone detection mode.
string
key
mandatory
noNotification
restricted
dtmfReceiverServiceId
The value component of the RDN.
boolean
extendedAudioToneDetection = false
Sets the behaviour for extended audio tone detection.
Specifies whether detection of overdriven audio DTMF tones, not matching the standards due to too high distortion in the high frequency range, is enabled or not.
int32
powerThreshold = -22 { -29..-22 }
The power threshold for the Dual-tone multifrequency (DTMF) receiver devices.

Unit: 1 dBm0

  class DtmfReceiverService  

 

class DtmfSenderService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-DtmfSenderService

This MO represents the Dual-tone multifrequency (DTMF) sender service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
DtmfSenderService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
dtmfSenderServiceId
The value component of the RDN.
DtmfSenderHighFreqency
readOnly
freqHighA
First highfrequency value.

For allowed settable frequencies, see enumeration for DtmfSenderHighFreqency.

Unit: 1 Hz
DtmfSenderHighFreqency
readOnly
freqHighB
Second highfrequency value.

For allowed settable frequencies, see enumeration for DtmfSenderHighFreqency.

Unit: 1 Hz
DtmfSenderHighFreqency
readOnly
freqHighC
Third highfrequency value.

For allowed settable frequencies, see enumeration for DtmfSenderHighFreqency.

Unit: 1 Hz
DtmfSenderHighFreqency
readOnly
freqHighD
Fourth highfrequency value.

For allowed settable frequencies, see enumeration for DtmfSenderHighFreqency.

Unit: 1 Hz
DtmfSenderLowFrequency
readOnly
freqLowA
First low frequency value.

For allowed settable frequencies, see enumeration for DtmfSenderLowFreqency.

Unit: 1 Hz
DtmfSenderLowFrequency
readOnly
freqLowB
Second low frequency value.

For allowed settable frequencies, see enumeration for DtmfSenderLowFreqency.

Unit: 1 Hz
DtmfSenderLowFrequency
readOnly
freqLowC
Third low frequency value.

For allowed settable frequencies, see enumeration for DtmfSenderLowFreqency.

Unit: 1 Hz
DtmfSenderLowFrequency
readOnly
freqLowD
Fourth low frequency value.

For allowed settable frequencies, see enumeration for DtmfSenderLowFreqency.

Unit: 1 Hz
int32
highFreqLevel = -9 { -40..0 }
Tone level for high frequencies.

Unit: 1 dBm
int32
lowFreqLevel = -11 { -40..0 }
Tone level for low frequencies.

Unit: 1 dBm
int32
maxDuration = 1500 { 40..60000, 327675 }
The maximum tone segment time.

Note that the value 327675 equals to infinite tone.

Unit: 1 ms
Dependencies: minDuration <= maxDuration and minInterworkingDuration <= maxDuration
int32
minDigitPause = 70 { 40..60000 }
The tone pause time. Unit: 1 ms.
int32
minDuration = 70 { 40..60000 }
The minimum tone segment time.

Unit: 1 ms
Dependencies: minDuration <= maxDuration

  class DtmfSenderService  

 

class EmergencyUnlock

ManagedElement
+-SystemFunctions
+-Lm
+-EmergencyUnlock

Emergency Unlock state information.

This MO is created by the system.

Actions
boolean
activate ( );
Initiates activation of the Emergency Unlock operational mode.

Return value is true if the activation succeeded, otherwise false.
boolean
deactivate ( );
Initiates the deactivation of the Emergency Unlock operational mode.

Return value is true in case the deactivation succeeded, false otherwise.

Attributes
uint8
readOnly
activationsLeft
Remaining allowed Emergency Unlock activations left.
LmActivationState
readOnly
activationState
Activation state of Emergency Unlock.
string
key
mandatory
noNotification
restricted
emergencyUnlockId
The value component of the RDN.
DateTime[0..1]
readOnly
expiration
Expiry date and time of Emergency Unlock.

The value is NULL if the activation state is INACTIVE.

  class EmergencyUnlock  

 

class EnrollmentAuthority

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-EnrollmentAuthority

Represents a Certification or Registration Authority for certificate enrollment.

References from:
EnrollmentServer; NodeCredential;
References to:
TrustedCertificate;
Attributes
AuthorityType[0..1]
authorityType
Indicates the type of the enrollment authority.

Used for the verification of the Public Key Infrastructure (PKI) response message. In case of a Certification Authority (CA), the self-signed certificate of the CA is accepted by ME given that the certificate is configured either in attribute enrollmentCaCertificate or enrollmentCaFingerprint. In case of a Registration Authority (RA), the RA certificate is verified using the CA certificate of the RA configured in attribute enrollmentCaCertificate.

This entity is deprecated as implemented redundant functionality.


Deprecated: Deprecated in version 2.0. Redundant functionality.

string
key
mandatory
noNotification
restricted
enrollmentAuthorityId
The value component of the RDN.
DistinguishedName[0..1]
enrollmentAuthorityName
Specifies the name of the issuing CA.

The X.501 distinguished name of the issuing CA used for addressing and reference identity.
TrustedCertificate[0..1]
enrollmentCaCertificate
The trusted cerificate of the RA or CA used for enrollment authentication.

Represents the certificate by the DN of the appropriate TrustedCertificate MO.

The RA or CA certificate provided in the PKI response is authenticated by this trusted certificate.
string[0..1]
userLabel
An additional descriptive text.

  class EnrollmentAuthority  

 

class EnrollmentServer

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-EnrollmentServerGroup
+-EnrollmentServer

Represents an enrollment server.

An enrollment server implements Simple Certificate Enrollment Protocol (SCEP) or the Certificate Management Protocol (CMP).

References to:
EnrollmentAuthority;
Attributes
EnrollmentAuthority[0..1]
enrollmentAuthority
The Certification Authority or Registration Authority used by this enrollment server.

Represents the enrollment authority by the DN of the EnrollmentAuthority MO.

This entity is deprecated. If this attribute is specified, the enrollmentAuthority attribute in the NodeCredential MO referring to the EnrollmentServerGroup MO of this EnrollmentServer MO is ignored.


Deprecated: Deprecated in version 2.0. Function replaced by enrollmentAuthority attribute in NodeCredential MOC.

string
key
mandatory
noNotification
restricted
enrollmentServerId
The value component of the RDN.
EnrollmentProtocol
mandatory
protocol
The enrollment protocol.
string
mandatory
uri
The URI of the enrollment server.

The URI consists of a protocol, an IP or DNS address and an optional port number. Specify the optional port designation by appending a colon followed by the port number to the host part, for example, 192.168.33.27:8080. If no port number is provided, the default port is used.

Example for CMP: http://192.168.33.27:8080 or cmp://192.168.33.27
string[0..1]
userLabel
An additional descriptive text.

  class EnrollmentServer  

 

class EnrollmentServerGroup

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-EnrollmentServerGroup
+-EnrollmentServer [0..]

Maintains a group of enrollment servers for load balancing.

References from:
NodeCredential;
Attributes
string
key
mandatory
noNotification
restricted
enrollmentServerGroupId
The value component of the RDN.
string[0..1]
userLabel
An additional descriptive text.

  class EnrollmentServerGroup  

 

class Equipment

ManagedElement
+-Equipment
+-ComputeResource [0..]

This is the Equipment MO.

Attributes
string
key
mandatory
noNotification
restricted
equipmentId
Unique identifier for this object instance.
string[0..1]
userLabel
User friendly name for equipment object.

  class Equipment  

 

class EricssonFilter

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LdapAuthenticationMethod
+-Ldap
+-EricssonFilter

Provides configuration of features supported by the Ericsson LDAP schema.

This class must be used when profileFilter in Ldap MO is set to ERICSSON_FILTER.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
ericssonFilterId
The value component of the RDN.
LdapDistinguishedName[0..1]
roleAliasesBaseDn
LDAP DN to a subtree of objects that is used to convert alias roles to roles the ME understands.

An option for authorization methods that implements Role Based Access Control.

The value is an LDAP DN. The format of the DN for such an object is 'role=[role], roleAliasesBaseDn', where [role] must be replaced with the name of a role alias or role group. All these objects must be accessible from the base DN defined in this attribute. For example: if roleAliasesBaseDn = "dc=example,dc=com" and the user has role Admin, and the object "role=Admin,dc=example,dc=com" exists and has attribute ericssonUserAuthorizationScope = Administrator, the user receives the Administrator role.
BasicAdmState
targetBasedAccessControl = LOCKED
Toggles Target Based Access Control.

The User Management MO provides the <Target Type> strings of the ME. The TBAC authorization behavior is defined in the User Management MOC.

The optional Ericsson LDAP-schema-specified attribute ericssonUserAuthenticationScope stores the targets where the user can be authenticated and authorized. It is a case-insensitive string of <Target Type>. The Ericsson target-type identifier, such as ‘bsc’, ‘cscf’, classifies the target type the user can access.

The optional Ericsson LDAP-schema-specified attribute ericssonUserAuthorizationScope stores the authorization profiles of which the user is a member. It is a case-insensitive string of form <Target Type>:<Authorization Profile>, where ':' is a separator; <Target Type> is the Ericsson target-type identifier, such as ‘bsc’, ‘cscf’, and it classifies the target type for which the user acquires the <Authorization Profile>. <Authorization Profile> is the Ericsson application-defined profile, for example, a role.

Attribute ericssonUserAuthenticationScope behavior:

When TBAC is LOCKED in the ME, authentication and authorization are performed without TBAC.
When TBAC is UNLOCKED in the ME and the user has a target-restricted authentication scope, authentication and authorization are performed when a match is found. If not, it fails.

Attribute ericssonUserAuthenticationScope allows the use of wild-carded scope ('*') to permit the user to be authorized on any ME based on its ericssonUserAuthorizationScope attribute.

Attribute ericssonUserAuthorizationScope behavior:

When TBAC is LOCKED in the ME, the authorization profiles without target qualifiers and with wildcard target qualifier ('*') are assigned to the user from the user database. When TBAC is UNLOCKED in the ME, the authorization profiles with matching target qualifiers and with wildcard target qualifier are assigned to the user from the user database. In addition, role aliases are accepted also without a target qualifier.

Not using the Ericsson LDAP schema in the user accounts, or improper use of this schema causes authorization failure.

For more details, refer to the Ericsson LDAP Interface Description.

Example with roles:
If the ME in User Management MOC is configured with 'cscf.ims.stockholm' and the LDAP user account contains:

ericssonUserAuthenticationScope: cscf.ims.stockholm
ericssonUserAuthenticationScope: cscf.ims.malmo
ericssonUserAuthorizationScope: cscf.ims.stockholm:SystemAdministrator
ericssonUserAuthorizationScope: cscf.ims.malmo:SystemSecurityAdministrator
ericssonUserAuthorizationScope: *:ApplicationOperator

Then given the LDAP user provided a correct password it is authenticated on the ME and assigned with role 'SystemAdministrator' and 'ApplicationOperator'.
EricssonFilterVersion
version = 2
The selected version of the Ericsson filtering behavior.

Version 1 is deprecated. Version 1 allows wildcarding of roles without any qualifier and it supports the use of '*' character. Such syntax applies the given role on all targets:

ericssonUserAuthorizationScope: ApplicationOperator
ericssonUserAuthorizationScope: *:ApplicationOperator

Version 2 differentiates the wildcarding behavior depending on the value of attribute targetBasedAccessControl. When targetBasedAccessControl is LOCKED, both syntaxes are allowed and assigns the role to the user in the ME. When targetBasedAccessControl is UNLOCKED, it only allows the use of '*' character, but unqualified roles are ignored.

  class EricssonFilter  

 

class EvsConfData

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-EvsService
+-EvsConfData

This MO models the EVS configuration data in the node.

The Relative Distinguished Name (RDN) for this MO type is:
EvsConfData=1

References from:
MrfData;
Attributes
string
key
mandatory
noNotification
restricted
evsConfDataId
The value component of the RDN.
SupportedEvsPrimaryBitrate[0..1]
supportedBitRatesRangeBegin = EVS_BITRATE_5_9
Specifies the beginning of the supported bit rate range of EVS audio codec.

Dependencies: EVS_BITRATE_5_9 <= supportedBitRatesRangeBegin <= supportedBitRatesRangeEnd <= EVS_BITRATE_128,
If supportedBwRange = EVS_BANDWIDTH_SWB, then supportedBitRatesRangeBegin >= EVS_BITRATE_9_6,
If supportedBwRange = EVS_BANDWIDTH_FB, then supportedBitRatesRangeBegin >= EVS_BITRATE_16_4
SupportedEvsPrimaryBitrate[0..1]
supportedBitRatesRangeEnd = EVS_BITRATE_128
Specifies the end of the supported bit rate range of EVS audio codec.

Dependencies: EVS_BITRATE_5_9 <= supportedBitRatesRangeBegin <= supportedBitRatesRangeEnd <= EVS_BITRATE_128,
If supportedBwRange = EVS_BANDWIDTH_NB, then supportedBitRatesRangeEnd <= EVS_BITRATE_24_4
SupportedEvsBandwidth[0..1]
supportedBwRange = EVS_BANDWIDTH_RANGE_NB_FB
Specifies the supported audio bandwidth range of EVS audio codec.

Dependencies:
If supportedBitRatesRangeBegin < EVS_BITRATE_9_6, then supportedBwRange != EVS_BANDWIDTH_SWB,
If supportedBitRatesRangeBegin < EVS_BITRATE_16_4, then supportedBwRange != EVS_BANDWIDTH_FB,
If supportedBitRatesRangeEnd > EVS_BITRATE_24_4, then supportedBwRange != EVS_BANDWIDTH_NB

  class EvsConfData  

 

class EvsService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-EvsService
+-EvsConfData [0..]

This MO models the EVS Service.

The Relative Distinguished Name (RDN) for this MO type is:
EvsService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
evsServiceId
The value component of the RDN.

  class EvsService  

 

class FeatureKey

ManagedElement
+-SystemFunctions
+-Lm
+-FeatureKey

Key of a licensed feature that is available for the Managed Element.

This MO is created by the system.

Attributes
DateTime[0..1]
readOnly
expiration
The key expiry date and time.

For perpetual keys, the value is NULL.
string
key
mandatory
noNotification
restricted
featureKeyId
The value component of the RDN.
boolean
readOnly
granted
Indicates whether or not the licensed feature has been granted by the License Manager.
string[0..1]
readOnly
keyId
Identity of the feature under license control.

E.g., CXC4011234, FAT1021234
string
readOnly
name
The name of the feature represented by the key.
string[0..1]
readOnly
productType
Identifier of the type of product to which the capacity is related.

This attribute is used only in systems where the different applications use separate key files to identify which application or product the capacity belongs to, e.g. SASN, GSN_GGSN, SSR 8000.
boolean[0..1]
readOnly
shared = false
Indicates whether the key is shared among Managed Elements or dedicated to the Managed Element.

A key is dedicated to the Managed Element if the key can be used only by the Managed Element. This is always the case when the ELIM format is used. A key can be shared among multiple Managed Elements if it is installed on a License Server to which multiple Managed Elements connect.
DateTime
readOnly
validFrom
The date and time from which the key is valid.
string[0..1]
readOnly
version
Version of licensed feature.

  class FeatureKey  

 

class FileGroup

ManagedElement
+-SystemFunctions
+-FileM
+-LogicalFs
+-FileGroup
+-FileGroup [0..]
+-FileInformation [0..]
..
+-FileGroup
+-FileGroup
+-FileGroup [0..]
+-FileInformation [0..]

A set of files that are logically related and possible to manage by a common policy.
To allow a tree-structured hierarchical representation of groups of files, the FileGroup class has an association to itself. Over the northbound interface of the managed element, the instances of classes LogicalFs and FileGroup represent a file system.

References from:
FileGroupPolicy;
References to:
ManagedObject;
Actions
boolean
removeFile ( string file );
Removes a named file from this file group.
The file name can contain a regular expression and thus a set of files in the file group that match the expression can be removed. The regular expression is interpreted according to POSIX pattern definition used for file name expansion. Action removeFile() returns True when the files are removed, otherwise False.

Parameters

Name: file
Description: This parameter specifies the file in the FileGroup to be removed.
The file string is interpreted as a regular expression and all files that match the expression are removed.


Attributes
string
key
mandatory
noNotification
restricted
fileGroupId
Value component of the RDN.
FileInfo[0..]
readOnly
files
Container with information about the files under this file group.
boolean
noNotification
readOnly
internalHousekeeping
If true, the files in this file group are maintained by the system.
User-defined housekeeping policies associated with this file group are excluded.
ManagedObject[0..1]
noNotification
readOnly
reservedByPolicy
Indicates the DN of the FileGroupPolicy MO and sets the file group housekeeping policy.

  class FileGroup  

 

class FileGroupPolicy

ManagedElement
+-SystemFunctions
+-FileM
+-FileGroupPolicy
+-ThresholdMonitoring [0..8]

FileGroupPolicy defines housekeeping rules for file groups.
FileGroups already maintained by the system, as indicated by internalHousekeeping, are excluded from FileM housekeeping.

References to:
FileGroup;
Attributes
FileGroup[0..] nonUnique
fileGroup
A reference to one or more file groups to which the defined housekeeping policy applies.
string
key
mandatory
noNotification
restricted
fileGroupPolicyId
Value component of the RDN.
FullAction[0..1]
fullFileGroupAction = DISCARD_OLDEST
Defines the action taken by the housekeeping logic when a limit is reached.
Two limits can be defined by attributes maxFileGroupSize or maxNumberFiles.
No limits are considered on maxFileGroupSize or maxNumberFiles if the action to take is unset.
Possible values are:
-DISCARD_NEWEST: The system does not allow a new file to be stored if that causes the limit to be exceeded.
-DISCARD_OLDEST: If the limit is exceeded by storing a new file, the oldest files in the group are deleted before storing the new file.
int32
maxFileGroupSize = 0
Defines the maximum size of each tree of file groups related to this FileGroupPolicy.
0 indicates that no limit is set. The unit is kilobyte.
If the tree of file groups referenced by this policy includes a tree of file groups with its own policy, these file groups are excluded when the number of files for this policy are calculated.
int32
maxNumberFiles = 0
Defines the maximum number of files of each tree of file groups related to this FileGroupPolicy.
0 indicates that no limit is set.
If the tree of file groups referenced by this policy includes a tree of file groups with its own policy, these file groups are excluded when the number of files for this policy are calculated.
int32
retentionTime = 0
Indicates for how long the files in this group are kept before being automatically deleted.
The unit is minutes.
0 indicates that the files are kept for ever.
string[0..1]
userLabel
Label for free use.

  class FileGroupPolicy  

 

class FileInformation

..
+-FileGroup
+-FileInformation

An instance of FileInformation represents a file.


This MO is created by the system.

Deprecated: 

Attributes
string
key
mandatory
noNotification
restricted
fileInformationId
Value component of the RDN.

Deprecated: 

DateTimeWithoutOffset[0..1]
noNotification
readOnly
modificationTime
Date and time of latest modification.

Deprecated: 

int64[0..1]
noNotification
readOnly
size
The size of the file in kilobyte.

Deprecated: 

string[0..1]
noNotification
readOnly
type
The type of the file.
The type specifies how the content of the file is structured and shall follow common practice. For example, "xml" indicates that the content of the file is structured according to the eXtensible Markup Language.


Deprecated: 

  class FileInformation  

 

class FileM

ManagedElement
+-SystemFunctions
+-FileM
+-FileGroupPolicy [0..]
+-LogicalFs [1..1]

The top class of the the FileM model.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
fileMId
Value component of the RDN.
string[0..1]
userLabel
Label for free use.

  class FileM  

 

class FileMConfigData

ManagedElement
+-SystemFunctions
+-FileM
+-LogicalFs
+-FileMConfigData

Hidden MOC for fileM configuration

This MO is created by the system.

Filter: filemData

Attributes
string
key
mandatory
noNotification
restricted
fileMConfigDataId
The value component of the RDN.

Filter: filemData
string
noNotification
readOnly
internalRoot
Internal root for File Management

Filter: filemData

  class FileMConfigData  

 

class Filter

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LdapAuthenticationMethod
+-Ldap
+-Filter

Indicates the filter used to locate the user's authorization profile in the LDAP directory.

This class must be used when profileFilter in Ldap MO is set to FLEXIBLE.

Example of use with POSIX group objects as authorization profile:

The user authorization profile is mapped to posixGroups in the LDAP schema. Each posixGroup contains a set of users and by this association, users are mapped into one or more groups. To identify the set of groups a user is a member of, the following search filter must be used:

(&(objectClass=posixGroup)(memberUid=%u)) cn

where %u is the user ID parameter used during authentication and cn is the common name value returned for the posixGroup. This must match an authorization entity, for example role, in an authorization method. (&(objectClass=posixGroup)(memberUid="")) is the search filter contained by the filter attribute.


This MO is created by the system.

Attributes
string[0..1]
filter
The filter used to search in the LDAP tree.

Example: (&(objectClass=posixGroup)(memberUid="")),

This specifies a filter, where the authorized users are members of posixGroup objects in the LDAP schema. Double quotes indicate where the ME inserts the user identifier.
string
key
mandatory
noNotification
restricted
filterId
The value component of the RDN.
string[0..1]
type
Determines which attribute to retrieve from an element in the database.

The value can be the name of any parameter in the LDAP schema, for example, 'cn'.
string[0..1]
userLabel
An additional descriptive text.

  class Filter  

 

class Fm

ManagedElement
+-SystemFunctions
+-Fm
+-FmAlarm [0..]
+-FmAlarmModel [0..]

The root MOC of the Fault Management branch.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
fmId
Holds the name used when identifying the MO.
uint32[0..1]
heartbeatInterval = 60
The interval in seconds, with which a heartbeat notification is sent to all alarm consumers.
DateTime[0..1]
noNotification
readOnly
lastChanged
The timestamp of when any alarm was last changed.
With this attribute, an external system can determine if a resynchronization operation is needed, such as following a loss and restore of a communications link.
uint64[0..1]
noNotification
readOnly
lastSequenceNo
The last used sequence number for an alarm state change notification.
The sequence numbers are consecutive. With this attribute, an external system can determine if a resynchronization operation is needed, such as following a loss and restore of a communications link.
uint32[0..1]
noNotification
readOnly
sumCritical
Shows the number of active alarms with perceived severity 'critical'.
uint32[0..1]
noNotification
readOnly
sumMajor
Shows the number of active alarms with perceived severity ‘major’.
uint32[0..1]
noNotification
readOnly
sumMinor
Shows the number of active alarms with perceived severity ‘minor’.
uint32[0..1]
noNotification
readOnly
sumWarning
Shows the number of active alarms with perceived severity ‘warning’.
uint32[0..1]
noNotification
readOnly
totalActive
Shows the total number of currently active alarms.
This corresponds to the the total number of instantiated FmAlarm objects.

  class Fm  

 

class FmAlarm

ManagedElement
+-SystemFunctions
+-Fm
+-FmAlarm

An FmAlarm instance represents an active alarm.
An alarm is a persistent indication of a fault that clears only when the triggering condition has been resolved.


This MO is created by the system.

Attributes
SeverityLevel[0..1]
noNotification
readOnly
activeSeverity
The perceived severity of the alarm.
It may change during the alarm's lifetime.


Specification: RFC3877
AdditionalInformation[0..]
noNotification
readOnly
additionalInfo
Further information about the problem.
The information is represented as a set of data structures with two items of information, an identifier and a value. It may change during the alarm's lifetime.
string[0..1]
noNotification
readOnly
additionalText
Extra information about the alarm.
It may change during the alarm's lifetime.
EventType[0..1]
noNotification
readOnly
eventType
General category for the alarm.

Specification: ITU-T X.733 X.736
string
key
mandatory
noNotification
restricted
fmAlarmId
Holds the name used when identifying the MO.
DateTime[0..1]
noNotification
readOnly
lastEventTime
The timestamp of when the alarm was last updated.
This is set at alarm information change or severity change.
uint32[0..1]
noNotification
readOnly
majorType
The attributes majorType and minorType are the two key attributes used to identify the alarm type.
uint32[0..1]
noNotification
readOnly
minorType
The attributes majorType and minorType are the two key attributes used to identify the alarm type.
string[0..1]
noNotification
readOnly
originalAdditionalText
The additional text set when the alarm was raised.
This attribute is set when the alarm is raised and will not change during the alarm's lifetime.
DateTime[0..1]
noNotification
readOnly
originalEventTime
The timestamp when the alarm was raised.
This attribute is set when the alarm is raised and will not change during the alarm's lifetime.
SeverityLevel[0..1]
noNotification
readOnly
originalSeverity
The perceived severity set when the alarm was raised.
It will not change during the alarm's lifetime.


Specification: RFC3877
ProbableCause[0..1]
noNotification
readOnly
probableCause
Qualifies and provides further information on the reason for the event.
A standard set of probableCause values is provided in the ERICSSON-ALARM-PC-MIB.
int64[0..1]
noNotification
readOnly
sequenceNumber
A unique identity for every notification sent.
This identity changes at every notification, that is, severity change and information change. It is not the same as the fmAlarmId as multiple notifications may be sent for one alarm instance.
string[0..1]
noNotification
readOnly
source
The distinguished name of the alarming object.
string[0..1]
noNotification
readOnly
specificProblem
Provides further refinement to the information given by probableCause.
Can be used to find an associated operating instruction (OPI).

  class FmAlarm  

 

class FmAlarmModel

ManagedElement
+-SystemFunctions
+-Fm
+-FmAlarmModel
+-FmAlarmType [0..]

This is a container for grouping FM alarm types.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
fmAlarmModelId
Holds the name used when identifying the MO.

  class FmAlarmModel  

 

class FmAlarmType

ManagedElement
+-SystemFunctions
+-Fm
+-FmAlarmModel
+-FmAlarmType

A specific kind of alarm that can be reported, for example "power failure".
In an X.733 context it maps to event type, probable cause, and specific problem. The same principle is used for alert types as for alarm types.


This MO is created by the system.

References from:
MeasurementType;
Attributes
string[0..1]
noNotification
readOnly
additionalText
Extra information that would not be contained by other FmAlarmType attributes.
SeverityLevel[0..1]
configuredSeverity
Gives the possibility to configure the perceived severity for all alarms of this type.
If set, this value overrides the perceived severity provided by the alarming object. Setting this attribute has no impact on existing alarms, only new and updated ones.


Specification: RFC3877
SeverityLevel[0..1]
noNotification
readOnly
defaultSeverity
The default perceived severity for all alarms of this type.
Not set means alarms of this type can be assigned different severities.


Specification: RFC3877
EventType[0..1]
noNotification
readOnly
eventType
General category for the alarm type.


Specification: ITU-T X.733, X.736
string
key
mandatory
noNotification
restricted
fmAlarmTypeId
Holds the name used when identifying the MO.
boolean[0..1]
noNotification
readOnly
isStateful
True indicates alarm. False indicates alert (stateless alarm).
uint32[0..1]
noNotification
readOnly
majorType
The attributes majorType and minorType are the two key attributes used to identify the alarm type.
uint32[0..1]
noNotification
readOnly
minorType
The attributes majorType and minorType are the two key attributes used to identify the alarm type.
string[0..1]
noNotification
readOnly
moClasses
A list of the Managed Object classes that can raise this alarm type.
This attribute contains a comma seperated list of Managed Object classes types that use this alarm type. It is for information only.


Deprecated: This attribute has no purpose and is not used by anyone.

ProbableCause[0..1]
noNotification
readOnly
probableCause
Qualifies and provides further information on the reason for the event.
A standard set of probableCause values is provided in the ERICSSON-ALARM-PC-MIB.


Specification: ITU-T M.3100, X.733, X.736; ETSI GSM 12.11.
string[0..1]
noNotification
readOnly
specificProblem
Provides further refinement to the information given by probableCause.
Can be used to find an associated operating instruction (OPI).

  class FmAlarmType  

 

class G722Service

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-G722Service

This MO models the G.722 Service.

The Relative Distinguished Name (RDN) for this MO type is:
G722Service=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
g722ServiceId
The value component of the RDN.

  class G722Service  

 

class G729Service

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-G729Service

This MO models the G.729 Service.

The Relative Distinguished Name (RDN) for this MO type is:
G729Service=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
g729ServiceId
The value component of the RDN.

  class G729Service  

 

class IntegrationUnlock

ManagedElement
+-SystemFunctions
+-Lm
+-IntegrationUnlock

Integration Unlock state information.

This MO is created by the system.

Attributes
uint8
readOnly
activationsLeft
Remaining allowed Integration Unlock activations left.
LmActivationState
readOnly
activationState
Activation state of Integration Unlock.
DateTime[0..1]
readOnly
expiration
Expiry date and time of Integration Unlock.

The value is NULL if the activation state is INACTIVE.
string
key
mandatory
noNotification
restricted
integrationUnlockId
The value component of the RDN.

  class IntegrationUnlock  

 

class JitterHandlingService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-JitterHandlingService

This MO represents the Adaptive Jitter Handling Service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
JitterHandlingService=1


This MO is created by the system.

Attributes
int32[0..1]
initialDeJitterBufferSize = 20 { 0..200 }
Defines the initial buffer size for jitter compensation used for connections.

The initial jitter buffer size must not exceed the maximum jitter buffer size.

Unit: 1 ms
Dependencies: maxDeJitterBufferSize >= initialDeJitterBufferSize
string
key
mandatory
noNotification
restricted
jitterHandlingServiceId
The value component of the RDN.
int32[0..1]
maxDeJitterBufferSize = 200 { 0..200 }
Defines the maximum buffer size for jitter compensation used for connections.

The maximum buffer size value must be equal to or greater than the initial buffer size for jitter compensation.

Unit: 1 ms
Dependencies: maxDeJitterBufferSize >= initialDeJitterBufferSize

  class JitterHandlingService  

 

class KeyFileInformation

ManagedElement
+-SystemFunctions
+-Lm
+-KeyFileManagement
+-KeyFileInformation

Basic information about the key file installed on the Managed Element.

This MO is not applicable to LM deployments that connect to Arwa.


This MO is created by the system.

Attributes
DateTime
readOnly
installationTime
Date and time when key file was installed on the Managed Element.
string
key
mandatory
noNotification
restricted
keyFileInformationId
The value component of the RDN.
boolean
readOnly
locatable
Indicates whether or not the key file can currently be located.
string[0..1]
readOnly
productType
Identifier of the type of product to which the capacity is related.

This attribute is used only in systems where the different applications use separate key files to identify which application or product the capacity belongs to, e.g. SASN, GSN_GGSN, SSR 8000.
int32
readOnly
sequenceNumber = 0
Sequence number of the key file.

If sequence number is not available this value is 0.

  class KeyFileInformation  

 

class KeyFileManagement

ManagedElement
+-SystemFunctions
+-Lm
+-KeyFileManagement
+-KeyFileInformation [0..]

Enables installation of key files and provides information about the installed key file.

This MO is not applicable to LM deployments that connect to Arwa.

This MO is not applicable to LM deployments that connect to NeLS.


This MO is created by the system.

Actions
boolean
installKeyFile ( string uri , EcimPasswordString password );
Initiates the key file installation defined by the URI given as a parameter.

The return value is the action Id if the initiation succeeded, otherwise it is 0.

The installation is an asynchronous operation. Progress is reported via attribute reportProgress.

Parameters

Name: uri
Description: The URI of the key file that is to be installed.

The URI may refer to a local (e.g., file://data/dir/subdir/rbs006.xml) or to a remote (e.g., sftp://myuser@myhostname.ericsson.local/dir/subdir/rbs006.xml) file.

If user name is needed to access the referenced file then the URI shall include the user name. The URI must not contain password.

The generic URI syntax is defined by RFC 3986.




Name: password
Description: Password to access the URI location. If password based authentication is not used, then this value is ignored.



Attributes
string
key
mandatory
noNotification
restricted
keyFileManagementId
The value component of the RDN.
AsyncActionProgress[0..1]
readOnly
reportProgress
Reference to the progress report including the result of the initiated key file installation.

  class KeyFileManagement  

 

class Ldap

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LdapAuthenticationMethod
+-Ldap
+-EricssonFilter [0..1]
+-Filter [0..1]

Contains the configurable information on primary and secondary LDAP directories.

This MO is created by the system.

References to:
ManagedObject;
Attributes
LdapDistinguishedName
mandatory
baseDn
Default base DN to use in LDAP operations.

The base DN must be specified in an LDAP DN format, for example, 'ou=people,dc=mycompany,dc=com'. All LDAP objects used for authentication and authorization must be accessible from the base DN.
LdapDistinguishedName[0..1]
bindDn
Default bind DN used to access the LDAP servers.

When configured, the ME uses the specified DN as the bind name for LDAP searches. The bind DN must be specified in an LDAP DN format, for example 'cn=bindaccount,dc=mycompany,dc=com'.
EcimPassword[0..1]
bindPassword
Password used with bindDn to access the LDAP servers.

When configured, the ME establishes a password-based LDAP simple bind.
IpDNSAddress[0..1]
fallbackLdapIpAddress
The IP or DNS address of the fallback LDAP server.

The fallback server is used when the primary server is inaccessible.

Default port number used is 389. The selected tlsMode overrides the default port number.
string
key
mandatory
noNotification
restricted
ldapId
The value component of the RDN.
IpDNSAddress
mandatory
ldapIpAddress
The IP or DNS address of the primary LDAP server.

Default port number used is 389. The selected tlsMode overrides the default port number.
ManagedObject[0..1]
nodeCredential
The credential used for LDAP.

Specifies the DN of a NodeCredential MO in Certificate Management.
ProfileFilter[0..1]
profileFilter
Selects an LDAP filter to determine the user's authorization profile.

Authorization profiles are used by authorization methods.

For ERICSSON_FILTER, the contained EricssonFilter MO must exist.
For FLEXIBLE, the contained Filter MO must exist.
uint16[0..1]
serverPort
Specifies the server port number to access the primary and secondary LDAP servers.

Must only be specified when the default port number is not in use.

Default ports are:
389, when useTls is false.
389, when useTls is true and tlsMode is STARTTLS.
636, when useTls is true and tlsMode is LDAPS.
TlsMode
tlsMode = STARTTLS
Toggles the TLS establishment mode to access the primary and secondary LDAP servers.

Takes effect when useTls is true.
ManagedObject[0..1]
trustCategory
The set of certificates trusted by LDAP.

Specifies the DN of a TrustCategory MO in Certificate Management.
boolean
useReferrals = false
Toggle to enable the use of referrals.

When set to false, the ME ignores referrals returned by the LDAP server.

When set to true, the ME follows referrals. Referrals can be used for authentication and authorization only if the referral URI refers back to a directory tree within the same LDAP server instance; otherwise, access is denied for referred user accounts.
string[0..1]
userLabel
An additional descriptive text.
boolean
mandatory
useTls
Toggle to enable TLS access to primary and secondary LDAP targets.

  class Ldap  

 

class LdapAuthenticationMethod

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LdapAuthenticationMethod
+-Ldap [1..1]

Root MOC of the LDAP Authentication Method.

LDAP-based authentication uses a directory to store a user's credentials and allows them to be queried over a secure LDAP interface.


This MO is created by the system.

Attributes
BasicAdmState
mandatory
administrativeState
The administrative state of this authorization method.
string
key
mandatory
noNotification
restricted
ldapAuthenticationMethodId
The value component of the RDN.
string[0..1]
userLabel
An additional descriptive text.

  class LdapAuthenticationMethod  

 

class Legacy

ManagedElement
+-Legacy

Introduced to support deprecated types

Filter: hidden

Attributes
AdmState[0..1]
readOnly
admState
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden
BasicAdmState[0..1]
readOnly
basicAdmState
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden
DateTime[0..1]
readOnly
dateTime
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden
IpDNSAddress[0..1]
readOnly
ipDNSAddress
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden
string
key
mandatory
noNotification
restricted
legacyId
The value component of the RDN.

Filter: hidden
OperState[0..1]
readOnly
operState
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden
SchemaFormat[0..1]
readOnly
schemaFormat
Legacy attribute deprecated in ECIM_Top and moved to ECIM_CommonLibrary.

Filter: hidden

  class Legacy  

 

class Lm

ManagedElement
+-SystemFunctions
+-Lm
+-ArwaConfiguration [0..1]
+-AutonomousMode [0..1]
+-CapacityKey [0..]
+-EmergencyUnlock [1..1]
+-FeatureKey [0..]
+-IntegrationUnlock [0..1]
+-KeyFileManagement [0..1]
+-NeLSConfiguration [0..1]

Supports activities and contains information related to license management.

This MO is created by the system.

Actions
boolean
publishLicenseInventory ( );
Publish the License Inventory.

Triggers the immediate publication of license information from the License Key File and usage information from the LmServer cache to the information model.

Return value is true if the publication is successful, false otherwise.

For LM deployments that connect to Arwa, the license information is retrieved from the Arwa License Server.
boolean
refreshLicenseInventory ( );
Initiates the synchronization of Managed Element's license inventory.

Return value is true if the synchronization succeeded, otherwise false.

This action is not applicable to LM deployments that connect to NeLS.

Attributes
LmPercentageType[0..1]
capacityAlarmHysteresis = 5
Specifies alarm hysteresis percentage for capacity licenses.

When a capacity reservation alarm is active, the reservation level has to drop below the alarm threshold by the hysteresis amount in order for the alarm to be cleared or downgraded.
LmPercentageType[0..1]
capacityAlarmThreshold = 80
The capacity reservation percentage level at which a minor alarm will be raised.
string
mandatory
fingerprint
The unique identification of the Managed Element.

Limited to 256 alphanumeric characters including hyphens (-) and underscores (_), no white spaces.

This attribute is not applicable to LM deployments that connect to Arwa.
boolean
readOnly
fingerprintUpdateable
Indicates whether or not the fingerprint of the Managed Element can be updated.

This attribute is not applicable to LM deployments that connect to Arwa.
DateTime
readOnly
lastInventoryChange
Date and time of the last change in the license inventory.

Change in the license inventory may occur when the key file is updated on the Managed Element or when license information is refreshed by synchronizing with license servers.

This attribute is not applicable to LM deployments that connect to Arwa.
DateTime
readOnly
lastLicenseInventoryRefresh
Date and time when License Manager last synchronized the license inventory of the Managed Element.
uint32[0..1]
licenseExpirationWarning = 7
License Expiration advance warning interval.

The number of days before expiration of a license at which LM raises a LmLicenseExpired alarm with severity=minor.
string
key
mandatory
noNotification
restricted
lmId
The value component of the RDN.
LmState
readOnly
lmState
The current operational state of the License Manager.
string[0..1]
readOnly
lockingCode
Locking code to be used by the supply organization to provide site-specific license key files.

This attribute is not applicable to LM deployments that connect to Arwa or LM deployments using ELIM.
string[0..]
referenceToLicenseServer
Reference to the primary license server used by the License Manager.

For instance, the reference can contain the IP address of the server or locate its configuration interface. The attribute value is NULL if the License Manager does not rely on any license server.

When the reference contains the IP address and port numbers of the servers, it is formatted as follows:
IPv4: <IP_Address>:<Port_Number>
IPv6: [<IP_Address>]:<Port_Number> (for future use)
uint32[0..1]
serverReconnectAttemptInterval = 30
License Server Reconnect Attempt Interval.

The interval, in seconds, between automatic reconnection attempts when LM has lost connection to all configured license servers.
uint32[0..1]
serverSynchronizationInterval = 30
License Server Synchronization Interval.

The interval, in minutes, at which LM automatically synchronizes license information with the license server.

This attribute is not applicable to LM deployments that connect to NeLS.

  class Lm  

 

class LocalAuthorizationMethod

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthorizationMethod
+-CustomRole [0..]
+-CustomRule [0..]
+-Role [0..]

The Root MOC of the Local Authorization method.

Roles and authorization rules are defined to build a Role Based Access Control (RBAC) model for controlling access to Managed Element resources such as Managed Objects, attributes, actions and CLI commands.


This MO is created by the system.

Attributes
BasicAdmState
mandatory
administrativeState
The administrative state of this authorization method.
string
key
mandatory
noNotification
restricted
localAuthorizationMethodId
The value component of the RDN.
string[0..1]
userLabel
An additional descriptive text.

  class LocalAuthorizationMethod  

 

class LogicalFs

ManagedElement
+-SystemFunctions
+-FileM
+-LogicalFs
+-FileGroup [0..]
+-FileMConfigData [1..1]

Represents the root of a file system where files exposed over the NBI are represented.
The included class FileGroup allows grouping of logically related files.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
logicalFsId
Value component of the RDN.
string[0..1]
userLabel
Label for free use.

  class LogicalFs  

 

class ManagedElement

ManagedElement
+-Equipment [1..1]
+-Legacy [0..1]
+-MediaResourceFunction [1..1]
+-SystemFunctions [1..1]
+-Transport [0..1]

The top-level class in the Common Information Model is Managed Element root Managed Object Class.
From this class, all model entities are contained. The Managed Object Class (MOC) has attributes that provide information on the Managed Element Identity, primary location and the products it contains.


This MO is created by the system.

Attributes
DifferenceFromUTC[0..1]
readOnly
dateTimeOffset
Deprecated. Difference between the value of the localDateTime attribute and UTC.

Deprecated: Deprecated at version 2.3. Functionality replaced by TimeM model.”

string[0..1]
dnPrefix
It provides naming context that allows the managed objects to be partitioned into logical domains.
A Distingushed Name (DN) is defined by 3GPP TS 32.300, which splits the DN into a DN Prefix and Local DN, for example DN format: dnPrefix=<DN Prefix>, localDn =<Local DN> Fault Management: dnPrefix does not impact Fault Management, since an NMS recognises a Managed Element by IP address Performance Management (PM): The dnPrefix is present in the PM Data file, Result Output Period (ROP) file, if the dnPrefix attribute is specified, that is, not an empty string. Example: DC=ericsson.se,g3SubNetwork=Sweden
Example: DC=ericsson.se,g3SubNetwork=Sweden
DateTimeWithoutOffset[0..1]
readOnly
localDateTime
Deprecated. This is the local date and time for the Managed Element.
The following format is used: YYYY-MM-DDThh:mm:ss

The meaning of each field is as follows:
YYYY = four digit year
MM = two digit month (01=January, etc.)
DD = two digit day of month (01 through 31)
T = time designator (shows start of time component)
hh = two digits of hour (00 through 23, AM/PM not allowed)
mm = two digits of minute (00 through 59)
ss = two digits of second (00 through 59, leap second not allowed)
The hyphen [-] and the colon [:] are used as separators within the date and time of day expressions, respectively.


Deprecated: Deprecated at version 2.3. Functionality replaced by TimeM model.”

Specification: ISO 8601:2004(E)
string
key
mandatory
noNotification
restricted
managedElementId
Holds the name used when identifying the MO.
string
readOnly
managedElementType
The type of product being managed.
For example the type could be RBS or CSCF.
string[0..1]
networkManagedElementId
Replaces the value component of the RDN in the COM Northbound Interface.
This attribute shall, if used, be set to a simple alphanumeric value. The value should be unique within the network namespace.
ProductIdentity[0..]
productIdentity
Contains product information for the Managed Element and its Managed Functions.
This attribute is deprecated.


Deprecated: 

string
readOnly
release
The release of the product type specified by the attribute managedElementType.
It commonly contains the Managed Element release, for example L12.0, 13A, R1A
string[0..1]
siteLocation
A freetext attribute describing the geographic location of a Managed Element.
string[0..1]
readOnly
timeZone
DEPRECATED. This is the timeZone in which the Managed Element resides.
The possible values for this attribute are defined in the public-domain zoneinfo or Olson database. Locations are identified by a string indicating the continent or ocean and then the name of the location, typically the largest city within the region. See http://www.iana.org/time-zones for more information. Example: Europe/Stockholm.


Deprecated: Deprecated at version 2.3. Functionality replaced by TimeM model.

string[0..1]
userLabel
A freetext string for additional information to assist Managed Element identification.

  class ManagedElement  

 

class ManagedObject

ManagedObject

The ManagedObject MO represents a generic MO type. It does not represent any real resource in the system and can therefore not be instanciated. It is used as a MO-reference that can refer to multiple MO types.

References from:
CliTls; FileGroup; Ldap; MrfData; NetconfTls; NodeCredential; PmMeasurementCapabilities; RoleUpgrade; Snmp; SwM; SwVersionMain; TrustCategory; UpgradePackage;
  class ManagedObject  

 

class MeasurementReader

ManagedElement
+-SystemFunctions
+-Pm
+-PmJob
+-MeasurementReader
+-PmThresholdMonitoring [0..4]

Represents the capability to read the value of the MeasurementType or group of MeasurementTypes.
There can be many Measurement Reader instances for each job (one for each MeasurementType or PmGroup).
For a Threshold Job, only a MeasurementType instance can be referenced by the Measurement Reader.

Attributes
string
key
mandatory
noNotification
restricted
measurementReaderId
Holds the name used when identifying the MO.
MeasurementReaderNameValue[0..]
noNotification
readOnly
measurementReaderNameValue
Contains the real-time measurement data.
Only used by a PM job of type REALTIMEJOB.
MeasurementSpecification
mandatory
measurementSpecification
This struct allows reference to either MeasurementType or PmGroup of MeasurementTypes to be defined.
MoFilter[0..] nonUnique
moInstances
Target MO instance or instances.
If not set, the job is applied to all MO instances relevant to the selected PmGroup or MeasurementType.
ThresholdDirection[0..1]
thresholdDirection
Specifies the threshold direction.
Used when the thresholdDirection in the MeasurementType instance is not set. If neither is set, the default value is used.
Only applicable when jobType = THRESHOLDJOB.
PerTimeInterval[0..1]
thresholdRateOfVariation = PER_SECOND
Time interval used for monitoring the Measurement Type against a threshold.
Specifies, for Threshold Monitoring of a Cumulative Counter Measurement Type, how to calculate the value of the Measurement Type used to compare against the threshold.
Only applicable when jobType = THRESHOLDJOB.

  class MeasurementReader  

 

class MeasurementType

ManagedElement
+-SystemFunctions
+-Pm
+-PmGroup
+-MeasurementType

Defines a Measurement Type on the Managed Element to be monitored and collected.
MeasurementType is unique within the PM Group.


This MO is created by the system.

References to:
FmAlarmType;
Attributes
Aggregation
noNotification
readOnly
aggregation
Describes how the PM service aggregates the measurement values for measurement instances.
CollectionMethod
noNotification
readOnly
collectionMethod
Contains the form in which this measurement data is obtained.
string
noNotification
readOnly
condition
Details the condition which causes the measurement result data to be updated.
int16[0..1]
noNotification
readOnly
derSampleRate
Specifies the sample rate for DER counters.
Defined as according to 3GPP 32.401.
Data related to a particular event is captured. Every nth event is registered, where n can be 1 or greater.
This attribute defines n.
Only applicable when collectionMethod = DER.
string
noNotification
readOnly
description
A comprehensible explanation of this measurement.
FmAlarmType[0..1]
noNotification
readOnly
fmAlarmType
FmAlarmType associated to Threshold Monitoring of this MeasurementType.
No value means that this MeasurementType is not available for selection for a PM Threshold Job.
int32[0..1]
noNotification
readOnly
initialValue
The initial value to which the Measurement Type is set at the beginning of a new granularity period.
Only applicable when resetAtGranPeriod = true. No value means it is reset to 0.
boolean[0..1]
readOnly
isCompressed
Indicates if the MeasurementType result is in compressed format.
For MeasurementTypes with multiplicity greater than 1, the result can be compressed by only reporting the non-zero values.
A detailed explanation of the format of the measurement result is given in the measurementResult attribute.
No value means that this MeasurementType is not compressed.
string
noNotification
readOnly
measurementName
The full name of the measurement type.
string[0..1]
noNotification
readOnly
measurementResult
Contains a description of expected result value or values.
For example, "a single integer value". See 3GPP 32.404.
MeasurementStatus
noNotification
readOnly
measurementStatus
Contains the status of the measurement.
If this is set to PRELIMINARY, the measurement is available and stepped in this version of the Managed Element, but is not yet approved.
If it is set to USED, the measurement is approved, available and stepped in this version of the Managed Element.
If it is set to OBSOLETE, the measurement is not available and not stepped in this version of the Managed Element.
If it is set to DEPRECATED, the measurement is available but is not stepped in this version of the Managed Element.
string
key
mandatory
noNotification
restricted
measurementTypeId
Holds the name used when identifying the MO.
int16
noNotification
readOnly
multiplicity
Where a counter is an array of values, this attribute represents the size of the array.
Where it produces a single value, this attribute is set to 1.
boolean
noNotification
readOnly
resetAtGranPeriod
Specifies whether the value is initialized at the beginning of each granularity period.
No value means that this MeasurementType is not initialized at the beginning of each granularity period.
uint16
noNotification
readOnly
size
Contains the size of the measurement in number of octets.
ThresholdDirection[0..1]
noNotification
readOnly
thresholdDirection
The threshold direction of a Measurement Type value which raises the Threshold Alarm severity.
The attribute is set if this MeasurementType shall only be monitored in one direction in a PM Threshold Job. If it can be monitored in either direction, then the direction will be set as part of the threshold job creation by setting thresholdDirection in MeasurementReader.
Only applicable if fmAlarmType is set.

  class MeasurementType  

 

class MediaResourceFunction

ManagedElement
+-MediaResourceFunction
+-Announcements [1..1]
+-MrfConfiguration [1..1]
+-MrfH248Control [1..1]
+-MrfResource [1..1]
+-MsProcessing [1..1]

Media Resource Function.

This MO represents common characteristics for the MRF feature.

The MO is created automatically at the initial start or the system upgrade of the node and cannot be deleted manually.

The Relative Distinguished Name (RDN) for this MO type is:
MediaResourceFunction=1


This MO is created by the system.

Attributes
int16
capacityForPriorityCalls = 20 { 0..1000 }
Fraction of the total processing capacity that will be reserved for emergency and priority calls.
Unit: fraction 1/1000 of the total processing capacity.
IpVersion
mediaIpVersion = IPV4
IP version of the network.
Defines the IP version(s) used for media in this network.
IP addresses for media interfaces are automatically fetched during runtime using DHCP.
string
key
mandatory
noNotification
restricted
mediaResourceFunctionId
The value component of the RDN.
string
noNotification
readOnly
release
The product release of the ManagedFunction.
It commonly contains the Managed Function release, for example L12.0, 13A, R1A
uint16
shuttingDownTimer = 0 { 0..1440 }
The time that the attribute administrativeState of MrfInstance MO can be in state SHUTTINGDOWN.
When the timer expires, administrativeState is set to LOCKED and services provided by the node is stopped.

Setting the value of this attribute to 0, disables the the shuttingDownTimer. This means that the MrfInstance becomes locked when all services has stopped in the node.


Unit: 1 Minute
string[0..1]
noNotification
userLabel
Used for product free-text description.

  class MediaResourceFunction  

 

class MrfConfiguration

ManagedElement
+-MediaResourceFunction
+-MrfConfiguration
+-MrfData [0..]

This MO is a container for all MRF configuration data.

The Relative Distinguished Name (RDN) for this MO type is:
MrfConfiguration=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
mrfConfigurationId
The value component of the RDN.

  class MrfConfiguration  

 

class MrfData

ManagedElement
+-MediaResourceFunction
+-MrfConfiguration
+-MrfData

This MO contains configuration data for one MRF instance.

References from:
MrfH248Interface;
References to:
EvsConfData; ManagedObject;
Attributes
int32[0..1]
dscpAudio = 46 { 0..63 }
Differentiated Services Code Point (DSCP).
The attribute specifies the codepoint value for audio streams handled by the MRF instances.
boolean[0..1]
dtmfForwardingInConference = false
This attribute determines whether the DTMF forwarding in conference function is enabled or not.

If function is enabled MRF instances will forward DTMF digits from one participant to all other participants.
EvsConfData[0..1]
evsConfDataMoRef
Contains a reference to the EvsConfData MO instance associated with this MrfData MO.

Default value of EvsConfData MO attributes are used in case evsConfDataMoRef is left empty.
string
key
mandatory
noNotification
restricted
mrfDataId
The value component of the RDN.
ManagedObject[0..]
readOnly
reservedBy
Contains a list of MO instances that reserve this MO instance.
string[0..1]
userLabel [ 0..128 ]
Label for free use.

  class MrfData  

 

class MrfH248Control

ManagedElement
+-MediaResourceFunction
+-MrfH248Control
+-MrfH248Interface [0..]

This MO represents the H.248 Control.

This MO is a container for all application server nodes that are controlling the vMRF VNF via H.248.
When new vMRF VM is created, it automatically creates SCTP association to all application server nodes defined in this container.

The Relative Distinguished Name (RDN) for this MO type is:
MrfH248Control=1


This MO is created by the system.

Attributes
uint16
localPortNumber = 2944 { 1024..65535 }
The local SCTP port used for the H248Interface.

In order to change the value of this attribute, administrativeState attribute of all MrfH248Interface MO instances has to be in LOCKED state.
string
key
mandatory
noNotification
restricted
mrfH248ControlId
The value component of the RDN.

  class MrfH248Control  

 

class MrfH248Interface

ManagedElement
+-MediaResourceFunction
+-MrfH248Control
+-MrfH248Interface

This MO represents one H.248 Interface.

This MO contains data for one application server node.
It is used by vMRF VMs to create an SCTP association toward the remote application server node.
This MO can be deleted only if its administrative state is in LOCKED state.

References to:
MrfData;
Attributes
AdmState
administrativeState = LOCKED
The administrative state of the MO.
uint16
noNotification
readOnly
discoveredPathMtu
The actual SCTP Maximum Transmission Unit (MTU) size towards the Multimedia Telephony Application Server (MTAS).
MrfData[0..1]
mrfDataMoRef
Contains a reference to the MrfData MO instance associated with this MrfH248Interface MO.

Default value of MrfData MO attributes are used in case mrfDataMoRef is left empty.
string
key
mandatory
noNotification
restricted
mrfH248InterfaceId
The value component of the RDN.
string
mandatory
restricted
remoteIpAddress
The primary IP address when initiating a Stream Control Transmission Protocol (SCTP) association.
Which corresponds to the parameter STC_DTA in the ITU-T Recommendation Q.2150.3.

Only IPv4 transport is supported.
uint16
restricted
remotePortNumber = 2944
The remote SCTP port used on the H.248 Controller.

  class MrfH248Interface  

 

class MrfInstance

ManagedElement
+-MediaResourceFunction
+-MrfResource
+-MrfInstance
+-MrfMediaInterface [0..2]

Represents an instance of MRF virtual machine (VM).
RDNs for this MO type is "MrfInstance=1" to "MrfInstance=100"


This MO is created by the system.

References to:
ComputeResource;
Attributes
AdmState
administrativeState = UNLOCKED
Administrative state of this node.
Can be used to to temporarily stop services provided by the node, in a graceful fashion.
While in LOCKED state, no service is provided until set to UNLOCKED.
While in SHUTTINGDOWN state, the only allowed next state is LOCKED.
ComputeResource[0..1]
readOnly
computeResourceMoRef
Contains a reference to the ComputeResource MO instance associated with this MrfInstance MO.
string[0..]
readOnly
faultyH248InterfaceList
List of faulty H.248 Interfaces.
string
key
mandatory
noNotification
restricted
mrfInstanceId
The value component of the RDN.
ScState
readOnly
scState
Indicates the state that the System Controller has in this node.
(SC active, SC standby or SC quiesced).

  class MrfInstance  

 

class MrfMediaInterface

ManagedElement
+-MediaResourceFunction
+-MrfResource
+-MrfInstance
+-MrfMediaInterface
+-MrfNextHop [0..2]

This MO represents an IP interface.
It is a logical interface created on a VLAN on an Ethernet interface used for user plane traffic.

The Relative Distinguished Name (RDN) for this MO type is of the form:
MrfMediaInterface=<MrfInstance.mrfInstanceId>_<IPversion>
IPversion=ipv4 or ipv6
Example: "4_ipv4"


This MO is created by the system.

Attributes
string
readOnly
ipAddress
Specifies the address of the IP interface. The IP address can be an IPv4 or an IPv6 address.
string
key
mandatory
noNotification
restricted
mrfMediaInterfaceId
The value component of the RDN.
SubnetMaskLengthRange
readOnly
subnetMaskLength
This attribute defines the number of bits used to derive the subnet identity from the IP address.
The given IP address (ipAddress) is an IPv4 or an IPv6 address.

  class MrfMediaInterface  

 

class MrfNextHop

ManagedElement
+-MediaResourceFunction
+-MrfResource
+-MrfInstance
+-MrfMediaInterface
+-MrfNextHop

This MO represents the next hops for an IP interface.
The next hops can be either IPv4 or IPv6. The existance of this MO is dependant on the existance of the nexthop in real life. When the nexthop is lost, the MO gets deleted.

The Relative Distinguished Name (RDN) for this MO type is of the form:
MrfNextHop=1 to MrfNextHop=2
The RDN value of MrfNextHop is unique within the scope of each MrfMediaInterface.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
mrfNextHopId
The value component of the RDN.
string
readOnly
nextHopIpAddress
Specifies the address of the next hop for the media IP interface.

The next hop address can be an IPv4 or an IPv6 address.

  class MrfNextHop  

 

class MrfResource

ManagedElement
+-MediaResourceFunction
+-MrfResource
+-MrfInstance [0..]

This MO is a container for all MRF instance data.

The Relative Distinguished Name (RDN) for this MO type is:
MrfResource=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
mrfResourceId
The value component of the RDN.

  class MrfResource  

 

class MsProcessing

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-AmrService [1..1]
+-AmrWbService [1..1]
+-AnnouncementService [1..1]
+-AudioMixingService [1..1]
+-DtmfReceiverService [1..1]
+-DtmfSenderService [1..1]
+-EvsService [1..1]
+-G722Service [1..1]
+-G729Service [1..1]
+-JitterHandlingService [1..1]
+-PcmService [1..1]
+-RtpRtcpService [1..1]
+-ToneSenderService [1..1]
+-UpFhService [1..1]

This MO structures the Media Stream Processing.

The Relative Distinguished Name (RDN) for this MO type is:
MsProcessing=1


This MO is created by the system.

Attributes
CodingLawMode
codingLaw = A_LAW
The type of the coding law that all of the services will use.
string
key
mandatory
noNotification
restricted
msProcessingId
Value for RDN = 1.

It is set automatically when the MO instance is created.

  class MsProcessing  

 

class NeLSConfiguration

ManagedElement
+-SystemFunctions
+-Lm
+-NeLSConfiguration

Network License Server (NeLS) configuration parameters.

This MO is created by the system.

Attributes
NeLSConnectionStatus[0..1]
readOnly
connectionStatus
Represents status of the connection toward NeLS.
IpDNSAddress[0..1]
host
IPv6, IPv4 or DNS name.

The IP address or domain name of NeLS.
string
key
mandatory
noNotification
restricted
neLSConfigurationId
The value component of the RDN.

Key attribute of the NeLSConfiguration class.
uint16[0..1]
port
The port number that is used to connect to NeLS.
uint32[0..1]
retryInterval = 30
The number of seconds between reconnection attempts.

First reconnection attempt occurs randomly between 3 to 5 minutes.

Subsequent attempts occur with the delay specified by retryInterval.

  class NeLSConfiguration  

 

class NetconfSsh

ManagedElement
+-SystemFunctions
+-SysM
+-NetconfSsh

Represents the Netconf configuration management service over Secure Shell.

This MO is created by the system.

Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the Netconf target.
When LOCKED all on-going netconf connections will immediately be terminated.

NOTE: Setting the administrativState to LOCKED for all Netconf and CLI interfaces disables O&M access to the ME. Refer to product specific troubleshooting instructions to resolve such a scenario.
string
key
mandatory
noNotification
restricted
netconfSshId
The value component of the RDN.

  class NetconfSsh  

 

class NetconfTls

ManagedElement
+-SystemFunctions
+-SysM
+-NetconfTls

Represents the Netconf configuration management service over Transport Layer Security (TLS).

This MO is created by the system.

References to:
ManagedObject;
Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the Netconf target.
When LOCKED all on-going netconf connections will immediately be terminated.

NOTE: Setting the administrativState to LOCKED for all Netconf and CLI interfaces disables O&M access to the ME. Refer to product specific troubleshooting instructions to resolve such a scenario.
string
key
mandatory
noNotification
restricted
netconfTlsId
The value component of the RDN.
ManagedObject[0..1]
nodeCredential
The credential used for the NETCONF service.
Specifies the DN of a NodeCredential MO in Certificate Management.
ManagedObject[0..1]
trustCategory
The set of certificates trusted by the NETCONF service.
Specifies the DN of a TrustCategory MO in Certificate Management.

  class NetconfTls  

 

class NodeCredential

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-NodeCredential

Represents the node credential and contains information about the corresponding certificate.

References to:
EnrollmentAuthority; EnrollmentServerGroup; ManagedObject;
Actions
boolean
cancelEnrollment ( );
Cancels the enrollment process.

If the enrollment runs in online polling mode, this action stops polling the enrollment server. The enrollment rejects to confirm the PKI response from the enrollment server and releases the generated key-pair. The enrollment fails.
boolean
installCredentialFromUri ( string uri , EcimPasswordString uriPassword , EcimPasswordString credentialPassword , Fingerprint fingerprint );
Installs a node credential or certificate from the specified Uniform Resource Identifier (URI).

If the container file is in PKCS#12 format, the action implicitly starts an offline enrollment. If the file is a certificate in Privacy Enhanced Mail (PEM) or Distinguished Encoding Rules (DER) format, this action closes the ongoing offline enrollment process started by the startOfflineCsrEnrollment action.

The action can be invoked if the enrollmentSupport attribute of the CertMCapabilites MO indicates that offline enrollment is supported.

For a container file in PKCS#12 format, the action can be invoked if there is no other action in progress on this MO. For a certificate file in PEM or DER format, the action can be invoked if there is a startOfflineCsrEnrollment action in progress on this MO.

The action returns immediately after invocation. The progress of the action can be tracked via the enrollmentProgress attribute.

The action returns with TRUE after successful invocation, otherwise it returns with FALSE.

The generic URI syntax is defined by RFC 3986.
Example: sftp://myuser@myhostname.ericsson.local/dir/subdir/file
Example: http://myhostname.ericsson.local/dir/subdir/certificate

Parameters

Name: uri
Description: This parameter contains a URI assumed to point to the certificate or credential container file.

The generic Uniform Resource Identifier (URI) syntax is defined by RFC 3986.
Example: sftp://myuser@myhostname.ericsson.local/dir/subdir/file
Example: http://myhostname.ericsson.local/dir/subdir/certificate
The URI must not contain any password. The password shall be provided in the second parameter of this action.
The URI may be local relative (e.g. data/dir/subdir/file), or local absolute (e.g. file:///data/dir/subdir/file), or remote (e.g. sftp://user@hostname/dir/subdir/file) or remote relative (e.g. sftp://user@hostname/~/cert.pem).
If the URI is local relative, the file is expected to be under directory path indicated by the localFileStorePath attribute in the CertM MO.



Name: uriPassword
Description: The password part of the Uniform Resource Identifier (URI).

If a password is not required, the 'NULL' string has to be provided.



Name: credentialPassword
Description: The password for decrypting the PKCS#12 container file.

If the action is called to install a certificate in Privacy Enhanced Mail (PEM) or Distinguished Encoding Rules (DER) format to finish a running enrollment process, the value of password has to be 'NULL'.



Name: fingerprint
Description: The Secure Hash Algorithm (SHA) fingerprint of the certificate to be installed.

The fingerprint is checked against the fingerprint calculated on the installed file. If the verification of the fingerprint is not required, the 'NULL' string must be provided. The hash must be calculated by the SHA algorithm indicated in fingerprintSupport of the CertMCapabilities MO.


boolean
startOfflineCsrEnrollment ( string uri , EcimPasswordString uriPassword );
Starts a manual enrollment procedure.

Creates a PKCS#10 Certificate Signing Request (CSR) that is stored at the specified local Uniform Resource Identifier URI. A file transfer service can be used to fetch the CSR file from the ME.

The action can be invoked if the enrollmentSupport attribute of the CertMCapabilites MO indicates that offline CSR-based enrollment is supported.

The action uses attributes subjectName and keyInfo attributes as inputs.

If no other action is in progress on this MO, the action can be invoked and it returns immediately after invocation.
The action progress can be tracked via the enrollmentProgress attribute.

The action returns with TRUE after successful invocation, otherwise it returns with FALSE.

Parameters

Name: uri
Description: This parameter contains a URI assumed to point to the certificate or credential container file.

The generic Uniform Resource Identifier (URI) syntax is defined by RFC 3986.
Example: sftp://myuser@myhostname.ericsson.local/dir/subdir/file
The URI must not contain any password. The password shall be provided in the second parameter of this action.
The URI may be local relative e.g. dir/subdir/csr.p10, or local absolute e.g. file:///data/dir/subdir/csr.p10, or remote e.g. sftp://user@hostname/dir/subdir/csr.p10).

If the URI is local relative, the file will be stored under the path indicated by the localFileStorePath attribute in the CertM MO.



Name: uriPassword
Description: The password section of the Uniform Resource Identifier (URI).

If a password is not required, the 'NULL' string must be provided.


boolean
startOnlineEnrollment ( EcimPasswordString challengePassword );
Starts the online enrollment process.

For initial enrollment a challengePassword must be provided.

The action can be invoked if the enrollmentSupport attribute of the CertMCapabilites MO indicates that online enrollment is supported.

As inputs, the action uses subjectName, keyInfo, enrollmentServerGroup and enrollmentAuthority attributes.

If no other action is in progress on this MO, the action can be invoked and it returns immediately after invocation.
Action progress can be tracked via the enrollmentProgress attribute.

The action returns with TRUE after successful invocation, otherwise it returns with FALSE.

Parameters

Name: challengePassword
Description: The one-time challenge password used as a shared-secret between the ME and the enrollment CA.


Attributes
CertificateContent[0..1]
readOnly
certificateContent
The X.509 content of the certificate.
CertificateState[0..1]
readOnly
certificateState
The current state of the certificate.
EnrollmentAuthority[0..1]
enrollmentAuthority
The DN of the EnrollmentAuthority used for online enrollments.
AsyncActionProgress[0..1]
readOnly
enrollmentProgress
Reports the progress of the ongoing enrollment.
EnrollmentServerGroup[0..1]
enrollmentServerGroup
The DN of the EnrollmentServerGroup used for online enrollments.
uint16[0..1]
enrollmentTimer = 60
The enrollment poll timer in minutes.

If the time indicated by this timer elapses before the enrollment is finished, the enrollment fails. Used only for online enrollment.
ExpiryAlarmThresholdRange
expiryAlarmThreshold = 30
Threshold value to calculate the date of the alarm indicating the coming expiry of the certificate.

The alarm severity is raised to MINOR in case the remaining time to expiry is reduced to the one third of the configured threshold.
The alarm severity is raised to MAJOR in case the remaining time to expiry is reduced to the one tenth of the configured threshold or one week.
The alarm is cleared and a certificate not available alarm is raised when the certificate expires.
KeyInfo[0..1]
keyInfo
Specifies the key type and length that is used for the next enrollment.
string
key
mandatory
noNotification
restricted
nodeCredentialId
The value component of the RDN.
RenewalMode[0..1]
renewalMode = MANUAL
The certificate renewal mode for online enrollment.

Renewals use subjectName, keyInfo and enrollmentServerGroup attributes as inputs.

If configured to AUTOMATIC, manually initiated offline and online renewals fail.

If an automatic enrollment failed alarm is present on the MO, setting this attribute to MANUAL clears the alarm.
ManagedObject[0..] nonUnique
noNotification
readOnly
reservedByUser
Indicates the users of this NodeCredential MO.

The users are identified by Distinguished Names of Credential User Managed Objects.
string[0..1]
noNotification
restricted
subjectName
The X.501 DN to be used in the subject field of the requested certificate.

For instance: "C=SE,O=Ericsson,CN=someserialnumber.ericsson.com"
string[0..1]
userLabel
An additional descriptive text.

  class NodeCredential  

 

class NtpServer

ManagedElement
+-SystemFunctions
+-SysM
+-NtpServer

A persistent NTP client mode network association with a specified remote server or local reference clock address.

Attributes
BasicAdmState
mandatory
administrativeState
Locks or unlocks the operation of the NTP client function.

This is a convenience function to permit some or all NtpServer instances to be temporarily locked without having to delete the object.
string
key
mandatory
noNotification
restricted
ntpServerId
The value component of the RDN.
IpDNSAddress
mandatory
serverAddress
The address of the NTP server with which a persistent client server mode association will be made.

The serverAddress represents either a V4 or a V6 IP address or a DNS domain name.
string[0..1]
userLabel
An additional descriptive text.

  class NtpServer  

 

class PcmService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-PcmService

This MO represents PCM service.

The Relative Distinguished Name (RDN) for this MO type is:
PcmService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
pcmServiceId
The value component of the RDN.

  class PcmService  

 

class Pm

ManagedElement
+-SystemFunctions
+-Pm
+-PmGroup [0..]
+-PmJob [0..]
+-PmMeasurementCapabilities [1..1]

The top class of the Performance Management model.
It is used to manage the Performance Management jobs and PM measurements.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
pmId
Holds the name used when identifying the MO.

  class Pm  

 

class PmGroup

ManagedElement
+-SystemFunctions
+-Pm
+-PmGroup
+-MeasurementType [1..]

A grouping of the measurements into logical grouping.
PmGroup is unique in the ME.


This MO is created by the system.

Attributes
string[0..1]
noNotification
readOnly
category
Deprecated, Comma-separated sequence of key words.
Used for categorization and searching for data among reports. e.g. KPI, Feature xx, etc.
Deprecated in ECIM PM 2.2.


Deprecated: There is no practical use for this attribute in the model. It will not be visible in PM report files.

boolean[0..1]
noNotification
readOnly
consistentData
Deprecated, Defines whether or not this group of data is guaranteed to be consistent.
Counter Data Consistency
In some MEs there are both detailed counters, e.g. #failedConnections and #succeededConnections, as well as more high-level summary counters. e.g. #totalConnections.
A counter group is guaranteed to be consistent if it does not contain a summary counter whose value can be calculated based on other counters in that group, or if it does so but this calculation will always show the same value as the summary counter.
Deprecated in ECIM PM 2.2.


Deprecated: There is no practical need for this attribute in the model.

string[0..1]
noNotification
readOnly
description
Description of the PmGroup.
string[0..1]
noNotification
readOnly
generation
Determines if group concerns GSM, UMTS, EPS, combined (GSM+UMTS+EPS) or IMS measurements.
Values are defined in 3GPP standard 32:404.
ManagedObjectClass[0..1]
noNotification
readOnly
moClass
The Managed Object Class that uses the Measurement Types in this PmGroup.
No value means this PM Group is not associated with any specific Managed Object Class.
string
key
mandatory
noNotification
restricted
pmGroupId
Holds the name used when identifying the MO.
string
noNotification
readOnly
pmGroupVersion
PM Group version identifier.
Unique version identifier associated with a change to the contents of the PM Group, where new MeasurementTypes have been added.
string[0..1]
noNotification
readOnly
switchingTechnology
The Switching domain or domains to which this measurement is applicable.
Values are defined in 3GPP standard 32.404.
boolean[0..1]
noNotification
readOnly
validity
States if the group is valid.
A group might not be valid if, for example, the feature that this group is used for is not available to the customer.

  class PmGroup  

 

class PmJob

ManagedElement
+-SystemFunctions
+-Pm
+-PmJob
+-MeasurementReader [1..]

Describes a user-defined PM job on the Managed Element.
A PM Job defines the attributes required per job and also defines the measurements to be included in the job. An instance of the MeasurementReader class is created for every PmGroup or MeasurementType instance being measured.

Attributes
CompressionTypes[0..1]
compressionType
Indicates file compression type to be applied to the report file.
If no value is set, then no compression is to be applied to the report file for this job.
Must have the same value for all PM jobs with the same jobGroup tag and reportingPeriod assigned.
Must have the same value for all PM jobs for which no jobGroup tag is assigned (the "default" jobGroup), but the same reportingPeriod assigned.
Only applicable when jobType = MEASUREMENTJOB.
JobState
readOnly
currentJobState
Describes the current state of the PM job.
TimePeriod[0..1]
granularityPeriod = FIFTEEN_MIN
Contains the granularity period of the job.
The granularity period is the time between the initiation of two successive gatherings of measurement data. This is directly related to the ReportingPeriod as the granularity period can not be longer than the reporting period.
Possible Values (s=second,m=minute, h=hour): 10s,30s,1m, 5m, 15m, 30m, 1h, 12h, 24h.
Default Value: 15m.
JobControl[0..1]
readOnly
jobControl = FULL
Describes the level of MS control of the PM job.
If no value is set, the MS shall treat it as FULL.
string[0..1]
jobGroup
Tag for grouping PM measurement job results.
Represents a grouping of separate PM Jobs for which the measurement results must be collected together in a single report file for that group only.
If this attribute is not set, then for each reporting period, the measurement results for this job are written to the same report file as other jobs that have no job group assigned.
Only applicable when jobType = MEASUREMENTJOB.
JobPriority[0..1]
jobPriority = MEDIUM
Contains the priority of the job.
Each job must have a priority if jobPrioritizationSupport in the PmMeasurementCapabilities is set to true.
JobType[0..1]
jobType = MEASUREMENTJOB
Contains the type of PM job.
string
key
mandatory
noNotification
restricted
pmJobId
Holds the name used when identifying the MO.
ReportContentGeneration[0..1]
reportContentGeneration = CHANGED_ONLY
Describes the measurement result file content generated by PM service.
TimePeriod[0..1]
reportingPeriod = FIFTEEN_MIN
Contains the reporting period of the result file.
This is directly related to the granularity period as the granularity period can not be longer than the reporting period.
Possible Values (s=second,m=minute, h=hour): 10s,30s,1m, 5m, 15m, 30m, 1h, 12h, 24h.
Default Value: 15m.
The value of reportingPeriod must be equal to the value of granularityPeriod if fileRPSupported in PmMeasurementCapabilities is false, or may be equal to a multiple of the value of granularityPeriod if fileRPSupported is set to true.
Only applicable when jobType = MEASUREMENTJOB.
JobState[0..1]
requestedJobState = ACTIVE
Contains the requested state of the PM job.
It represents the state that the job has been ordered to reach.

  class PmJob  

 

class PmMeasurementCapabilities

ManagedElement
+-SystemFunctions
+-Pm
+-PmMeasurementCapabilities

Contains the measurement capabilities of the ME.

This MO is created by the system.

References to:
ManagedObject;
Attributes
boolean[0..1]
readOnly
alignedReportingPeriod
Defines whether or not the Managed Element aligns its reporting periods to the hour.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as true.
ManagedObject[0..1]
readOnly
fileGroup
Deprecated, contains the file storage path to the measurement files on the ME.
This attribute is only set if FileM is present, and refers to the file storage path. If this attribute is not set, the file storage path is stored locally in the fileLocation attribute in PmMeasurementCapabilities.
Deprecated in ECIM PM 2.0.


Deprecated: References to attributes in FileM must be removed from Common Fragments. fileLocation attribute contains all required information. Deprecated in ECIM PM 2.0.

string[0..1]
readOnly
fileLocation
Contains the path to the virtual file system on the node from which to fetch the measurement files.
Only applicable when measurementJobSupport = true.
boolean[0..1]
readOnly
fileRPSupported
Specifies if ME supports a file Reporting Period different to Granularity Period where RP > GP.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as false.
boolean[0..1]
readOnly
finalROP
Indicates if measurement file for the last Result Output Period (ROP) is expected.
When a measurement job is stopped, this attribute specifies whether a result file for the last ROP is expected (true), or not expected (false).
Only applicable when measurementJobSupport = true.
boolean[0..1]
readOnly
jobGroupingSupport
Indicates if Managed Element supports grouping of selected measurement job results in a report file.
If set to true, the ME groups selected measurement job results into one file per reporting period based on the PmJob attribute jobGroup.
If set to false, the default behaviour is to generate a single PM report file per reporting period for all jobs.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as false.
boolean[0..1]
readOnly
jobPrioritizationSupport
Defines whether or not measurement jobs can be stopped by the system.
Based on the priority of the Measurement jobs, they can either be stopped (true) or not (false) by the system. Attribute jobPriority in the job sets the priority per job.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as false.
JobStartStopSupport
readOnly
jobStartStopSupport
Specifies whether or not Performance Management jobs defined in the ME can be started and stopped.
Possible values:
NONE: a job is started when it is created and runs until it is deleted.
BASIC: simple start/stop supported.
uint16
readOnly
maxNoOfJobs
Specifies the maximum number of jobs that can be defined.
A value of 0 means there is no limit to the number of jobs.
If the specified limit is exceeded, when a performance monitoring is created or started, the create job or start job operation is rejected.
This is an upper system limit, and support for it cannot be guaranteed in high-load conditions.
uint32[0..1]
readOnly
maxNoOfMeasurements
The maximum number of counter instances, i.e. active counters, that can be reported in one ROP.
This is used by an MS to determine the max PM data file size. This is an upper-system limit, and support for it cannot be guaranteed in high-load conditions.
A value of 0 means there is no limit.
Only applicable when measurementJobSupport = true.
uint16[0..1]
readOnly
maxNoOfPmFiles
Specifies the maximum number of Result Output Period (ROP) files that are maintained in the ME.
If a new file is created and the limit is exceeded, the oldest file is deleted. This is an upper-system limit, and support for it cannot be guaranteed in high-load conditions.
Only applicable when measurementJobSupport = true.
boolean
readOnly
measurementJobSupport
Indicates if Managed Element supports Measurement Jobs.
string
key
mandatory
noNotification
restricted
pmMeasurementCapabilitiesId
Holds the name used when identifying the MO.
boolean[0..1]
readOnly
producesUtcRopFiles
Deprecated, Indicates if the PM report files are produced using UTC format.
If the timestamp is expressed in UTC time with no offset, then the value is true.
If the timestamp is expressed in local time with UTC offset, then the value is false.
Only applicable when measurementJobSupport = true.
Deprecated in ECIM PM 2.5.


Deprecated: Attribute definition was ambiguous. It is replaced by new attribute ropFilenameTimestamp. Deprecated in ECIM PM 2.5.

boolean
readOnly
realTimeJobSupport
Indicates if the Managed Element supports Realtime Jobs.
RopFilenameTimestamp[0..1]
readOnly
ropFilenameTimestamp
Indicates how the timestamp format is used in the Result Output Period (ROP) filename.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as LOCAL_WITH_UTC_OFFSET.
CompressionTypes[0..2] nonUnique
readOnly
supportedCompressionTypes
Indicates which compression types are supported by the ME for report files.
No value means that compression of report files is not supported.
Only applicable when measurementJobSupport = true.
TimePeriod[0..9] nonUnique
readOnly
supportedMeasJobGps
Indicates which granularity periods are supported by the ME for Measurement jobs.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as a single value of FIFTEEN_MIN.
TimePeriod[0..9] nonUnique
readOnly
supportedRopPeriods
Indicates the Result Output Period (ROP) or ROPs supported by the ME.
Only applicable when measurementJobSupport = true.
If no value is set, the MS shall treat it as a single value of FIFTEEN_MIN.
TimePeriod[0..9] nonUnique
readOnly
supportedRtJobGps
Indicates which granularity periods are supported by the ME for Realtime jobs.
Only applicable when realTimeJobSupport = true.
If no value is set, the MS shall treat it as a single value of ONE_MIN.
TimePeriod[0..9] nonUnique
readOnly
supportedThreshJobGps
Indicates which granularity periods are supported by the ME for Threshold jobs.
Only applicable when thresholdJobSupport = true.
If no value is set, the MS shall treat it as a single value of FIFTEEN_MIN.
boolean
readOnly
thresholdJobSupport
Indicates if the Managed Element supports Threshold Jobs.

  class PmMeasurementCapabilities  

 

class PmThresholdMonitoring

ManagedElement
+-SystemFunctions
+-Pm
+-PmJob
+-MeasurementReader
+-PmThresholdMonitoring

Contains configuration of each threshold for Threshold jobs.
To be able to monitor the overall health of the network, thresholds are used for generating Performance Alarms.
Performance alarms cannot be cleared manually. Performance alarms must be cleared when the threshold is (a) crossed, or (b) reached, in the opposite direction to the one that triggers the alarm.

Attributes
string
key
mandatory
noNotification
restricted
pmThresholdMonitoringId
Holds the name used when identifying the MO.
int64
mandatory
thresholdHigh
Defines the high-threshold level for this alarm severity.
For each pair of high-threshold and low-threshold levels, one of them must generate an alarm notification - or increase the severity of an existing alarm. The other one must generate an alarm clear notification, or decrease the severity of an existing alarm.
If the direction of the threshold is increasing, a new alarm (or severity increase of an existing alarm) is not generated before the measurement value has (a) crossed or (b) reached the high-level threshold value.
Furthermore, an existing alarm is not cleared (or its severity decreased) before the measurement value has reached or crossed the low-level threshold value.
For decreasing thresholds, the opposite is applied. The hysteresis mechanism can be used for both Gauges and Cumulative Counters thresholds.
int64
mandatory
thresholdLow
Defines the low-threshold level for this alarm severity.
For each pair of high-threshold and low-threshold levels, one of them must generate an alarm notification, or increase the severity of an existing alarm. The other one must generate an alarm clear notification, or decrease the severity of an existing alarm.
If the direction of the threshold is increasing, a new alarm (or severity increase of an existing alarm) is not generated before the measurement value has (a) crossed or (b) reached the high-level threshold value.
Furthermore, an existing alarm is not cleared (or its severity decreased) before the measurement value has reached or crossed the low-level threshold value.
For decreasing thresholds, the opposite is applied. The hysteresis mechanism can be used for both Gauges and Cumulative Counters thresholds.
SeverityLevel[0..1]
thresholdSeverity = MINOR
Threshold severity.
One of the following Severity Levels must be assigned per threshold, in order to raise a threshold alarm of this severity, or change an existing alarm to this severity, if that threshold is reached or crossed:
CRITICAL
MAJOR
MINOR
WARNING

Severity level CLEARED is not a valid severity level and cannot be assigned to this attribute.

  class PmThresholdMonitoring  

 

class Role

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthorizationMethod
+-Role
+-Rule [0..]

Authorization roles that may be assigned to users.

Roles have a containment relationship to the rules which define the access controls to objects.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
roleId
The value component of the RDN.
string[0..1]
readOnly
roleName
The role name a user may have.

The name is matched against role names retrieved from the user information store.
string[0..1]
userLabel
An additional descriptive text.

  class Role  

 

class RoleUpgrade

ManagedElement
+-SystemFunctions
+-SwM
+-UpgradePackage
+-RoleUpgrade
ManagedElement
+-SystemFunctions
+-SwM
+-RoleUpgrade

Contains configuration for Balanced In-Service upgrade.
A RoleUpgrade defines the attributes required for the upgrade and defines the scalable Role of the nodes to be upgraded.
There can be one RoleUpgrade per UpgradePackage and one default, top-level, RoleUpgrade.

References to:
ManagedObject;
Attributes
uint32[0..1]
noNotification
minRemainingCapacity
Minimum remaining capacity in percent of engineered capacity during the activation of the upgrade.
uint32[0..1]
noNotification
minSizeOfRole
Minimum number of nodes in the scalable role to do the upgrade in bigger chunks than one by one (rolling).
uint32[0..1]
readOnly
numberOfSteps
Calculated number of steps based on required minimum service capacity during upgrade.
ManagedObject
mandatory
noNotification
roleId
Reference to an instance of Role MO.
The role is identified by the Distinguished Name of the Role MO.
string
key
mandatory
noNotification
restricted
roleUpgradeId
The value component of the RDN.

  class RoleUpgrade  

 

class RtpRtcpService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-RtpRtcpService

This MO represents RtpRtcp Service.

The Relative Distinguished Name (RDN) for this MO type is:
RtpRtcpService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
rtpRtcpServiceId
The value component of the RDN.

  class RtpRtcpService  

 

class Rule

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthorizationMethod
+-Role
+-Rule

The rules that define the access control to objects.

A Rule MO is contained by a Role MO which may be then applied to users.


This MO is created by the system.

Attributes
PermissionType[0..1]
noNotification
readOnly
permission
Permission is the access right the rule provides on a target specified by the ruleData attribute.
RuleDataType[0..1]
noNotification
readOnly
ruleData
Defines the model elements for which the permission is applicable.
string
key
mandatory
noNotification
restricted
ruleId
The value component of the RDN.
string[0..1]
noNotification
readOnly
ruleName
The rule name.

The rule name is a string of '<FunctionName>_<RuleNumber>'

<FunctionName> is a unique name for a system, transport, equipment, or application function.

<RuleNumber> is a numerical ID of the Rule MO within a <FunctionName>.

Examples:

BackupAndRestoreManagement_1
FileManagement_2
SecurityManagement_2
SystemManagement_1
string[0..1]
userLabel
An additional descriptive text.

  class Rule  

 

class Schema

ManagedElement
+-SystemFunctions
+-SysM
+-Schema

Represents a MIM model fragment whose corresponding functionality is operational in the Managed Element.

This MO is created by the system.

Actions
void
export ( string uri , EcimPasswordString password );
Pushes the schema file out from the ME.

The URI shall contain both the file name and the destination address. The password is optional.

Parameters

Name: uri
Description: The URI used for identifying the adress to the remote location to which the file shall be transferred to.


Name: password
Description: The password used for connecting to the remote file location.

Attributes
string[0..1]
readOnly
baseModelIdentifier
Represents the name of the common information model fragment that the data model fragment is derived from.
string[0..1]
readOnly
baseModelVersion
The full version information for the common information model fragment that the data model fragment is derived from.
string[0..1]
readOnly
identifier
Represents the name of the data model fragment that the schema represents.
string
key
mandatory
noNotification
restricted
schemaId
The value component of the RDN.

From a usability perspective, the value could e.g. be set to the corresponding model name.
string[0..] nonUnique
readOnly
selectedModelOptions
Contains the model features used in the generation of the MIM.

The MS can query the information from the model without having to access the MIM file itself.
string[0..1]
readOnly
version
Represents the full version information for the data model fragment that the schema represents.

  class Schema  

 

class SctpEndpoint

ManagedElement
+-Transport
+-SctpEndpoint

An SCTP Endpoint is the logical sender and receiver of SCTP packets.
It is not possible to delete a SctpEndpoint that is referenced from a user/application.

The Relative Distinguished Name (RDN) for this MO type is:
SctpEndpoint=1


This MO is created by the system.

Attributes
string
readOnly
localIpAddress
Local address used for the SCTP endpoint.
uint16
readOnly
portNumber
Local port number for the SCTP endpoint.
string
key
mandatory
noNotification
restricted
sctpEndpointId
Value component of the RDN.

  class SctpEndpoint  

 

class SctpProfile

ManagedElement
+-Transport
+-SctpProfile

The SctpProfile defines the configuration that controls the behaviour of an SCTP Association.

This MO is created by the system.

Attributes
AlphaIndex
alphaIndex = ALPHA_1_8TH
This is the RTO.
Alpha value when expressed in right shifts and is used in RTO calculations.


Specification: RFC 4960, section 6.3.1
uint8
assocMaxRtx = 8 { 1..20 }
Maximum number of consecutive retransmissions to a peer.
If the number of retransmissions exceeds this value, endpoint considers that the peer is unreachable and closes the association.


Specification: RFC 4960, section 6.3.1
BetaIndex
betaIndex = BETA_1_4TH
This is the RTO.
Beta value when expressed in right shifts and is used in RTO calculations.


Specification: RFC 4960, section 6.3.1
uint8
cookieLife = 60 { 1..180 }
This is the maximum lifespan of the Cookie sent in an INIT ACK chunk.

Unit: 1 s
Specification: RFC 4960, section 5.1.3
uint8
dscp = 40 { 0..63 }
The DSCP value.
boolean
enablePathMtuDiscovery = false
Automatic discovery of SCTP Maximum Transmission Unit (MTU) size based on ICMP.
false (default) : Disable automatic discovery of SCTP MTU size towards the Multimedia Telephony Application Server (MTAS). The used SCTP MTU size value is based on the 'maxSctpPduSize' attribute.
true : Enable automatic discovery of SCTP MTU size towards the Multimedia Telephony Application Server (MTAS). The initial value and upper limit for the SCTP MTU size value is based on the 'maxSctpPduSize' attribute.
uint32
heartbeatInterval = 1000 { 10..180000 }
This is the interval when a HEARTBEAT chunk is sent to a destination transport address.
It is to monitor the reachability of an idle destination transport address.


Unit: 1 ms
Specification: RFC 4960, section 8.3
uint32
initRto = 300 { 10..120000 }
This is the initial value of RTO (retransmission timeout) that is used in RTO calculations.

Unit: 1 ms
Specification: RFC 4960, section 6.3.1.
uint16
maxBurst = 4 { 1..16384 }
Maximum number of new data packets that can be sent in a burst.

Specification: RFC 4960, section 6.1
uint8
maxInitRt = 8 { 1..16 }
Maximum number of times an INIT chunk or a COOKIE ECHO chunk is retransmitted.
If the number of retransmissions exceeds this value, endpoint aborts the initialization process and closes the association.
uint32
maxRto = 400 { 11..120000 }
This is the maximum value of RTO (retransmission timeout) that is used in RTO calculations.

Unit: 1 ms
Specification: RFC 4960, section 6.3.1
uint16
maxSctpPduSize = 1432 { 480..1480 }
The maximum size of the SCTP PDU towards the Multimedia Telephony Application Server (MTAS).
The maximum number of bytes in an SCTP PDU that can be transferred in a single unit over a specific path in an IP network. If an SCTP PDU exceeds the configured value it is segmented into multiple IP packets. Note that the value does not include the IP header. When 'enablePathMtuDiscovery' is set, the upper limit of the discovered MTU is based on the value of this attribute.
uint16
minRto = 100 { 10..5000 }
This is the minimum value of RTO (retransmission timeout) that is used in RTO calculations.

Unit: 1 ms
Specification: RFC 4960, section 6.3.1
uint8
pathMaxRtx = 4 { 1..20 }
Maximum number of consecutive retransmissions over a destination transport address of a peer.
If the number of retransmissions exceeds this value, peer endpoint is marked as inactive.
uint8
primaryPathMaxRtx = 0 { 0..20 }
Maximum value of the error counter of the current primary path in case of enabled PPA.
In case of enabled Primary Path Avoidance(PPA), if the error counter of the primary path exceeds this value, SCTP will chooses another current primary path.
uint16
sackTimer = 40 { 0..500 }
Time delay for sending the Selective Acknowledgement (SACK).
Time is measured from reception of the DATA chunk to sending of the SACK chunk.


Unit: 1 ms
string
key
mandatory
noNotification
restricted
sctpProfileId
Value component of the RDN.

  class SctpProfile  

 

class SecM

ManagedElement
+-SystemFunctions
+-SecM
+-CertM [1..1]
+-Ssh [0..1]
+-Tls [0..1]
+-UserManagement [1..1]

Security Management root MOC.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
secMId
The value component of the RDN.

  class SecM  

 

class Snmp

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpTargetV1 [0..]
+-SnmpTargetV2C [0..]
+-SnmpTargetV3 [0..]
+-SnmpTargetV3Dtls [0..]
+-SnmpViewV1 [0..]
+-SnmpViewV2C [0..]
+-SnmpViewV3 [0..]

Configuration of the SNMP protocol.
For instance configuration of the IP addresses and ports used for SNMP are supported.


This MO is created by the system.

References to:
ManagedObject;
Attributes
BasicAdmState
administrativeState = UNLOCKED
The administrative state for the SNMP protocol.
If LOCKED, no SNMP Traps (alarm, alerts or heartbeats) are generated and all access to the SNMP protocol is disabled.
HostAndPort[0..]
agentAddress
Listen addresses for the SNMP agent.
This attribute defines on which ports and IP addresses the agent shall listen for incoming SNMP requests using the UDP protocol. The typical configuration is using one port with IP address 0.0.0.0 and port 161, which means that the standard SNMP port is used on all interfaces.
HostAndPort[0..]
agentAddressDtls
Listen addresses for the SNMP agent using DTLS.
This attribute defines on which ports and IP addresses the agent shall listen for incoming SNMP requests using the DTLS transport protocol. The typical configuration is using one port with IP address 0.0.0.0 and port 10161, which means that the standard port for SNMP over DTLS is used on all interfaces.
ManagedObject[0..1]
nodeCredential
The node credential to be used for SNMP notifications using the Transport Security Model.
Specifies the DN of a NodeCredential MO in Certificate Management. If Transport Sercurity Model (DTLS) is not used,
the attribute value may be empty.
OperState[0..1]
noNotification
readOnly
operationalState
The operational status of the SNMP functionality.
If DISABLED, there is some problem that degrades the SNMP functionality.
string
key
mandatory
noNotification
restricted
snmpId
The value component of the RDN.
ManagedObject[0..1]
trustCategory
The trust category used for authentication of DTLS protocol users.
Specifies the DN of a TrustCategory MO in Certificate Management.
If not the DTLS protocol is used, the attribute value may be empty.

  class Snmp  

 

class SnmpTargetV1

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpTargetV1

An SNMP target defines a Trap receiver and gives access privileges.
This class, defines V1 protocol attributes.

Attributes
IPAddress
mandatory
address
Host address (or DNS name) for the SNMP Trap target.
BasicAdmState
administrativeState = UNLOCKED
Administrative state for the SNMP target.
When LOCKED, for this MO instance traps will not be sent and access is not allowed.
SnmpCommunity
mandatory
community
The SNMP community string.
boolean
isMibWritable = true
Specifies if the user has write access to MIB or not.
If false, the user is only allowed to perform read access (SNMP GET etc.)
The value of this attribute has no relevance if there is a SnmpViewV1 for the community of this instance. The permissions in the view will then override this attribute.
OperState[0..1]
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV1Id
The value component of the RDN.

  class SnmpTargetV1  

 

class SnmpTargetV2C

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpTargetV2C

An SNMP target defines a Trap receiver and gives access privileges.
This class, defines V2C protocol attributes

Attributes
IPAddress
mandatory
address
Host address (or DNS name) for the SNMP Trap target.
BasicAdmState
administrativeState = UNLOCKED
Administrative state for the SNMP target.
When LOCKED, for this MO instance traps will not be sent and access is not allowed.
SnmpCommunity
mandatory
community
The SNMP community string.
uint32
informRetryCount = 1
The number of retries to be attempted when a response is not received for a notification.
This value has only relevance if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
When an SNMP INFORM is not acknowledged within this time period, an implementation may assume that the notification has not been delivered. This value has only relevance if transportMethod is set to INFORM. The unit is centisecond (0.01 seconds).
boolean
isMibWritable = true
Specifies if the user has write access to MIB or not.
If false, the user is only allowed to perform read access (SNMP GET etc.)
The value of this attribute has no relevance if there is a SnmpViewV2C for the community of this instance. The permissions in the view will then override this attribute.
OperState
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV2CId
The value component of the RDN.
NotifyType
transportMethod = TRAP
The type of method to use, can be TRAP or INFORM.

  class SnmpTargetV2C  

 

class SnmpTargetV3

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpTargetV3

An SNMP target defines a Trap receiver and gives access privileges.
This class, defines V3 USM protocol attributes.

Attributes
IPAddress
mandatory
address
Host address (or DNS name) for the SNMP Trap target.
BasicAdmState
administrativeState = UNLOCKED
Administrative state for the SNMP target.
When LOCKED, for this MO instance traps will not be sent and access is not allowed.
EcimPassword
mandatory
authKey
The authentication key used for signing SNMP notifications.
Authentication is performed by using a user's authKey to sign the messages being sent. Note that the length of the key must be at least 8 characters. This value attribute has only relevance if authorization is enabled (see attribute snmpSecurityLevel).
AuthProtocol
authProtocol = MD5
The authentication protocol used.
This value attribute has only relevance if authorization is enabled (see attribute snmpSecurityLevel).
uint32
informRetryCount = 1
The number of retries to be attempted when a response is not received for a notification.
This value has only relevance if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
When an SNMP INFORM is not acknowledged within this time period, an implementation may assume that the notification has not been delivered. This value has only relevance if transportMethod is set to INFORM. The unit is centisecond (0.01 seconds).
boolean
isMibWritable = true
Specifies if the user has write access to MIB or not.
If false, the user is only allowed to perform read access (SNMP GET etc.).
The value of this attribute has no relevance if there is a SnmpViewV3 for the user of this instance. The permissions in the view will then override this attribute.
OperState[0..1]
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162
UDP port number for this SNMP trap target.
EcimPassword
mandatory
privKey
Privacy key used for encryption.
Encryption is performed by using a user's privKey to encrypt the data portion of the message being sent.
Note that the length of the key must be at least 8 characters.
This value attribute has only relevance if privacy is enabled (see attribute snmpSecurityLevel).
PrivProtocol
privProtocol = DES
The privacy protocol used.
This value attribute has only relevance if privacy is enabled (see attribute snmpSecurityLevel).
SecurityLevel
snmpSecurityLevel = AUTH_PRIV
The SNMP security level.
string
key
mandatory
noNotification
restricted
snmpTargetV3Id
The value component of the RDN.
NotifyType
transportMethod = TRAP
The type of method to use, can be TRAP or INFORM.
SnmpSecurityName
mandatory
user
The SNMP V3 user name for the SNMP V3 message.

  class SnmpTargetV3  

 

class SnmpTargetV3Dtls

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpTargetV3Dtls

An SNMP target defines a Trap receiver and gives access privileges.
This class, defines attributes needed for SNMP over DTLS. The attributes nodeCredential and trustCategory defined in the Snmp MO class/instance are used. DTLS is used as transport protocol both for incoming requests, outgoing responses and SNMP notifications.

Attributes
IPAddress
mandatory
address
Host address (or DNS name) for the SNMP Trap target.
BasicAdmState
administrativeState = UNLOCKED
Administrative state for the SNMP target.
When LOCKED, for this MO instance traps will not be sent and access is not allowed.
uint32
informRetryCount = 1
The number of retries to be attempted when a response is not received for a notification.
This value has only relevance if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
When an SNMP INFORM is not acknowledged within this time period, an implementation may assume that the notification has not been delivered. This value has only relevance if transportMethod is set to INFORM. The unit is centisecond (0.01 seconds).
boolean
isMibWritable = true
Specifies if the user has write access to MIB or not.
If false, the user is only allowed to perform read access (SNMP GET etc.).
The value of this attribute has no relevance if there is a SnmpViewV3 for the user of this instance. The permissions in the view will then override this attribute.
OperState[0..1]
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 10162
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV3DtlsId
The value component of the RDN.
NotifyType
transportMethod = TRAP
The type of method to use, can be TRAP or INFORM.
SnmpSecurityName
mandatory
user
The SNMP V3 user name.
The user name is used for authorization of incoming SNMP requests. The user name is defined by the subject alternative name field of the certificate provided by the client at the DTLS session setup.

  class SnmpTargetV3Dtls  

 

class SnmpViewV1

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpViewV1

An SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for one or several SNMP V1 users. A user is identified by a community name.

Communities that are not configured in any view, are by default given access to the following SNMP MIBs:
- Ericsson Alarm MIB
- SNMP-FRAMEWORK-MIB
- MIB-2

The default denies access to other SNMP MIBs. An explicit view configuration must be created if this default behaviour is not sufficient.

Attributes
string[0..]
community
The SNMP V1 communities that this view shall be applied on.
If a specific community is set in more than one V1 view, the user will get access to the sum of the views. The information in this object will override the attribute isMibWriteable in all SnmpTargetV1 for these communities.
SnmpOid[0..]
readOids
Defines which SNMP OIDs the user is allowed to read.
The defined OIDs and all their contained OIDs will be readable.
string
key
mandatory
noNotification
restricted
snmpViewV1Id
The value component of the RDN.
SnmpOid[0..]
writeOids
Defines which SNMP OIDs the user is allowed to write.
The defined OIDs and all their contained OIDs will be writeable.

  class SnmpViewV1  

 

class SnmpViewV2C

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpViewV2C

An SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for one or several SNMP V2C users. A user is identified by a community name.

Communities that are not configured in any view, are by default given access to the following SNMP MIBs:
- Ericsson Alarm MIB
- SNMP-FRAMEWORK-MIB
- MIB-2

The default denies access to other SNMP MIBs. An explicit view configuration must be created if this default behaviour is not sufficient.

Attributes
string[0..]
community
The SNMP V2C communities that this view shall be applied on.
If a specific community is set in more than one V2 view, the user will get access to the sum of the views. The information in this object will override the attribute isMibWriteable in all SnmpTargetV2C for these communities.
SnmpOid[0..]
readOids
Defines which SNMP OIDs the user is allowed to read.
The defined OIDs and all their contained OIDs will be readable.
string
key
mandatory
noNotification
restricted
snmpViewV2CId
The value component of the RDN.
SnmpOid[0..]
writeOids
Defines which SNMP OIDs the user is allowed to write.
The defined OIDs and all their contained OIDs will be writeable.

  class SnmpViewV2C  

 

class SnmpViewV3

ManagedElement
+-SystemFunctions
+-SysM
+-Snmp
+-SnmpViewV3

An SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for one or several SNMP V3 users. A user is identified by a user name.

Users that are not configured in any view, are by default given access to the following SNMP MIBs:
- Ericsson Alarm MIB
- SNMP-FRAMEWORK-MIB
- MIB-2

The default denies access to other SNMP MIBs. An explicit view configuration must be created if this default behaviour is not sufficient.

Attributes
SnmpOid[0..]
readOids
Defines which SNMP OIDs the user is allowed to read.
The defined OIDs and all their contained OIDs will be readable.
string
key
mandatory
noNotification
restricted
snmpViewV3Id
The value component of the RDN.
string[0..]
user
The SNMP V3 users that this view shall be applied on.
If a specific user is defined in more than one V3 view, the user will get access to the sum of the views. The information in this object will override the attribute isMibWriteable in all SnmpTargetV3 for these users.
SnmpOid[0..]
writeOids
Defines which SNMP OIDs the user is allowed to write.
The defined OIDs and all their contained OIDs will be writeable.

  class SnmpViewV3  

 

class Ssh

ManagedElement
+-SystemFunctions
+-SecM
+-Ssh

Configures system-wide properties of Secure Shell Transport Layer Protocol (SSH).

This MO is created by the system.

Attributes
SshAlgorithm[1..]
mandatory
selectedCiphers
The list of selected ciphers.

The ciphers are offered to the SSH peer in the order as configured. Each value indicates one cipher.
SshAlgorithm[1..]
mandatory
selectedKeyExchanges
The list of selected key exchange algorithms.

The algorithms are offered to the SSH peer in the order as configured. Each value indicates one algorithm.
SshAlgorithm[1..]
mandatory
selectedMacs
The list of selected message authentication codes.

The algorithms are offered to the SSH peer in the order as configured. Each value indicates one coding algorithm.
string
key
mandatory
noNotification
restricted
sshId
The value component of the RDN.
SshAlgorithm[1..]
readOnly
supportedCiphers
Lists the supported encryption ciphers.
SshAlgorithm[1..]
readOnly
supportedKeyExchanges
Lists the supported key exchange algorithms.
SshAlgorithm[1..]
readOnly
supportedMacs
Lists the supported message authentication codes.

  class Ssh  

 

class SwInventory

ManagedElement
+-SystemFunctions
+-SwInventory
+-SwItem [0..]
+-SwVersion [0..]

A singleton class which has only structural purpose.

This MO is created by the system.

References to:
SwVersion;
Attributes
SwVersion[1..]
readOnly
active
A reference to the active software version of a software domain.
The software of a managed element can be stuctured into more than one software domain. The active software version(s) control the behavior of the managed element .
string
key
mandatory
noNotification
restricted
swInventoryId
The value component of the RDN.
string[0..1]
userLabel
A label for free usage.

  class SwInventory  

 

class SwItem

ManagedElement
+-SystemFunctions
+-SwInventory
+-SwItem

A software item holds information about an executable software product.
A software item can also represent a container product that contains other software items, which represents a subordinate container and/or executable software products.


This MO is created by the system.

References from:
SwItem; SwVersion;
References to:
SwItem;
Attributes
string[0..1]
readOnly
additionalInfo
Describes any additional relevant aspects of the software item.
ProductData[0..1]
readOnly
administrativeData
The product identification of the software item.
SwItem[0..]
readOnly
consistsOf
Describes a hierarchical relationship between software items.
An empty value indicates that current software item is not a container that includes subordinate software items.
string
key
mandatory
noNotification
restricted
swItemId
The value component of RDN.
string[0..1]
userLabel
A label for free usage.

  class SwItem  

 

class SwM

ManagedElement
+-SystemFunctions
+-SwM
+-RoleUpgrade [0..1]
+-SwVersionMain [1..]
+-UpgradePackage [0..]

The root structural element of SW management activities.





This MO is created by the system.

References to:
ManagedObject; SwVersionMain; UpgradePackage;
Actions
boolean
cancel ( );
Stops the operation and restores the (consistent) state present before the long lasting operation was started.

Cancel can be invoked during any long lasting operation.

The action returns immediately after invocation. The consequences of the action can be tracked via the progressReport attribute. The action returns false if the action is refused by the ME, returns true otherwise.
uint16
createUpgradePackage ( string uri , EcimPasswordString password );
Creates a new UpgradePackage MO representing an UP specified by a URI.

This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.

This action can be invoked when there is no other action in progress on this MO.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.

The action returns 0 if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns the id of the action. The action id is different and unique for every invocation of the action.

The action also returns 0 if the ME cannot handle the URI (e.g., does not support the protocol specified in the URI).

Parameters

Name: uri
Description: Contains a URI pointing to a directory containing the UP content.

The generic URI syntax is defined by RFC 2396

The URI must not contain any password. (The password shall be provided in the second parameter of this action.)
The URI may be local absolute (e.g., file:///data/dir/subdir), or remote (e.g., sftp://hostname/dir/subdir).



Name: password
Default value: NULL
Description: A password to the server which provides UP.

If authentication is not password based, this parameter will be ignored.


boolean
createUpgradePackageFromUri ( string uri , EcimPassword password );
Creates a new UpgradePackage MO representing an UP specified by a URI.

Deprecated, replaced by the createUpgradePackage action.

This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.

This action can be invoked when there is no other action in progress on this MO.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.

The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.

The action also returns false if the ME cannot handle the URI (e.g., does not support the protocol specified in the URI).


Deprecated: 


Parameters

Name: uri
Description: Contains a URI pointing to a directory containing the UP content.

The generic URI syntax is defined by RFC 2396

The URI must not contain any password. (The password shall be provided in the second parameter of this action.)
The URI may be local absolute (e.g., file:///data/dir/subdir), or remote (e.g., sftp://hostname/dir/subdir).



Name: password
Description: A password to the server which provides UP.

If there is no password, this parameter shall not be specified (i.e., NULL).


boolean
createUpgradePackageLocal ( string directoryPathExtension );
Creates a new UpgradePackage MO representing an UP stored locally in the file system of the ME.

Deprecated, replaced by the createUpgradePackage action.

This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.


Deprecated: 


Parameters

Name: directoryPathExtension
Description: Parameter is a relative file system path pointing to the directory where the UP content is located. The path is relative to the localFileStore attribute.

boolean
createUpgradePackageRemote ( string directoryPathExtension , ManagedObject remoteFileStore );
Creates a new UpgradePackage MO representing an UP stored remotely that is not stored on the ME.

Deprecated, replaced by the createUpgradePackage action.

This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information will be available: e.g. administrativeData, number/names of activation step(s) data.
The location of the UP file is specified (by this action) input parameters: directoryPathExtension and remoteLocation.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.


Deprecated: 


Parameters

Name: directoryPathExtension
Description: This parameter is a relative file system path pointing to the directory where the UP content is located. The path is relative to the uriPathExtension in the TransferPolicyConsumer.


Name: remoteFileStore
Description: This TransferPolicyConsumer object contains a uriPathExtension attribute, which (together with Target and TargetGroup, all defined in the FileM fragment) define the exact remote location of the Upgrade Package.

boolean
removeSwVersion ( SwVersionMain swVersion );
Removes a SW version as completely as possible without disturbing node functionality.

Files shared with other SW versions are not deleted.
The active SW version cannot be removed.
This action can only be invoked when there is no other action in progress on this MO.

The action returns false if any of these conditions are violated.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.

Parameters

Name: swVersion
Description: The value component of the RDN of the SwVersionMain MO to remove.


boolean
removeUpgradePackage ( UpgradePackage upgradePackage );
Removes an UpgradePackage.

This action removes the UpgradePackage MO specified as action parameter as well as all files temporarily stored in the ME and associated with the UP.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute.
This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.

Parameters

Name: upgradePackage
Description: An UpgradePackage MO to be removed. The DN of the UpgradePackage MO to be removed.

Attributes
SwVersionMain[1..]
readOnly
activeSwVersion
Reference to the active software version(s) actively controlling the behavior of the managed element.
uint32
noNotification
alarmBeforeTimeout = 180
alarmBeforeTimeout is the time in seconds an alarm is sent out before a fallback occurs.
uint32
noNotification
automaticBackup = 1
automaticBackup is set to true(1) if ECIM SwM shall perform backup at activate() action otherwise set to false(0).
uint32
noNotification
automaticRestore = 1
automaticRestore is set to true(1) if ECIM SwM shall automatically perform fallback operation at certain events otherwise set to false(0).

These events are the following:
• The ME meets a critical problem.
(The ME must be able to detect any kind of software problem that prohibits a successful activation (step).)
• The user calls the cancel() action any time during the activation.
o Sub-case: Calling the cancel() action after the last activation step has completed (instead of calling commit()).
• The fallback timer expires during the activation.

The fallback operation shall restore the state that the ME had before starting the activation procedure.

ExecMethod[0..1]
noNotification
execMethod
The default execution method.
int16
fallbackTimer = 1200
The maximum number of seconds allowed to elapse between the finish of an activation step and the start of the next action - a new activate() action - or commit() action.

I.e., this attribute holds the value to which the attribute timeRemainingBeforeFallback is set after the action activate() is successfully completeted.
-1 symbolizes "infinity". In this case, the starting value of timeRemainingBeforeFallback shall also be set to -1 when the timer stars even though no counting down ever starts (it remains always -1).
ManagedObject[0..1]
readOnly
localFileStore
Reference to a FileGroup MO (in the File Managment MOM Fragment) representing a directory in the local file system.

Deprecated, superseded by the localFileStorePath attribute.

The locally stored UPs are stored under this directory. If the ME does not support pull download of the UP, the MS has a separate procedure for downloading the files to a directory modeled as a FileGroup MO.

If FileM MOM fragment is not implemented by the Managed Element, the localFileStore attribute is NULL.
If the ME supports pull download only, the localFileStore attribute is NULL.


Deprecated: 

string[0..1]
readOnly
localFileStorePath
URI of the directory where the UPs are stored on the ME.
AsyncActionProgress
readOnly
reportProgress
Represents the progress report (including result) of the ongoing action.

This MO supports only one action to be executed at a time.
string[0..1]
noNotification
readOnly
subType
subType is any string value identifying the type of node from a ECIM SwM perspective.
string
key
mandatory
noNotification
restricted
swMId
The value component of the RDN.
SwMTimeoutFallbackCapability[0..1]
noNotification
readOnly
timeoutFallbackCapability = SUPPORTED
Indicates whether fallback capability is supported or not.

If fallback capability is not supported, then setting SwM fallbackTimer has no effect and automatic fallback never happens.
int16
noNotification
readOnly
timeRemainingBeforeFallback = -1
Remaining number of seconds before performing fallback.

The value -1 indicates infinite number of seconds.
Fallback means that the system returns to the state PREPARE_COMPLETED.
string[0..1]
userLabel
Used for free-text description.

  class SwM  

 

class SwVersion

ManagedElement
+-SystemFunctions
+-SwInventory
+-SwVersion

An MO of this class represents the software version of a domain of the software.
If there is only one software domain, then the MO represents the overall version of the managed element.


This MO is created by the system.

References from:
SwInventory;
References to:
SwItem;
Attributes
ProductData[0..1]
readOnly
administrativeData
The product identification of the software version.
SwItem[0..]
readOnly
consistsOf
List of references to the software items the software version consists of.
string
key
mandatory
noNotification
restricted
swVersionId
The value component of the RDN.
DateTime[0..1]
readOnly
timeOfActivation
Indicates the time when the software version was activated.
If no time is presented, then current software version has not been activated.
DateTime[0..1]
readOnly
timeOfDeactivation
Indicates the time when the software version was deactivated.
If no time is presented, then current software version has not been deactivated.
DateTime[0..1]
readOnly
timeOfInstallation
Indicates the time the software version was installed.
string[0..1]
userLabel
A label for free usage.

  class SwVersion  

 

class SwVersionMain

ManagedElement
+-SystemFunctions
+-SwM
+-SwVersionMain

This class is used to represent the main SW version running on the ME.

Such MO may be created after activating an UP.

An active software version is actively controlling the behaviour of the ME, while a non-active version represents software not yet activated or software which has been de-activated during some previous activation. There may be one or more active software versions.

This class is similar to the SwVersion class in the SW Inventory Fragment. Both SW Inventory SwVersion MOC and SwM SwVersionMain MOC represent overall software version of the ME.







This MO is created by the system.

References from:
SwM;
References to:
ManagedObject;
Attributes
ProductData
readOnly
administrativeData
The product identification of the software version.
string
readOnly
name
Everyday name of the SW version.

It may contain any longer textual description.
int64[0..1]
readOnly
size
Amount of disk space in KB that will be freed if this SW version is deleted.

This figure may thus vary depending on what other SW versions exist - files shared between two SW versions will only be deleted when the last of those SW versions is deleted.

ManagedObject[0..1]
readOnly
swVersion
Associated Software Inventory Management MO.

Both SW Inventory SwVersion MOC and SwM SwVersionMain MOC represent overall software version of the ME.
string
key
mandatory
noNotification
restricted
swVersionMainId
The value component of the RDN.

  class SwVersionMain  

 

class SysM

ManagedElement
+-SystemFunctions
+-SysM
+-CliSsh [0..1]
+-CliTls [0..1]
+-NetconfSsh [0..1]
+-NetconfTls [0..1]
+-NtpServer [0..]
+-Schema [2..]
+-Snmp [1..1]

This is the System Management MO.

It is a parent to the MOs which represent the system level functions such as time handling and version handling as well as file transfer capabilities and netconf configuration.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
sysMId
The value component of the RDN.

It is set automatically when the MO instance is created.
string[0..1]
userLabel
An additional descriptive text.

  class SysM  

 

class SystemFunctions

ManagedElement
+-SystemFunctions
+-FileM [1..1]
+-Fm [1..1]
+-Lm [1..1]
+-Pm [1..1]
+-SecM [1..1]
+-SwInventory [1..1]
+-SwM [1..1]
+-SysM [1..1]

This model has a purpose to group the management of the system functions of the Managed Element.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
systemFunctionsId
Holds the name used when identifying the MO.

  class SystemFunctions  

 

class ThresholdMonitoring

ManagedElement
+-SystemFunctions
+-FileM
+-FileGroupPolicy
+-ThresholdMonitoring

Specifies a threshold for housekeeping files in a file group.

Attributes
HousekeepingAspect[0..1]
monitoredAspect = SIZE
Defines the aspect this monitor monitors.
There will be no monitoring if the aspect is unset.

Possible values are: SIZE | QUANTITY
uint32
mandatory
thresholdHigh
Defines the upper threshold for the configured monitored aspect.
A new alarm must be sent or an existing alarm must change severity if the monitored value has reached or exceeded this threshold. The alarm must change severity if there is another MO of the same monitored aspect with a higher threshold value than this MO. The unit of the configured value depends on the selected monitored aspect. SIZE is given in kilobytes (kB) and QUANTITY has no unit.
uint32
mandatory
thresholdLow
Defines the lower threshold for the configured monitored aspect.
If there is an outstanding alarm, it must change severity or be cleared when the monitored value has reached or fallen below this threshold. The alarm must be cleared if there is no other MO of the same monitored aspect with a lower threshold value. Otherwise, it is only permitted to send a new alarm with lower severity. The unit of the configured value depends on the selected monitored aspect. SIZE is given in kilobytes (kB) and QUANTITY has no unit.
string
key
mandatory
noNotification
restricted
thresholdMonitoringId
Value component of the RDN.
Severity[0..1]
thresholdSeverity = WARNING
Severity of the alarm associated with this monitor.

Possible values are: WARNING | MINOR | MAJOR | CRITICAL
string[0..1]
userLabel
Label for free use.

  class ThresholdMonitoring  

 

class Tls

ManagedElement
+-SystemFunctions
+-SecM
+-Tls

Configures system-wide properties of Transport Layer Security (TLS).

This MO is created by the system.

Attributes
CipherList
cipherFilter = kEECDH:kEDH:kRSA:!kPSK:!aPSK:!aDSS:!aNULL:!NULL:!SEED:!3DES:!DES:!MD5:!RC4:!CAMELLIA
Specifies a filter for the cipher suite list.

Applied on the cipher suites listed in attribute supportedCiphers. The result is shown in attribute enabledCiphers.
Cipher[0..] nonUnique
readOnly
enabledCiphers
Lists the cipher suites as filtered by the attribute cipherFilter.

Cipher suites are ordered by strength. The strongest cipher suite is offered first.
Cipher[0..] nonUnique
readOnly
supportedCiphers
Lists the cipher suites supported by the ME.
string
key
mandatory
noNotification
restricted
tlsId
The value component of the RDN.

  class Tls  

 

class ToneSenderService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-ToneSenderService

This MO represents the Tone Sender Service in the node.

The Relative Distinguished Name (RDN) for this MO type is:
ToneSenderService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
toneSenderServiceId
The value component of the RDN.

  class ToneSenderService  

 

class Transport

ManagedElement
+-Transport
+-SctpEndpoint [0..100]
+-SctpProfile [1..1]

This is a container for common transport functions used within the Managed Element.



This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
transportId
Holds the name used when identifying the MO.

  class Transport  

 

class TrustCategory

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-TrustCategory

Represents a group of trusted certificates that can be referenced by Credential Users on the ME.

References from:
TrustedCertificate;
References to:
ManagedObject; TrustedCertificate;
Attributes
ManagedObject[0..] nonUnique
noNotification
readOnly
reservedByUser
Indicates the users of this TrustCategory MO.

The users are identified by Distinguished Names of Credential User Managed Objects.
string
key
mandatory
noNotification
restricted
trustCategoryId
The value component of the RDN.
TrustedCertificate[1..] nonUnique
mandatory
trustedCertificates
The list of trusted certificates that belongs to this trust category.

Contains the Distinguished Names of the TrustedCertificate Managed Objects.
string[0..1]
userLabel
An additional descriptive text.

  class TrustCategory  

 

class TrustedCertificate

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-TrustedCertificate

Represents a trusted certificate.

This MO is created by the system.

References from:
CertM; EnrollmentAuthority; TrustCategory;
References to:
TrustCategory;
Attributes
CertificateContent[0..1]
readOnly
certificateContent
The X.509 content of the certificate.
CertificateState[0..1]
readOnly
certificateState
The current state of the certificate.
ManagedCertificateState
managedState = ENABLED
The state of the trusted certificate set by the MS.

If set to ENABLED, the certificate is trusted and the state of the certificate is represented by certificateState.
If set to DISABLED, the trusted certificate is quarantined, and thus the trust relationship is suspended.
TrustCategory[0..] nonUnique
noNotification
readOnly
reservedByCategory
Indicates the trust categories this trusted certificate belongs to.

Contains the Distinguished Names of the TrustCategory Managed Objects.
string
key
mandatory
noNotification
restricted
trustedCertificateId
The value component of the RDN.

  class TrustedCertificate  

 

class UpFhService

ManagedElement
+-MediaResourceFunction
+-MsProcessing
+-UpFhService

This MO represents the User Plane Frame Handler Service.

The Relative Distinguished Name (RDN) for this MO type is:
UpFhService=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
upFhServiceId
The value component of the RDN.

  class UpFhService  

 

class UpgradePackage

ManagedElement
+-SystemFunctions
+-SwM
+-UpgradePackage
+-RoleUpgrade [0..1]

Describes the process of changing the software configuration of an ME and actions to control the change process.

An instance of UpgradePackage (UP) represents a specific change of software configuration from the existing one to the new one identified by the attribute administrativeData. The execution of the change process described by UP class is the normal way to change the content of the SW inventory.

An UP may be seen as a "modification agent": it can add new, remove, or modify functionality.

When the upgrade package MO is created the upgrade control file is downloaded to specify the administrative data and the activation steps for this upgrade.
The sequence in which a Software upgrade executes is:

1. Prepare
2. Verify (optional)
3. Activate
4. Commit


This MO is created by the system.

References from:
SwM;
References to:
ManagedObject;
Actions
boolean
activate ( );
Current upgrade package is taken into operation fully or partially.

Partial activation occurs if the UCF defines activation steps and the attribute ignoreBreakPoints is false.
The ME upgrade engine notifies the operator that the activation step is completed. The next activation step starts when the operator invokes an activate action.
Each UP has to have at least 1 activation step.

When the attribute ignoreBreakPoints=true, all activation steps are executed in sequence, when an activation step is complete the ME executes the next activation step i.e. there is no operator invocation when an activation step is complete.

The time for observation of the correct operation of the ME after each completed step is always monitored by a supervision timer.
The invocation of activate() may be monitored by a supervision timer.
If the supervision timer expires before invocation of activate() or commit(), then the activation fails and the ME falls back to the state PREPARE_COMPLETED.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.

This action can be invoked when the state is PREPARE_COMPLETED or ACTIVATION_STEP_COMPLETED. If the action is invoked in a state where the action has no meaning, ME is expected to return an error message.
boolean
cancel ( );
Stops the operation and restores the (consistent) state present before the long lasting operation was started.

Cancel can be invoked during any long lasting operation. Furthermore, cancel() can also be invoked when the UP is in WAITING_FOR_COMMIT or ACTIVATION_STEP_COMPLETED state (without having a long lasting operation in progress). Calling cancel(), in this state, orders the ME to restore the state present before the activation procedure was started (PREPARE_COMPLETED).

The action returns immediately after invocation. The consequences of the action can be tracked via the progressReport attribute. The action returns false if the action is refused by the ME, returns true otherwise.

This action can be invoked when the UP state is PREPARE_IN_PROGRESS, VERIFICATION_IN_PROGRESS, ACTIVATION_IN_PROGRESS, ACTIVATION_STEP_COMPLETED, or WAITING_FOR_COMMIT. If the action is invoked in a state where the action has no meaning, the ME is expected to return false.
boolean
commit ( );
Stops the activation supervision timer (fallback timer) and confirms the upgrade.

The action returns when the action has completed (synchronous).
This action can be invoked when the state is WAITING_FOR_COMMIT. The action returns true on success, false on failure.
boolean
prepare ( );
Prepares the Managed Element for the activation of current upgrade package.

Executing prepare() does not have any negative impact on the in service performance of Managed Element.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.


boolean
verify ( );
Verifies the ability to activate current upgrade package.

The action returns immediately after invocation. The progress of the action can be tracked via the progressReport attribute. The action returns false if the action could not start for any reason (e.g., another parallel action is in progress), otherwise returns true.

This action can be invoked when the state is PREPARE_COMPLETED. If the action is invoked in a state where the action has no meaning, ME is expected to return an error message.
Calling this action is optional in the whole upgrade procedure. The action can be called more than once if wished.


Attributes
int32
noNotification
readOnly
activationFallbackTimer = -1
The activationFallbackTimer is the maximum execution time of an activation operation.
The activationFallbackTimer is fetched from the packageInfo.xml.

The default -1 value denotes that the activation timer is disabled.
ActivationStep[1..]
readOnly
activationStep
List of activation steps the activation procedure consists of.

It is possible to stop after each step, perform supervision and continue with the procedure.
The upgrade procedure consists of at least one activation step.
ProductData[1..]
readOnly
administrativeData
The product identification of the software version(s) being activated at successful completion of the full sequence of actions for an upgrade.

If the resulting software version after activation is unknown or uncertain, the administrativeData could be empty.
DateTime
readOnly
created
Date and time this Upgrade Package instance was created.
uint16[0..1]
noNotification
readOnly
creatorActionId = 0
The Id (actionId) of the action that have created this UpgradePackage managed object.

The default 0 value denotes that the managed element does not record this information.
string[0..1]
readOnly
directoryPathExtension
DEPRECATED
Relative path to the directory containing the Upgrade Package.

It reflects the input given when creating this UP.
If the UP is stored locally, this path extension is relative to the localFileStore FileGroup MO (or LocalFileStorePath).
If the UP is stored remotely, this path extension is concatenated to the uriPathExtension in the TransferPolicyProducer.



Deprecated: 

ExecMethod[0..1]
noNotification
execMethod
The execution method of a specific UpgradePackage.
boolean
ignoreBreakPoints = true
Influences the behaviour of the activate() action.

false => There is a breakpoint between each activation step. Activation process stops at each breakpoint.
true => Execution shall ignore breakpoints between activation steps and instead execute the end to end activation process invoking all activation steps in sequence (assuming no errors occur).
boolean
readOnly
isLocallyStored
DEPRECATED
Shows if upgrade package is stored on the node.

If true the upgrade package is stored in the local file system of the managed element.
If false the upgrade package is stored in a remote file system (remote file server).


Deprecated: 

ManagedObject[0..1]
readOnly
remoteFileStore
DEPRECATED
If the upgrade package is stored remotely, this attribute contains a reference to a TransferPolicyConsumer object.

This attribute indicates the relative location of the UP and reflects the input given when creating this UP.




Deprecated: 

AsyncActionProgressWithSteps
readOnly
reportProgress
Represents the progress report (including result) of the ongoing action.

This MO supports only one action to be executed at a time.
UpgradePackageState
readOnly
state
Current state of Upgrade Package.
string
key
mandatory
noNotification
restricted
upgradePackageId
The value component of the RDN.
string
readOnly
uri
A URI pointing to the directory where the UP can be found.

The URI may be local (e.g., file://data/dir/subdir) or a remote (e.g., ftp://hostname/dir/subdir).
string[0..1]
userLabel
Used for free-text description.

  class UpgradePackage  

 

class UserManagement

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LdapAuthenticationMethod [1..1]
+-LocalAuthorizationMethod [1..1]

User Management MOC.

This MO is created by the system.

Attributes
string[0..1]
legalNotice = IF YOU ARE NOT AN AUTHORIZED USER, PLEASE EXIT IMMEDIATELY
The legal notice presented to the user when starting an O&M session.

The message is presented to the client before authentication takes place. Depends on the client capability and configuration if the message is presented to the O&M user. The O&M user may receive this information before authentication if the authentication is password based; otherwise, it is perceived as post-authentication message. The purpose of the message is to warn the user about the consequences of unauthorized access. No value means there is no legal notice.
SecSecM_UserManagement_loginFailureDelay[0..1]
loginFailureDelay = 5
Delay after a failed login attempt in seconds.

No value means no delay.
SecSecM_UserManagement_targetType[0..] nonUnique
targetType
Lists the target types of the ME for Target Based Access Control (TBAC).

This attribute is optional for Authentication Methods that require TBAC configuration. Authentication Methods use TBAC to determine the following: whether a user can be authorized in the ME, and which authorization profiles apply to the user in the ME, based on the target types specified in this attribute.

This attribute can contain any classifier string for the ME such as geographical, for example: 'stockholm', network, for example 'ims', or functional identifiers, for example 'cscf', and any combination of these.

The generic behavior of TBAC for authorization is as follows:

TBAC is LOCKED in the ME: authorization is performed without TBAC.
TBAC is UNLOCKED in the ME: authorization is performed if the targets that the user is provided with exactly match at least one string of configured target types. Otherwise, authorization fails.

Determining the authorization profiles of the user is specific per Authentication Method.

The LOCKED and UNLOCKED states of TBAC in the ME are controlled by the Authentication Methods.

Example value: 'cscf.ims.stockholm'.
string[0..1]
userLabel
An additional descriptive text.
string
key
mandatory
noNotification
restricted
userManagementId
The value component of the RDN.

  class UserManagement  

 

class VariableAnnouncement

ManagedElement
+-MediaResourceFunction
+-Announcements
+-VariableAnnouncements
+-VariableAnnouncement

This MO represents MRF variable announcement data.

Attributes
string
mandatory
noNotification
restricted
languageCode [ 0..128 ]
Language code of the variable announcement.

Language code has the format of an RFC 5646 language tag.

The combination of the variableAnnouncementType and languageCode attributes form a unique identity for the variable announcement.

Example: en-GB


Valid values: [a-zA-Z]{1,8}([-_][a-zA-Z0-9]{1,8})*|^$
string
mandatory
logicFileName
The name of the variable announcement logic file.
The H.248 (or SIP) request contains the wanted variable announcement type and data associated to the announcement.
string
mandatory
logicFilePath
The relative file path to the directory where the variable announcement logic file is stored.
The value of this attribute is relative to the announcement_storage_server_path in deployment template.
Recommended value: variable/<languageCode>/

Example: variable/en-GB/
string[0..1]
userLabel [ 0..128 ]
Label for free use.
string
key
mandatory
noNotification
restricted
variableAnnouncementId
The value component of the RDN.
VariableAnnouncementType
mandatory
noNotification
restricted
variableAnnouncementType
This attribute identifies the variable announcement type.
The combination of the variableAnnouncementType and languageCode attributes form a unique identity for the variable announcement.

The types are defined in H.248.9. Only one MO instance for each languageCode can be defined for each supported variable type (DIGITS, DATE, TIME, NUMBER, MONEY).

  class VariableAnnouncement  

 

class VariableAnnouncements

ManagedElement
+-MediaResourceFunction
+-Announcements
+-VariableAnnouncements
+-VariableAnnouncement [0..100]

This MO is a container for all MRF variable announcements data.

The Relative Distinguished Name (RDN) for this MO type is:
VariableAnnouncements=1


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
variableAnnouncementsId
The value component of the RDN.

  class VariableAnnouncements