Classes for

Managed Object Model

(MOM)

PM Counter Details

Contents

AccountPolicy
AdministratorAccount
Apns
AppConfig
ArwaConfiguration
AuthenticationOrder
AutonomousMode
AVP
BrM
BrmBackup
BrmBackupHousekeeping
BrmBackupLabelStore
BrmBackupManager
BrmBackupScheduler
BrmCalendarBasedPeriodicEvent
BrmFailsafeBackup
BrmPeriodicEvent
BrmRollbackAtRestore
BrmSingleEvent
BusinessEvents
CapacityKey
CertM
CertMCapabilities
ChainCertificate
ClientAddress
CliSsh
CliTls
ComputeResource
ComputeResourceRole
Connection
CrM
CustomRole
CustomRule
DateAndTime
DbsFmRoot
DiameterNode
DiameterNodes
DscpConfig
EbmBusinessEvent
EbmBusinessEvents
EbmServer
EbmServers
EDSource
EDSources
EDTarget
EDTargets
EmergencyUnlock
EnrollmentAuthority
EnrollmentServer
EnrollmentServerGroup
EntityData
Equipment
EventBasedMonitoring
Evip
EvipAlb
EvipAlbs
EvipCluster
EvipCommand
EvipCommandDefinition
EvipDeclarations
EvipErsipParams
EvipFee
EvipFees
EvipFlowPolicies
EvipFlowPolicy
EvipFmDummy
EvipLbe
EvipLbes
EvipNode
EvipParam
EvipParams
EvipPayload
EvipPortRange
EvipPortRanges
EvipProtocol
EvipRoutingSetup
EvipSe
EvipSelectionPolicies
EvipSelectionPolicy
EvipSes
EvipSupervisedRemoteGateway
EvipTargetPool
EvipTargetPools
EvipVip
EvipVips
EvipXfrmSelectionPolicies
EvipXfrmSelectionPolicy
FeatureKey
FileGroup
FileGroupPolicy
FileInformation
FileM
FileMConfigData
FileTPM
FlexibleDiameter
Fm
FmAlarm
FmAlarmModel
FmAlarmType
FtpServer
FtpTls
FtpTlsServer
GeoRedManager
Host
Ikev1PolicyProfile
Ikev1Session
Ikev2PolicyProfile
Ikev2Session
IntegrationUnlock
IpsecPolicy
IpsecProposalProfile
IpsecTunnel
KeyFileInformation
KeyFileManagement
LdeAlarmConf
LdeBondingConf
LdeBootServerConf
LdeConfig
LdeDnsConf
LdeGeneralConf
LdeHaiadConf
LdeHostConf
LdeInterfaceConf
LdeIpConf
LdeIpInterfaceConf
LdeIpmiConf
LdeIptablesConf
LdeIptablesVersionConf
LdeMipConf
LdeNetConsoleConf
LdeNetworkConf
LdeNodeConf
LdeNodeOiConf
LdeNtpServerConf
LdePropertyConf
LdeRouteConf
LdeScalingConf
LdeSyslogConf
LdeTipcConf
Legacy
Lm
LmDummyInstance
LocalAuthenticationMethod
LocalAuthorizationMethod
LogicalFs
ManagedElement
ManagedObject
MeasurementReader
MeasurementType
NeLSConfiguration
NetconfSsh
NetconfTls
NetsharedConfig
Network
NodeCredential
Notification
NotificationConfig
NotifObject
NotifObjects
NtfMap
Ntp
NtpServer
NtpServer
OverloadConfig
OverloadPriority
PasswordPolicy
PasswordQuality
PccConfig
PeerAddress
PeerCluster
Phase2Policy
Pm
PmGroup
PmJob
PmMeasurementCapabilities
PmThresholdMonitoring
PolicyControlFunction
Role
Role
Rule
Schema
SecM
ServerAddress
SessionInactivityConfig
SessionInfoPublicationConfig
Sftp
SftpServer
SmsCenter
SmsDestination
Snmp
SnmpTargetV1
SnmpTargetV2C
SnmpTargetV3
SnmpTargetV3Dtls
SnmpViewV1
SnmpViewV2C
SnmpViewV3
Ssh
SshPublicKey
SwInventory
SwItem
SwVersion
SysM
SystemFunctions
Tdf
TdfRoute
Tdfs
ThresholdMonitoring
TimeM
Tls
Transport
TrustCategory
TrustedCertificate
UeTrace
UserAccount
UserAccountM
UserManagement
WebServiceEndPoint
WebServiceEndPoints
WsDestination

 

class AccountPolicy

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-AccountPolicy

Configures properties of account policy.

References from:
UserAccount;
References to:
ManagedObject;
Attributes
string
key
mandatory
noNotification
restricted
accountPolicyId
The value component of the RDN.
uint16[0..1]
dormantTimer = 180 { 1..65535 }
Account dormant timer in days.

Specifies the number of days it takes for the ME to automatically lock an account that was not used in this time period. The dormant state is calculated based on the lastLoginTime attribute and the current system time. No value means the account dormant time is not measured.


Unit: 1 days
ManagedObject[0..]
noNotification
readOnly
reservedByAccount
The accounts using this policy.

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

 

class AdministratorAccount

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-AdministratorAccount
+-SshPublicKey [0..1]

The administrator account.

Used for initial and recovery scenarios when authentication to regular O&M accounts is inaccessible.


This MO is created by the system.

References to:
PasswordQuality;
Actions
void
clearFailedAuthenticationAlarm ( );
Clears the alarm of failed authentications.

The action shall be invoked when the external password attack leading to the Authentication Failure Limit Reached alarm is isolated from the ME or to test if the attack persists.

The threshold when the alarm is raised can be configured by attributes passwordMaxFailure and passwordFailureCountInterval.

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

The user ID to be provided at authentication.
DateTime[0..1]
readOnly
lastLoginTime
The date of the last successful login.
DateTime[0..1]
readOnly
passwordChangedTime
The time the password was last changed.
int32[0..1]
passwordFailureCountInterval = 86400 { 1..2147483647 }
The time interval within which consecutive failed login attempts count in seconds.

Specifies the time interval it takes to obsolete records in passwordFailureTimes used for attribute passwordMaxFailure. No value means the failure counter is reset only on successful authentication.


Unit: 1 seconds
DateTime[0..] nonUnique
noNotification
readOnly
passwordFailureTimes
Dates of failed login attempts.

The list of dates when a user tried to authenticate to this account and failed. The attribute can be reset by a successful authentication. The dates outside the time-window set by passwordFailureCountInterval are removed.
int32
noNotification
readOnly
passwordHistoryLength
Specifies the number of passwords remembered by the ME to avoid reuse of old passwords.
int32[0..1]
passwordMaxFailure = 3 { 1..32 }
Maximum failed login attempts to send an authentication failure alarm.

Specifies the number of consecutive failed login attempts that can be performed before the account is alarmed, as counted in passwordFailureTimes. No value disables alarm sending.
int32
noNotification
readOnly
passwordMinLength
Minimum length of passwords.

Specifies the minimum character lengths of passwords that the ME can accept.
PasswordQuality
mandatory
passwordQuality
The password quality parameters used.

Refers to the DN of a PasswordQuality MO.

 

class Apns

ManagedElement
+-PolicyControlFunction
+-Network
+-Apns

It represents the APN configuration data.

Attributes
string
key
mandatory
noNotification
restricted
apnsId
Identifies the instance of this class. Forced value=1.
string[0..]
emergencyIds
The list of APN identifiers restricted to emergency services.
string[0..]
epsBearerIds
The list of APN identifiers enabled for EPS bearer priority services.
string[0..]
imsIds
The list of APN identifiers enabled for IMS priority services.

 

class AppConfig

ManagedElement
+-PolicyControlFunction
+-AppConfig
+-PccConfig [1..1]
+-SessionInactivityConfig [1..1]
+-SessionInfoPublicationConfig [1..1]

Holds general SAPC application level configuration data.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
appConfigId
Identifies the instance of this class. Forced value = 1.
boolean
enableMsTimeZone = true
Enables the use of 3GPP-MS-TimeZone AVP.
Indicates if 3GPP-MS-TimeZone AVP (received from the mobile access network) should be considered for the group activation/deactivation time, the usage accumulator lifetime calculation, and ToD based policies.
boolean[0..1]
noNotification
enableReauthsOnSubsChange = true
Enables subscriber change reauthorizations.
Indicates if it is enabled the sending of reauthorizations to the traffic gateway, when subscriber profile is changed. To prevent traffic overload, set it to false when doing massive subscriber changes.
Any other processing triggered by the reauthorization is also disabled in case this parameter is set to false (e.g Sd session establishment).
boolean[0..1]
noNotification
enableReauthsOnToD = true
Enables Time of Day reauthorizations.
Indicates if it is enabled the sending of reauthorizations to the traffic gateway owing to Time of Day internal events. To prevent traffic overload, set it to false when foreseen a large number of reauthorizations owing to ToD during a period of time.
Any other processing triggered by the reauthorization is also disabled in case this parameter is set to false (e.g Sd session establishment).

 

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 AuthenticationOrder

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-AuthenticationOrder

MO Class used to view the order of authentication methods.

This MO is created by the system.

Attributes
MethodOrder[1..]
readOnly
authenticationMethodOrder
The order in which authentication methods are to be used.

Methods must be called up in the order specified by the orderNumber member. The method is referenced by the methodReference member.
string
key
mandatory
noNotification
restricted
authenticationOrderId
The value component of the RDN.
string[0..1]
userLabel
An additional descriptive text.

 

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 AVP

ManagedElement
+-PolicyControlFunction
+-FlexibleDiameter
+-AVP

Contains AVP definition, used to transform AVPs in Diameter messages.

Attributes
uint32[0..1]
avpCode
The code of the AVP.
AvpDataTypesEnum[0..1]
avpDataType
Identifies the AVP data type.
string
key
mandatory
noNotification
restricted
avpId
Name of the AVP.
boolean[0..1]
avpMandatoryFlag
Indicates whether support of the AVP is required.
boolean[0..1]
avpProtectedFlag
Indicates the need for encryption for end-to-end security.
uint32[0..1]
avpVendor
The vendor of the AVP.

 

class BrM

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager [0..]
+-BrmRollbackAtRestore [0..1]

BrM Root MO class.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
brMId
The value component of the RDN.
string[0..1]
exportPackageLabelPrefix
Free text to help better identify a backup export package when residing outside the ME.
If specified, BRM prepends this prefix to the label that it generates for the backup export package.

 

class BrmBackup

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackup

Represents one backup of the type and domain specified by the BrmBackupManager in which it is contained.

This MO is created by the system.

Actions
boolean
cancelCurrentAction ( );
Cancel an ongoing asynchronous restore or export operation.
boolean
export ( string uri , EcimPasswordString password );
Export the backup using the specified uri.

This is an asynchronous action; progress and result will be reported in the progressReport attribute. Note that when finished successfully, a copy of the backup has been transferred and the original backup remains in the ME.

Parameters

Name: uri
Description: Specifies the location (url) where the backup is to be exported.
Or the resource name (urn) that encapsulates the backup export procedure.



Name: password
Description: The password required to access the location specified by the uri.
If no password is required, this parameter may be omitted.


boolean
restore ( );
Restore from this backup.
This is an asynchronous action - progress and result will be reported in the progressReport attribute.

Attributes
BrmAsyncActionProgress[0..1]
noNotification
readOnly
asyncActionProgress
The stucture used to report the progress and final result of asynchronous actions.
[Deprecated - Replaced by progressReport]


Deprecated: Replaced by progressReport

string
readOnly
backupDescriptor
This includes a list of storage owners that participate in a backup.
This backup is used by BRM when restoring or deleting the backup.
string
readOnly
backupName
Backup name, provided by the operator.
string
key
mandatory
noNotification
restricted
brmBackupId
The value component of the RDN.
DateTime
readOnly
creationTime
Date and time when the backup was created (start time of backup procedure).
BrmBackupCreationType
readOnly
creationType
Creation type; whether manually created or automatically via BrmBackupScheduler.
BrmAsyncActionProgress[0..1]
readOnly
progressReport
Represents the progress report and final result of the ongoing (asynchronous) action in this MO.
This MO supports only one action to be executed at a time.
BrmBackupStatus
readOnly
status
Status of the backup.
ProductData[0..]
readOnly
swVersion
This is the administrative data portion of active software version(s) of backup.
This information is specified in the software inventory management when the backup is created.

 

class BrmBackupHousekeeping

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupHousekeeping

Provides optional support for automated housekeeping of manually created backups.

If autoDelete is set to ENABLED, before creating a new manual backup, BRM first checks the number of manual backups and if the limit specified by the value of maxStoredManualBackups is reached, BRM removes the oldest manual backup before creating a new one.


This MO is created by the system.

Attributes
BrmManualBackupAutoDelete[0..1]
autoDelete = ENABLED
Determines whether automated housekeeping of manual backups is enabled.
If ENABLED and the number of backups already stored on the ME is equal to the value of maxStoredManualBackups, BRM removes the oldest backup before creating a new one. If set to DISABLED, BRM does not attempt to remove the oldest backup and instead returns failure when createBackup() is invoked.
string
key
mandatory
noNotification
restricted
brmBackupHousekeepingId
The value component of the RDN.
uint32[0..1]
maxStoredManualBackups = 100
Maximum number of manual backups (per backup type) to store in the ME.
When this limit is reached, if autoDelete=ENABLED, BRM removes the oldest manual backup before creating a new one; otherwise, an error is returned when createBackup() is invoked and the NMS must do the required housekeeping before attempting to create a new backup.

 

class BrmBackupLabelStore

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupLabelStore

Provides optional support for labeling of certain backups.
This class contains attributes that help distinguish certain backups such as the last restored backup, primary restore candidate, and so on.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
brmBackupLabelStoreId
The value component of the RDN.
string[0..1]
readOnly
lastCreatedBackup
The name of the last created backup.
This backup may be MANUAL or SCHEDULED. Note that this attribute will not be updated in case of a failed attempt to create a backup resulting in an INCOMPLETE backup.
string[0..1]
readOnly
lastExportedBackup
The name of the last exported backup from the ME.
Note that this attribute will not be updated in case of a failed attempt to export a backup.
string[0..1]
readOnly
lastImportedBackup
The name of the last imported backup to the ME.
Note that this attribute will not be updated in case of a failed attempt to import a backup.
string[0..1]
readOnly
lastRestoredBackup
The name of the backup that has been last used to restore the ME.
This does not imply that the currently running version of the system is the same as this backup, but instead shows which one of the backups has last been used to restore the ME. In a system which has never been restored using a backup, this attribute is empty.
string[0..] ordered
readOnly
restoreEscalationList
Specifies a list of backup names, in the order that shall be used to restore the ME if need be.
Specifically, the first element of this ordered list identifies the 'primary restore candidate'. Should the attempt to restore the ME with a given backup fail, the next backup in the list must be tried.

 

class BrmBackupManager

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackup [0..]
+-BrmBackupHousekeeping [0..1]
+-BrmBackupLabelStore [0..1]
+-BrmBackupScheduler [0..1]
+-BrmFailsafeBackup [0..1]

Serves as container for Backup instances of a particular backupType and backupDomain.

This class also provides the actions for creating new backups, importing backups from other locations, and deleting existing backups of the corresponding type and domain.


This MO is created by the system.

Actions
boolean
cancelCurrentAction ( );
Cancel an ongoing asynchronous createBackup, deleteBackup, or importBackup operation.
boolean
createBackup ( string name );
Creates a new backup of the backupType and backupDomain managed by the BackupManager.
This is an asynchronous action - progress and result will be reported in the ReportProgress attribute.

Parameters

Name: name
Description: The name of the backup to create.
If specified, input name validation is done by the implementation to forbid illegal names. Backup name validation rules are defined by the implementation and include duplicate backup names, names exceeding maximum allowed length, etc.
If not specified, the implementation will generate a backup name automatically with format defined by the implementation, example: <managedElementId>_<YYYY-MM-DDThh-mm-ss>.


boolean
deleteBackup ( string name );
Delete a backup specified by its name and of the type and domain managed by this BackupManager.
This is an asynchronous action - progress and result will be reported in the progressReport attribute.

Parameters

Name: name
Description: The name of the backup to delete.

boolean
importBackup ( string uri , EcimPasswordString password );
Import a backup using the specified uri.
This is an asynchronous action; progress and result will be reported in the progressReport attribute. Note that the type and domain of the backup to be imported must match the backup type and domain indicated by the instance of the backup manager on which this action is invoked.

Parameters

Name: uri
Description: Specifies the location (url) of the backup to import.
Orthe resource name (urn) that encapsulates the backup import procedure.



Name: password
Description: The password required to access the location specified by the uri.
If no password is required, this parameter may be omitted.


Attributes
BrmAsyncActionProgress[0..1]
noNotification
readOnly
asyncActionProgress
The structure used to report the progress and final result of asynchronous actions.
[Deprecated - Replaced by progressReport]


Deprecated: Replaced by progressReport

BrmAutoExport[0..1]
autoExport = DISABLED
Determines whether a manual backup is to be automatically exported at successful creation.
If set to ENABLED, the manual backup most recently created is exported to the location specified by attribute autoExportUri after it is successfully created. Note that the automatic export is only triggered if creation of the manual backup was successful. Otherwise, no export operation is triggered, even if this attribute is set to ENABLED. Also, note that setting this attribute to ENABLED has no impact on the manual backups that were already created and stored prior to the new configuration.
EcimPassword[0..1]
autoExportPassword
Password used by the manual backup when automatically exporting a manually created backup.
If autoExport attribute if set to ENABLED, this password will be used for authentication when automatically exporting the manually created backup.
string[0..1]
autoExportUri
Uri used by the manual backup when automatically exporting a manual created backup.
If attribute autoExport is set to ENABLED, this uri specifies the location to which the manual created backup is automatically exported.
string
readOnly
backupDomain
Backup domain, for example System.
string
readOnly
backupType
Type of backup; System Data or User Data.
string
key
mandatory
noNotification
restricted
brmBackupManagerId
The value component of the RDN.
string[0..1]
manualBackupName
The configurable portion of the manual backup name.
The format of generared backups are named <manualBackupName>-<creation date and time>, where creation date and time is of type DateTime defined in the common library.

Note: <creation date and time> will based on local time when operatior issues action request
BrmAsyncActionProgress[0..1]
readOnly
progressReport
Represents the progress report and final result of the ongoing (asynchronous) action.
This MO supports only one action to be executed at a time.

 

class BrmBackupScheduler

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupScheduler
+-BrmCalendarBasedPeriodicEvent [0..]
+-BrmPeriodicEvent [0..]
+-BrmSingleEvent [0..]

Provides optional support for scheduling of backup creation.

Each instance of BrmBackupScheduler MOC serves as the backup scheduler for the backup type indicated by its parent instance of BrmBackupManager. The scheduled backup event(s) can be instance(s) of BrmSingleEvent MOC, BrmCalendarBasedPeriodicEvent MOC, or BrmPeriodicEvent MOC contained in the instance of BrmBackupScheduler.


This MO is created by the system.

Attributes
BasicAdmState[0..1]
adminState = UNLOCKED
Administrative state of the scheduler.
BrmAutoExport[0..1]
autoExport = DISABLED
Determines whether a scheduled backup should be automatically exported upon successful creation.
If set to ENABLED, the scheduled backup specified by the attribute 'mostRecentlyCreatedAutoBackup' will be exported to the location specified by the attribute 'autoExportUri' after it has been successfully created. Note that the automatic export will be triggered ONLY IF the creation of the scheduled backup has been successful; otherwise, no export operation will be triggered even if this attribute has been set to ENABLED. Also, note that setting this attribute to ENABLED has no impact on the scheduled backups that have already been created and stored prior to the new configuration.
EcimPassword[0..1]
autoExportPassword
Password used by backup scheduler when automatically exporting a scheduled backup.
If autoExport attribute is set to ENABLED, this password will be used for authentication when automatically exporting the scheduled backup.
string[0..1]
autoExportUri
Uri used by backup scheduler when automatically exporting a scheduled backup.
If autoExport attribute is set to ENABLED, this uri specifies the location to which the scheduled backup will be automatically exported.
string
key
mandatory
noNotification
restricted
brmBackupSchedulerId
The value component of the RDN.
BrmSchedBackupStrategy[0..1]
housekeepingStrategy = REMOVE_OLDEST
Indicate the strategy of housekeeping will execute for scheduled backups
uint32[0..1]
maxStoredScheduledBackups = 5
The maximum number of scheduled backups to store in the local ME.
When this threshold is reached, the oldest scheduled backup is deleted by the BRM before creating a new one.
string
readOnly
mostRecentlyCreatedAutoBackup
The name of the scheduled backup created most recently by BrmBackupScheduler.
DateTime[0..1]
readOnly
nextScheduledTime = 2099-12-31T23:59:59
The date and time when the next scheduled event is triggered.
This is the earliest scheduled event from the set of configured events, i.e. single, periodic, and calendar-based periodic events.
BrmAsyncActionProgress[0..1]
readOnly
progressReport
The structure used to report the progress and final result of asynchronous actions.
string[0..1]
scheduledBackupName = BACKUP
The configurable portion of the scheduled backup name.
The scheduled backups are named <scheduledBackupName>-<creation date and time>, where creation date and time is of type DateTime defined in the common library.

Note: If date and time of creation (of the format DateTime) has '.' to denote the fraction of a second, it is rounded up and '.' is removed by BRM to maximize portability on the file system. Also, for the same reason, ":" is replaced by "-".
OperState[0..1]
readOnly
schedulerState
Operational state of the scheduler (ENABLED/DISABLED).
If the scheduler configuration has been successfully done and the scheduler is administratively unlocked, the implementation sets this attribute to ENABLED to confirm that the scheduler has been successfully configured and the next event has been calculated. If the event(s) is scheduled for a limited period of time, at the end of the period when there is no more scheduled events, this attribute is set to DISABLED by the implementation.

 

class BrmCalendarBasedPeriodicEvent

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupScheduler
+-BrmCalendarBasedPeriodicEvent

Periodic backup event using calendar-based interval.

This construct can be used to configure a periodic scheduled backup event by specifying the desired interval using calendar. For instance, in order to configure a scheduled backup event to occur every night at 2:00 am, the following setup must be done:
time=02:00:00
The start time for calculating scheduled events is assumed to be the current system time by default, unless explicitly set using the startTime attribute. Furthermore, if the configured event is to stop at a specific date, stopTime attribute must be set accordingly. Note that the default value of stopTime is the end of century.
A scheduled backup event of this type is triggered only if ALL the conditions with regard to attribute values are satisfied. For example, if "dayOfWeek" is set to Monday and "dayOfMonth" is set to 1, the event will be triggered only if the first day of month is Monday.
Daylight saving adjustments in Spring and Fall are addressed such that the affected scheduled backup events are triggered exactly once.

Attributes
string
key
mandatory
noNotification
restricted
brmCalendarBasedPeriodicEventId
The value component of the RDN.
DayOfMonth
dayOfMonth = 0
Day of month.
DayOfWeek
dayOfWeek = ALL
Day of week.
DayOfWeekOccurrence
dayOfWeekOccurrence = ALL
The occurrence of the day of week specified by dayOfWeek attribute in the month.
Month
month = 0
Month.
DateTime[0..1]
startTime
Start time. It is an optional attribute.
If not specified, the implementation uses the current system time as the default value.
DateTime[0..1]
stopTime = 2099-12-31T23:59:59
Stop time. It is an optional attribute. The default value is the end of the century.
Time
mandatory
time
This is the time when the scheduled event must occur.

 

class BrmFailsafeBackup

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmFailsafeBackup

MO for activating and deactivating failsafe backups.
Failsafe backups can be used when making changes to sensitive parts of the model, in which an error in configuration can lead to lost OAM connectivity or other failures from which the system can recover by a restore from a backup. When activated the failsafe backup function will automatically restore the system from a backup if the configuration as not been confirmed within a defined time period.


This MO is created by the system.

Actions
string
activate ( );
Activates a failsafe backup, which is created when this action is invoked.
string
deactivate ( );
Deactivates failsafe function and the failsafe backup is removed.

Attributes
string[0..1]
readOnly
backupName
Name of the backup that will be restored in case the failsafe function is activated.
string
key
mandatory
noNotification
restricted
brmFailsafeBackupId
The value component of the RDN.
BrmAsyncActionProgress[0..1]
readOnly
progressReport
Represents the progress report and final result of creating backup for failsafe configuration.
It will return the same information as the progressReport attribute of the BrmBackupManager managed object class.
uint64[0..1]
timeoutLength = 1200 { 1..86400 }
The number of seconds the system waits before activating the failsafe function.

If the value is set while the function is active the timeRemaining will be changed to that time instead.


Unit: 1 seconds
uint64[0..1]
noNotification
readOnly
timeRemaining
The number of seconds that remains before the system is restored from the selected backup.
UsageState
readOnly
usageState
Shows if the failsafe function is activated or not.
Multiple failsafe points is not possible, therefore this state is either IDLE or BUSY.

 

class BrmPeriodicEvent

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupScheduler
+-BrmPeriodicEvent

Periodic backup event.
This construct can be used to configure a periodic scheduled backup event by specifying the number of months, weeks, days, hours, or minutes. For instance, in order to configure a scheduled backup event to occur every 12 hours, the following setup must be done:

hours=12

The start time for calculating scheduled events is assumed to be the current system time by default, unless explicitly set using the startTime attribute. Furthermore, if the configured event is to stop at a specific date, stopTime attribute must be set accordingly. Note that the default value of stopTime is the end of century.

Attributes
string
key
mandatory
noNotification
restricted
brmPeriodicEventId
The value component of the RDN.
uint16
days = 0
The number of days.
uint16
mandatory
hours
The number of hours.
uint16
minutes = 0
The number of minutes.
uint16
months = 0
Deprecated, The number of months.
Replaced by CalendarBasedPeriodicEvent.month.


Deprecated: 

DateTime[0..1]
startTime
Start time. It is an optional attribute.
If not specified, the implementation uses the current system time as the default value.
DateTime[0..1]
stopTime = 2099-12-31T23:59:59
Stop time. It is an optional attribute. The default value is the end of the century.
uint16
weeks = 0
The number of weeks.

 

class BrmRollbackAtRestore

ManagedElement
+-SystemFunctions
+-BrM
+-BrmRollbackAtRestore

Confirm a restore action or automatic rollback after an unconfirmed restore operation was executed.
The existence of an instance of this class indicates that this feature is supported by the implementation.
This is optional support.


This MO is created by the system.

Actions
ActionInvocationResult
confirmRestore ( );
Invoking this action indicates acceptance of the previously executed restore operation.
The restore supervision timer, counting down from the initial value indicated by the timeAllowedBeforeRollback attribute, is stopped when this action is invoked. If this action is not invoked before the supervision timer expires, the system is restored to the state it was in before the last restore operation was invoked. This is a synchronous action.

Attributes
string
key
mandatory
noNotification
restricted
brmRollbackAtRestoreId
The value component of the RDN.
uint16[0..1]
timeAllowedBeforeRollback = 3600
Number of seconds to wait before performing the rollback to the state before restore.
uint16[0..1]
readOnly
timeRemainingBeforeRollback
The remaining number of seconds before performing the rollback to the state before restore.
The countdown stops after confirmRestore action is invoked on the BrmBackup MO, representing the restored backup. If action confirmRestore is not invoked before the expiration of the rollback timer, an automatic rollback is triggered. Countdown starts at restore, and stops when confirmRestore() is invoked.

 

class BrmSingleEvent

ManagedElement
+-SystemFunctions
+-BrM
+-BrmBackupManager
+-BrmBackupScheduler
+-BrmSingleEvent

A single scheduled backup event.

This construct can be used to configure a single (one-shot) scheduled backup event by specifying the desired date and time.

Attributes
string
key
mandatory
noNotification
restricted
brmSingleEventId
The value component of the RDN.
DateTime
mandatory
scheduledTime
Scheduled time.

 

class BusinessEvents

ManagedElement
+-PolicyControlFunction
+-BusinessEvents

Holds the SAPC logging events configuration data.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
businessEventsId
Identifies the instance of this class. Forced value=1.
int32
noNotification
loggingLevel = 6
Indicates the system logging level.
Values:
0: EMERGENCY
1: ALERT
2: CRITICAL
3: ERROR
4: WARNING
5: NOTICE
6: INFORMATIONAL

 

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 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 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.


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. 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 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
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.
KeyInfo[1..]
readOnly
keySupport
List of the key types the ME supports.

 

class ChainCertificate

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

Chain certificate belonging to the credential.

This MO is created by the system.

Attributes
CertificateContent[0..1]
readOnly
certificateContent
The X.509 content of the certificate.
CertificateState[0..1]
readOnly
certificateState
The current state of the certificate.
string
key
mandatory
noNotification
restricted
chainCertificateId
The value component of the RDN.

 

class ClientAddress

NetsharedConfig
+-PeerCluster
+-Connection
+-ClientAddress

The local address and port the update channel binds to.

Attributes
string
key
mandatory
noNotification
restricted
dbsClientAddressId
Unique id.
string
mandatory
noNotification
host
Host address.
uint16
mandatory
noNotification
port
Host port.

 

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 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 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.

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 ComputeResourceRole

ManagedElement
+-SystemFunctions
+-SysM
+-CrM
+-ComputeResourceRole

Represents the service (defined by the role) provided by the compute resource.
Logically, an instance of this class represents the state of the software stack (operating system, middleware, and application) running on the compute resource.


This MO is created by the system.

References to:
ManagedObject;
Attributes
AdmState[0..1]
adminState
Administrative state of compute resource role.
Can be used to to temporarily stop services provided by the compute resource in a graceful fashion (e.g. for HW maintenance, etc.)
While in LOCKED state, no services is provided until set to UNLOCKED.
string
key
mandatory
noNotification
restricted
computeResourceRoleId
The value component of the RDN.
InstantiationState[0..1]
readOnly
instantiationState
Instantiation state of the compute resource role.
OperState[0..1]
readOnly
operationalState
Operational state of the compute resource role.
ManagedObject[0..1]
provides
Reference to an instance of Role MO.
This determines what role (which dictates what type of service) is provided by the compute resource.
The role is identified by the Distinguished Name of the Role MO.
ManagedObject[0..1]
readOnly
uses
Reference to the compute resource which is used by this MO.
The compute resource is identified by the Distinguished Name of the ComputeResource MO.

 

class Connection

NetsharedConfig
+-PeerCluster
+-Connection
+-ClientAddress [0..1]
+-PeerAddress [1..1]

Represents a connection to the peer cluster.

Attributes
uint32
mandatory
connectTimeout
The time DBS waits between connection attempts.
string
key
mandatory
noNotification
restricted
dbsNetsharedConnectionId
Unique id of the Connection.
uint32
mandatory
retryLimit
The number of times DBS tries to connect before declaring the peer unreachable.

 

class CrM

ManagedElement
+-SystemFunctions
+-SysM
+-CrM
+-ComputeResourceRole [0..]
+-Role [0..]

The root class

This MO is created by the system.

Attributes
AutoRoleAssignment[0..1]
autoRoleAssignment
Shows whether a role, if one exists, should be automatically assigned to newly detected compute resrouce(s).
string
key
mandatory
noNotification
restricted
crMId
The value component of the RDN.

 

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 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 DateAndTime

ManagedElement
+-SystemFunctions
+-SysM
+-TimeM
+-DateAndTime

Local time and time zone values.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
dateAndTimeId
The value component of the RDN.
DifferenceFromUTC[0..1]
readOnly
dateTimeOffset
The offset in hours and minutes from UTC to local time.
DateTime[0..1]
noNotification
readOnly
localDateTime
The local date and time of the ME.

Local time is standard time in a time zone at a fixed offset from Coordinated Universal Time (UTC), possibly adjusted by Daylight Saving Time (DST) during part of the year.
string[0..1]
timeZone
The time zone of the ME.

A time zone is a region that has a uniform standard time. The string must match an entry in the ME’s time zone database, for example ‘Europe/Stockholm’.
string[0..1]
readOnly
tzRevision
The revision of the time zone database stored on the ME.

 

class DbsFmRoot

DbsFmRoot

<p>DBS&nbsp;FM&nbsp;Root</p>

Attributes
string
key
mandatory
noNotification
restricted
dbsFmRootId
.

 

class DiameterNode

ManagedElement
+-PolicyControlFunction
+-Network
+-DiameterNodes
+-DiameterNode
+-TdfRoute [0..]

It represents a Diameter node that communicates with the SAPC.

Attributes
boolean
adcSupport = false
Indicates if the Diameter node supports ADC Rules.
string[0..1]
noNotification
restricted
clusterPattern
Cluster pattern.
For clustered systems (logical system composed of several different Origin-Host), the pattern to match with the received Origin-Host.
The pattern can include any number of wildcards (example: *realm*.com). If no wildcard is specified the pattern matches with the ending part of the received Origin-Host (example: pcefrealm.com).
PccControl[1..]
mandatory
noNotification
controls
The list of applicable controls for the Diameter node.
string
key
mandatory
noNotification
restricted
diameterNodeId
The Diameter Origin-Host received from the Diameter node.
For clustered systems, the logical cluster identity to consider several Origin-Host as a single Diameter node in the SAPC.
boolean
noNotification
dynamicServiceSupport = false
Indicates if the Diameter node supports preconfigured and dynamic Pcc Rules.
boolean
gxRel91OrLowerCompatibility = false
Enable the support for interoperability with PCEFs handling Gx Rel versions 9.1.0 or 9.0.0.
TRUE: SAPC supports Gx Rel9 version 9.1.0 or 9.0.0 with this PCEF.
FALSE: SAPC supports Gx Rel9 version 9.7.0 or higher versions with this PCEF (Flow-Description AVP uplink (direction 'in') inside Flow-Information AVP is not supported).
string[0..1]
ipDomainId
IP address domain identity, assistant to match with the value of IP-Domain-Id AVP.

 

class DiameterNodes

ManagedElement
+-PolicyControlFunction
+-Network
+-DiameterNodes
+-DiameterNode [0..]
+-Tdfs [1..1]

Container for DIAMETER network related configuration classes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
diameterNodesId
Identifies the instance of this class. Forced value = 1.

 

class DscpConfig

NetsharedConfig
+-DscpConfig

DSCP configuration used by the DBS Netshared connections.

References to:
ManagedObject;
Attributes
string
key
mandatory
noNotification
restricted
dbsDscpConfigId
Unique id.
ManagedObject
readOnly
geoRedDscpReference
Read only reference to the currently configured DSCP service category object.
string
mandatory
serviceCategory
DSCP service category used by the Netshared connections.

 

class EbmBusinessEvent

ManagedElement
+-PolicyControlFunction
+-EventBasedMonitoring
+-EbmBusinessEvents
+-EbmBusinessEvent

It represents an Event Based Monitoring Business Event.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
ebmBusinessEventId
Identifier of the EBM event. It corresponds with the slogan event name.
string[0..]
ebmServerIds
List of EBM servers the event is sent to. If empty, the event is sent to all EBM servers.
boolean
enable = false
Enables the EBM event.

 

class EbmBusinessEvents

ManagedElement
+-PolicyControlFunction
+-EventBasedMonitoring
+-EbmBusinessEvents
+-EbmBusinessEvent [0..]

Container for Event Based Monitoring Business Event classes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
ebmBusinessEventsId
Identifies the instance of this class. Fixed value = 1.

 

class EbmServer

ManagedElement
+-PolicyControlFunction
+-Network
+-EbmServers
+-EbmServer

It represents an Event Based Monitoring server node that SAPC communicates with.

Attributes
string
key
mandatory
noNotification
restricted
ebmServerId
It represents an EBM server configuration.
IPv4v6Address
mandatory
ipAddress
IP address to communicate to the EBM Server.
uint32
mandatory
port
TCP port number to communicate to the EBM Server.

 

class EbmServers

ManagedElement
+-PolicyControlFunction
+-Network
+-EbmServers
+-EbmServer [0..]

Container for Event Based Monitoring network related configuration classes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
ebmServersId
Identifies the instance of this class. Fixed value = 1.

 

class EDSource

ManagedElement
+-PolicyControlFunction
+-EntityData
+-EDSources
+-EDSource

Contains the definition and location of a data object used for the SAPC business logic.

Attributes
EcimPassword[0..1]
noNotification
dbPassword
Password used by the Entity Data Source to connect to a given external DB.
string
mandatory
noNotification
definition
Metadata to specify from where and how access the data.
string
key
mandatory
noNotification
restricted
eDSourceId
Identifies the instance of this class.

 

class EDSources

ManagedElement
+-PolicyControlFunction
+-EntityData
+-EDSources
+-EDSource [0..]

Serves as repository of EDSource instances.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
eDSourcesId
Identifies the instance of this class. Forced value = 1.

 

class EDTarget

ManagedElement
+-PolicyControlFunction
+-EntityData
+-EDTargets
+-EDTarget

Allows to extend the SAPC behaviour to take actions and produce output data.

Attributes
string
mandatory
noNotification
definition
Specifies the action to perform and their output data.
string
key
mandatory
noNotification
restricted
eDTargetId
Identifies the instance of this class.
EcimPassword[0..1]
noNotification
targetPassword
Password used if the destination of the output data requires it.

 

class EDTargets

ManagedElement
+-PolicyControlFunction
+-EntityData
+-EDTargets
+-EDTarget [0..]

Serves as container of EDTarget instances.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
eDTargetsId
Identifies the instance of this class. Forced value = 1.

 

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 EnrollmentAuthority

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

Represents a Certification or Registration Authority for certificate enrollment.

References from:
EnrollmentServer; NodeCredential;
References to:
ManagedObject; 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.

If this attribute has any value, the attribute enrollmentCaFingerprint is ignored.
ManagedObject[0..]
readOnly
reservedBy
The MO Distinguished Names using this EnrollmentAuthority.
string[0..1]
userLabel
An additional descriptive text.

 

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.

For SCEP, the URI contains the relative URI of the enrollment CA HTTP Common Gateway interface (CGI) script path, which is the resource identifier of the resource on the server which will process the enrollment request.

Example for CMP: http://192.168.33.27:8080 or cmp://192.168.33.27
Example for SCEP: http://192.168.33.27:8080/cgi-bin/pkiclient.exe
string[0..1]
userLabel
An additional descriptive text.

 

class EnrollmentServerGroup

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

Maintains a group of enrollment servers for load balancing.

References from:
NodeCredential;
References to:
ManagedObject;
Attributes
string
key
mandatory
noNotification
restricted
enrollmentServerGroupId
The value component of the RDN.
ManagedObject[0..]
readOnly
reservedBy
The Distinguished Names of MOs using this EnrollmentServerGroup.
string[0..1]
userLabel
An additional descriptive text.

 

class EntityData

ManagedElement
+-PolicyControlFunction
+-EntityData
+-EDSources [1..1]
+-EDTargets [1..1]
+-NotifObjects [1..1]

Serves as container for Entity Data related configuration data.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
entityDataId
Identifies the instance of this class.
IpDNSAddress[0..1]
noNotification
localIp
Indicates the local IPv4 address used for external database access.
IpDNSAddress[0..1]
noNotification
localIpv6
Indicates the local IPv6 address used for external database access.

 

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 EventBasedMonitoring

ManagedElement
+-PolicyControlFunction
+-EventBasedMonitoring
+-EbmBusinessEvents [1..1]

Holds the SAPC Event Based Monitoring configuration data.

This MO is created by the system.

Attributes
boolean
enable = false
Enables Event-Based Monitoring.


string
key
mandatory
noNotification
restricted
eventBasedMonitoringId
Identifies the instance of this class. Fixed value = 1.

 

class Evip

ManagedElement
+-Transport
+-Evip
+-EvipAlbs [1..1]
+-EvipDeclarations [1..1]
+-EvipParams [1..1]
+-EvipPortRanges [1..1]
+-EvipSelectionPolicies [1..1]
+-EvipXfrmSelectionPolicies [1..1]

Top class for EVIP Configuration

Attributes
string
key
mandatory
noNotification
restricted
evipId
The version of Evip config

 

class EvipAlb

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipErsipParams [1..1]
+-EvipFees [1..1]
+-EvipFlowPolicies [1..1]
+-EvipLbes [1..1]
+-EvipSes [1..1]
+-EvipTargetPools [1..1]
+-EvipVips [1..1]

Defines an Abstract Load Balancer (ALB).

Actions
void
activate ( );
Activates the ALB. The activation may fail if the ALB configuration is invalid. The current state can be examined in the "state" attribute.
void
inactivate ( );
Inactivates the ALB.
void
reloadike ( );
Send reload command to the IKE agent.

Attributes
string[0..]
commands
Deprecated.
An array of commands that are executed when the ALB is activated. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher. The commands are executed on all LBEs, FEEs in the ALB.


Deprecated: Deprecated in eVIP 2.3

string
key
mandatory
noNotification
restricted
evipAlbId
The RDN attribute. Must be a unique name selected by the operator.
string[0..1]
ipsecServiceIp
This is an IPv6 address for internal use in eVIP (one per ALB). The eVIP system administrator must make sure this IP does not collide with anything else in the system.
If this value is not provided then eVIP uses an internally calculated value.
string[0..1]
ipvsTcpfinTimeout = 120
This timeout value (in seconds) is used for IPVS connections, for TCP sessions after receiving a FIN packet. The default value is 120.

For more information see manual page of IPVS (IP Virtual Server).
string[0..1]
ipvsTcpTimeout = 9000
This timeout value (in seconds) is used for IPVS connections, for TCP sessions in ESTABLISHED state. The default value is 9000.

For more information see manual page of IPVS (IP Virtual Server).
string[0..1]
ipvsUdpTimeout = 120
This timeout value (in seconds) is used for IPVS connections, for UDP packets. The default value is 120.

For more information see manual page of IPVS (IP Virtual Server).
string[0..1]
lbeHash = 2-tuple
Defines the hash algorithm for traffic distribution to Load Balancing Elements (LBE).
Valid settings; 2-tuple | 5-tuple

2-tuple is default. Protocol ports are not included and hence all traffic between a src,dest address pait will pass the same LBE.

5-tuple hashing will include protocol port and traffic from a specific source will be distributed between available LBE's. HOWEVER THERE IS A PRICE TO PAY;

5-tuple distribution will exclude some important features such as;

- IPSec
- "Strict" traffic distribution
- Traffic bundling
string[0..1]
numIpsecKeys = 256
Number of units (keys) used for SE connection distribution. Must be a power of 2. This value should be several times higher than the number of SEs but a too high value will slow down reconfiguration on an SE failure. The default is 256 and will do nicely for most cases.
string
numKeys = 256
Number of units (keys) used for connection distribution. Must be a power of 2. This value should be several times higher than the number of LBEs but a too high value will slow down reconfiguration on an LBE failure. The default is 256 and will do nicely for most cases.
string[0..1]
private = no
Private ALB secures full traffic separation towards the user-application allowing IP-address ranges to overlap between ALBs. Default value is "no".
string[0..1]
serviceIp
This is an IPv6 address for internal use in eVIP (one per ALB). The eVIP system administrator must make sure this IP does not collide with anything else in the system.
If this value is not provided then eVIP uses an internally calculated value.
string[0..1]
stackOnFixedNode = no
This attribute can be used to enable/disable stacking of FEE local IP's on fixed nodes in case there are no fixed nodes available to host the IP. Default value is no.
string[0..1]
readOnly
state
This is the state of the ALB. The state can be "ACTIVE" or "INACTIVE".
string[0..1]
udpEncapsulationPort = 0
Optional port number used for UDP encapsulation of IPsec packets, aka NAT traversal. If the value is 0 or the attribute is omitted, NAT-T is disabled. Recommended value is 4500 if not 0.

 

class EvipAlbs

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb [0..]

Container class for Abstract Load Balancers (ALBs).

Attributes
string[0..]
commands
DEPRECATED
An array of commands that are executed on all ALBs when they are activated. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher. The commands are executed on all LBEs, FEEs and payload nodes in all ALBs.


Deprecated: Planned to be deleted.

string
key
mandatory
noNotification
restricted
evipAlbsId
The RDN attribute. Always "1".

 

class EvipCluster

ManagedElement
+-Transport
+-Evip
+-EvipDeclarations
+-EvipCluster
+-EvipNode [0..]

Describes the cluster where EVIP is running.

Attributes
string[0..]
commands
An array of commands that are executed on all nodes when EVIP starts. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string[0..]
commandsForAllUndesignated
An array of commands that are executed on all undesignated nodes when EVIP starts. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipClusterId
RDN Attribute. Always "1".
string[0..1]
macvlanLinkLocalRangeStart = fe80::200:ff:feff:1
An ipv6 link-local range used for internal evip interfaces (evip_macvlan0). Evip uses IPVLAN when possible but resorts to MACVLAN if ipvlan is not supported by the kernel. If MACVLAN is used the specified link-local address range is used to create the MAC addresses for the macvlan interfaces.
string
primaryInterface = bond0
Names the interface to use for EVIP traffic. This interface should be redundant in some way for instance with bonding.

 

class EvipCommand

ManagedElement
+-Transport
+-Evip
+-EvipDeclarations
+-EvipCommandDefinition
+-EvipCommand

Defines a command to be used as a startup command. Startup commands may be defined at many places in the EVIP configuration. The actual shell command is defined here and is referred by its identity from other places.

Attributes
string
mandatory
command
This is the shell command to execute.
string
key
mandatory
noNotification
restricted
evipCommandId
The RDN attribute. This identity is used as reference at other places in the EVIP configuration when the command is used.

 

class EvipCommandDefinition

ManagedElement
+-Transport
+-Evip
+-EvipDeclarations
+-EvipCommandDefinition
+-EvipCommand [0..]

Container class for all command definitions.

Attributes
string
key
mandatory
noNotification
restricted
evipCommandDefinitionId
The RDN attribute. Always "1".

 

class EvipDeclarations

ManagedElement
+-Transport
+-Evip
+-EvipDeclarations
+-EvipCluster [0..1]
+-EvipCommandDefinition [0..1]

Container class for generic EVIP declarations.

Attributes
string
key
mandatory
noNotification
restricted
evipDeclarationsId
The RDN attribute. Always "1".

 

class EvipErsipParams

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipErsipParams
+-EvipParam [0..]

Container for the ALB specific RSIP parameters.

Attributes
string
key
mandatory
noNotification
restricted
evipErsipParamsId
RDN attribute. Always "1".

 

class EvipFee

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFees
+-EvipFee
+-EvipRoutingSetup [0..]
+-EvipSupervisedRemoteGateway [0..]

Defines a Front End Element (FEE).

Actions
void
activate ( );
Deprecated.
Activates the FEE. The FEE must be activated after the routing parameters have been updated. The current state can be examined in the "state" attribute.


Deprecated: Deprecated in eVIP 2.1

void
inactivate ( );
Deprecated.
Inactivates the FEE. The FEE must be inactive when routing parameters are updated. The current state can be examined in the "state" attribute.


Deprecated: Deprecated in eVIP 2.1

Attributes
string[0..]
commands
An array of commands that are executed on the FEE when the containing ALB is activated. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipFeeId
The RDN attribute. A unique name within the ALB.
string
mandatory
externalInterface
The name of the interface to the external DCN. The interfaces may have a appended VLAN tag, for instance "eth3.4711".
string[0..1]
extIfBridging = 1
Default true.
Indicate if a bridged interface shall be used in the FEE. If set to false the nic-interface (e.g. "eth1") will be moved into the FEE container and will become invisible in the main name space. This attribute shall be set to false when bridging external interfaces is not allowed, e.g. some cloud environments.
string
mandatory
node
The node-id of the node where the FEE is executing.
string[0..1]
readOnly
state
The state of the FEE. May be ACTIVE or INACTIVE.

 

class EvipFees

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFees
+-EvipFee [0..]

Container class for Front End Elements (FEEs).

Attributes
string[0..]
commands
An array of commands that are executed on all FEEs when the containing ALB is activated. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipFeesId
The RDN Attribute. Always "1".

 

class EvipFlowPolicies

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFlowPolicies
+-EvipFlowPolicy [0..]

Container Class for Flow Policies.

Attributes
string
key
mandatory
noNotification
restricted
evipFlowPoliciesId
The RDN attribute. Always "1".

 

class EvipFlowPolicy

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFlowPolicies
+-EvipFlowPolicy

Defines a Flow Policy. Incoming traffic selected by this Flow Policy must match all defined attributes (logical AND).

Attributes
string[0..1]
addressFamily
Incoming traffic with this address family is selected by this Flow Policy.

Obsolete: 

string
mandatory
dest
It specifies the destination VIP address identified either by its corresponding name (named reference to VIP address) or by explicit IP address value as configured in the EvipVIP managed object. The incoming packet traffic with this destination (local) IP address is selected by this Flow Policy.
string[0..1]
destPort
Incoming traffic with this (local) destination port is selected by this Flow Policy.
Only 15 distinct ports or port ranges can map to one sticky target pool. This is due to a hard limit in iptables. Flow policies that specify ports that are in a range are converted to a range. For example if there are three flow policies for destPort 80, 81 and 82 (otherwise identical and mapped to the same sticky target pool) these policies will be converted to one range 80-82. 15 such ranges (or individual ports) on one sticky target pool is the maximum.
string
key
mandatory
noNotification
restricted
evipFlowPolicyId
The RDN attribute. A unique name within the ALB.
string
mandatory
protocol
Defines the protocol for the Flow Policy: Supported values are;
"tcp"
"udp"
"sctp"
"other"
"all"
string[0..1]
soGrp
The socket group for this flow policy. The soGrp is used instead of a targetPool for certain protocols, for now only SCTP. soGrp and targetPool are mutually exclusive.
string[0..1]
src
Incoming traffic with this source (remote) network address is selected by this Flow Policy.
string[0..1]
srcPort
Incoming traffic with this source (remote) port is selected by this Flow Policy.
string[0..1]
targetPool
The name of the Target Pool within the containing ALB that receives traffic selected by this Flow Policy. soGrp and targetPool are mutually exclusive.
UsageState
noNotification
readOnly
usageState
Specifies whether Flow policy is currently deployed or not.

This depends if vip address is provided in corresponding VIP object

 

class EvipFmDummy

EvipFmDummy

Not used

Attributes
string
key
mandatory
noNotification
restricted
dummyId
-

 

class EvipLbe

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipLbes
+-EvipLbe

Defines a Load Balancing Element (LBE).

Attributes
string[0..]
commands
An array of commands that are executed on the LBE the containing ALB is activated. The commands are refered by their identity specified in the EvipCommandDefinition. The commands are preceeded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipLbeId
RDN attribute. A unique name within the ALB.
string
mandatory
node
The node-id of the node where the LBE is executing.

 

class EvipLbes

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipLbes
+-EvipLbe [0..]

Container class for Load Balancing Elements (LBEs)

Attributes
string[0..]
commands
An array of commands that are executed on all LBEs when the containing ALB is activated. The commands are refered by their identity specified in the EvipCommandDefinition. The commands are preceeded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipLbesId
The RDN attribute. Always "1".

 

class EvipNode

ManagedElement
+-Transport
+-Evip
+-EvipDeclarations
+-EvipCluster
+-EvipNode

Describes the logical EvipNode and how it is allocated to a processing unit (blade/VM) in the cluster.

Attributes
string[0..]
commands
An array of commands that are executed on this node when EVIP starts. The commands are refered by their identity specified in the EvipCommandDefinition. The commands are preceeded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher. The commands defined here are executed after any commands defined on cluster level.
string
distribution = fixed
Floating behavior of the EvipNode can be selected by setting distribution to FLOATING. This means that the EvipNode automatically is allocated, and reallocated if needed, to any vacant processing unit in the cluster. If this parameter is set to FIXED (default) the EvipNode will be allocated to a specific processing unit identified by Hostname.
string
key
mandatory
noNotification
restricted
evipNodeId
This is the RDN attribute. The node identities must be a consecutive integer value for all nodes. This identity is used to define node ranges, for instance "3-9" at other places in the EVIP configuration.
string[0..1]
floatPriority
This attribute is used to prioritize which EvipNodes to keep running in the case where fewer vacant processing units than the number of floating EvipNodes are available in the cluster. Lower value equals higher priority and the use of decimal numbers (floating point) is allowed. The attribute is only valid if distribution is set to FLOATING.
string[0..1]
hostname
This is the hostname of the processing unit (blade/VM) in the cluster where the EvipNode shall be located. It is just the simple hostname printed when the "hostname" command is executed, not the fully qualified domain name. The attribute is only valid if distribution is set to FIXED.
string[0..1]
primaryInterface
Obsolete (Not used any more)
Names the interface to use for EVIP traffic. This interface should be redundant in some way for instance with bonding. This should only be specified if the interface name on this particular node differs from the one specified on cluster level.


Obsolete: 

 

class EvipParam

ManagedElement
+-Transport
+-Evip
+-EvipParams
+-EvipParam
ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFees
+-EvipFee
+-EvipRoutingSetup
+-EvipParam
ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipErsipParams
+-EvipParam

Defines a generic parameter. This class is used on many places for defining various parameters.

Attributes
string
key
mandatory
noNotification
restricted
evipParamId
The RDN attribute. This is the parameter name or "key".
string
mandatory
value
The parameter value.

 

class EvipParams

ManagedElement
+-Transport
+-Evip
+-EvipParams
+-EvipParam [0..]

Container class for generic EVIP parameters.

Attributes
string
key
mandatory
noNotification
restricted
evipParamsId
The RDN attribute. Always "1".

 

class EvipPayload

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipTargetPools
+-EvipTargetPool
+-EvipPayload

Defines a payload node in a Target Pool.

Attributes
string[0..]
commands
An array of commands that are executed on this node when EVIP starts. The commands are referred by their identity specified in the EvipCommandDefinition. The commands are preceded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipPayloadId
The RDN attribute. This specifies the node-id or a node-id range.
string[0..1]
weight
For weighted distribution methods this is an integer value defining the "weight" of the payload node. Id the distribution method is non-weighted this attribute is ignored.

 

class EvipPortRange

ManagedElement
+-Transport
+-Evip
+-EvipPortRanges
+-EvipProtocol
+-EvipPortRange

Defines a Port Range.

Attributes
string[0..1]
blocksize
OBSOLETE. Blocksize=64 (fixed value)

Obsolete: 

string
key
mandatory
noNotification
restricted
evipPortRangeId
The RDN attribute. The port range. This must be a port range, for instance "1-32767".

Please see restrictions on allowed ranges in the EVIP Management Guide.
string
type = wellknown
The range type. Must be "wellknown".

 

class EvipPortRanges

ManagedElement
+-Transport
+-Evip
+-EvipPortRanges
+-EvipProtocol [0..]

Container for port-ranges. The ranges are defined per protocol.

Attributes
string
key
mandatory
noNotification
restricted
evipPortRangesId
The RDN, always "1"

 

class EvipProtocol

ManagedElement
+-Transport
+-Evip
+-EvipPortRanges
+-EvipProtocol
+-EvipPortRange [0..]

Container class for Port Ranges.

Attributes
string
key
mandatory
noNotification
restricted
evipProtocolId
The RDN attribute. Defines the protocol for the cotained port ranges. Supported values are;
"tcp"
"udp"
"sctp"
"other"
"all"

 

class EvipRoutingSetup

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFees
+-EvipFee
+-EvipRoutingSetup
+-EvipParam [0..]

Contains routing setup parameter for a specific routing protocol.

Attributes
string
key
mandatory
noNotification
restricted
evipRoutingSetupId
The RDN attribute. This attribute specifies the routing protocol. The supported protocols are;
"ospfv2"
"bfd_ospfv2"
"ospfv3"
"bfd_ospfv3"
"bfd_static"
"bfd_static6"
"static"
"static6"
For the specific routing parameters please see the "EVIP Management Guide"

 

class EvipSe

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipSes
+-EvipSe

IP-sec related

Attributes
string[0..] nonUnique
commands
An array of commands that are executed the SE when the containing ALB is activated. The commands are refered by their identity specified in the EvipCommandDefinition. The commands are preceeded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipSeId
This is the RDN attribute. This must be an unique name within the alb.
string
mandatory
node
The node-id of the node where the SE is executing.

 

class EvipSelectionPolicies

ManagedElement
+-Transport
+-Evip
+-EvipSelectionPolicies
+-EvipSelectionPolicy [0..]

Container class for Selection policies.

Attributes
string
key
mandatory
noNotification
restricted
evipSelectionPoliciesId
The RDN attribute. Always "1".

 

class EvipSelectionPolicy

ManagedElement
+-Transport
+-Evip
+-EvipSelectionPolicies
+-EvipSelectionPolicy

Defines a Selection Policy. Traffic selected by a Selection Policy in this ALB is directed to this ALB.
Traffic selected by this Selection Policy must match all defined attributes (logical AND).

Attributes
string
mandatory
alb
Traffic selected by this policy is directed towards this ALB.
string[0..1]
bindPort
OBSOLETE (value ignored)
Incoming traffic to this port is selected by this selection policy.
This attribute is only checked if an application makes a "bind" to the ANY address.


Obsolete: 

string[0..1]
dest
OBSOLETE (value ignored)
Outgoing traffic with this (remote) address or subnet is selected by this Selection Policy.


Obsolete: 

string[0..1]
destPort
OBSOLETE (value ignored)
Outgoing traffic with this (remote) port is selected by this Selection Policy.


Obsolete: 

string[0..1]
env
OBSOLETE (value ignored)

Obsolete: 

string
key
mandatory
noNotification
restricted
evipSelectionPolicyId
The RDN attribute. The name must be unique.
string[0..]
payloadNode
OBSOLETE (value ignored)
A multivalue attribute that defines the payload nodes where this Selection Policy is applied.


Obsolete: 

string[0..1]
process
Taffic to or from this process is selected by this Selection Policy.
string[0..1]
protocol
OBSOLETE (value ignored)
The level 4 protocol. Supported values are;
"tcp"
"udp"
"sctp"
"other"
"all"


Obsolete: 

string
mandatory
sortorder
This must be a floating point number. The SelectionPolicies are ordered and are applied lowest->highest. This attribute defines the order. If more than one SelectionPolicy has the same value in this attribute the order is unspecified.

 

class EvipSes

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipSes
+-EvipSe [0..]

Container for se-objects

Attributes
string[0..] nonUnique
commands
An array of commands that are executed on all SEs when the containing ALB is activated. The commands are refered by their identity specified in the EvipCommandDefinition. The commands are preceeded by a floating point order number and a colon, for example "1.0:defroute". The commands are executed in order lower to higher.
string
key
mandatory
noNotification
restricted
evipSesId
The RDN attribute. Always "1"

 

class EvipSupervisedRemoteGateway

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipFees
+-EvipFee
+-EvipSupervisedRemoteGateway

Defines an external gateway to supervise. This gateway may for instance be a router essential for EVIP traffic. If EVIP loses contact with the gateway an alarm is raised.

Attributes
string[0..1]
description
This is an optional description defined by the operator. The purpose of this attribute is to simplify the procedure when an alarm is raised for this gateway. The operator receiving the alarm for this gateway should open this object and read the description attribute for more information about the gateway. This attribute can for instance contain the location or identiry of the gateway, or a local contact person or any other useful information.
string
key
mandatory
noNotification
restricted
evipSupervisedRemoteGatewayId
The RDN attribute. This is the IP-address of the supervised gateway.

 

class EvipTargetPool

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipTargetPools
+-EvipTargetPool
+-EvipPayload [0..]

Defines a Target Pool.

Attributes
string[0..1]
allUndesignated = 0
True if any undesignated node will belong to this target pool. Used for cloud floating node configuration.
string
distributionMethod = round_robin
The distribution method. Supported values are;
"round_robin"
"weighted_round_robin"
"least_connection"
"weighted_least_connection"
"locality_based_least_connection"
"locality_based_least_connection_with_replication"
"destination_hash"
"source_hash"
"shortest_expected_delay"
"never_queue"

OBSOLETE values:
"strict_round_robin"
"strict_weighted_round_robin"
"strict_least_connection"
"strict_weighted_least_connection"
"strict_shortest_expected_delay"
"strict_never_queue"
string
key
mandatory
noNotification
restricted
evipTargetPoolId
The RDN attribute. This is a unique name within the ALB. This name is used in Flow Policies that selects traffic to this Target Pool.
string[0..1]
stickinessTimeout = 0
Decides the time in seconds a connection shall be persistent.
string[0..1]
stickyGroup = true
Stickiness means that all network traffic form one remote host is distributed to the same node. This may for instance be necessary to hold together a HTTP session consisting of multiple connections. Stickiness could however cause poor distribution if you have a dominant source and is to be avoided if possible.
string[0..1]
udpStateless = false
Decides if UDP traffic should be semi-persistant or totaly stateless. Should be used if "packet-sprayer" is needed for UDP.

 

class EvipTargetPools

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipTargetPools
+-EvipTargetPool [0..]

Container class for Target Pools.

Attributes
string
key
mandatory
noNotification
restricted
evipTargetPoolsId
RDN attribute. Always "1".

 

class EvipVip

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipVips
+-EvipVip

Defines a Virtual IP address (VIP)

Actions
void
activate ( );
Activates the VIP. The current state can be examined in the "state" attribute.
void
deactivate ( );
Deactivates the VIP.

Attributes
IpDNSAddress[0..1]
address
The real VIP address to use if evipVipId specifies the VIP by name.
Note: Not used if EvipVipId is configured with an explicit IP address for the VIP.
string[0..1]
autoActivate = 1
True if the vip shall be announced (activated) at startup and creation.
string[0..1]
deflt
OBSOLETE (value ignored)
Identifies the default VIP. Only one VIP in the containing ALB must have this attribute set to "true"


Obsolete: 

string[0..1]
equivSrcAddr = 0
True if this address can be used for alias feature.
string
key
mandatory
noNotification
restricted
evipVipId
The RDN attribute.
VIP addresses can be specified in two alternative ways. Either by explicit IP address or specified by name, that is, by a named reference. The names must be unique within the scope of an ALB.
The value configured here can either be an explicitly given IPv4 or IPv6 address or a named reference to the actual IP address. When a named reference is used, the actual IP address is configured within this same managed object in the vipAddr attribute.
For example, the IPv4 address 10.1.1.4 can be explicitly given here with its numerical dot notation syntax, or alternatively be given here implicitly through a named reference to the actual IP address.
The value of evipVipId attribute can be used to identify a VIP address in Flow Policy configuration. For example, a VIP address specified by name.
string[0..1]
readOnly
state
This is the state of the VIP. The state can be "ACTIVE", "INACTIVE" or "PENDING".

 

class EvipVips

ManagedElement
+-Transport
+-Evip
+-EvipAlbs
+-EvipAlb
+-EvipVips
+-EvipVip [0..]

Container class for Virtual IP addresses (VIPs).

Attributes
string
key
mandatory
noNotification
restricted
evipVipsId
The RDN attribute. Always "1".

 

class EvipXfrmSelectionPolicies

ManagedElement
+-Transport
+-Evip
+-EvipXfrmSelectionPolicies
+-EvipXfrmSelectionPolicy [0..]

Container class for Xfrm Selection policies.

Attributes
string
key
mandatory
noNotification
restricted
evipXfrmSelectionPoliciesId
RDN attribute, always "1".

 

class EvipXfrmSelectionPolicy

ManagedElement
+-Transport
+-Evip
+-EvipXfrmSelectionPolicies
+-EvipXfrmSelectionPolicy

Xfrm Alb selection policy. This is used to redirect XFRM (IPSec) configuration settings to a particular ALB (rather than the local Linux kernel).
For further information please see the EVIP Management Guide.

Attributes
string
mandatory
alb
The ALB that handles traffic selected by this policy.
string[0..1]
default
If default=yes, this policy will apply to any process name and any value of EVIP_XALB. But selection policies with a lower order value can still override this policy.
string[0..1]
env
Set the EVIP_XALB environment variable to this value to use this policy.
string
key
mandatory
noNotification
restricted
evipXfrmSelectionPolicyId
The RDN attribute, must be a unique name.
string[0..1]
local
OBSOLETE!
Replaced by the "storage" attribute.


Obsolete: 

string[0..1]
order
The order of the selection policy as a floating point number. The selection plicy with lowest order is used if multiple policies match.
string[0..] nonUnique
payloadNode
Optional integer, denoting the payload node where this parameter is valid. If the eVIP configuration contains floating nodes, this parameter must be empty, and every XFRM ALB selection policy has an effect on every blade.
string[0..1]
process
The name of the process this policy maps to.
string[0..1]
storage
How IPsec objects are stored.
"local"=use local linux kernel
"node"=accessible from inserter node only. Not supported on floating nodes.
"alb"=accessible from whole ALB.
Please see the EVIP Management Guide for more information.

 

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 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 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 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 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 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 FileTPM

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-FtpServer [0..1]
+-FtpTls [0..1]
+-Sftp [0..1]

The top class for server and client configuration of different protocols implementing file transfer.
Lists the protocols supported by the ME by any file transfer client or server.


This MO is created by the system.

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

 

class FlexibleDiameter

ManagedElement
+-PolicyControlFunction
+-FlexibleDiameter
+-AVP [0..]

Container to configure AVPs used in Diameter flexible transformations.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
flexibleDiameterId
Identifies the instance of this class. Forced value = 1.

 

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 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 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 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 FtpServer

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-FtpServer
+-FtpTlsServer [0..1]
+-SftpServer [0..1]

Generic configuration options for a file transfer server.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
ftpServerId
The value component of the RDN.
uint16[0..1]
idleTimer { 1.. }
The amount of seconds after which an idle session is terminated.

Specifies the maximum time an FTP session may remain idle. A session will be dropped if the length of the idle session exceeds the configured time. No idleTimer means idle sessions are not limited.


Unit: 1 seconds

 

class FtpTls

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-FtpTls

Represents the common configuration parameters of FTP over Transport Layer Security (TLS) clients on the ME.




This MO is created by the system.

References to:
ManagedObject;
Attributes
string
key
mandatory
noNotification
restricted
ftpTlsId
The value component of the RDN.
ManagedObject[0..1]
nodeCredential
The credential used for FTP over TLS based file transfer.
Specifies the DN of a NodeCredential MO in Certificate Management.
ManagedObject[0..1]
trustCategory
The set of certificates trusted by the FTP over TLS based file transfer.
Specifies the DN of a TrustCategory MO in Certificate Management.

 

class FtpTlsServer

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-FtpServer
+-FtpTlsServer

Represents the FTP over Transport Layer Security (TLS) server of the ME.

The server only accepts FTP sessions that are explicitly requesting a TLS layer by the "AUTH TLS" command.


This MO is created by the system.

References to:
ManagedObject;
Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the FTP server.
When LOCKED all on-going connections will immediately be terminated.
string
key
mandatory
noNotification
restricted
ftpTlsServerId
The value component of the RDN.
uint16
mandatory
maxDataPort
The maximum port number for PASV data connections.

Must be greater or equal to minDataPort.
uint16
mandatory
minDataPort
The minimum port number for PASV data connections.

Must be lower or equal to maxDataPort.
ManagedObject[0..1]
nodeCredential
The credential used for FTP over TLS based file transfer.
Specifies the DN of a NodeCredential MO in Certificate Management.
uint16
port = 21
The listening port number of the FTP over TLS server control connection.

The TLS layer is established on the regular FTP port by issuing an "AUTH TLS" command.
ManagedObject[0..1]
trustCategory
The set of certificates trusted by the FTP over TLS based file transfer.
Specifies the DN of a TrustCategory MO in Certificate Management.

 

class GeoRedManager

ManagedElement
+-PolicyControlFunction
+-GeoRedManager

Holds the SAPC geographical redundancy configuration data.

This MO is created by the system.

Actions
string
giveback ( );
In active-standby configuration sets the local SAPC as active.
It has to be executed in preferred SAPC. This action is not available in a geored active-active configuration.
string
setConfig ( boolean preferred );
Set preferred cluster in a Geored environment.

Parameters

Name: preferred
Description: preferred = [true | false].

string
showConfiguration ( );
Shows configuration parameters related to Geored.
string
start ( string state );
Starts the replication in the SAPC.
The parameter 'state' is mandatory in active-standby configuration and it indicates if the data mirroring (replication) is initiated as active or standby. This parameter is not available in active-active configuration.

Parameters

Name: state
Description: state values = [active|standby].

string
stop ( );
Stops the replication in the SAPC.

Attributes
GeoRedState[0..1]
noNotification
readOnly
currentState
Indicates the current status of the local SAPC in a geographical redundancy deployment.
string
key
mandatory
noNotification
restricted
geoRedManagerId
Identifies the instance of this class. Forced value = 1.
string[0..1]
lastOperationDetailedInfo
Detailed information about last executed operation.
GeoRedAction[0..1]
lastOperationExecuted
Indicates the last action executed.
GeoRedActionStatus[0..1]
lastOperationStatus
Indicates the status of the last action executed.
DateTime[0..1]
noNotification
readOnly
lastTransitionState
Indicates the timestamp of the last transition between states.
GeoRedState[0..1]
noNotification
readOnly
previousState
Indicates the previous status of the local SAPC in a geographical redundancy deployment.

 

class Host

ManagedElement
+-Transport
+-Host
+-Ikev1PolicyProfile [0..]
+-Ikev2PolicyProfile [0..]
+-IpsecProposalProfile [0..]
+-IpsecTunnel [0..]

Representation of an IP domain for traffic termination.



This MO is created by the system.

References to:
ManagedElement;
Attributes
string
key
mandatory
noNotification
restricted
hostId
Value component of the RDN.
ManagedElement
mandatory
restricted
l3Ref
Reference to an eVIP ALB
string[0..1]
userLabel
Label for free use.

 

class Ikev1PolicyProfile

ManagedElement
+-Transport
+-Host
+-Ikev1PolicyProfile

Common information for multiple IKE sessions to be instantiated on a managed element.

One or more Ikev2Session instances might refer to this instance.

References from:
Ikev1Session;
References to:
ManagedObject;
Attributes
ConnectionType
restricted
connectionType = BOTH
Connection type of the IKEv1 session.
ManagedObject[0..1]
restricted
credential
Reference to the managed element own credential to be used in IKEv1 negotiation.

Valid reference is NodeCredential in Certificate Management Branch.


If credential and trustCategory are not specified, then preshared key-based authentication is selected. The referring Ikev1Session instances must have preshared keys installed.
uint32
restricted
dpdKeepAliveInterval = 30
dpdKeepAliveInterval defines the time interval between R_U_THERE messages sent to the IKE peer.

Unit: 1 secs
uint32
restricted
dpdTime = 150
Time to detect an IKE SA is down.

If the SA is down, an attempt is made to re-establish the SA.
If this attempt fails, an alarm is issued.


Unit: 1 secs
Identity[0..1]
restricted
identityLocal
Local identity.

If the local identity is not configured, it is automatically configured in the system as follows:

a) In case of certificate based authentication, the local identity is set to the same value as specified by the subject alt name in the certificate that the node use.
b) In case of preshared key-based authentication, the local identity is set to the local IP address of the tunnel.
string
key
mandatory
noNotification
restricted
ikev1PolicyProfileId
Value component of the RDN.
Ikev1Proposal[1..] nonUnique ordered
mandatory
restricted
ikev1Proposal
Ordered list of IKE transforms (proposals) to be used for IKE SA negotiation.

At least one IKE transform must be specified. The first one in the list has the highest priority.
uint32
restricted
phase1SaLifetime = 180
Lifetime for Phase 1 SA.

Unit: 1 mins
ManagedObject[0..1]
restricted
trustCategory
Reference to a trusted certificates group.

Valid reference is TrustCategory in Certificate Management Branch.


If credential and trustCategory are not specified, then pre-shared key based authentication is selected. The referring Ikev1Session instances have to have pre-shared keys installed.
string[0..1]
restricted
userLabel
Label for free use.

 

class Ikev1Session

ManagedElement
+-Transport
+-Host
+-IpsecTunnel
+-Ikev1Session

Runtime information on IKEv2 session.

References to:
Ikev1PolicyProfile;
Actions
void
installPreSharedKey ( string presharedKey );
Install a preshared key for this IKEv1 session.

If both credential and trustCategory have valid references, then the preshared key is not used even if it is installed.

Parameters

Name: presharedKey
Description: String used as presharedkey.

Attributes
Identity[0..1]
restricted
identityRemote
Identity of the IKEv1 peer.

If identityRemote is not specified, the session will validate the remote IKE identify as follows:

a) In case of certificate based authentication, the peer’s IKE ID must be consistent with either the subject alt name or the subject field in the peers certificate;
b) In case of pre-shared key based authentication, the peer's IKE ID must be consistent with the configured IP address of the peer.
Ikev1PolicyProfile
mandatory
restricted
ikev1PolicyProfile
Reference to an IKE profile instance.
string
key
mandatory
noNotification
restricted
ikev1SessionId
Value component of the RDN.
string[0..1]
restricted
userLabel
Label for free use.

 

class Ikev2PolicyProfile

ManagedElement
+-Transport
+-Host
+-Ikev2PolicyProfile

Common information for multiple IKE sessions to be instantiated on a managed element.

One or more Ikev2Session instances might refer to this instance.

References from:
Ikev2Session;
References to:
ManagedObject;
Attributes
ConnectionType
restricted
connectionType = BOTH
Connection type of the IKEv2 session.
ManagedObject[0..1]
restricted
credential
Reference to the managed element own credential to be used in IKEv2 negotiation.

Valid reference is a NodeCredential in Certificate Management Branch.


If credential and trustCategory are not specified, then preshared key-based authentication is selected. The referring Ikev2Session instances must have preshared keys installed.
uint32
restricted
dpdKeepAliveInterval = 30
The keep alive interval with which INFORMATIONAL exchanges are sent to the peer.


Unit: 1 secs
Identity[0..1]
restricted
identityLocal
Local identity.

If the local identity is not configured, it is automatically configured in the system as follows:

a) In case of certificate based authentication, the local identity is set to the same value as specified by the subject alt name in the certificate that the node use.
b) In case of preshared key-based authentication, the local identity is set to the local IP address of the tunnel.
uint32
restricted
ikeSaLifetime = 180
Lifetime for IKE SA.

Unit: 1 mins
string
key
mandatory
noNotification
restricted
ikev2PolicyProfileId
Value component of the RDN.
Ikev2Proposal[1..] nonUnique ordered
mandatory
restricted
ikev2Proposal
Ordered list of IKE proposals to be used for IKE SA negotiation.

At least one IKE proposal must be specified. The first one in the list has the highest priority.
ManagedObject[0..1]
restricted
trustCategory
Reference to a trusted certificates group.

Valid reference is TrustCategory in Certificate Management Branch.


If credential and trustCategory are not specified, then pre-shared key based authentication is selected. The referring Ikev2Session instances have to have pre-shared keys installed.
string[0..1]
restricted
userLabel
Label for free use.

 

class Ikev2Session

ManagedElement
+-Transport
+-Host
+-IpsecTunnel
+-Ikev2Session

Ikev2Session is used to specify that IKEv2 should be used to negotiate SA’s for the tunnel.

It contains parameters specific to the IKEv2 protocol.

References to:
Ikev2PolicyProfile;
Actions
void
installPreSharedKey ( PresharedKey presharedKey );
Install a preshared key for the IKEv2 session.

The installation of the pre-shared key is completed if the action is completed without error. Any error returned by the action indicates that the installation is not performed.
If both credential and trustCategory have valid references, then the preshared key is not used even if it is installed.

Parameters

Name: presharedKey
Description: String used as presharedkey.

Attributes
Identity[0..1]
restricted
identityRemote
Identity of the IKEv2 peer.

If identityRemote is not specified, the session will validate the remote IKE identify as follows:
a) In case of certificate based authentication, the peer’s IKE ID must be consistent with either the subject alt name or the subject field in the peers certificate;
b) In case of pre-shared key based authentication, the peer's IKE ID must be consistent with the configured IP address of the peer.
Ikev2PolicyProfile
mandatory
restricted
ikev2PolicyProfile
Reference to an IKE policy profile instance.
string
key
mandatory
noNotification
restricted
ikev2SessionId
Value component of the RDN.
string[0..1]
restricted
userLabel
Label for free use.

 

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 IpsecPolicy

ManagedElement
+-Transport
+-Host
+-IpsecTunnel
+-IpsecPolicy

Holds configuration information for Ipsec policies.

References to:
IpsecProposalProfile;
Attributes
string
key
mandatory
noNotification
restricted
ipsecPolicyId
Value component of the RDN.
IpsecProposalProfile
mandatory
restricted
ipsecProposalProfile
Reference to an Ipsec transform profile.
TrafficSelector[0..] nonUnique ordered
restricted
localTrafficSelector
Ordered list of traffic selectors to be used for SA negotiation.

If localTrafficSelector is not specified, it means that all the local addresses and subnets within the current routing domain are included.
The first in the list has the highest priority.
TrafficSelector[0..] nonUnique ordered
restricted
remoteTrafficSelector
Ordered list of traffic selectors to be used for SA negotiation.

If remoteTrafficSelector is not specified, it means wildcard(i.e. any possible IP address, protocol etc).

The first in the list has the highest priority.
string[0..1]
restricted
userLabel
Label for free use.

 

class IpsecProposalProfile

ManagedElement
+-Transport
+-Host
+-IpsecProposalProfile

Configuration information for Ipsec policies.

References from:
IpsecPolicy; Phase2Policy;
Attributes
ChildSaLifetime
restricted
childSaLifetime
Lifetime for the negotiated ChildSAs.
IpsecProposal[1..] nonUnique ordered
restricted
ipsecProposal
An ordered list of Ipsec transforms to be proposed during IKEv2 negotiation.
string
key
mandatory
noNotification
restricted
ipsecProposalProfileId
Value component of the RDN.
string[0..1]
restricted
userLabel
Label for free use.

 

class IpsecTunnel

ManagedElement
+-Transport
+-Host
+-IpsecTunnel
+-Ikev1Session [0..1]
+-Ikev2Session [0..1]
+-IpsecPolicy [0..]
+-Phase2Policy [0..]

Configuration and runtime information of an Ipsec tunnel between two end points.

Attributes
string
key
mandatory
noNotification
restricted
ipsecTunnelId
Value component of the RDN.
IpAddress
mandatory
restricted
localAddressStr
Tunnel local endpoint assigned IP address.

Rule: The local and remote address must have the same address family and belong to the same routing domain.
IpAddress
mandatory
restricted
remoteAddressStr
Tunnel remote end point external IP address.

Rule: The local and remote address must have the same address family and belong to the same routing domain.
string[0..1]
restricted
userLabel
Label for free use.

 

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 NeLS.


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 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 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 LdeAlarmConf

LdeAlarmConf

Specifies the threshold for an alarm

Attributes
AlarmType
key
mandatory
noNotification
restricted
alarmTypeId
percent
mandatory
threshold
Threshold for the alarm (in %). See the Operating Instruction (OPI) of the alarm in question for more information.

 

class LdeBondingConf

LdeBondingConf

Set driver parameters for the specified bonding interface. The bonding mode should be set at the interface definition

Attributes
Enum012[0..1]
adSelect
0 | 1 | 2
Enum01[0..1]
allSlavesActive
0 | 1
IPv4v6Address[0..]
arp
Switches to Address Resolution Protocol (ARP) monitoring for a bonding interface.
uint32[0..1]
arpInterval
Specifies the ARP link monitoring frequency in milliseconds.
Enum0123[0..1]
arpValidate
Specifies whether or not ARP probes and replies should be validated in the active-backup mode. (0 | 1 | 2 | 3)
string
key
mandatory
noNotification
restricted
bondingId
bondingId=interface
uint32[0..1]
downdelay
Specifies the time, in milliseconds, to wait before disabling a slave after a link failure has been detected.
Enum012[0..1]
failOverMac
0 | 1 | 2
Enum01[0..1]
lacpRate
0 | 1
uint32[0..1]
miimon
Specifies the MII link monitoring frequency in milliseconds.
Uint0255[0..1]
numGratArp
0-255
string[0..1]
primary
Specifies which slave is the primary device to use.
Enum012[0..1]
primaryReselect
0 | 1 | 2
Uint0255[0..1]
resendIgmp
0-255
uint32[0..1]
updelay
Specifies the time, in milliseconds, to wait before enabling a slave after a link recovery has been detected.
Enum01[0..1]
useCarrier
0 | 1
Enum012[0..1]
xmitHashPolicy
0 | 1 | 2

 

class LdeBootServerConf

LdeBootServerConf

Defines attributes for the bootserver property

Attributes
string
key
mandatory
noNotification
restricted
bootServerNameId
IPv4v6Address[0..]
masterIp
Defines the tftp server ip when running the boot server in slave mode.
string[1..]
mandatory
mipName [ 1..253 ]
Defines which mip the boot server should use to serve tftp. Can be defined several times to support both several networks but also to support the shared mode.
BootServerMode
mandatory
mode
Bootserver mode
StringName[1..]
mandatory
network
Defines which network the boot server is serving. Can be defined several times if the boot server should serve several networks
StringName[1..]
mandatory
servingBlades
Defines how the bootserver will be segmented. Can be set to 'all' to indicate a bootserver should serve all blades

 

class LdeConfig

LdeConfig

ClusterConf class

Attributes
string
key
mandatory
noNotification
restricted
ldeConfigId

 

class LdeDnsConf

LdeDnsConf

Specifies an external DNS server.

Attributes
IP_DNS_Address
mandatory
address
uint32
key
mandatory
noNotification
restricted
dnsId

 

class LdeGeneralConf

LdeGeneralConf

GeneralConf class

Attributes
Enum01
dscpFeature = 0
dscp feature is disable if 0, enable if 1
EnumOnOff[0..1]
enableStorageResize
In a Cloud deployment where the disk size can be increased after deployment, enable the automatic resize of the cluster filesystem to utilize all available space on disk
string
key
mandatory
noNotification
restricted
generalConfId
IPv4Address
mandatory
nfsAddress
Defines the IP address of the NFS server that all blades should use.
EnumOnOff[0..1]
nfsManageGids
Configures how the group memberships of users accessing files over LDE's NFS client should be determined
string[0..1]
ntpLargeSteps [ 2..3 ]
Valid values: ^on|off$
string[0..1]
ntpSlew [ 2..3 ]
Valid values: ^on|off$
EnumOnOff[0..1]
rpmPostErrors
Configures how errors generated by commands executed in the %post section of user-installed RPMs will be handled.
string[0..]
selectedCiphers
string[0..]
selectedKeyExchanges
string[0..]
selectedMacs
string[0..1]
timeZone
Defines the time zone of the cluster.

 

class LdeHaiadConf

LdeHaiadConf

Defines a HAIAD monitored network

Attributes
string[1..]
mandatory
devices [ 1..253 ]
Physical interfaces to run HAIAD over.
string
key
mandatory
noNotification
restricted
haiadId
IPv4v6Address
mandatory
ipAddress
IP-address for target or "dynamic" for dynamic assignment.

 

class LdeHostConf

LdeHostConf

Defines a host entry in the /etc/hosts file

Attributes
IPv4v6Address
mandatory
hostAddress
IP address of the host.
string
key
mandatory
noNotification
restricted
hostnameId

 

class LdeInterfaceConf

LdeInterfaceConf

Defines a network interface for a node, either a physical, bonding, alias, Virtual Local Area Network (VLAN) or Media Access Control (MAC) VLAN interface.

Attributes
MACAddress[0..1]
address
Physical address of device.
BondingMode[0..1]
bondingMode
The bonding mode to use on the bonding interface.
string
key
mandatory
noNotification
restricted
interfaceId
InterfaceType
mandatory
interfaceType
Interface type
string[0..1]
parent [ 1..253 ]
Physical interface to use as MAC VLAN base.
string[0..]
slaves [ 1..253 ]
Interfaces to bond together.

 

class LdeIpConf

LdeIpConf

Defines an IP address for an interface.

Attributes
IPv4v6Address
mandatory
ipAddress
IP address. Both IPv4 and IPv6 addresses are accepted.
uint32
key
mandatory
noNotification
restricted
ipId
To avoid using index when add/change/delete, we combine interface and network as a key, for example ipId=interface@@network. Using either interface or netwrok as key is not enough but we have to combine them to make a unique key.
string
mandatory
network [ 1..253 ]
Network the IP address belongs to.

 

class LdeIpInterfaceConf

LdeIpInterfaceConf

Attributes
string
key
mandatory
noNotification
restricted
ipInterfaceId
Interface

 

class LdeIpmiConf

LdeIpmiConf

Defines power management using Intelligent Platform Management Interface (IPMI).

Attributes
IPv4v6Address
key
mandatory
noNotification
restricted
ipmiAddressId
string[0..1]
password [ 1..253 ]
Password to authenticate towards the IPMI controller. Must be coordinated with the IPMI configuration made in e.g. BIOS of the blade.
string
mandatory
username [ 1..253 ]
User to authenticate towards the IPMI controller. Must be coordinated with the IPMI configuration made in e.g. BIOS of the blade.

 

class LdeIptablesConf

LdeIptablesConf

Defines a rule in iptables.

Attributes
string
mandatory
command
uint32
key
mandatory
noNotification
restricted
iptablesId
string
mandatory
target

 

class LdeIptablesVersionConf

LdeIptablesVersionConf

Defines the IP tables version to use

Attributes
uint32
key
mandatory
noNotification
restricted
iptablesVersionId
- 4: IP tables v4
- 6: IP tables v6

 

class LdeMipConf

LdeMipConf

Defines a movable IP address and associates it with a symbolic name.

Attributes
IPv4v6Address
mandatory
address
IP address.
string
mandatory
interface [ 1..253 ]
string
key
mandatory
noNotification
restricted
mipNameId
string
mandatory
network [ 1..253 ]
Network the IP address belongs to.

 

class LdeNetConsoleConf

LdeNetConsoleConf

Defines a network console destination. All console messages will be sent to the destination address and port as plain-text UDP traffic.

Attributes
uint32
key
mandatory
noNotification
restricted
netConsoleId
netConsoleId=interface
IPv4v6Address
mandatory
targetAddress
The port of the destination.
NetConsoleMAC[0..1]
targetMAC
The MAC address of the destination.
TCPIPPortRange
mandatory
targetPort
The port of the destination.

 

class LdeNetworkConf

LdeNetworkConf

Defines a network with a name together with its network address and prefix.

Attributes
NetworkAddress
mandatory
networkAddress

The address of the network. Both IPv4 and IPv6 addresses are accepted.
string
key
mandatory
noNotification
restricted
networkNameId

 

class LdeNodeConf

LdeNodeConf

Defines a blade in the cluster and gives it a role and an identity, either a control blade or a payload blade.

Attributes
CoredumpSize[0..1]
coredumpSize
Specifies the default core dump size for processes
DefaultOutput[0..1]
defaultOutput
Specifies if the console is to default to a serial or Video Graphics Adapter (VGA) output for the whole cluster
EnumOnOff[0..1]
disableSerial
Disables the serial console for the whole cluster. In contrast to default-output, which sets what the system is to default to, disable-serial removes the serial console option completely
StringName[0..]
groupMember
The id(s), role(s), or node group(s) that will be added to the node group.
StringName
mandatory
hostname
metavar="<host name>" var="hostname" type=string ranges=None choices=None regex=None regex_help=None nargs=? show=1 add=1 change=1 delete=1 requisite=None help="Host name of the blade. If no host name is defined for the blade, it will be assigned as node<id>."
string[0..1]
kernelCmdline
Defines the command line parameters to be given to the kernel on a blade in the cluster.
string[0..1]
keymap
Defines the keymap to be used on a blade in the cluster.
GroupFunction
nodeFunction = node
string
key
mandatory
noNotification
restricted
nodeId
EnumOnOff[0..1]
quickReboot
Specifies if a node or nodes are to use quick reboot or not.
uint32[0..1]
ramRootfsSize
Configures the size of the root filesystem in RAM. Not applicable for blades running with the disk_cache installation option.
string[0..] ordered
serialConsole
Serial Console port(s) to be used
uint32[0..1]
shutdownTimeout
Sets how long the system will wait after a shutdown has begun until a forced reboot is done.
string[0..]
ssh [ 1..255 ]
Restrict SSH to listen to a specific network.
TCPIPPortRange[0..1]
sshPort
The port that the SSH service should listen for connections on, instead of the default 22.
EnumOnOff[0..1]
sshRootLogin
Disable root login over the SSH connection.
NodeType[0..1]
type
metavar="<node type>" var="nodetype" type=string ranges=None choices="control payload" regex=None regex_help=None nargs=1 show=1 add=1 change=0 delete=0 requisite=None help="Node type i.e control or payload"
WatchdogType[0..1]
watchdogType
Defines the default or fallback watchdog to use.

 

class LdeNodeOiConf

LdeNodeOiConf

Attributes
string
key
mandatory
noNotification
restricted
nodeId
uint32
oiReady = 0

 

class LdeNtpServerConf

LdeNtpServerConf

Defines an external NTP server.

Attributes
NtpAdministrativeState
administrativeState = LOCKED
Administative state of NTP server
uint32
key
mandatory
noNotification
restricted
ntpServerId
IP_DNS_Address
mandatory
serverAddress
NTP server address
string[0..1]
userLabel
Symbolic name of NTP server address

 

class LdePropertyConf

LdePropertyConf

Assigns a specific property to the target node(s)

Attributes
string
key
mandatory
noNotification
restricted
propertyId
propertyId=<propertyName,nodeId=ID,ldeConfigId=1>
string[1..]
mandatory
propertyValue

 

class LdeRouteConf

LdeRouteConf

Defines a IP network route.

Attributes
RouteGatewayAddress[0..1]
gateway
IP address or host name of the gateway.
string[0..1]
interface
Name of the interface to route through packets.
string
mandatory
networkName [ 1..253 ]
Name of the network that should be routed.
uint32
key
mandatory
noNotification
restricted
routeId
IPv4v6Address[0..1]
sourceAddress
IP source address that should be set when using the route.

 

class LdeScalingConf

LdeScalingConf

Configures the DHCP server to enable scaling.

Attributes
string[0..1]
bootServer [ 1..253 ]
A boot server that will issue temporary IP(s) to scaled blade(s).
IPv4v6Address
mandatory
ipFrom
Inclusive start of the temporary IP address pool.
IPv4v6Address
mandatory
ipTo
Inclusive end of the temporary IP address pool.
uint32[0..1]
leaseTime
Value in seconds the DHCP server will keep a temporary IP address lease.
string[0..1]
network
Name of the network of the boot server issuing temporary addresses.
uint32
key
mandatory
noNotification
restricted
scalingId

 

class LdeSyslogConf

LdeSyslogConf

Filters a syslog facility to a separate file or to a remote host over the network.

Attributes
SyslogFacility
key
mandatory
noNotification
restricted
facilityId
string
mandatory
file [ 1..253 ]
Name of the file where log entries should be stored.
string[0..1]
hostnamePort
<hostname>:<port>
<hostname>: Hostname or IP address of remote syslog machine i.e host
<port>: listening port of the remote syslog

 

class LdeTipcConf

LdeTipcConf

Defines an attribute for TIPC and sets a value to this attribute.

Attributes
string[0..] nonUnique
interface [ 1..253 ]
the address will be automatically assigned based on to the node ID.
TIPCLinkPriority[0..1]
linkPriority
TIPC link priority
TIPCLinkTolerance[0..1]
linkTolerance
TIPC link tolerance
TIPCLinkWindow[0..1]
linkWindow
TIPC link window
TIPCNetworkId[0..1]
networkId
TIPC network id number
TIPCAddress[0..1]
tipcAddress
TIPC address (that is, Z.C.N).
string
key
mandatory
noNotification
restricted
tipcId

 

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 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 NeLS, the license information is retrieved from the Network 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 NeLS.
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 NeLS.
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 NeLS.
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 NeLS 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 LmDummyInstance

LmDummyInstance

This is a dummy instance to appease DX tool

Attributes
string
key
mandatory
noNotification
restricted
lmDummyInstanceId
Dummy Key Attribute

 

class LocalAuthenticationMethod

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-AccountPolicy [0..]
+-AdministratorAccount [1..1]
+-PasswordPolicy [0..]
+-PasswordQuality [1..1]
+-UserAccountM [1..1]

The root MOC of Local Authentication.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
localAuthenticationMethodId
The value component of the RDN.
string[0..1]
userLabel
An additional descriptive text.

 

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 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 ManagedElement

ManagedElement
+-Equipment [1..1]
+-Legacy [0..1]
+-PolicyControlFunction [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.

References from:
Host;
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 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:
AccountPolicy; CliTls; ComputeResourceRole; DscpConfig; EnrollmentAuthority; EnrollmentServerGroup; FileGroup; FtpTls; FtpTlsServer; Ikev1PolicyProfile; Ikev2PolicyProfile; NetconfTls; NodeCredential; PasswordPolicy; PasswordQuality; PmMeasurementCapabilities; Role; Snmp; TrustCategory; TrustedCertificate;

 

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 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 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 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 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 NetsharedConfig

NetsharedConfig
+-DscpConfig [1..1]
+-PeerCluster [0..]
+-ServerAddress [0..]

The root object for the netshared configuration. Created by DBS during installation.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
dbsNetsharedConfigId
Unique id.
boolean
isEnabled = false
A boolean value which defines whether network redundancy is enabled.
boolean
preferredCluster = false
.

 

class Network

ManagedElement
+-PolicyControlFunction
+-Network
+-Apns [1..1]
+-DiameterNodes [1..1]
+-EbmServers [1..1]
+-SmsCenter [1..1]
+-WebServiceEndPoints [1..1]

Network class serves as a container for network-related configuration classes.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
networkId
Identifies the instance of this class. Forced value = 1.

 

class NodeCredential

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-NodeCredential
+-ChainCertificate [0..]

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.

Chain certificates are imported from PEM formatted file or PKCS#12 container file.

The action can be invoked if the enrollmentSupport attribute of the CertMCapabilities 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, and the URI scheme is a secure file transfer protocol, or points to a local file. 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/certificate
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
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).


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


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. 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 CertMCapabilities 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).

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

If a vendor credential is not available, a challengePassword must be provided for initial enrollments. Otherwise, the active vendor credential, indicated in the CertM MO, or the existing valid node credential signs the PKI request.

If the enrollmentSupport attribute of the CertMCapabilities MO indicates that online enrollment is supported, the action can be invoked.

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 { 1.. }
The enrollment poll timer in minutes.

If the time indicated by this timer elapses before the enrollment is finished, the enrollment fails. No value means the timer is disabled. Used only for online enrollment.


Unit: 1 minutes
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.

Mandatory for actions startOfflineCsrEnrollment or startOnlineEnrollment.

For the supported key types see CertMCapabilities MO keySupport attribute. Deprecated key types are not recommended for new enrollments.

string
key
mandatory
noNotification
restricted
nodeCredentialId
The value component of the RDN.
RenewalMode
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.
DistinguishedName[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 Notification

NtfMap
+-Notification

Only the SM_ID for the "raise" notification is used if it belongs to an alarm.

Minor IDs are calculated based on a module ID and the SM alarm ID.
MinorID = "moduleID"*256+SM_ID
Since some module IDs have very high values some exceptions have been made: ECM is given the module ID 2 (PLMN_ID) and ANSITCAP is given the module ID 8 (TESTREADER_ID)
SMNTF itself is given module ID 9 (TESTLOGGER_ID)
None of these IDs are used in a normal stack so the ranges allocated should therefore remain free.

Attributes
string
alarmDocRef = ""
--
uint64
classMinorId = 2304
Minor IDs are calculated based on a module ID and the SM alarm ID.

MinorID = "moduleID"*256+SM_ID
EventType
eventType = ALARM_COMMUNICATION
ALARM_COMMUNICATION.

SA_NTF_ALARM_COMMUNICATION - 16385
string
moduleId = SAF_OAM
moduleID
uint8
key
noNotification
restricted
notificationId = 1
SM_ID
ProbablyCause
probableCause = UNSPECIFIED_REASON
CONFIGURATION_OR_CUSTOMIZATION_ERROR.

SA_NTF_CONFIGURATION_OR_CUSTOMIZATION_ERROR - 6
UNSPECIFIED_REASON = SA_NTF_UNSPECIFIED_REASON - 74
OUT_OF_SERVICE = SA_NTF_OUT_OF_SERVICE - 70
THRESHOLD_CROSSED = SA_NTF_THRESHOLD_CROSSED - 50
CONGESTION = SA_NTF_CONGESTION - 7
REMOTE_NODE_TRANSMISSION_ERROR = SA_NTF_REMOTE_NODE_TRANSMISSION_ERROR - 41
Severity
severity = SEVERITY_MAJOR
severity:.

SEVERITY_MAJOR = SA_NTF_SEVERITY_MAJOR - 4
SEVERITY_MINOR = SA_NTF_SEVERITY_WARNING - 3
SEVERITY_WARNING = SA_NTF_SEVERITY_WARNING - 2

 

class NotificationConfig

ManagedElement
+-PolicyControlFunction
+-NotificationConfig

Holds end user notification global configuration data.

This MO is created by the system.

Attributes
boolean[0..1]
noNotification
enableDelivery = false
Indicates if the end user notifications are enabled or not.
string
key
mandatory
noNotification
restricted
notificationConfigId
Identifies the instance of this class.
Fixed value = 1.
string[0..1]
smsNotificationFrom
It describes the sender identification of the SMS notification.

 

class NotifObject

ManagedElement
+-PolicyControlFunction
+-EntityData
+-NotifObjects
+-NotifObject

This class maps notifications objects to the SAPC internal business logic objects.
When the SAPC receives notification of data changes from an external database, it includes an indication of the changed objects and its key.

Attributes
string
key
mandatory
noNotification
restricted
notifObjectId
One of the SAPC business objects.
The SAPC only supports the value "Subscriber".
ObjectMapping[0..] nonUnique
objectMapping
Contains the mapping details for the NotifObject.

 

class NotifObjects

ManagedElement
+-PolicyControlFunction
+-EntityData
+-NotifObjects
+-NotifObject [0..]

Serves as repository of NotifObject instances.

Attributes
string
key
mandatory
noNotification
restricted
notifObjectsId
Identifies the instance of this class.

 

class NtfMap

NtfMap
+-Notification [0..1]

The main class.

Attributes
string
baseDn = ""
Which format the DN strings should be generated with.

"Default" - leaf first and 3GPP prefix is used.
Format is:
3GPPclass1.key1=value,key2=value,class2.key1=value,...
Actual example is:
3GPPSystemComponents.Name=System Components,Ecm.Name=ECM,Host.Address=PL-4,ClassID=1,InstanceType=0,Process.InstanceID=2
"IMM" - root first and all names ends with "Id".
uint32
bindTimer = 10000
The bind timer is how many milliseconds to wait before sending.

connection down alarm when the initial connection attempt fails.
string
dnFormat = Default
Which format the DN strings should be generated with.

"Default" - leaf first and 3GPP prefix is used.
Format is:
3GPPclass1.key1=value,key2=value,class2.key1=value,...
Actual example is:
3GPPSystemComponents.Name=System Components,Ecm.Name=ECM,Host.Address=PL-4,ClassID=1,InstanceType=0,Process.InstanceID=2
"IMM" - root first and all names ends with "Id".
uint32
majorId = 24209
-
uint8
key
noNotification
restricted
ntfmapId = 1
Value component of the RDN for System class.
string
ownDn = SM_NTF_Agent=1
The DN string to use for the agent.
uint32
queueSize = 1000
How many events (notifications) to queue before starting to drop them.

Note that the queue is dynamically allocated so this is just a maximum.
uint32
tryagainCount = 10
How many times to try again when the API responds with this error code.
uint32
tryagainTimer = 5000
How long time to wait between each re-try.
uint32
vendorId = 193
Erricsson vendor ID is 193.

 

class Ntp

ManagedElement
+-SystemFunctions
+-SysM
+-TimeM
+-Ntp
+-NtpServer [0..]

The NTP top class.

Attributes
string
key
mandatory
noNotification
restricted
ntpId
The key attribute.

 

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

ManagedElement
+-SystemFunctions
+-SysM
+-TimeM
+-Ntp
+-NtpServer

The NTP server configuration data.

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

Attributes
AdmState
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 the need 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 is 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 OverloadConfig

ManagedElement
+-PolicyControlFunction
+-OverloadConfig
+-OverloadPriority [0..]

Holds the SAPC overload configuration data.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
overloadConfigId
Identifies the instance of this class. Forced value = 1.

 

class OverloadPriority

ManagedElement
+-PolicyControlFunction
+-OverloadConfig
+-OverloadPriority

Indicates the priority order (precedence) that is given to a service when the SAPC is overloaded.

Attributes
string
key
mandatory
noNotification
restricted
overloadPriorityId
Name of the OverloadPriority.
uint32
mandatory
priorityOrder { 0..1 }
Priority level assigned to a service in overload situations. Lower values denote higher precedence.
ServiceTag
mandatory
serviceTag
Identifies the service to prioritize over the rest of the traffic in the case of overload.
Values:
"MultimediaPriorityServices"
"EmergencyServices"

 

class PasswordPolicy

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-PasswordPolicy

Configures properties of password policy.

References from:
UserAccount;
References to:
ManagedObject; PasswordQuality;
Attributes
int16[0..1]
expireWarning = 7 { 1..24855 }
Password expiry warning in days.

Specifies the number of days before the expiry date when the ME starts to notify the user at authentication to change password due to approaching expiry date. No value means expiry warnings are never sent.


Unit: 1 days
int32[0..1]
failureCountInterval = 1800 { 1..2147483647 }
The time interval within which consecutive failed login attempts count in seconds.

Specifies the time interval it takes to obsolete records in passwordFailureTimes used for attribute maxFailure. No value means the failure counter is reset only on successful authentication.


Unit: 1 seconds
int32[0..1]
historyLength = 12 { 1..2147483647 }
Specifies the number of passwords remembered by the ME to avoid the reuse of old passwords.

No value means old passwords are not recorded.
int32[0..1]
lockoutDuration { 1..2147483647 }
Account lockout duration in seconds due to password failures.

Specifies the time in seconds after a locked account is unlocked automatically. An administrative lock placed on the user account by configuring administrativeState is not managed by this attribute. No value means that only the administrator can unlock an account manually by invoking unlockOperationalLock action on the UserAccount MO.


Unit: 1 seconds
int16[0..1]
maxAge = 90 { 1..24855 }
Password maximum age in days.

Specifies the number of days after a password is considered expired. No value means passwords never expire.


Unit: 1 days
int32[0..1]
maxFailure = 3 { 1..32 }
Maximum failed login attempts to lock an account.

Specifies the number of consecutive failed login attempts which locks the account automatically, as counted in passwordFailureTimes of the respective UserAccount Managed Objects. No value means that an unlimited number of failed attempts is allowed.
int32[0..1]
minAge = 15 { 1..24855 }
Password minimum age in days.

Specifies the minimum number of days that need to pass before a password can be changed. No value means there is no control on the minimum age of passwords.


Unit: 1 days
int32
minLength = 10 { 6..255 }
Minimum length of passwords.

Specifies the minimum character lengths of passwords that the ME can accept.
string
key
mandatory
noNotification
restricted
passwordPolicyId
The value component of the RDN.
PasswordQuality
mandatory
passwordQuality
The password quality parameters used.

Refers to the DN of a PasswordQuality MO.
ManagedObject[0..]
noNotification
readOnly
reservedByAccount
The accounts using this policy.

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

 

class PasswordQuality

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-PasswordQuality

Configures the dimensions of password quality checking.

References from:
AdministratorAccount; PasswordPolicy;
References to:
ManagedObject;
Attributes
int16[0..1]
minDigit { 1..32767 }
Minimum number of digits in passwords.

Minimum number of digits a new password must have to be accepted by the ME. No value means the check is disabled.
int16[0..1]
minLower { 1..32767 }
Minimum number of lower case characters in passwords.

Minimum number of lower case characters a new password must have to be accepted by the ME. No value means the check is disabled.
int16[0..1]
minOther { 1..32767 }
Minimum number of non-alphanumeric characters in passwords.

Minimum number of non-alphanumeric characters a new password must have to be accepted by the ME. No value means the check is disabled.
int16
minPoints = 3 { 1..4 }
Minimum password quality points.

Minimum number of quality points a new password must have to be accepted by the ME. One quality point is awarded for each character class used in the password. Possible character classes are digits, uppercase, lowercase, and other characters.
int16[0..1]
minUpper { 1..32767 }
Minimum number of upper case characters in passwords.

Minimum number of upper case characters a new password must have to be accepted by the ME. No value means the check is disabled.
string
key
mandatory
noNotification
restricted
passwordQualityId
The value component of the RDN.
ManagedObject[0..]
readOnly
reservedBy
The managed objects using this PasswordQuality MO.

Lists the Distinguished Names of PasswordPolicy Managed Objects or the AdministratorAccount.
string[0..1]
userLabel
An additional descriptive text.

 

class PccConfig

ManagedElement
+-PolicyControlFunction
+-AppConfig
+-PccConfig

Configuration data applicable to Pcc access.

This MO is created by the system.

Attributes
boolean[0..1]
noNotification
enableEmergenciesWithImei = true
Enables emergencies with IMEI.
Allows the use of unauthenticated emergency services, that is, IMEI used as subscriber traffic identifier.
EventTriggers[0..]
noNotification
eventTriggers
Pcc Event Triggers.
Indicates the events that the SAPC is interested in receiving from the PCEF, whenever the subscribed events occur.
string
key
mandatory
noNotification
restricted
pccConfigId
Identifies the instance of this class. Forced value=1.
SubsIdType[0..1]
noNotification
subsIdType
Indicates the type of Subscription Identifier used to locate the subscriber profile.
Used when the SAPC receives several identifiers in incoming Gx requests.
When this attribute is not provided, the SAPC uses the content of the first received Subscription-Id AVP.

 

class PeerAddress

NetsharedConfig
+-PeerCluster
+-Connection
+-PeerAddress

The remote address and port the update channel tries to connect to.

Attributes
string
key
mandatory
noNotification
restricted
dbsPeerAddressId
Unique id.
string
mandatory
noNotification
host
Host address.
uint16
mandatory
noNotification
port
Host port.

 

class PeerCluster

NetsharedConfig
+-PeerCluster
+-Connection [0..]

Represents the remote cluster identified by its cluster ID.

Actions
string
syncFromPeer ( );
This method starts synchronization from the peer cluster.

Attributes
string
key
mandatory
noNotification
restricted
dbsNetsharedPeerClusterId
Unique id.
boolean[0..1]
isEnabled
This field is currently unused.
string
readOnly
state
The state of the netshared service toward this PeerCluster.

 

class Phase2Policy

ManagedElement
+-Transport
+-Host
+-IpsecTunnel
+-Phase2Policy

Holds configuration information for Ipsec policies.

References to:
IpsecProposalProfile;
Attributes
IpsecProposalProfile
mandatory
restricted
ipsecProposalProfile
Reference to an Ipsec transform profile.
string
key
mandatory
noNotification
restricted
phase2PolicyId
Value component of the RDN.
Ikev1TrafficSelector
mandatory
restricted
trafficSelector
Traffic selector to be used for SA negotiation.
string[0..1]
restricted
userLabel
Label for free use.

 

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 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 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 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 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 PolicyControlFunction

ManagedElement
+-PolicyControlFunction
+-AppConfig [1..1]
+-BusinessEvents [1..1]
+-EntityData [1..1]
+-EventBasedMonitoring [1..1]
+-FlexibleDiameter [1..1]
+-GeoRedManager [1..1]
+-Network [1..1]
+-NotificationConfig [1..1]
+-OverloadConfig [1..1]
+-UeTrace [1..1]

The SAPC application class serves as container for the classes belonging to that application.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
policyControlFunctionId
Identifies the instance of this class. Fixed value=1.
string
noNotification
readOnly
release
The product release of the ManagedFunction.
It commonly contains the Managed Function release, for example L12.0, 13A, R1A
string
mandatory
userLabel
Used for product free-text description.

 

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

ManagedElement
+-SystemFunctions
+-SysM
+-CrM
+-Role

Represents a role that determines the type of service provided by a compute resource.

This MO is created by the system.

References to:
ManagedObject;
Attributes
ManagedObject[0..] nonUnique
readOnly
isProvidedBy
Reference to an instance of Compute Resource Role.
string
key
mandatory
noNotification
restricted
roleId
The value component of the RDN.
Scalability[0..1]
readOnly
scalability
Indicates whether or not the role can scale for capacity reasons.

 

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 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 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 ServerAddress

NetsharedConfig
+-ServerAddress

The local address and port where DBS listens for incoming connections.

Attributes
string
key
mandatory
noNotification
restricted
dbsServerAddressId
Unique id.
string
mandatory
noNotification
host
Host address.
uint16
mandatory
noNotification
port
Host port.

 

class SessionInactivityConfig

ManagedElement
+-PolicyControlFunction
+-AppConfig
+-SessionInactivityConfig

Configuration attributes for the deletion mechanism of inactive sessions.

This MO is created by the system.

Attributes
boolean
noNotification
checkForSessionAlive = true
Indicates if SAPC sends a RAR message to PCEF in order to verify if the session is still alive.
Default value: True.
[0..1]
noNotification
cleanupDuration = 180 { 1.. }
Indicates the maximum consecutive time dedicated to remove inactive sessions.
After this period of time the cleanup mechanism is stopped.
Default value: 180. Minimal value: 1.
Time[0..1]
cleanupStartTime = 00:30:00
Indicates the time when the SAPC starts removing all inactive sessions. Default value: 00:30:00.
boolean
enabledCleanup = true
Indicates if the cleanup mechanism of inactive sessions is enabled. Default value: True.
[0..1]
noNotification
inactivityPeriod = 36 { 1.. }
Indicates the inactivity period of a session in order to be considered as inactive.
The value is expressed in hours. Default value: 24. Minimal value: 1.
string
key
mandatory
noNotification
restricted
sessionInactivityConfigId
Identifies the instance of this class. Forced value = 1.
It is set automatically when the MO instance is created.

 

class SessionInfoPublicationConfig

ManagedElement
+-PolicyControlFunction
+-AppConfig
+-SessionInfoPublicationConfig

Configuration attributes for the mechanism of session information publication.

Attributes
[0..1]
durationSessionInfoPublication = 0
Indicates the type of duration of session information publication.
When the storage time of the closed session exceeds the duration, the session information shall be removed.
Values:
0: INFINITE
1: WEEKLY
2: MONTHLY
3: QUARTERLY
4: YEARLY
When this attribute is not provided or provided with default value (0), the SAPC doesn't enable the auto detection mechanism. The obsolete closed session only can be overwritten by new closed session with same APN and traffic ID.
boolean
enableSessionInfoPublication = false
Indicates if the mechanism of session information publication is enabled. Default value: False.
string
key
mandatory
noNotification
restricted
sessionInfoPublicationConfigId
Identifies the instance of this class. Forced value=1.

 

class Sftp

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-Sftp

Represents the common configuration parameters of Secure Shell File Transfer Protocol (SFTP) clients on the ME.

This MO is created by the system.

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

 

class SftpServer

ManagedElement
+-SystemFunctions
+-SysM
+-FileTPM
+-FtpServer
+-SftpServer

Represents the Secure Shell File Transfer Protocol (SFTP) server of the ME.

This MO is created by the system.

Attributes
BasicAdmState
mandatory
administrativeState
The administrative state for the SFTP server.
When LOCKED all on-going connections will immediately be terminated.
uint16
port = 115
The listening port number of the SFTP server.
string
key
mandatory
noNotification
restricted
sftpServerId
The value component of the RDN.

 

class SmsCenter

ManagedElement
+-PolicyControlFunction
+-Network
+-SmsCenter
+-SmsDestination [0..]

Container that holds generic SMS Center configuration data.
The data is common to all SmsDestination objects that are part of it.


This MO is created by the system.

Attributes
int32[0..1]
connectionTimeout = 5000
It represents the maximum time (in milliseconds) waiting for a SMPP connection to be established.
It also represents the maximum time (in milliseconds) waiting for a SMS notification to be acknowledged.

int32[0..1]
maxNumberRetries = 1
It represents the maximum number of delivery retries.
A retry is performed when sending a SMS notification to a SMS center fails.
string
key
mandatory
noNotification
restricted
smsCenterId
Identifies the instance of this class.
Fixed value = 1.

 

class SmsDestination

ManagedElement
+-PolicyControlFunction
+-Network
+-SmsCenter
+-SmsDestination

It represents a SMS center node (end-point) that SAPC directly communicates with.

Attributes
int32[0..1]
noNotification
serverNpiDestination = 0
It represents the Numeric Plan Indicator (NPI) of the notification destination.
Range: 0-255.
int32[0..1]
noNotification
serverNpiOrigin = 0
It represents the Numeric Plan Indicator (NPI) of the notification origin.
Range: 0-255.
int32[0..1]
noNotification
serverPort = 2775
It represents the TCP/IP port used by the SMS center to communicate with.
EcimPassword[0..1]
serverPwd
If authentication to the SMS center is needed, it represents the password of the user.
The maximum length of the password is 9 bytes.
int32[0..1]
noNotification
serverTonDestination = 0
It represents the Type of Number (ToN) of the notification destination.
Range: 0-255.
int32[0..1]
noNotification
serverTonOrigin = 0
It represents the Type of Number (ToN) of the notification origin.
Range: 0-255.
string
mandatory
serverUser
If authentication is needed, it represents the user to authenticate to the SMS center node.
The maximum length is 16 bytes.
IpDNSAddress
key
mandatory
noNotification
restricted
smsDestinationId
Identifies the instance of this class.
It represents the IP-Address of SMS Center node.

 

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 example IP addresses and ports.

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 are generated, for example, alarm, alerts or heartbeats. Also, all access to the SNMP protocol is disabled.
HostAndPort[0..]
agentAddress
Listen addresses for the SNMP agent.
Attribute defines ports and IP addresses the agent listens to for incoming SNMP requests that use UDP protocol. Typical configurations use 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 SNMP agent that uses DTLS.
Attribute defines ports and IP addresses the agent listens to for incoming SNMP requests that use DTLS transport protocol. The typical configuration uses one port with IP address 0.0.0.0 and port 10161. This means that the standard port for SNMP over DTLS is used on all interfaces.
boolean
enableSourceCheckForV1V2C = false
Enables source IP check on the agent for community based Snmp V1 and Snmp V2C protocol access.
If false, agent may accept SNMP GET, SET messages from any IP address.
If true, agent only accepts SNMP GET, SET messages from configured target IP subnet.
string[0..1]
engineId [ 5..32 ]
Unique identifier of the SNMP agent. Only applicable when using SNMPv3.
To be configured when auto discovery of the SNMP Engine ID is not supported or it is desired to use an identifier that is not automatically calculated and remains unchanged across re-initializations.
Where SNMP stack can not support setting the Engine ID, the applied value is ignored, keeping the current empty value.


Specification: RFC3411, RFC5343
ManagedObject[0..1]
nodeCredential
Node credential used for SNMP notifications with Transport Security Model.
Specifies the DN of a NodeCredential MO in Certificate Management. If Transport Security Model, DTLS, is not used, the attribute value can be empty.
OperState
noNotification
readOnly
operationalState
The operational status of the SNMP functionality.
If DISABLED, there is some problem that degrades the SNMP functionality.
uint16
port = 161
Port number used by agent to listen for incoming SNMP requests over OamAccessPoint interface.
Note that OamAccessPoint interface is configured in System Management.
The agent uses the value only if agentAddress attribute is not configured in this MO.
uint16
portDtls = 10161
Port number used by agent to listen for SNMP with DTLS requests over OamAccessPoint interface.
Note that OamAccessPoint interface is configured in System Management.
The agent uses the value only if agentAddressDtls attribute is not configured in this MO.
string
key
mandatory
noNotification
restricted
snmpId
Holds the name used when identifying the MO.
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 the DTLS protocol is not used, the attribute value can be empty.

 

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, traps are not sent and access is not allowed for this MO instance.
SnmpCommunity
mandatory
community
The SNMP community string.
boolean
isMibWritable = true
Specifies if user has write-access to MIB.
If false, user is only allowed to perform read-access, such as SNMP GET.
Attribute value has no relevance if SnmpViewV1 exists for the community of this instance. Permissions in the view override this attribute.
uint8[0..1]
networkPrefixLength { 1..128 }
The network prefix length identifying the number of subnet mask bits in the target address.
For IPv4 target address, range 1-32
For IPv6 target address, range 1-128

The value of this attribute is used only if Snmp MO's enableSourceCheckForV1V2C is set to true. In which case, the agent uses the value to determine the source IP address range permitted to execute Snmp GET and SET on managed device. An empty value in that case will mean that Snmp GET and SET shall be permitted from just a single target IP as configured in address attribute of this MO.
OperState
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162 { 1..65535 }
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV1Id
Holds the name used when identifying the MO.

 

class SnmpTargetV2C

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

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 SNMP target.
If LOCKED, traps are not sent and access is not allowed for this MO instance.
SnmpCommunity
mandatory
community
SNMP community string.
uint32
informRetryCount = 1
The number of retries attempted when no response is received for a notification.
Attribute value relevant only if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
If SNMP INFORM is not acknowledged during this time, the implementation can assume that the notification was not delivered. Attribute value relevant only if transportMethod is set to INFORM. The unit is hundredth of a second, 0.01 seconds.
boolean
isMibWritable = true
Specifies if users have write-access to MIB.
If false, users are only allowed to perform read-access, such as SNMP GET.
Attribute value has no relevance if SnmpViewV2C exists for the community of this instance. Permissions in the view override this attribute.
uint8[0..1]
networkPrefixLength { 1..128 }
The network prefix length identifying the number of subnet mask bits in the target address.
For IPv4 target address, range 1-32
For IPv6 target address, range 1-128

The value of this attribute is used only if Snmp MO's enableSourceCheckForV1V2C is set to true. In which case, the agent uses the value to determine the source IP address range permitted to execute Snmp GET and SET on managed device. An empty value in that case will mean that Snmp GET and SET shall be permitted from just a single target IP as configured in address attribute of this MO.
OperState
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162 { 1..65535 }
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV2CId
Holds the name used when identifying the MO.
NotifyType
transportMethod = TRAP
Method type used. Can be TRAP or INFORM.

 

class SnmpTargetV3

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

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 SNMP target.
If LOCKED, traps are not sent and access is not allowed for this MO instance.
EcimPassword
mandatory
authKey
Authentication key used for signing SNMP notifications.
AuthKey used to sign the messages sent. Key must contain at least 8 characters.
Must have a value, but the value is used only if authorization is enabled.
See attribute snmpSecurityLevel.
If authorization is disabled, attribute can contain any arbitrary value.
AuthProtocol
authProtocol = MD5
Authentication protocol used.
Value relevant only if authorization is enabled. See attribute snmpSecurityLevel.
uint32
informRetryCount = 1
The number of retries attempted when no response is received for a notification.
Attribute value relevant only if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
If SNMP INFORM is not acknowledged during this time, the implementation can assume that the notification was not delivered. Attribute value relevant only if transportMethod is set to INFORM. The unit is hundredth of a second, 0.01 seconds.
boolean
isMibWritable = true
Specifies if users have write-access to MIB.
If false, users are only allowed to perform read-access, such as SNMP GET.
Attribute value has no relevance if SnmpViewV3 exists for the community of this instance. Permissions in the view override this attribute.
OperState
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 162 { 1..65535 }
UDP port number for this SNMP trap target.
EcimPassword
mandatory
privKey
Privacy key used for encryption.
User's privKey encrypts the data portion of the message.
Key must contain at least 8 characters.
Must have a value, but the value is used only if privacy is enabled. See attribute snmpSecurityLevel.
If privacy is disabled, attribute can contain any arbitrary value.
PrivProtocol
privProtocol = DES
Privacy protocol used.
Attribute value relevant only if privacy is enabled. See attribute snmpSecurityLevel.
SecurityLevel
snmpSecurityLevel = AUTH_PRIV
Specifies the level of security applied to messages exchanged with this target.
string
key
mandatory
noNotification
restricted
snmpTargetV3Id
Holds the name used when identifying the MO.
NotifyType
transportMethod = TRAP
Method type used. Can be TRAP or INFORM.
SnmpSecurityName
mandatory
user
SNMP V3 user name for the SNMP V3 message.

 

class SnmpTargetV3Dtls

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

SNMP target defines a trap receiver and gives access privileges.
This class defines attributes needed for SNMP over DTLS. Attributes nodeCredential and trustCategory defined in the Snmp MO class/instance are used. DTLS is used as transport protocol 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 SNMP target.
If LOCKED, traps are not sent and access is not allowed for this MO instance.
uint32
informRetryCount = 1
The number of retries attempted when no response is received for a notification.
Attribute value relevant only if transportMethod is set to INFORM.
Timeout
informTimeout = 300
Timeout for SNMP INFORM.
If SNMP INFORM is not acknowledged during this time, the implementation can assume that the notification was not delivered. Attribute value relevant only if transportMethod is set to INFORM. The unit is hundredth of a second, 0.01 seconds.
boolean
isMibWritable = true
Specifies if users have write-access to MIB.
If false, users are only allowed to perform read-access, such as SNMP GET.
Attribute value has no relevance if SnmpViewV3 exists for the community of this instance. Permissions in the view override this attribute.
OperState
noNotification
readOnly
operationalState
The operational status of this SNMP target.
uint32
port = 10162 { 1..65535 }
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV3DtlsId
Holds the name used when identifying the MO.
NotifyType
transportMethod = TRAP
Method type used. Can be TRAP or INFORM.
SnmpSecurityName
mandatory
user
SNMP V3 user name.
Used for authorization of incoming SNMP requests. Defined by the subject alternative name field, from the certificate provided by the client during DTLS session setup.

 

class SnmpViewV1

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

SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for SNMP V1 users. Users are identified by community name.

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

Default status denies access to other SNMP MIBs. Create a new view configuration if default behaviour is insufficient.

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 contained OIDs are readable.
string
key
mandatory
noNotification
restricted
snmpViewV1Id
Holds the name used when identifying the MO.
SnmpOid[0..]
writeOids
Defines which SNMP OIDs the user is allowed to write.
The defined OIDs and all contained OIDs are writeable.

 

class SnmpViewV2C

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

SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for SNMP V2C users. Users are identified by community name.

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

Default status denies access to other SNMP MIBs. Create a new view configuration if default behaviour is insufficient.

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 contained OIDs are readable.
string
key
mandatory
noNotification
restricted
snmpViewV2CId
Holds the name used when identifying the MO.
SnmpOid[0..]
writeOids
Defines which SNMP OIDs the user is allowed to write.
The defined OIDs and all contained OIDs are writeable.

 

class SnmpViewV3

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

SNMP view gives users access to SNMP MIBs.
This class explicitly defines a view for SNMP V3 users. Users are identified by community name.

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

Default status denies access to other SNMP MIBs. Create a new view configuration if default behaviour is insufficient.

Attributes
SnmpOid[0..]
readOids
Defines which SNMP OIDs the user is allowed to read.
The defined OIDs and all contained OIDs are readable.
string
key
mandatory
noNotification
restricted
snmpViewV3Id
Holds the name used when identifying the MO.
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 contained OIDs are writeable.

 

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 SshPublicKey

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-UserAccountM
+-UserAccount
+-SshPublicKey
ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-AdministratorAccount
+-SshPublicKey

Stores an SSH public key of the user account.

Attributes
string
mandatory
publicKeyContent
Holds the whole content of a public key file.

The content should be either in OpenSSH key format or entered in base64 format without line breaks of an RFC4716, PEM, or PKCS8 formatted key content. The base64 formats encode the whole content of the public key including the corresponding begin and end marker lines.

For additional supported formats please refer to product documentation.


Valid values: (^[A-Za-z0-9+/]+[=]*$)|(^[a-z0-9][a-z0-9-]*[ ][A-Za-z0-9+/]+[=]*([ ][^[:cntrl:]]*)?$)
string
key
mandatory
noNotification
restricted
sshPublicKeyId
The value component of the RDN.

 

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 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 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 SysM

ManagedElement
+-SystemFunctions
+-SysM
+-CliSsh [0..1]
+-CliTls [0..1]
+-CrM [1..1]
+-FileTPM [1..1]
+-NetconfSsh [0..1]
+-NetconfTls [0..1]
+-NtpServer [0..]
+-Schema [2..]
+-Snmp [1..1]
+-TimeM [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 SystemFunctions

ManagedElement
+-SystemFunctions
+-BrM [1..1]
+-FileM [1..1]
+-Fm [1..1]
+-Lm [1..1]
+-Pm [1..1]
+-SecM [1..1]
+-SwInventory [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 Tdf

ManagedElement
+-PolicyControlFunction
+-Network
+-DiameterNodes
+-Tdfs
+-Tdf

It represents a Traffic Detection Function that communicates with the SAPC.

Attributes
string[0..1]
noNotification
host
TDF destination host. Used by the SAPC to initiate a Sd session establishment.
string[0..1]
noNotification
ipAddress
TDF IP address. Used by the SAPC to initiate a Sd session establishment.
string[0..1]
noNotification
realm
TDF destination realm. Used by the SAPC to initiate a Sd session establishment.
string
key
mandatory
noNotification
restricted
tdfId
TDF identifier.

 

class TdfRoute

ManagedElement
+-PolicyControlFunction
+-Network
+-DiameterNodes
+-DiameterNode
+-TdfRoute

It represent a route between a DiameterNode and Tdf based on an apn list.

Attributes
string[0..1]
apns
Traffic addressed to this list of APNs will be routed towards the TDF specified by tdfId.
If this parameter is left empty, the associated TDF will be selected regardless the apn value
included in the CCR-I incoming message.
string
key
mandatory
noNotification
restricted
tdfId
TDF identifier.

 

class Tdfs

ManagedElement
+-PolicyControlFunction
+-Network
+-DiameterNodes
+-Tdfs
+-Tdf [0..]

Container for Traffic Detection Function related configuration classes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
tdfsId
Identifies the instance of this class. Forced value = 1.

 

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 TimeM

ManagedElement
+-SystemFunctions
+-SysM
+-TimeM
+-DateAndTime [1..1]
+-Ntp [1..1]

Time management concerns the calendar date and local time of the node.

This MO is created by the system.

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

 

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[1..]
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[1..]
readOnly
supportedCiphers
Lists the cipher suites supported by the ME.
string
key
mandatory
noNotification
restricted
tlsId
The value component of the RDN.

 

class Transport

ManagedElement
+-Transport
+-Evip [1..1]
+-Host [0..]

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 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 TrustedCertificate

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

Represents a trusted certificate.

This MO is created by the system.

References from:
CertM; EnrollmentAuthority; TrustCategory;
References to:
ManagedObject; 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.
ManagedObject[0..]
readOnly
reservedBy
The Distinguished Names of MOs using this TrustedCertificate.
TrustCategory[0..] nonUnique
noNotification
readOnly
reservedByCategory
Indicates the trust categories this trusted certificate belongs to.

Contains the Distinguished Names of the TrustCategory Managed Objects.


Deprecated: Deprecated in version 3.0. Restrictive to TrustCategory objects. Replaced by reservedBy.

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

 

class UeTrace

ManagedElement
+-PolicyControlFunction
+-UeTrace

Holds the SAPC UE trace configuration data.

This MO is created by the system.

Actions
string
list ( );
Lists the UE trace sessions to be traced.
string
start ( string imsis , string msisdns , string sipuris , string traceSessionRef , string interfaces , DateTime timeStart , DateTime timeEnd , int32 duration );
Orders the start of a UE trace session.
Note: At least one subscriber identifier is <b>mandatory</b>. Multiple identifiers are supported.

Parameters

Name: imsis
Description: IMSI values = [<imsiToBeTraced1>, ... ,<imsiToBeTracedN>].
Required: optional.



Name: msisdns
Description: MSISDN values= [<msisdnToBeTraced1>, ... , <msisdnToBeTracedN>].
Required: optional.



Name: sipuris
Description: SIP-URI values= [<sipuriToBeTraced1>, ... , <sipuriToBeTracedN>].
Required: optional.
Note: the SIP-URI is just for tracing over the Rx interface if the AAR initial message includes the SIP-URI value in the subscription-Id AVP.



Name: traceSessionRef
Description: Unique identifier of a UE trace session.
Recommended values: (^[0-9]{5,15}$)|(^[0-9]{1,18}$).
Required: mandatory.



Name: interfaces
Default value: Gx,Rx
Description: The interfaces over which the messages are traced.
interface values = [Gx, Rx].
Required: optional.



Name: timeStart
Description: The start time of a UE trace session.
timeStart value = [<YYYY-MM-DDThh:mm:ss>].
Required: optional.
Note: If no start time is specified, the UE trace session starts immediately.



Name: timeEnd
Description: The end time of a UE trace session.
timeStart value = [<YYYY-MM-DDThh:mm:ss>].
Required: optional.
Note: If no end time is specified, the UE trace session just stops using the stop command.



Name: duration
Description: The duration of the UE trace session in minutes.
duration value = [<integer value>].
Required: optional.


string
stop ( EcimEmpty all , string traceSessionRef , EcimEmpty nonPcapFile );
Stops the specified UE trace sessions.
Note: Either all or traceSessionRef are mandatory.

Parameters

Name: all
Description: Deactivates all the UE trace sessions.
Required: optional.



Name: traceSessionRef
Description: Identifiers of the UE trace sessions to be stopped.
traceSessionRef values = [<sessionName1>, ... , <sessionNameN>].
Required: optional.



Name: nonPcapFile
Description: After stopping the session(s), do not generate PCAP files.
Required: optional.


Attributes
TimeReport
reportPeriod = FIFTEEN_MIN
Contains the time between two successive XML generations.
Possible values: FIVE_MIN, FIFTEEN_MIN, THIRTY_MIN, ONE_HOUR.
Default value: FIFTEEN_MIN.
string
key
mandatory
noNotification
restricted
ueTraceId
Identifies the instance of this class. Forced value = 1.

 

class UserAccount

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-UserAccountM
+-UserAccount
+-SshPublicKey [0..1]

Represents a user account.

The O&M users need to authenticate to a UserAccount MO to access the ME.

References to:
AccountPolicy; PasswordPolicy;
Actions
void
removePassword ( );
Removes the password from the account.
void
resetPassword ( EcimPasswordString password , EcimEmpty noChange );
Resets the password of the account.

The reset of the password requires the user authenticating to this account to change the password and the passwordState is set to EXPIRED_MUSTCHANGE. The password is only usable for a grace period.

If the noChange parameter was provided, the passwordState is set to VALID and no forced change is required.

The action returns an error if passwordPolicy attribute is not set or if the password does not match the configured quality criteria. Check the configured PasswordQuality MO for more details.

Parameters

Name: password
Description: The new password for this user account.


Name: noChange
Description: Indicates that no forced password change is needed at first login to this account.

void
unlockOperationalLock ( );
Unlocks the account.

The ME may lock an account automatically based on the associated account policy or if a password is set based on associated password policy. The action should be called if the administrativeState is UNLOCKED but the accountState or passwordState is LOCKED.

The action returns an error if the account is LOCKED by administrativeState.

If the accountUsageState is DORMANT, the lastLoginTime attribute is cleared and the accountUsageState becomes UNUSED.

Attributes
AccountPolicy
mandatory
accountPolicy
The account policy.

Refers to the DN of an AccountPolicy MO.
AccountState
readOnly
accountState
The state of the account.

In LOCKED state, users are not able to authenticate to this account.
In UNLOCKED state, users are able to authenticate to this account.

Automatic lock can be placed due to dormant account. Manual locking and unlocking performed by the attribute administrativeState is also reflected by the account state. A manual lock has precedence over an automatic lock, thus enabling an account must always start with checking the value of the administrativeState attribute and setting it UNLOCKED. If already UNLOCKED and the account state is LOCKED, the ME automatically locked the account, unlockOperationalLock must be invoked for unlock.
AccountUsageState
readOnly
accountUsageState
The state of the account based on user activity.

The account is DORMANT if the system time passes the value of the lastLogin attribute plus the dormantTimer, thus indicating lock due to account inactivity. When the account is DORMANT the account gets locked by changing accountState to LOCKED.

The account is UNUSED when no successful authentication was performed to it.

The account is ACTIVE in all other cases.
BasicAdmState
administrativeState = UNLOCKED
The administrative state of the account.

Specifies the state of the account based on administration performed by the MS.

If set to UNLOCKED but accountState is LOCKED, unlockOperationalLock must be invoked.
DateTime[0..1]
readOnly
lastLoginTime
The date of the last successful login.
DateTime[0..1]
readOnly
lockedTime
The time the account was locked.

Specifies the time the account was locked regardless if that was due to an administrative lock or an automatic operational lock. The value is cleared when the account is unlocked.
DateTime[0..1]
readOnly
passwordChangedTime
The time the password was last changed or reset.

Has no value if the password is not set.
DateTime[0..] nonUnique
noNotification
readOnly
passwordFailureTimes
Dates of failed login attempts.

The list of dates when a user tried to authenticate to this account and failed. The attribute can be reset by a successful authentication, by the resetPassword action, or by the removePassword action. The dates outside the time-window set by failureCountInterval of the configured PasswordPolicy MO are removed.
DateTime[0..1]
readOnly
passwordLockedTime
The time the password authentication was locked.

Specifies the time the password was locked due to excessive failure attempts or expired password. The value is cleared when the password is unlocked or removed.
PasswordPolicy[0..1]
passwordPolicy
The password policy.

Refers to the DN of a PasswordPolicy MO.
PasswordState[0..1]
readOnly
passwordState
The state of the password.

Has no value if the password is not initialized by resetPassword action after creating the account or the password was removed; thus, no password is set.

If the state is EXPIRED_MUSTCHANGE the password must be changed by the user at login.
After a grace period the state turns to EXPIRED and password authentication is locked; only the MS can reset the password in that state by resetPassword.

If the password was successfully changed, or no change was required at setting the password, the state turns to VALID. After expiry the state returns to EXPIRED_MUSTCHANGE.

If failure counters reached the limit, the password state turns to LOCKED and password authentication is not possible. The locked state may be resolved by an automatic operational unlock by ME, or a manual unlock by the MS. The automatic unlock is based on the lockoutDuration attribute of the PasswordPolicy MO. The manual unlock is done by invoking the MO action unlockOperationalLock.
RoleString[0..]
roles
The authorization profile of the user account.

List the roles of the account for Role Based Access Control. The user authenticating to this account will receive the permissions defined in an authorization model.
AccountIdString
key
mandatory
noNotification
restricted
userAccountId
The user ID to be provided at authentication.
string[0..1]
userLabel
An additional descriptive text.
string[0..1]
userName
The full name of the user assigned to the account.

 

class UserAccountM

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-LocalAuthenticationMethod
+-UserAccountM
+-UserAccount [0..]

Contains and enables the management of O&M user accounts.

This MO is created by the system.

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

 

class UserManagement

ManagedElement
+-SystemFunctions
+-SecM
+-UserManagement
+-AuthenticationOrder [0..1]
+-LocalAuthenticationMethod [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.
uint8[0..1]
loginFailureDelay = 5 { 1..255 }
Delay after a failed login attempt in seconds.

No value means no delay.


Unit: 1 seconds
string[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'.


Valid values: ^(\\\\[a-fA-F0-9]{2}|[A-Za-z0-9!$%&'./:=?@^_`{|}~-])((\\\\[a-fA-F0-9]{2}|[A-Za-z0-9!$%&'./:=?@^_`{|}~# -])*(\\\\[a-fA-F0-9]{2}|[A-Za-z0-9!$%&'./:=?@^_`{|}~#-]))?$
string[0..1]
userLabel
An additional descriptive text.
string
key
mandatory
noNotification
restricted
userManagementId
The value component of the RDN.

 

class WebServiceEndPoint

ManagedElement
+-PolicyControlFunction
+-Network
+-WebServiceEndPoints
+-WebServiceEndPoint
+-WsDestination [0..]

Container that holds web service end point generic configuration data.
The data is common to all WsDestination objects that are part of it.

Attributes
int32[0..1]
connectionTimeout = 5000
It represents the maximum time (in milliseconds) waiting for a HTTP request to be acknowledged.
int32[0..1]
maxNumberRetries = 1
It represents the maximum number of retries of a HTTP request.
A retry is performed when sending a SOAP message to a web service end point destination node fails.
string
mandatory
soapAction
It represents the SOAP Action HTTP request header.
The value must be an URI (Uniform Resource Identifier) identifying the intent of the SOAP HTTP request.
string
key
mandatory
noNotification
restricted
webServiceEndPointId
Identifies the instance of this class.
It is the administrative identifier of the WebServiceEndPoint.

 

class WebServiceEndPoints

ManagedElement
+-PolicyControlFunction
+-Network
+-WebServiceEndPoints
+-WebServiceEndPoint [0..]

Container for web service end point related configuration classes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
webServiceEndPointsId
Identifies the instance of this class.
Fixed value = 1.

 

class WsDestination

ManagedElement
+-PolicyControlFunction
+-Network
+-WebServiceEndPoints
+-WebServiceEndPoint
+-WsDestination

It represents a web service end point destination (HTTP server) node.
The SAPC communicates directly with it.

Attributes
string[0..1]
httpProxy
If a HTTP proxy node is used, it represents the URL of the proxy node.
The proxy node is located between the SAPC and the web service end point destination node.
string
key
mandatory
noNotification
restricted
wsDestinationId
Identifies the instance of the class.
It represents the URL address of the web service end point destination node.