Classes for

Managed Object Model

(MOM)

Managed Information Model (MIM) identity
     Name   : BrM
     Version : 3
     Release : 2
     Correction : 0
    

All PM Counters

Contents

AccountPolicy
AdministratorAccount
AuthenticationOrder
AutonomousMode
BcfNetworkInterface
BcfNwIfs
BrM
BrmBackup
BrmBackupHousekeeping
BrmBackupLabelStore
BrmBackupManager
BrmBackupScheduler
BrmCalendarBasedPeriodicEvent
BrmFailsafeBackup
BrmPeriodicEvent
BrmRollbackAtRestore
BrmSingleEvent
CapacityKey
CertM
CertMCapabilities
ChainCertificate
CliSsh
CliTls
ComputeResourceRole
CrM
CscfAccessNetworkAssertion
CscfActiveUserLicenseModel
CscfAdvancedProfileEntry
CSCF-Application
CscfAuthenticationClass
CscfAuthenticationGroupClass
CscfCallerPreferencesClass
CscfChargingClass
CscfConfigProfileMappingTableClass
CscfConfigProfileMappingTableGroupClass
CscfDialogEvent
CscfDomainRoutingApplication
CscfDomainRoutingConfiguration
CscfDomainRoutingConfigurations
CscfDomainRoutingMatchingTable
CscfDomainRoutingMatchingTableEntry
CscfDomainRoutingMatchingTables
CscfDomainRoutingResultTable
CscfDomainRoutingResultTableEntry
CscfEmergencyClass
CscfEmergencyGroupClass
CscfEosAnalysis
CscfEosApplication
CscfEosCaseTable
CscfEosCaseTableEntry
CscfEosMatchProfileTable
CscfEosMatchProfileTableEntry
CscfEosRouteTable
CscfEosRouteTableEntry
CscfFaultIsolationClass
CscfFunction
CscfGenericNumberPortability
CscfHssQuarantine
CscfIdentificationGroupClass
CscfLicenseModelGroup
CscfMaxMediaFlowTableClass
CscfMaxMediaFlowTablesContainer
CscfMediaAuthorizationPolicyContainer
CscfMediaCodecDataEntryClass
CscfMediaCodecDataTableContainer
CscfMediaContainer
CscfMediaTypeBandwidthTableClass
CscfMonitoredInterfaceClass
CscfMonitoredInterfaceGroupClass
CscfNumPortability
CscfNumPortabilityCountryCodeList
CscfNumPortabilityPrefixList
CscfNwIfContainer
CscfNwTopologyClass
CscfNwTopologyGroupClass
CscfOperatorAllocatedDomainRangeListClass
CscfOperatorAllocatedNumberRangeListClass
CscfPayloadBlackWhiteListClass
CscfPayloadBlackWhiteListsContainer
CscfPersonalProfileEntry
CscfPmConfig
CscfPmConfigGroup
CscfProactiveMonitoredSipInterface
CscfProactiveMonitoredSipInterfaceGroup
CscfProfileClass
CscfProfileGroupClass
CscfRegistrationClass
CscfRegistrationEvent
CscfRegistrationGroupClass
CscfResourceBrokerClass
CscfRoutingClass
CscfRoutingGroupClass
CscfSecurityAdmin
CscfSecurityAdminGroup
CscfServiceInvocationClass
CscfServiceInvocationGroupClass
CscfServicePriorityClass
CscfServicePriorityGroupClass
CscfSipConfigDestProfile
CscfSipConfigDestProfileGroup
CscfSipErrorConfigurationClass
CscfSipErrorConfigurationEntryClass
CscfSipErrorConfigurationTableClass
CscfSipMsgPreProcessing
CscfSipOverloadControl
CscfSipOverloadControlGroup
CscfSipProtocolClass
CscfSipProtocolGroupClass
CscfSmpAuthorizationPolicyContainer
CscfSmpAuthorizationPolicyEntry
CscfSubscriptionGroup
CscfSystemConfigClass
CscfSystemConfigGroupClass
CscfTelephonyClass
CscfTelephonyGroupClass
CscfTerminalIdentificationClass
CscfThrottledInterface
CscfThrottledInterfaceGroup
CscfTroubleshootingGroupClass
CscfUaRestriction
CscfUnallocatedRoutingContainer
CscfUserDataActions
CscfUserDataManagementGroup
CscfUserDataOutputClass
CustomRole
CustomRule
DIA-CFG-AccReqContainer
DIA-CFG-Application
DIA-CFG-AppRouting
DIA-CFG-AuthReqContainer
DIA-CFG-AvpDef
DIA-CFG-Configuration
DIA-CFG-Conn
DIA-CFG-DictionaryContainer
DIA-CFG-Drt
DIA-CFG-NeighbourNode
DIA-CFG-OwnNodeConfig
DIA-CFG-PeerNodeContainer
DIA-CFG-RoutingContainer
DIA-CFG-StackContainer
DIA-CFG-Vendor
DNS-Application
EatfNetworkInterfaceEntry
EatfNwIfContainer
Ecscf
EcscfChargingClass
EcscfChargingProfileClass
EcscfChargingProfilesClass
EcscfChargingRequestUriTriggerClass
EcscfChargingSessionCaseTriggerClass
EcscfChargingSipHeaderTriggerClass
EcscfChargingSipMethodTriggerClass
EcscfChargingTransactionInfoClass
EcscfChargingTransactionTypeClass
EcscfChargingTriggerGroupClass
EcscfChargingTriggerGroupsClass
EcscfChargingTriggersClass
EcscfNetworkInterface
EcscfNwIfs
EcscfOfflineChargingAVPsClass
EcscfOfflineChargingCauseClass
EcscfOfflineChargingEricssonServiceInformationClass
EcscfOfflineChargingEventTypeClass
EcscfOfflineChargingInterOperatorIdentifierClass
EcscfOfflineChargingOmits
EcscfOfflineChargingOmitVendor
EcscfOfflineChargingProfileClass
EcscfOfflineChargingSDPMediaComponentClass
EcscfOfflineChargingServiceInformationClass
EcscfOfflineChargingTimeStampsClass
EmergencyUnlock
EnrollmentAuthority
EnrollmentServer
EnrollmentServerGroup
EricssonFilter
Evip
EvipAlb
EvipAlbs
EvipCluster
EvipCommand
EvipCommandDefinition
EvipDeclarations
EvipErsipParams
EvipFee
EvipFees
EvipFlowPolicies
EvipFlowPolicy
EvipLbe
EvipLbes
EvipNode
EvipParam
EvipParams
EvipPayload
EvipPortRange
EvipPortRanges
EvipProtocol
EvipRoutingSetup
EvipSe
EvipSelectionPolicies
EvipSelectionPolicy
EvipSes
EvipSupervisedRemoteGateway
EvipTargetPool
EvipTargetPools
EvipVip
EvipVips
EvipXfrmSelectionPolicies
EvipXfrmSelectionPolicy
ExtNetSel-Application
ExtNetSelCalledTableClass
ExtNetSelCalledTableEntryClass
ExtNetSelCalledTablesClass
ExtNetSelCallingPartyHeaderPriorityTableClass
ExtNetSelCallingPartyHeaderPriorityTableEntryClass
ExtNetSelCallingTableClass
ExtNetSelCallingTableEntryClass
ExtNetSelCallingTablesClass
ExtNetSelCicTableClass
ExtNetSelCicTableEntryClass
ExtNetSelCicTablesClass
ExtNetSelMatchTable
ExtNetSelMatchTableEntry
ExtNetSelMatchTables
ExtNetSelPoolsClass
ExtNetSelPoolTableEntryClass
ExtNetSelRegexMTblClass
ExtNetSelRegexMTblEntryClass
ExtNetSelRegexTableClass
ExtNetSelRegexTableEntryClass
ExtNetSelRnTableClass
ExtNetSelRnTableEntryClass
ExtNetSelRnTablesClass
ExtNetSelSipMessageTable
ExtNetSelSipMessageTableEntry
ExtNetSelSipMessageTables
ExtNetSelTableClass
ExtNetSelTableEntryClass
ExtNetSelTablesClass
ExtNetSelUtcTable
ExtNetSelUtcTableEntry
ExtNetSelUtcTables
ExtNetSelWeightTable
ExtNetSelWeightTables
FeatureKey
FileGroup
FileGroupPolicy
FileInformation
FileM
FileMConfigData
Filter
Fm
FmAlarm
FmAlarmModel
FmAlarmType
Host
ICMP-Application
IcscfDynamicUserIdentitySupportClass
IcscfDynamicUserIdentitySupportGroupClass
IcscfNetworkInterface
IcscfNwIfs
Ikev1PolicyProfile
Ikev1Session
Ikev2PolicyProfile
Ikev2Session
IntegrationUnlock
IpsecPolicy
IpsecProposalProfile
IpsecTunnel
KeyFileInformation
KeyFileManagement
Ldap
LdapAuthenticationMethod
LdapClientApplication
LdapClientUser
LdapClientUserGroup
LdapServerEntry
Legacy
Lm
LocalAuthenticationMethod
LocalAuthorizationMethod
LogicalFs
ManagedElement
ManagedObject
MeasurementReader
MeasurementType
NeLSConfiguration
NetconfSsh
NetconfTls
NodeCredential
NtpServer
NumberNormalisation
NumNormContext
NumNormDefaultContext
NumNormDenormalizationSubstitutionRule
NumNormNsnData
NumNormOsnData
NumNormProfile
NumNormSubstitutionRule
PasswordPolicy
PasswordQuality
PcscfNetworkInterface
PcscfNwIfs
PcscfRfc2543Compatibility
Phase2Policy
Pm
PmGroup
PmJob
PmMeasurementCapabilities
PmThresholdMonitoring
Role
Role
RoleUpgrade
Rule
Schema
ScscfChargingAsInvolvementTriggerClass
ScscfChargingClass
ScscfChargingProfileClass
ScscfChargingProfilesClass
ScscfChargingRequestUriTriggerClass
ScscfChargingRoamingStatusTriggerClass
ScscfChargingSessionCaseTriggerClass
ScscfChargingSipHeaderTriggerClass
ScscfChargingSipMethodTriggerClass
ScscfChargingTransactionInfoClass
ScscfChargingTransactionTypeClass
ScscfChargingTriggerGroupClass
ScscfChargingTriggerGroupsClass
ScscfChargingTriggersClass
ScscfIfcClass
ScscfNetworkInterface
ScscfNodeDefaultIfc
ScscfNwIfs
ScscfOfflineChargingAVPsClass
ScscfOfflineChargingCauseClass
ScscfOfflineChargingEricssonServiceInformationClass
ScscfOfflineChargingEventTypeClass
ScscfOfflineChargingInterOperatorIdentifierClass
ScscfOfflineChargingOmits
ScscfOfflineChargingOmitVendor
ScscfOfflineChargingProfileClass
ScscfOfflineChargingPSInformationClass
ScscfOfflineChargingSDPMediaComponentClass
ScscfOfflineChargingServiceInformationClass
ScscfOfflineChargingSIPReasonClass
ScscfOfflineChargingSubscriptionIdClass
ScscfOfflineChargingTimeStampsClass
ScscfOnlineChargingAVPsClass
ScscfOnlineChargingEricssonServiceInformationClass
ScscfOnlineChargingEventTypeClass
ScscfOnlineChargingIMSInformationClass
ScscfOnlineChargingInterOperatorIdentifierClass
ScscfOnlineChargingMessageBodyClass
ScscfOnlineChargingProfileClass
ScscfOnlineChargingPSInformationClass
ScscfOnlineChargingSDPMediaComponentClass
ScscfOnlineChargingServiceInformationClass
ScscfOnlineChargingSIPReasonClass
ScscfOnlineChargingSubscriptionIdClass
ScscfOnlineChargingTimeStampsClass
ScscfRestorationClass
ScscfRestorationGroupClass
ScscfSharedIfcClass
ScscfSharedIfcGroupClass
ScscfSptClass
ScscfSptGroupClass
ScscfWiFiCallingLicenseModel
SecM
SigComp-Subsystem
Snmp
SnmpTargetV1
SnmpTargetV2C
SnmpTargetV3
SnmpTargetV3Dtls
SnmpViewV1
SnmpViewV2C
SnmpViewV3
Ssh
SshPublicKey
SwInventory
SwItem
SwM
SwVersion
SwVersionMain
SysM
SystemFunctions
ThresholdMonitoring
Tls
Transport
TrustCategory
TrustedCertificate
UpgradePackage
UserAccount
UserAccountM
UserManagement

 

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.
SecLA_AccountPolicy_dormantTimer[0..1]
dormantTimer = 180
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.
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 AccountPolicy  

 

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.
SecLA_AdministratorAccount_passwordFailureCountInterval[0..1]
passwordFailureCountInterval = 86400
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.
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.
SecLA_AdministratorAccount_passwordMaxFailure[0..1]
passwordMaxFailure = 3
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 AdministratorAccount  

 

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 AuthenticationOrder  

 

class AutonomousMode

ManagedElement
+-SystemFunctions
+-Lm
+-AutonomousMode

Autonomous Mode state information.

This MO is created by the system.

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

The value is NULL if the activation state is INACTIVE.

  class AutonomousMode  

 

class BcfNetworkInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-BcfNwIfs
+-BcfNetworkInterface

This is Managed Object Class for BCF Network Interface

Attributes
BcfNetworkInterfaceDT
key
mandatory
noNotification
restricted
bcfNetworkInterfaceEntry
This attribute defines the network interface the BCF uses to receive and send SIP traffic. To add an interface the BcfEnabled parameter must first be set true. One UDP transport address is mandatory for the BcfOperationalState parameter to become ENABLED and domain name entries must be in the internal DNS table as well. A TCP transport address can optionally be added and must be configured with the same port-nr and IP-address as the UDP interface for BcfOperationalState to become ENABLED. Maximum one UDP and one TCP interface can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
NetworkInterfaceStatusDT[0..1]
readOnly
bcfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
Note: The value NO_TRAFFIC_DIRECTION_SET indicates the initial state. Although the function of assigning traffic direction has been deprecated, for backwards compatibility reason, this value is kept.

  class BcfNetworkInterface  

 

class BcfNwIfs

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-BcfNwIfs
+-BcfNetworkInterface [0..]

This is Managed Object Class for BCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
bcfNwIfContainerKey
This is the key attribute of the BcfNwIfs class. One instance of the BcfNwIfs with the key bcfNwIfContainerKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class BcfNwIfs  

 

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 BrM  

 

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 BrmBackup  

 

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 BrmBackupHousekeeping  

 

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 BrmBackupLabelStore  

 

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 BrmBackupManager  

 

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 BrmBackupScheduler  

 

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 BrmCalendarBasedPeriodicEvent  

 

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.
BrM_BrmFailsafeBackup_timeoutLength[0..1]
timeoutLength = 1200
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.
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 BrmFailsafeBackup  

 

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 BrmPeriodicEvent  

 

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 BrmRollbackAtRestore  

 

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 BrmSingleEvent  

 

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 CapacityKey  

 

class CertM

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

The top class of the Certificate Management model.

Certificate management encompasses management of node credentials and trusted certificates.


This MO is created by the system.

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

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

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

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

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

Parameters

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

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



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


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 CertM  

 

class CertMCapabilities

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

Contains the certificate management capabilities of the ME.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
certMCapabilitiesId
The value component of the RDN.
EnrollmentSupport[1..] nonUnique
noNotification
readOnly
enrollmentSupport
Indicates the enrollment methods supported by the ME.
FingerprintSupport
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 CertMCapabilities  

 

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 ChainCertificate  

 

class CliSsh

ManagedElement
+-SystemFunctions
+-SysM
+-CliSsh

Represents the CLI configuration management service over Secure Shell.

This MO is created by the system.

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

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

  class CliSsh  

 

class CliTls

ManagedElement
+-SystemFunctions
+-SysM
+-CliTls

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

This MO is created by the system.

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

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

  class CliTls  

 

class 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 ComputeResourceRole  

 

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 CrM  

 

class CscfAccessNetworkAssertion

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfAccessNetworkAssertion

This is Managed Object Class for CSCF Access Network Assertion

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfAccessNetworkAssertionKey
This is the key attribute of the CscfAccessNetworkAssertion class. One instance of the CscfAccessNetworkAssertion with the key cscfAccessNetworkAssertionKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
AccessTypeValidationDT[0..] nonUnique ordered
pcscfAccessTypeValidationEntry
Allowed, limited access types and default access type of each supported IP address range is kept in this list. The list is indexed by IP range represented as subnet, for example 143.27.19.0/16. There can be multiple allowed access types per IP subnet. It is mandatory to define a default access type per IP subnet..
boolean
pcscfPaniAssertionEnabled = false
This parameter enables and disables the functionality of PANI Header Assertion in P-CSCF.
TrustedPaniGwDT[0..] nonUnique ordered
pcscfTrustedPaniGatewayEntry
A list of IP addresses of trusted PANI providing access gateways. The subnet is the key. The table is empty by default.

  class CscfAccessNetworkAssertion  

 

class CscfActiveUserLicenseModel

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfLicenseModelGroup
+-CscfActiveUserLicenseModel
+-CscfAdvancedProfileEntry [1..1]
+-CscfPersonalProfileEntry [1..1]

This is the basic container for the configuration parameters related to the CSCF Active User Licensing function.

This MO is created by the system.

Attributes
boolean
cscfActiveUserLicenseModelEnabled = false
This attribute enables or disables the Active User License Model Function.
String1to00010DT
key
mandatory
noNotification
restricted
cscfActiveUserLicenseModelId
This is the key attribute of CscfActiveUserLicenseModel. One instance of the CscfActiveUserLicenseModel with the key cscfActiveUserLicenseModeld=default is created at startup. This instance can’t be deleted. No other instances can be created of this class.
ActiveUserVoiceDT
readOnly
cscfActiveUserLicenseModelPolicy = VOICE
This attribute is used to indicate the active user license model policy. If the feature tag corresponding to the active user license model policy is included in the SIP Request, then the applicable license(s) will be incremented.
LicenseMeasurementIntervalDT
cscfActiveUserMeasurementInterval = oneMonth
This attribute is used to define the measurement interval as the unit of time that applies to the active user licenses.

  class CscfActiveUserLicenseModel  

 

class CscfAdvancedProfileEntry

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfLicenseModelGroup
+-CscfActiveUserLicenseModel
+-CscfAdvancedProfileEntry

This class contains all the attributes related to the CSCF Profile Active User Licensing function.

This MO is created by the system.

Attributes
AdvancedActiveUserRangeDT
cscfAdvancedMaxNumOfContacts = 10
This attribute is used to indicate the maximum number of Contacts for the Advanced Active User Profile. The attribute cscfAdvancedMaxNumOfContacts must be greater than cscfPersonalMaxNumOfContacts and cscfMultiDeviceNumberOfContacts (if present).
AdvancedActiveUserRangeDT
cscfAdvancedMaxNumOfIMPUs = 10
This attribute is used to indicate the maximum number of IMPUs for the Advanced Active User Profile. The attribute cscfAdvancedMaxNumOfIMPUs must be greater than cscfPersonalMaxNumOfIMPUs.
String0to65535DT
key
mandatory
noNotification
restricted
cscfAdvancedProfileEntryId
This is the key attribute of CscfAdvancedProfileEntry. One instance of the CscfAdvancedProfileEntry with the key cscfAdvancedProfileEntryId=advanced is created at startup. This instance can’t be deleted. No other instances can be created of this class.
boolean
cscfProfessionalActiveUsersEnabled = false
This attribute enables or disables the Professional Active User Function. The Professional users have user characteristics that surpass the user characteristics of Advanced users. Applicable only for the Advanced Active User Profile.

  class CscfAdvancedProfileEntry  

 

class CSCF-Application

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfAccessNetworkAssertion [1..1]
+-CscfAuthenticationGroupClass [1..1]
+-CscfChargingClass [1..1]
+-CscfConfigProfileMappingTableGroupClass [1..1]
+-CscfEmergencyGroupClass [1..1]
+-CscfGenericNumberPortability [1..1]
+-CscfHssQuarantine [1..1]
+-CscfIdentificationGroupClass [1..1]
+-CscfLicenseModelGroup [1..1]
+-CscfMediaContainer [1..1]
+-CscfMonitoredInterfaceGroupClass [1..1]
+-CscfNumPortability [1..1]
+-CscfNwIfContainer [1..1]
+-CscfNwTopologyGroupClass [1..1]
+-CscfPmConfigGroup [1..1]
+-CscfProfileGroupClass [1..1]
+-CscfRegistrationGroupClass [1..1]
+-CscfResourceBrokerClass [1..1]
+-CscfRoutingGroupClass [1..1]
+-CscfSecurityAdminGroup [0..1]
+-CscfServiceInvocationGroupClass [1..1]
+-CscfServicePriorityGroupClass [1..1]
+-CscfSipErrorConfigurationClass [1..1]
+-CscfSipMsgPreProcessing [1..1]
+-CscfSipOverloadControlGroup [1..1]
+-CscfSipProtocolGroupClass [1..1]
+-CscfSubscriptionGroup [1..1]
+-CscfSystemConfigGroupClass [1..1]
+-CscfTelephonyGroupClass [1..1]
+-CscfThrottledInterfaceGroup [1..1]
+-CscfTroubleshootingGroupClass [1..1]
+-CscfUaRestriction [1..1]
+-CscfUnallocatedRoutingContainer [1..1]
+-Ecscf [1..1]
+-IcscfDynamicUserIdentitySupportGroupClass [1..1]
+-ScscfRestorationGroupClass [1..1]
+-ScscfSharedIfcGroupClass [1..1]

This is Managed Object Class for CSCF Application

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
DomainNameDT[0..] nonUnique ordered
bcfDomainNameEntry
This attribute is the domain name of the BCF. This is the fully qualified domain name of the BCF node, if one exists. It is possible to configure multiple domain names of the BCF. The purpose with this is to have the possibility to address the same BCF node with different names, used at, for example, load sharing or network redundancy. It shall be noted that outgoing messages from the BCF will always include the first configured domain name.
boolean
bcfEnabled = false
Determines if the BCF application is available or not.
OperState
readOnly
bcfOperationalState = DISABLED
The attribute indicates the current operational state of the BCF. This operational state is based on the current configuration of the BCF and its ability to handle traffic. The following is required for BcfOperationalState to become ENABLED:
- BcfEnabled = true.
- One UDP instance of the BcfNetworkInterfaceEntry including all prerequisite information for that interface must be configured.
- If a TCP instance of the BcfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the UDP interface.
String0to01024DT[0..] nonUnique ordered
cscfActiveUserMethod = ""
A multi-value configuration parameter that specifies which SIP method, for example, INVITE, MESSAGE, will result in incrementing the cscfActiveUsers counter. If the configuration parameter is not defined, that is, empty, then the function Active Users is not active, that is, default. This is valid for when the SIP methods are either sent or received by users.
AdmState
cscfAdministrativeState = LOCKED
A short description of the behavior of CSCF at different states of CscfAdministrativeState is given here. Refer to "CSCF Configuration Management User Guide" for detailed description considering the different CSCF types and collocation aspects.

When the node is in state: 0 (Locked), the CSCF is to be taken out of service as soon as possible. Established sessions except emergency sessions are released, users are deregistered and new SIP requests are rejected.

When the node is in state: 1 (Unlocked), the CSCF node handles requests and performs functions normally.

When the node is in state: 2 (Shutting down), the CSCF is gracefully taken out of service with minimal traffic disturbance. As long as users are registered, non-register traffic is processed as when in "Unlocked" state. Users are de-registered/re-distributed when handling registration traffic. When all users are de-registered/re-distributed and all sessions are terminated the CSCF will automatically transit from "Shutting down" to "Locked" state.
AkaAlgorithmDT[6..6] nonUnique ordered
cscfAkaAlgorithmEntry = 1:hmac-md5-96,aes-cbc:enabled,2:hmac-sha-1-96,aes-cbc:enabled,3:hmac-md5-96,des-ede3-cbc:enabled,4:hmac-sha-1-96,des-ede3-cbc:enabled,5:hmac-md5-96,null:enabled,6:hmac-sha-1-96,null:enabled
This parameter let the user enable and disable specific AKA algorithm encryption-algorithm pairs and change the priority order for them. CSCF will always use the pair with the lowest priority number that match the UE supported list of algorithms.
CicRoutingDT
cscfCicRoutingEnabled = DISABLED
This parameter controls how the S-CSCF shall invoke the External Network selection when the CIC (Carrier Identification Code) parameter is available.
boolean
cscfCxAlwaysUseRealmBasedRouting = false
Determines whether CSCF should always use realm based diameter routing on the Cx/Dx interface.
CxDestinationHostDT[0..1]
cscfCXDestinationHost = ""
This parameter identifies the Home Subscriber Server (HSS) that the Cx and/or Sh Diameter message is sent to.
This value is used in the Destination-Host AVP. If the Subscriber Location Function (SLF) or an HSS redundant cluster is used, this parameter value must be set to "NotConfigured". In the SLF case only the SLF is defined as default route in the Diameter stack. In the HSS redundant cluster case all HSS in the cluster are defined as default routes in the Diameter stack.
String0to00100DT[0..1]
cscfCXDestinationRealm = ""
This parameter identifies the realm the Cx and/or Sh Diameter message is to be routed to. The absence of the CscfCxDestinationHost will cause a message that is sent to any diameter server supporting the application within the realm specified in Destination-Realm AVP.
String0to00100DT[0..1]
cscfCXOriginHost = ""
This parameter identifies the CSCF that originated the Cx and/or Sh Diameter message. This value is used in the Origin-Host AVP.
String0to00100DT[0..1]
cscfCXOriginRealm = ""
This parameter identifies the realm of the CSCF of the Cx and/or Sh Diameter message. This value is used in the Origin-Realm AVP.
DbSweeperTimeDT
cscfDatabaseSweeperTime = 03:00
This attribute defines the time when the CSCF database sweeper executes to purge stale data from the database.
Fqdn0to1024orEmptyDT[0..] nonUnique ordered
cscfDomainAlias
Every entry in the list must be an FQDN. An FQDN is a string that starts with a letter and contains only letters, numbers, "-" (hyphens) or "." (dots).

CscfDomainAlias is used to specify the Domain Name(s) that are applicable to the home network. This information is used by the P-CSCF, the S-CSCF and the I-CSCF functions. Note: If CscfDomainAlias is empty, all domains are considered to be applicable to the home network. CscfDomainAlias is used for the following functionality:

·

P-CSCF uses CscfDomainAlias to determine if the I-CSCF is colocated for initial REGISTER requests. P-CSCF compares the content of the request-URI, which contains the home domain name, with the domains configured in CscfDomainAlias. If a match is found, then the P-CSCF invokes the colocated I-CSCF function. Having CscfDomainAlias empty will always invoke the colocated I-CSCF function.

·

Originating S-CSCF uses CscfDomainAlias to determine if SIP-URI that contains a telephone number will be treated as telephone number or if the SIP-URI will be routed normally using the domain part.

·

I-CSCF uses CscfDomainAlias to determine if a non-REGISTER request should be redirected, when a 300, 301, 302 or 380 response is received.
String1to01024DT[0..] nonUnique ordered
cscfDomainBasedPSIRoutingEntry
A list of subdomains expressed as regular expressions. In case an INVITE request is received and the requested domain is found in the CscfDomainBasedPSIRoutingEntry, but not found in the HSS, the CSCF will send the INVITE request to the subdomain using the Domain Name Server (DNS).

An example of a regular expression is /^mrf.*\.ericsson\.com$/i. This would be a case insensitive search that matches domains starting with mrf and ending with ericsson.com
boolean
cscfEnableGlobalNumberNormalization = false
Determines if number normalization will be performed on global (international) telephone numbers.

Dependencies: CscfGlobalNumberNormalizationPhoneContext needs to be configured before CscfEnableGlobalNumberNormalization can be set to true.
boolean
cscfEnableRecordRouteSubscribe = true
This parameter controls if S-CSCF shall record-route SUBSCRIBE requests or not. If set to true, the S-CSCF will add a Record-Route header in the initial SUBSCRIBE request in order to receive all subsequent messages within the dialog. If set to false, the S-CSCF will not add Record-Route header (to minimize network traffic) in SUBSCRIBE dialog. However, when the Public GRUU feature is enabled and GRUU routing is used to route a SUBSCRIBE request, the S-CSCF still Record-Route even if this parameter is set to false. P-CSCF always Record-Route SUBSCRIBE dialogs.
boolean
cscfEnumForLocalNumbersEnabled = true
This attribute configures the behavior in originating S-CSCF when a non global number is returned from the number normalization.
Fqdn0to1024orEmptyDT
cscfEnumTopDomain = e164.arpa
When CSCF is performing an ENUM lookup, CscfEnumTopDomain is used as top domain when performing ENUM queries.
OnEnumPstnDT
cscfExtNetSelOnEnumPstn = Tel
This attribute configures the behavior in S-CSCF when an ENUM response indicates E2U+pstn.
boolean
cscfExtNetSelOnRnBeforeEnum = false
This attribute configures the behavior in S-CSCF when an RN parameter is present in the request URI which contains a telephone number.
ForkingTimerDT
cscfForkingTimer = 12
This attribute defines the number of seconds the CSCF will wait for an answer message (2XX). It attempts by forking a request in parallel. If the attempt fails then the CSCF attempts contacts with a lower q-value.
TimerMin0to5DT
cscfGaugeInterval = 2
Defines the interval for how often the CSCF will send the number of sessions and registrations to the PMF for the gauges:
- cscfPeakConcurrentRegistration
- cscfConcurrentRegistrations
- cscfPeakConcurrentSessions
- cscfConcurrentSessions
- cscfPeakConcurrentRegisteredUserProfiles
- cscfConcurrentRegisteredUserProfiles
- scscfConcurrentUnregisteredUserProfiles
- scscfPeakConcurrentUnregisteredUserProfiles
- eatfPeakConcurrentSessions
- eatfConcurrentSessions

If set to 0 the value will never be sent and the gauges will not be used.
Example: If set to 2 it will send the current registrations and sessions every two minutes.
For more information about CSCF counters, see the following document: CSCF Performance Management Parameters
String0to01024DT[0..1]
cscfGlobalNumberNormalizationPhoneContext = ""
Phone context to use when performing number normalization on a global telephone number. CscfGlobalNumberNormalizationPhoneContext needs to be configured before CscfEnableGlobalNumberNormalization can be set to true.
CscfBehaviorDT
cscfISPBehavior = ISP
This attribute determines the behavior of the P-, I-, and S-CSCF application. It can only be set if CscfAdministrativeState =LOCKED.
OperState
readOnly
cscfISPOperationalState = DISABLED
This attribute indicates the current operational state of the I,S and P- CSCF. This operational state is based on the current configuration of the node and its ability to handle traffic. Operational state prerequisites:

I-CSCF operational state requirements (CscfISPBehavior = I_CSCF):
- One UDP instance of the IcscfNetworkInterfaceEntry must be configured including all prerequisites.
- If a TCP instance of the IcscfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the UDP interface.
- The parameters CscfCXOriginRealm, CscfCXOriginHost CscfCXDestinationRealm, and CscfCXDestinationHost must be configured.

P-CSCF operational state requirements (CscfISPBehavior = P_CSCF):
- Two UDP instance of the PcscfNetworkInterfaceEntry must be configured including all prerequisites. (One instance for Gm and one for Mw).
- If a TCP PcscfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the corresponding UDP interface.

S-CSCF operational state requirements (CscfISPBehavior = S_CSCF):
- One UDP instance of the ScscfNetworkInterfaceEntry instances must be configured including all prerequisites.
- If a TCP ScscfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the UDP interface.
- Parameter CscfChargingInterOpId must be configured.

IS-CSCF operational state requirements (CscfISPBehavior = IS):
- One UDP instance of the IcscfNetworkInterfaceEntry must be configured including all prerequisites.
- One UDP instance of the ScscfNetworkInterfaceEntry must be configured including all prerequisites.
- If a TCP instance of the IcscfNetworkInterfaceEntry or ScscfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the corresponding UDP interface.
- Parameters CscfCXOriginRealm, CscfCXOriginHost, CscfCXDestinationRealm, CscfCXDestinationHost, and CscfChargingInterOpId must be configured.

ISP-CSCF operational state requirements (CscfISPBehavior = ISP):
- One UDP instance of the IcscfNetworkInterfaceEntry must be configured including all prerequisites.
- One UDP instance of the ScscfNetworkInterfaceEntry must be configured including all prerequisites.
- Two UDP instances of the PcscfNetworkInterfaceEntry must be configured including all prerequisite. (One instance for Gm and one for Mw).
- If a TCP instance of the IcscfNetworkInterfaceEntry, ScscfNetworkInterfaceEntry or PcscfNetworkInterfaceEntry has been configured it must be configured with same IP-address and port as the corresponding UDP interface.
- Parameters CscfCXOriginRealm, CscfCXOriginHost, CscfCXDestinationRealm, CscfCXDestinationHost and CscfChargingInterOpId must be configured.

Note: If CscfISPBehavior = NONE then CscfISPOperationalState will be disabled.
MaxNonSupervisedSessionDurationDT
cscfMaxNonSupervisedSessionDuration = 1440
The maximum allowed duration for a session in the CSCF that has been established without client support for session timers.
boolean
cscfNumberPortabilityRejectOnFailedENUM = false
This parameter configures CSCF behavior when ENUM error response SERVFAIL is received.
boolean
cscfOnwardRoutingEnabled = false
This parameter is used by the Number Portability Function. This parameter controls the availability of the breakout gateway control function for terminating calls for ported number.
boolean
cscfOverrideDefaultContext = false
If this parameter is enabled, the P-CSCF overrides phone-context, if provided.
String0to01024DT[0..1]
cscfPhoneContext = ""
This parameter specifies the phone-context. The phone-context shall be added to a SIP URI with a local number. P-CSCF adds the phone-context dependent on the above mentioned parameters. S-CSCF adds the phone-context if it is missing and if it is not provisioned in the user profile.
boolean
cscfProvideDefaultContext = false
If this parameter is enabled, the P-CSCF will add a phone-context parameter to all originating SIP requests that have a SIP URI in the Request-URI with a local number, if the context is not already present.
boolean
cscfReducedTransactionLifespan = false
This attribute defines if Timer H and Timer J must take the standard value 64*T1 or use the configured value for. Timer H is used to supervise reception of ACK in the INVITE transaction (non-2xx) and Timer J defines the maximum waiting time for request retransmits for a non-INVITE request. It defines as well if the waiting time for ACK retransmits in a successful session setup must take the standard value 64*T1 or use the configured value for .
RegEventEnabledDT
cscfRegEventEnabled = disabled
The CscfRegEventEnabled parameter is used for enabling or disabling the registration event functionality in the CSCF node. Furthermore, in the enabled configuration, the CscfRegEventEnabled parameter indicates a particular enabled-mode for the registration event functionality.

Deprecated: 

boolean
cscfRegEventFullStateNotification = true
This parameter specifies whether the registration information in the NOTIFY request will contain full state information or partial state information.

Deprecated: 

RegEventMaxNotificationRateDT
cscfRegEventMaximumNotificationRate = 5
This parameter specifies the minimum time spent between subsequent notifications sent for the same public user identity.

Deprecated: 

boolean
cscfRegEventNotifyOnResubscribe = false
This parameter specifies if the S-CSCF will send notifications or not as answer to a refreshment of the subscription.

Deprecated: 

RegEventRefreshTimerDT
cscfRegEventRefreshMax = 60
This parameter is used to set the maximum refresh time for Registration Event requests. Any RegEvent request received with a refresh time greater than what is specified in this parameter will be reduced to this value in the 200 OK. The time is defined in minutes and must be greater than CscfRegEventRefreshMin.

Deprecated: 

RegEventRefreshTimerDT
cscfRegEventRefreshMin = 15
This parameter is used to set the minimum refresh time for Registration Event requests. Any RegEvent request with a refresh time below this value is rejected. The time is defined in minutes and must be less than CscfRegEventRefreshMax.

Deprecated: 

boolean
cscfRemoveDialogueOnNegativeNotifyResponse = true
This attribute defines if CSCF should remove the SUBSCRIBE dialog after a negative response on a NOTIFY request (except 5xx response with Retry-After header) is received, or no response is received during subscription initiation, subscription refreshment or event state change.
true - The SUBSCRIBE dialog will be removed.
false - The SUBSCRIBE dialog will be kept.
ReplaceRequestUriDT
cscfReplaceRequestUriWithDefaultIMPU = Inactive
Activating this parameter will trigger the terminating S-CSCF to replace the public identity in the Request-URI with the default public user identity before sending the request to an application server. The logic will be applied only if the addressed user is part of an implicit registration set.
The default value of the parameter is Inactive, which means that the terminating S-CSCF will not replace the Request-URI.
Setting this parameter to ReplaceTelOnly will triggers the terminating S-CSCF to only change the Request-URI in case the Request-URI is of schema type TEL. No other URI schemas will be changed.
Setting this parameter to AlwaysUseDefault will trigger the terminating S-CSCF to unconditionally replace the Request-URI.
Setting this parameter to UseDefaultAsServedUser will trigger the terminating S-CSCF to always replace the Request-URI with the default public user identity and to use the default public user identity as served user. Terminating S-CSCF will invoke the service profile of the default public user identity and include the default public user identity in the P-Server-User header and in the Original Dialog Identifier.
Setting this parameter to ReplaceTelAsServedUser will trigger the terminating S-CSCF to replace the Request-URI with the default public user identity if the received Request-URI contains a TEL-URI. Terminating S-CSCF will invoke the service profile of the default public user identity and include the default public user identity in the P-Server-User header and in the Original Dialog Identifier if the Request-URI was replaced.
Note:
1. When a TEL-URI with uri-parameters is received by the terminating S-CSCF in the Request-URI, if the CscfReplaceRequestUriWithDefaultIMPU is configured to replace the Request-URI with the default public user identity, and the default public identity is in SIP-URI, the value of Request-URI is replaced by the default public user identity (in SIP-URI) concatenated with the associated uri-parameters received in the original TEL-URI.
2. When the CscfReplaceRequestUriWithDefaultIMPU is configured to replace the Request-URI with the default public user identity, after the value of Request-URI has been replaced successfully, the value of P-Called-Party-ID is also replaced with the default public user identity. However, the following exceptions apply:
* The value of Request-URI received is with Globally Routable User Agent URI
* IcscfDynamicUserIdentitySupportEnabled attribute is set to true



Takes effect: ChangeTypeRuntimeType - Session
boolean
cscfRequireUserEqualPhone = true
If this parameter is true, any SIP URI must have the user=phone parameter to be considered as a telephone number.
TimerSec0to30DT
cscfScscfFailoverTimer = 7
cscfScscfFailoverTimer gives the time in seconds for which the I-CSCF will wait for an answer from an S-CSCF (via Mw interface), an AS (via Ma interface) or an EATF (via I5 interface) before trying another node instance. This parameter is only applicable for responses to INVITE and REGISTER requests. If this parameter is disabled (set to 0), cscfSipDefaultFailoverTimer will be used instead.

Takes effect: ChangeTypeRuntimeType - Session / Registration
boolean
cscfSendRequestUdpOnly = false
If set to true, all requests are sent using UDP independent of message size or explicit TCP transport indications. If set to false, the requests will be sent according to the rules in RFC3261 and RFC3263.
ServedUserIdSelectionDT
cscfServedUserIdentitySelection = PPreferredId
This parameter specifies the procedure to be used for selecting the identity of the served user in the P-CSCF node.
SessionRefreshTimerDT
cscfSessionRefreshDefault = 30
This attribute is the default session refresh time for the CSCF in minutes. The CSCF will use this time in cases when no session expires value is provided in the request and a default value is needed. This value can be between 1 and 1440 minutes but must be less than or equal to CscfSessionRefreshMax and greater or equal to CscfSessionRefreshMin.
SessionRefreshTimerDT
cscfSessionRefreshMax = 60
This attribute is the maximum session refresh time allowed by the CSCF in minutes. Any session refresh time specified greater than this value is reduced to equal this value. This value can be between 1 and 1440 minutes but must be equal or greater than CscfSessionRefreshMin.
SessionRefreshTimerDT
cscfSessionRefreshMin = 15
This attribute is the minimum session refresh time allowed by the CSCF in minutes. Any request with a refresh time below this value is rejected. This value can be between 1 and 1440 minutes but must be equal or less than CscfSessionRefreshMax.
boolean
cscfSigCompEnabled = false
This attribute is OBSOLETE. It’s no longer possible to enable Signaling Compression function.
This Boolean attribute used to control whether the P-CSCF enabled SigComp when sending messages to and receiving messages from a SigComp compatible client.


Obsolete: This attribute is obsolete because the Signaling Compression functionality is disabled in CSCF.

SipPmKeyDT[0..18] nonUnique ordered
cscfSipPMKey = ""
List of IP addresses that are used for the keyed Session Initiation Protocol (SIP) stack counters.
SmpAuthorizationDT
cscfSmpAuthorization = Inactive
Disable or enable the Subscribed Media Profile (SMP) Authorization function.
TimerMSec0to2000000000DT
cscfTimerBValue = 32000
The CscfTimerBValue is used to configure the value of the SIP B timer that is used to control the transmission of SIP messages. Timer B is the INVITE transaction time-out timer. Only used to the access side. If this parameter is disabled (set to 0), CscfSipDefaultFailoverTimer will be used instead.
TimerMSec180000to600000DT
cscfTimerCValue = 180000
The CscfTimerCValue is used to configure the value of the SIP C timer that is used to control the transmission of SIP messages. Timer C is the proxy INVITE transaction time-out.
TimerMSec32000to300000DT
cscfTimerDValue = 32000
The CscfTimerDValue is used to configure the value of the SIP D timer that is used to control the transmission of SIP messages. Timer D is the wait time for response retransmits. Only used to the access side otherwise the value recommended by the RFC is used (64*T1).
TimerMSec0to2000000000DT
cscfTimerFValue = 32000
The CscfTimerFValue is used to configure the value of the SIP F timer that is used to control the transmission of SIP messages. Timer F is the non-INVITE transaction time-out timer. Only used to the access side. If this parameter is disabled (set to 0), CscfSipDefaultFailoverTimer will be used instead.
TimerMSec1to180000DT
cscfTimerT1Value = 500
The CscfTimerT1Value is used to configure the value of the SIP T1 timer that is used to control the transmission of SIP messages. T1 is the Round Trip Time (RTT) in ms.
TimerMSec1to180000DT
cscfTimerT2Value = 4000
The CscfTimerT2Value is used to configure the value of the SIP T2 timer that is used to control the transmission of SIP messages. T2 is the maximum retransmit interval for non-INVITE requests and INVITE responses.
TimerMSec1to180000DT
cscfTimerT4Value = 5000
The CscfTimerT4Value is used to configure the value of the SIP T4 timer that is used to control the transmission of SIP messages. T4 is the Maximum duration a message will remain in the network.
boolean
cscfTrustedNetwork = false
This attribute specifies if both headers P-Charging Vector (PCV) and the P-Charging-Function-Address (PCFA) should be removed or included in the outgoing SIP Signaling. Note: The P-Charging Vector header may not contain the IOI parameters due to the fact that the IOI parameters are removed by S-CSCF before forwarding to P-CSCF. CSCF supports Type 2 IOI parameter as per 3GPP TS 24.299 Standards.
boolean
cscfUnallocatedRoutingEnabled = false
Enables or disables the CSCF unallocated routing functionality.

Dependencies: CscfUnallocatedPublicServiceIdentity must be configured before CscfUnallocatedRoutingEnabled can be set to true. Before CscfUnallocatedRoutingEnabled can be set to false, CscfUnallocatedPublicServiceIdentity must have a different value than "empty".
UsageStateDT
readOnly
cscfUsageState = ACTIVE
This attribute indicates the current usage state of the CSCF. This usage state is based on the number of registrations and sessions maintained by the CSCF. If there is one ongoing session or one registration, the value is active. Otherwise, it is idle.
DomainNameDT[0..] nonUnique ordered
icscfDomainNameEntry
This attribute is the domain name of the I-CSCF. This is the fully qualified domain name of the I-CSCF node, if one exists. It is possible to configure multiple domain names of the I-CSCF. The purpose with this is to have the possibility to address the same I-CSCF node with different names, used at, for example, load sharing or network redundancy. It shall be noted that outgoing messages from the I-CSCF will always include the first configured domain name.
TimerSec0to30DT
icscfNonInviteFailoverTimer = 0
icscfNonInviteFailoverTimer gives the time in seconds for which the I-CSCF will wait for an answer from a S-CSCF (via Mw interface), or an AS (via Ma interface) before trying another node instance. The parameter is only applicable for responses to non-INVITE requests, except REGISTER.
If this parameter is disabled (set to 0), cscfSipDefaultNonInviteFailoverTimer will be used instead.


Takes effect: ChangeTypeRuntimeType - Session
boolean
icscfTransitEnabled = false
This attribute configures the behavior in terminating I-CSCF when the user is not found in HSS and no other service initiates an alternative routing.
DomainNameDT[0..] nonUnique ordered
pcscfDomainNameEntry
This attribute is the domain name of the P-CSCF. This is the fully qualified domain name of the P-CSCF node, if one exists. It is possible to configure multiple domain names of the P-CSCF. The purpose with this is to have the possibility to address the same P-CSCF node with different names, used at, for example, load sharing or network redundancy. It shall be noted that outgoing messages from the P-CSCF will always include the first configured domain name.
boolean
scscfContactUriMatchingEnabled = false
true: Contact URI matching for the request is enabled.
false: Contact URI matching for the request is disabled.

This parameter enables and disables the usage of Contact-URI matching for identifying information of a registered contact for Originating Non-Register requests. When enabled, the Contact-URI in the received request is used to match with Contact-URI stored at registration. If the Contact URIs do not match or the Contact-URI is missing from the received request, the request is rejected.
DomainNameDT[0..] nonUnique ordered
scscfDomainNameEntry
This attribute is the domain name of the S-CSCF. This is the fully qualified domain name of the S-CSCF node, if one exists.

  class CSCF-Application  

 

class CscfAuthenticationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfAuthenticationGroupClass
+-CscfAuthenticationClass

This is Managed Object Class for CSCF Authentication

Attributes
AkaStalenessTimerDT
cscfAkaStalenessTimer = 1440
Maximum lifetime for AKA authentication. A zero value means that the timer never expires. This parameter is NOT access aware.
String0to65535DT
key
mandatory
noNotification
restricted
cscfAuthentication
This is the key attribute of the CscfAuthenticationClass containing all the authentication parameters. One instance of the CscfAuthenticationClass with the key CscfAuthentication=default is created at startup. It is possible to create new instances. The default instance can not be deleted.
boolean
cscfAuthenticationBlackListEnabled = false
This parameter is used to enable and disable the Blacklist function. Default is set to false, that means the function is not enabled.
AuthPolicyDT[7..] nonUnique ordered
cscfAuthenticationPolicyEntry = Re-Registration:disabled,User Initiated De-Registration:disabled,INVITE:disabled,BYE:disabled,MESSAGE:disabled,SUBSCRIBE:disabled,NOTIFY:disabled
This attribute defines the authentication policy for a specific SIP method or registration condition. Multiple attributes of this type are allowed. The default values cannot be removed, but the policy part can be changed. This parameter is access aware.

This attribute value is in the form of: "method":"policy" or "registration_type":"policy"
method = string defining SIP method type such as INVITE
policy = enabled or disabled
registration_type = Re-Registration, User Initiated De-Registration
AuthProcedureDT
cscfAuthenticationProcedure = digest
Used for authentication optimization, to avoid the second round trip of the challenge / response after the inital registration. This parameter only applies to Digest authentication.
This parameter is NOT access aware.
Integer1to65535DT
cscfBlackListLoggingFrequency = 1
This parameter defines the maximum number of blacklist time periods have to complete before log is issued. Default is set to 1. Unit: Number of blacklist time periods.
BlacklistMaxAuthAttemptsDT[0..1]
cscfBlackListMaxAuthenticationAttempt = 3
This parameter is used to configure the limit of the number of consecutive authentication attempts due to a failed verification of an authentication response. When max value is reached, the SIP client is blacklisted. All subsequent authentication attempts from this SIP client will be rejected by S-CSCF for the period of time specified in the CscfBlackListTimer parameter. This parameter is NOT access aware.
Integer0to65535DT[0..1]
cscfBlackListTimer = 300
This parameter is used to configure the period of time in seconds that the user's request will not be processed and rejected due to maximum number of failed authentications.
String0to01024DT[0..] nonUnique ordered
cscfNBAAccessNetworkType
This parameter contains a list of access network types for which NASS bundled authentication is applicable. If the list is empty, the NBA function is disabled. Default is an empty list. This parameter is NOT access aware.

Format: P-Access-Network-Info header, Access network types
Integer0to65535DT
cscfNbaChallengeAuthenticationNonceTimeLength = 0
This parameter is used to configure the length of time in seconds that a nonce used in a NBA (NASS Bundled Authentication) Challenge Authentication response, is considered valid. A zero value means that the timer never expires. This parameter is NOT access aware.

Takes effect: ChangeTypeRuntimeType - Session / Registration
AuthPolicyEnabledDT
cscfOverallAuthenticationPolicyEnabled = enabled
This attribute defines the overall authentication policy for the CSCF. If this is set to enabled, initially all initial registrations are always authenticated. The authentication of all other requests is based on the CscfAuthenticationPolicyEntries. This parameter is NOT access aware.
Integer1to65535DT[0..1]
cscfSipDigestAuthenticationNonceReusabilityLimit = 10
This parameter is used to configure the maximum number of times a generated nonce can be reused. This parameter is NOT access aware.
Integer0to65535DT[0..1]
cscfSipDigestAuthenticationNonceTimeLength = 900
This parameter is used to configure the length of time in seconds that a nonce used in a Digest Authentication response, is considered valid. This parameter is NOT access aware. A zero value means that the timer never expires.
boolean
cscfSSOAuthenticationEnabled = false
If set to true, Single Sign-On authentication is enabled. This parameter is access aware.

Deprecated: 

TrustedAsDT[0..] nonUnique ordered
cscfTrustedASEntry = 0.0.0.0
This parameter holds a list of trusted application servers. Each CscfTrustedASEntry forming the list contains an IPv4 or IPv6 address. This parameter is NOT access aware.
TrustedGwDT[0..] nonUnique ordered
cscfTrustedGatewayEntry = 0.0.0.0/32
This parameter holds a list of trusted SIP gateway nodes. Each CscfTrustedGatewayEntry forming the list contains an IPv4 or IPv6 address and the prefix length, separated by a slash sign "/". The prefix length is a number between 0 - 32 for IPv4 and between 0 - 128 for IPv6. This is the amount of bits of the IP address that are the subnet. The CSCF uses this list to authenticate SIP nodes that do not support digest authentication.
boolean
scscfGibaAuthenticationEnabled = false
This parameter is used for enabling or disabling the GIBA (GPRS IMS Bundled Authentication) authentication in the CSCF node. This parameter is access aware. ScscfGibaAuthenticationEnabled cannot be enabled at the same time as ScscfSipDigestAuthenticationRealm is configured.
boolean
scscfNbaAuthSchemeUnknownEnabled = false
If set to true, Line Profile is enabled. This parameter is not access aware.
boolean
scscfNbaChallengeEnabled = false
This parameter is used to enable and disable the additional challenge for the NBA authentication. If enabled, a challenge is included as part of the NBA authentication for all REGISTER and possibly De-REGISTER, Re-REGISTER and INVITE requests.
HssBypassDT
scscfReRegWithAuthBypass = NO_BYPASS
NO_BYPASS=CSCF performs normal reregistration handling with HSS inquiry.
BYPASS_ IF_FAILED= The reregister request is sent directly to S-CSCF when HSS inquiry fails due to HSS overloaded, no reply or request not sent due to throttling.
String0to01024DT[0..1]
scscfSipDigestAuthenticationRealm = ""
This parameter is used for indicating the Digest Authentication Realm for Digest users in the CSCF node.
This parameter contains a string to be displayed to users so they know which username and password to use.
This string contains at least the name of the host performing the authentication.
This parameter is also used for enabling or disabling Digest authentication for UEs not sending SIP Authorization header in 1st REGISTER, in the CSCF node.
The presence of a non-empty Digest Authentication Realm enables the feature.
Empty string means Digest authentication for UEs not sending SIP Authorization header in 1st REGISTER is disabled
This parameter MUST be configured with the same content as Digest-Realm is configured in HSS.
This parameter is access aware.
ScscfSipDigestAuthenticationRealm cannot be enabled at the same time as ScscfGibaAuthenticationEnabled.
Example: "Welcome to the ims.XYZ.net network, please insert your username and password"

  class CscfAuthenticationClass  

 

class CscfAuthenticationGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfAuthenticationGroupClass
+-CscfAuthenticationClass [1..]

This class contains all the attributes related to the Cscf Authentication Group.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfAuthenticationGroup
This is the key attribute of the CscfAuthenticationGroupClass. One instance of the CscfAuthenticationGroupClass with the key CscfAuthenticationGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfAuthenticationGroupClass  

 

class CscfCallerPreferencesClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfRoutingGroupClass
+-CscfCallerPreferencesClass

This is a container class for the CSCF Caller Preferences related attributes.

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfCallerPreferences
This is the key attribute of the CscfCallerPreferencesClass containing all the Caller Preferences parameters. One instance of the CscfCallerPreferencesClass with the key CscfCallerPreferences=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
boolean
scscfEnhancedCallerPreferencesEnabled = false
The operator shall be able to enable or disable the enhanced Caller Preferences function using a this parameter. The default of this parameter shall be disabled. This means the legacy Caller Preferences is applied. When the parameter is set to enable, the enhanced Caller Preferences is applied.
ImmuneContactsBehaviorDT
scscfImmuneContactsPolicy = HIGHEST_PRIORITY
This parameter is used to set the priority of the immune contacts for terminating contacts prioritization of the Caller Preferences function.

  class CscfCallerPreferencesClass  

 

class CscfChargingClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass [1..1]
+-ScscfChargingClass [1..1]

This is Managed Object Class for CSCF Charging

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfCharging
This is the key attribute of the CscfChargingClass class. One instance of the CscfChargingClass with the key cscfCharging=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
ChargingBackupRetryIntervalDT
cscfChargingBackupRetryInterval = 100
Defines the rate at which backup will check for an available charging server.
ChargingCancelCauseDT
cscfChargingCancelCauseCode = SUCCESSFUL_TRANSACTION
Cause Code to be sent in ACR[EVENT] for CANCEL sent to S-CSCF and E-CSCF for a not established session.
Fqdn0to1024orEmptyDT[0..1]
cscfChargingInterOpId = ""
The parameter defines the domain of the CSCF and is used to identify both the originating and terminating networks involved in a SIP dialog or transaction outside a dialog. There is an IOI generated from each side of the dialog to identify the network associated with each side.
TimerMSec100to1000DT
cscfChargingResendingTimer = 200
Defines the length of the pause from the response to a stored request until the next stored request is sent.
ChargingSessionTimerExpiresDT
cscfChargingSessionTimerExpiresCauseCode = UNSPECIFIED_ERROR
Cause Code to be sent in ACR[STOP] and CCR[TERMINATE] when Session Timer expires and S-CSCF releases the session.
MaxNumBackupPerDestDT
cscfMaxNumChargingBackupfilesPerDestination = 1
Configuration for maximum number of concurrent files per destination realm or per destination host in charging backup function.
Fqdn0to1024orEmptyDT[0..1]
cscfOwnChargingHost = ""
The Diameter host name identifying the CSCF node on the Charging Interface. The CSCF inserts the configured value of CscfOwnChargingHost in the Origin-Host AVP.
Fqdn0to1024orEmptyDT[0..1]
cscfOwnChargingRealm = ""
The Diameter realm that the CSCF node belongs to. The CSCF inserts the configured value of CscfOwnChargingRealm in the Origin-Realm AVP.

  class CscfChargingClass  

 

class CscfConfigProfileMappingTableClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfConfigProfileMappingTableGroupClass
+-CscfConfigProfileMappingTableClass

This is Managed Object Class for CSCF Configuration Profile Mapping Table

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfConfigProfileMappingTable
This is the key attribute of the CscfConfigProfileMappingTableClass. One instance of the CscfConfigProfileMappingTableClass with the key CscfConfigProfileMappingTable=AccessType is created at startup. This instance can't be deleted. No other instances can be created of this class.
String0to00256DT[0..] nonUnique ordered
cscfConfigProfileMappingTableEntry
This multi value attribute defines what configuration profile to be used for what access type. An access type can only exist once in the list but several access types can point to the same profile. A CscfConfigProfile must have been configured before it can be pointed out to be used for a specific access type.

Each entry in the list follows the syntax &lt;Access type&gt;:&lt;CscfProfile&gt;

  class CscfConfigProfileMappingTableClass  

 

class CscfConfigProfileMappingTableGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfConfigProfileMappingTableGroupClass
+-CscfConfigProfileMappingTableClass [1..1]

This is Managed Object Class for CSCF Configuration Profile Mapping Table Group

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfConfigProfileMappingTableGroup
This is the key attribute of the CscfConfigProfileMappingTableGroupClass. One instance of the CscfConfigProfileMappingTableGroupClass with the key cscfConfigProfileMappingTableGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfConfigProfileMappingTableGroupClass  

 

class CscfDialogEvent

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSubscriptionGroup
+-CscfDialogEvent

This is a container class containing dialog event related attributes.


This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfDialogEventId
This is the key attribute of the CscfDialogEventClass. One instance of the CscfDialogEventClass with the key CscfDialogEventClassId=default is crated at startup. This instance cannot be deleted.
DialogEventRefreshTimerMaxDT
noNotification
cscfDialogEventRefreshMax = 60
This parameter is used to set the maximum refresh time for Dialog Event SUBSCRIBE requests. Any Dialog Event SUBSCRIBE request with a refresh time greater than what is specified in this parameter will be reduced to the value in the 200 OK. The time is defined in minutes, the value must be set to be greater than the value of CscfDialogEventRefreshMin.
DialogEventRefreshTimerMinDT
noNotification
cscfDialogEventRefreshMin = 15
This parameter is used to set the minimum refresh time for Dialog Event SUBSCRIBE requests. Any Dialog Event SUBSCRIBE request with a refresh time below the value (excluding 0) is rejected. The time is defined in minutes, the value must be less than the value of cscfDialogEventRefreshMax.

  class CscfDialogEvent  

 

class CscfDomainRoutingApplication

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations [1..1]

This is the root class and basic container for the configuration parameters related to the CSCF Domain Routing function.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
String1to00128DT
readOnly
cscfDomainRoutingActiveConfig = default
Indicates the configuration set being used for traffic handling. Its value is automatically updated with the value in cscfDomainRoutingSelectedConfig after successful configuration synchronization.
String1to00128DT
readOnly
cscfDomainRoutingActiveMatchingTable = 0
This attribute specifies the identity of the matching table to be used when handling traffic.
This attribute is reset on a successful configuration synchronization to identify the system created (default) matching table for traffic handling.
boolean
cscfDomainRoutingEnabled = false
This attribute enables or disables the Domain Routing Function. If set to true, the Domain Routing Function is enabled. A CSCF/BCF functional entity invokes the Domain Routing matching table with a FQDN destination address before normally proxying a SIP request. If set to false, the Domain Routing Function is disabled.
String1to00128DT
readOnly
cscfDomainRoutingSelectedConfig = default
This attribute is used by operators to identify the configuration set (cscfDomainRoutingConfigurationId) subject to the next synchronization process when the attribute cscfDomainRoutingSyncConfig is set to True. If the synchronization is successfully executed, the identified configuration data will be used for traffic handling.
boolean
cscfDomainRoutingSyncConfig = false
This attribute is used by operators to initiate the construction of runtime data used for traffic based on the selected configuration set specified in cscfDomainRoutingSelectedConfig.
Setting it to true synchronizes the modified Domain Routing table configuration where CSCF converts the configuration data into an internal data structure and stores it in a temporary memory location, separated from the existing traffic handling data structure. Integrity of the existing traffic handling data structure is preserved. If the configuration data is successfully synchronized, the internal data structure in the temporary memory location will be switched in to handle traffic, replacing the preserved data. If the configuration data fails the synchronization process, the internal data structure in the temporary memory location is discarded. Traffic handling is resumed using the preserved data structure.
This attribute will be automatically set to false when the synchronization has finished.
DomainRoutingSyncStateDT
readOnly
cscfDomainRoutingSyncState = not_synchronized
This attribute is updated by the system and it indicates the status of the selected configuration specified in cscfDomainRoutingSelectedConfig versus the current runtime data. It indicates whether the selected configuration set is synchronized, not synchronized, or failed to synchronize.
synchronized: indicates that the configuration data has been successfully read. The data is used for traffic handling as soon as it is synchronized successfully.
not_synchronized: indicates that the configuration data identified by cscfDomainRoutingSelectedConfig has not been synchronized. The data needs to be synchronized before it can be used for traffic handling.
synchronization_failed: indicates that a synchronization attempt of the configuration data has failed. The data needs to be corrected and synchronized again before it can be used for traffic handling. When the data is corrected, the state goes from synchronization_failed to not_synchronized.

  class CscfDomainRoutingApplication  

 

class CscfDomainRoutingConfiguration

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingMatchingTables [1..1]
+-CscfDomainRoutingResultTable [1..1]

This is the Managed Object Class for the CSCF Domain Routing Configuration.

This MO is created by the system.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingConfigurationId
Key attribute to CscfDomainRoutingConfiguration.
This attribute defines the name/identity of a Domain Routing Function configuration set.

  class CscfDomainRoutingConfiguration  

 

class CscfDomainRoutingConfigurations

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration [0..]

This is the Managed Object Class for the CSCF Domain Routing Configurations.

This MO is created by the system.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingConfigurationsId
Key attribute to CscfDomainRoutingConfigurations.
This attribute will be used as a key to differentiate CSCF Domain Routing configuration sets.

  class CscfDomainRoutingConfigurations  

 

class CscfDomainRoutingMatchingTable

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingMatchingTables
+-CscfDomainRoutingMatchingTable
+-CscfDomainRoutingMatchingTableEntry [0..]

This is the Managed Object Class for the CSCF Domain Routing Matching Table.

This MO is created by the system.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingMatchingTableId
Key attribute to cscfDomainRoutingMatchingTable.
This attribute specifies the name of the table that includes cscfDomainRoutingMatchingTableEntryId entries. This table must be configured before cscfDomainRoutingMatchingTableEntryId.


  class CscfDomainRoutingMatchingTable  

 

class CscfDomainRoutingMatchingTableEntry

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingMatchingTables
+-CscfDomainRoutingMatchingTable
+-CscfDomainRoutingMatchingTableEntry

This is the Managed Object Class for the CSCF Domain Routing Matching Table Entry.

Attributes
String1to00255DT
key
mandatory
noNotification
restricted
cscfDomainRoutingMatchingTableEntryId
Key attribute to CscfDomainRoutingMatchingTableEntry.
This attribute contains an operator configured domain name string for table lookup using domain name best match to the original FQDN.
DomainRoutingDestinationModeDT
mandatory
cscfDomainRoutingMatchingTableEntryMode
This attribute specifies the destination routing option. Its value is an operator configured option for destination address list construction. The CSCF application collects the desired destination addresses and composes a destination address list based on the destination mode configuration.
The following destination modes can be defined:
1: The list consists of only the destination address(es) from the referenced Domain Routing Result Table entry. The SIP request is to be routed to these destination address(es) only. This is the default value.
2: The list consists of the destination address(es) from the referenced Domain Routing Result Table entry. The original FQDN destination address is also appended to the list with the lowest priority assignment. The SIP request is to be first routed to the destination address(es) from the result table. If routings to all the result table addresses fail, the SIP request routing falls back to the original FQDN destination address.
3: The list consists of the original FQDN destination address with the highest priority assignment followed by the destination address(es) from the referenced Domain Routing Result Table entry. The SIP request is to be routed to the original FQDN destination address first. If this routing fails, the SIP request is routed to the destination address(es) from the result table.
String1to00128DT
mandatory
cscfDomainRoutingMatchingTableEntryResult
This attribute references to a previously defined entry in the Domain Routing Result Table for next hop routing address resolution. It points to an existing result table entry in the format of result_table_name:result_entry_name.

  class CscfDomainRoutingMatchingTableEntry  

 

class CscfDomainRoutingMatchingTables

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingMatchingTables
+-CscfDomainRoutingMatchingTable [0..]

This is the Managed Object Class for the CSCF Domain Routing Matching Tables.

This MO is created by the system.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingMatchingTablesId
Key attribute to CscfDomainRoutingMatchingTables.

  class CscfDomainRoutingMatchingTables  

 

class CscfDomainRoutingResultTable

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingResultTable
+-CscfDomainRoutingResultTableEntry [0..]

This is the Managed Object Class for the CSCF Domain Routing Result Table.

This MO is created by the system.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingResultTableId
This is the key attribute for CscfDomainRoutingResultTable.

  class CscfDomainRoutingResultTable  

 

class CscfDomainRoutingResultTableEntry

ManagedElement
+-CscfFunction
+-CscfDomainRoutingApplication
+-CscfDomainRoutingConfigurations
+-CscfDomainRoutingConfiguration
+-CscfDomainRoutingResultTable
+-CscfDomainRoutingResultTableEntry

This is the Managed Object Class for the CSCF Domain Routing Result Table Entry.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
cscfDomainRoutingResultTableEntryId
Key attribute to CscfDomainRoutingResultTableEntry.
Idenitity/Name of the result table entry.
Since this value is referenced from the Domain Routing Matching Table, it must be configured first and it cannot be deleted while it is being referenced by a Domain Routing Matching Table.
DomainRoutingResultAddressDT[1..100] nonUnique ordered
mandatory
cscfDomainRoutingResultTargetAddress
This is an operator configured attribute representing an array of next hop routing destination addresses, which will be used to proxy the SIP request to its intended destination. Since this value is referenced from the Domain Routing Matching Table, it must be configured first and it cannot be deleted while it is being referenced by a Domain Routing Matching Table.
An address entry can be in FQDN, IPv4 or IPv6 format. It can optionally include a port number specification and a transport protocol. The transport protocol can be either TCP or UDP. If not configured, the default transport or port value will be used. An address entry must include a unique operator configured priority assignment, which will indicate the order in which the addresses have to be processed. The priority values range from 1 to 100, where 100 represents the highest priority value allowed and 1 the lowest priority value allowed.
- FQDN [&lt;: port&gt;] [; transport=&lt;T&gt;] ;priority=N
- IPv4 [&lt;: port&gt;] [; transport=&lt;T&gt;] ;priority=N
- IPv6 [&lt;: port&gt;] [; transport=&lt;T&gt;] ;priority=N
where T is either TCP or UDP and N is in the range of 1 – 100.

  class CscfDomainRoutingResultTableEntry  

 

class CscfEmergencyClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfEmergencyGroupClass
+-CscfEmergencyClass

This is Managed Object Class for CSCF Emergency

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfEmergency
This is the key attribute of the CscfEmergencyClass containing all the Emergency parameters. One instance of the CscfEmergencyClass with the key CscfEmergency=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
String0to00256DT[0..1]
cscfEmergencyCallFailureDestination = ""
This parameter is configured with information used by the S-CSCF to reconstruct the Request URI to reach a last resort destination when break out to all configured external network pools fails. This parameter will only be used for emergency calls if CscfEmergencyCallFailureRoute is configured. It is possible to have CscfEmergencyCallFailureDestination empty, when CscfEmergencyCallFailureRoute is configured. If that is the case, the original request URI will be kept.

The format of this parameter must be a valid sip- or tel-URI, for example "sip:sos@ims.com" or "tel:911;phone-context=+358" or "sip:sos@ims.com" or
"sip:sos@[1234::1234:1234]:5060;lr".
String0to00256DT[0..1]
cscfEmergencyCallFailureRoute = ""
The attribute contains the SIP URI that the S-CSCF will use to construct/populate the Route header with, when break out to all configured external network pools fail and the request is to be sent to an application or announcement server or any other node that should terminate the emergency request.

The format of this parameter must be a valid sip-URI where loose routing is required, for example "sip:mgc.net;lr" or "sip:sos@[1234::1234:1234]:5060;lr". If the "lr" parameter is not defined, CSCF will automatically add it.
TimerSec0to60DT[0..1]
eatfPsFallbackTimer = 0
This parameter defines the Packet Switched Fallback Timer of an emergency session anchored at the EATF. This timer starts after the access transfer of an anchored emergency session is successful. Until the timer expires, if the emergency call is transferred back to the Packet Switched Network, EATF connects it back to the anchored session. When this timer expires, the Packet Switched Call Leg is terminated.

Unit: second.
A value of 0 means that PS Fallback is disabled.
Any number larger than 0 and less than or equal to 60 defines the PS Fallback time window in seconds.
EatfRedundantEatfEntryDT[0..4] ordered
eatfRedundantEatfEntry
This configuration parameter defines the redundant EATFs. The configured values will be used as redirect targets in a 305 response sent by an EATF when it cannot locate an established session for an emergency access transfer request. It supports a maximum of 4 entries. Each entry consists of a priority and an IPV4 or IPV6 address with port number.
<Priority>:<IP address>:<Port> The “Priority” can take the value of an integer between 1 (highest) and 4 (lowest). The "IP address" is an IPV4 or IPV6 address. FQDN is not accepted. Duplicated transport addresses are not allowed. The same priority can be used in more than one entry. The “Port” is the port to reach the redundant EATF. The accepted range is between 1024 and 49151. For example: “1:192.168.73.100:5555”
SessionIdentifier
eatfSessionIdentifier = IMEI_BASED
Emergency session established in EATF can be identified by the IMEI based sip.instance found in the Contact header of a request or the C-MSISDN found in the P-Asserted-Identity of a request. This parameter configured the session identifier to be used.

IMEI_BASED means that ONLY the IMEI based sip.instance shall be used as the EATF session identifier. If C-MSISDN is present, it shall be ignored.

CMSISDN_BASED means that ONLY the C-MSISDN shall be used as the EATF session identifier. The IMEI based sip.instance shall be ignored
String0to01024DT[0..1]
ecscfAssertedPsapIdentity = ""
This attribute defines the PSAP identity used by E-CSCF in the response to an emregency request with emergency service URN.

Empty or TEL uri in canonical form, that is, either be a number with "+" (international format) or a number without "+" but with phone-context,
for example, tel:119;phone-context=+81 or tel:+81119

boolean[0..1]
ecscfCalledNumberManipulation = false
This parameter determines if the called number shall be manipulated (using the number normalization feature) before sent to LRF.
EcscfDefaultPsapBehaviorDT
ecscfDefaultPsapBehavior = USE_DEFAULT_CONFIG
This parameter configures the E-CSCF behavior for selecting the default PSAP. When it is set to INVOKE_BGCF_FOR_TEL_NUMBER, the configuration in EcscfDefaultPSAPNumber is ignored and Breakout Gateway Control Function (BGCF) is used to determine the default PSAP based on the telephone number indicated in the original Request URI. When it is set to USE_DEFAULT_CONFIG, the configuration in EcscfDefaultPSAPNumber applies.
TelNoOrEmptyDT[0..1]
ecscfDefaultPSAPNumber = ""
For HTTP based Ml interface configured (EcscfMlInterface=http), this attribute defines a default number to be used within the E-CSCF as input to number normalization and external selection,
if no telephone number has been received from the LRF (not available or faulty) and no telephone number is available in the Request-URI of the incoming INVITE or a routable SIP address is not available.
For SIP based Ml interface configured (EcscfMlInterface=sip), this attribute defines a default address to be used as PSAP address within the E-CSCF, if no PSAP address has been received from the LRF (not available or faulty).
boolean
noNotification
ecscfDialogEventEnabled = false
This parameter defines if the dialog event subscription function in E-CSCF is enabled.
Before configuring ecscfDialogEventEnabled=true, the value of EcscfMlInterface must be set to "sip"
DomainNameDT[0..] nonUnique ordered
ecscfDomainNameEntry
This attribute is the domain name of the E-CSCF. This is the fully qualified domain name of the E-CSCF node, if one exists. It is possible to configure multiple domain names of the E-CSCF. The purpose with this is to have the possibility to address the same E-CSCF node with different names, used at, for example, load sharing or network redundancy. It shall be noted that outgoing messages from the E-CSCF will always include the first configured domain name.
FqdnIPv4IPv6[0..1]
noNotification
ecscfEatfAddress = ""
This parameter is used to configured the address of the EATF node. E-CSCF uses the configured value to reach the EATF node
boolean
noNotification
ecscfEatfEnabled = false
This parameter is used to enable E-CSCF to anchor a VoLTE emergency request with the EATF.
If this parameter is set to true, EATF anchoring of VoLTE emergency requests is enabled. If it is set to false, the anchoring function is disabled.
LRFAddressDT
mandatory
ecscfEmergencyLRFAddress = ""
Used to store the address for the LRF node available in the network. If the address has not been defined, no interaction with the LRF will be performed.
For HTTP-based Ml interface configured (EcscfMlInterface=http), EcscfHttpLocalAddress must be defined before this parameter can be set.


Dependencies: For HTTP-based interface, EcscfHttpLocalAddress must be defined before this parameter can be set.
EmergencyPhoneContextDT[0..1]
ecscfEmergencyPhoneContext = ""
Defines the emergency phone context to be used as input to number normalization together with the telephone number received from the LRF, or if the telephone number received from the LRF is a non-international number.
boolean[0..1]
ecscfFetchRefLocationInfo = true
This parameter determines if the reference location information shall be retrieved from HSS if the location (PANI) is missing in the incoming INVITE. If the parameter is set to true, the reference location information shall be retrieved from HSS. The parameter CscfCXDestinationRealm needs to be defined as well, otherwise the reference location information will not be retrieved from HSS.
String0to01024DT[0..1]
ecscfHttpDigestPw = ""
This parameter defines the password to use to create the HTTP Digest response towards LRF (if authentication was requested by LRF).
Note that due to security reasons the password is not shown as clear text. In case configuration data is exported and imported again the password needs to be provided manually again.
String0to01024DT[0..1]
ecscfHttpDigestUsername = ""
This parameter defines the user name to use to create the HTTP Digest response towards LRF (if authentication is required).
String0to01024DT[0..1]
ecscfHttpLocalAddress = ""
Defines the IP address the E-CSCF uses to recieve and send HTTP traffic to and from the LRF.
HttpRequestTimerDT
ecscfHttpRequestTimer = 500
Defines the timeout value for HTTP requests to the LRF node.
MlInterfaceDT
ecscfMlInterface = http
This parameter defines what type of protocol will be utilized on Ml interface.
String0to01024DT[0..1]
ecscfNonRegAssertedCallerIdentity = ""
This attribute defines a regular expression to be applied on the value of P-Preferred-Identity received, to retrieve and compose an asserted identity for a non-registered caller.

Format: The format contains three parts, using "/" as separator: /<regex>/<string>/[i], example "/^.+([0-9]{7})@.+$/911\1/i" where [regex] specifies the matching rule to be applied on the P-Preferred-Identity value, and [string] specifies the modification rule of the matched value. The optional "i" makes the matching case insensitive. An omitted "i" makes the matching case sensitive. The configured value must pass the syntax validation before it can be accepted by E-CSCF.
boolean
ecscfNonRegAssertedCallerIdPreLrfEnabled = false
This parameter is used to enable E-CSCF to populate the P-Asserted-Identity with the non-dialable number for a non-registered caller before it sends the SIP INVITE to the LRF. Before configuring ecscfNonRegAssertedCallerIdPreLrfEnabled = true, the value of EcscfMlInterface must be set to "sip".

Takes effect: ChangeTypeRuntimeType - Session
boolean[0..1]
ecscfPutPsapNumberInRn = false
This parameter determines how to handle the emergency center number received from LRF. If it is set to false the emergency center number received from LRF shall replace the Request-URI. If the parameter is set to true, the emergency center number shall be placed in the rn parameter (within the user part of the Request-URI).
SoapBehaviorDT[0..1]
ecscfSoapBehavior = LOCATION_BASED_SOAP1_1
This parameter defines the the behavior to apply towards the LRF. This includes what SOAP wsdl specification to apply for the request and response to LRF and what the retrieval of a PSAP number (emergency center number) shall be based on: the location of the user or the IP address of the user.
TrustedLrfDT[0..] nonUnique
noNotification
ecscfTrustedLrfEntry = 0.0.0.0/32
This parameter holds a list of trusted LRFs, which will be authorized to subscribe the dialog event in E-CSCF.
It contains a list of IPv4 or/and IPv6 addresses.

String0to02048DT[0..1]
pcscfAltServiceIndication = ""
The content specified in this parameter will be added in the body of the 380 message if an emergency call is detected and a 380 negative response is sent back in order to redirect the call. Caution: It is the responsibility of the operator to validate the content of this parameter. No XML-parsing is made for example if XML is used.
AltServiceIndicationContentTypeDT[1..] nonUnique ordered
pcscfAltServiceIndicationContentType = application/3gpp-ims+xml
This parameter indicates the type of content in the PcscfAltServiceIndication parameter.
EmergencyCallBehaviorDT
pcscfECBehavior = prioritizeECCall
Upon the detection of an emergency call, the CSCF can behave in two distinct ways. The actual behavior is determined by the configuration value set to this parameter.
EcNumberListDT[0..] nonUnique ordered
pcscfECNumberList
The emergency numbers in this multi value parameter are used to detect and validate an emergency call.
EcscfAddressDT[0..1]
pcscfEcscfAddress = ""
Defines the address of the E-CSCF node to be used by the P-CSCF for routing emergency calls.
ScscfContactTrunkGroupAndContextDT[0..] nonUnique ordered
scscfContactTrunkGroupAndContext
This parameter represents a list of configured trunk groups and contexts. Each entry (row) of the list associated with an ESRN number. When an entry is selected (based on the ESRN number), the Contact header of the request will be updated with the entry's trunk group and context.

Format:
- ESRN:trunk_group:trunk_context
- default:trunk_group:trunk_context
- NotPresent:trunk_group:trunk_context
String0to00128DT[0..1]
scscfEmergencyPhoneContext = ""
This parameter defines the phone-context to be used for emergency call. Only Global number format or Fully Qualified Domain Name (FQDN) format are accepted.
ScscfEmergencyRegServiceRouteBehaviorDT[0..1]
scscfEmergencyRegServiceRouteBehavior = ALWAYS_INCLUDE
This is a data type for a parameter that controls if Scscf will include Service-Route header in 200OK response for emergency registration requests.

EXCLUDE = do not include Service Route Header
ALWAYS_INCLUDE = always include Service Route Header
boolean
scscfIgnoreIfcForEmergencyCall = false
This parameter indicates whether originating triggers are to be executed for emergency call. By default, this parameter is set to false.

  class CscfEmergencyClass  

 

class CscfEmergencyGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfEmergencyGroupClass
+-CscfEmergencyClass [1..1]

This is Managed Object Class for CSCF Emergency Group

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfEmergencyGroup
This is the key attribute of the CscfEmergencyGroupClass. One instance of the CscfEmergencyGroupClass with the key CscfEmergencyGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfEmergencyGroupClass  

 

class CscfEosAnalysis

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosCaseTable [1..1]
+-CscfEosMatchProfileTable [1..1]
+-CscfEosRouteTable [1..1]


This is the container for the configuration parameters related to an instance of the
End-of-selection analysis. Currently it is only possible to have one instance.


This MO is created by the system.

Attributes
EOSTableIdDT
key
mandatory
noNotification
restricted
cscfEosAnalysisId
Key attribute used in the CscfEosAnalysis Managed Object instance.
boolean
cscfEosInternalLoopAlarmReset = false
This attribute is used to cease the ”End-Of-Selection Analysis Internal Loop Detected” alarm. If the alarm is raised follow the instructions in the OPI to correct the fault causing the alarm. When the fault has been corrected the alarm is manually ceased by setting this parameter to true. When the alarm has been ceased the attribute will automatically be set to false again by the system.
Integer0to00010DT
cscfEosMaxEosAttempts = 3
This attribute specifies how many times EOS Analysis may be triggered per call/session. If the attribute is set to 0, the EOS Analysis function is disabled.

  class CscfEosAnalysis  

 

class CscfEosApplication

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis [1..1]

This is the root class and basic container for the configuration parameters related to the End-of-selection function in CSCF.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.

  class CscfEosApplication  

 

class CscfEosCaseTable

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosCaseTable
+-CscfEosCaseTableEntry [0..]


This is the container for the EOS case entries of the End-of-selection analysis.


This MO is created by the system.

Attributes
EOSTableIdDT
key
mandatory
noNotification
restricted
cscfEosCaseTableId
Key attribute used in the CscfEosCaseTable Managed Object instance.

  class CscfEosCaseTable  

 

class CscfEosCaseTableEntry

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosCaseTable
+-CscfEosCaseTableEntry

This is the container Managed Object Class for End-of-Selection Case Table Entry

Attributes
EOSTableNameDT
mandatory
cscfEosCaseMatchProfileName
This attribute is the name of the Match Profile that contains the applicable error response(s)/reason header(s) that should be matched for this EOS Case. The attribute cannot be empty and must refer to an existing cscfEosMatchProfileTableEntryId in the Match Profile Table.
EOSTableNameDT
mandatory
cscfEosCaseRouteName
An existing cscfEosRouteTableEntryId or keyword "exit" to indicate that there is no Route Alternative and EOS Analysis should be exited, or "enum" to indicate that originating S-CSCF shall trigger an ENUM query. (Other CSCF node types will handle "enum" in the same way as "exit".).
EOSTableEntryIdDT
key
mandatory
noNotification
restricted
cscfEosCaseTableEntryId
This attribute is the name of the EOS Case. This parameter is referred to by the application triggering EOS Analysis or other EOS Cases. The attribute cannot be empty and it cannot be set to the string "exit" since it is a reserved word.

EOSTableNameDT
mandatory
cscfEosNextEosCaseName
This attribute is the name of the next EOS Case to be used if the alternative route fails or no Matching Profile is found in the Match Profile Table. The attribute cannot be empty and must refer to an EOS Case (cscfEosCaseTableEntryId) that may or may not exist in the EOS Case Table or the keyword “exit” to indicate that EOS Analysis should be exited if the selected Route Alternative results in failure.

The value of cscfEosNextEosCaseName may not begin with a decimal digit (0-9). These values are reserved for internal EOS Cases.

  class CscfEosCaseTableEntry  

 

class CscfEosMatchProfileTable

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosMatchProfileTable
+-CscfEosMatchProfileTableEntry [0..]

This is the container for the match profile entries of the End-of-selection analysis.


This MO is created by the system.

Attributes
EOSTableIdDT
key
mandatory
noNotification
restricted
cscfEosMatchProfileTableId
Key attribute used in the CscfEosMatchProfileTable Managed Object instance.

  class CscfEosMatchProfileTable  

 

class CscfEosMatchProfileTableEntry

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosMatchProfileTable
+-CscfEosMatchProfileTableEntry

Each instance of this class represents a match profile that could be referred to from a CscfEosCaseTableEntry instance.

Attributes
EOSTableEntryIdDT
key
mandatory
noNotification
restricted
cscfEosMatchProfileTableEntryId
This attribute is the name of the Profile. It is referred to from one or more EOS Cases and is therefore a precondition to the definition of any EOS Case that refers to it. The attribute cannot be empty and it cannot be set to the string &quot;exit&quot; since it is a reserved word. The attribute cannot be removed if referred to.
EOSMatchSipReasonDT[0..1]
cscfEosMatchSipReasonHeader
This attribute contains the Protocol and Cause Code combination part of the Reason Header(s) that are to be matched in this profile against the received SIP response. The attribute can be specified as a single, multiple (comma-separated), or all (empty) Protocol/Cause combination(s). Ranges (hyphen-separated) are not supported. This attribute is not matched against the received SIP response header if there was no match in cscfEosMatchSipResponseCode.
EOSMatchSipResponseDT[0..1]
cscfEosMatchSipResponseCode
This attribute contains the Response Code(s) that are to be matched in this profile against the received SIP response. It can be specified as a single response code, multiple response codes (comma-separated), a range of response codes (hyphen-separated), or all response codes (empty).

  class CscfEosMatchProfileTableEntry  

 

class CscfEosRouteTable

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosRouteTable
+-CscfEosRouteTableEntry [0..]

This is the container for the route entries of the End-of-selection analysis.

This MO is created by the system.

Attributes
EOSTableIdDT
key
mandatory
noNotification
restricted
cscfEosRouteTableId
Key attribute used in the CscfEosRouteTable Managed Object instance.

  class CscfEosRouteTable  

 

class CscfEosRouteTableEntry

ManagedElement
+-CscfFunction
+-CscfEosApplication
+-CscfEosAnalysis
+-CscfEosRouteTable
+-CscfEosRouteTableEntry

Each instance of this class represents a route result that could be referred to from a CscfEosCaseTableEntry instance.

Attributes
EOSAdditionalRouteDT[0..4] nonUnique
cscfEosRouteAdditionalRoute
This attribute is a list of any additional Route-URIs (Route headers) to be added to the outgoing SIP request. The format is n:sip:<FQDN>:[<port>];[lr] or n:sip:<IP Address>:[<port>];[lr], where “n” is the order indicator of the Route-URI. Each additional Route-URI must have a unique value for “n” in the range of 1-9. The order indicators do not need to be sequential. The “lr” parameter should be included in the parameter value but if not specified will be implicitly set by system and added to the applicable Route-URI.The SIP-URI specified by the user will be normalized meaning that for an example extra whitespaces will be removed and if the same URI-parameter is specified several times only the first one will be kept.
TimerSec0to32DT
cscfEosRouteFailoverTimer = 0
This attribute is the Failover Timer value (in seconds) specific to this Routing Alternative and overrides the value of the CscfSipDefaultFailoverTimer if not set to 0. It defines the number of seconds before the destination needs to respond.

EOSRouteTableEntryIdDT
key
mandatory
noNotification
restricted
cscfEosRouteTableEntryId
This attribute is the name of the Routing Alternative. It is referred to from one or more EOS Cases and is therefore a precondition to the definition of any EOS Case that refers to it. The attribute cannot be empty or use the keyword "exit" or "enum". The attribute cannot be removed if referred to.
EOSRouteUriDT
mandatory
cscfEosRouteUri
This parameter specifies the SIP URI of this specific routing alternative. The SIP URI includes the FQDN (or IP-address) of the target node and can optionally include URI parameters, like transport, a port number and an “lr” parameter. Next hop routing will be performed to the target in case the “lr” parameter is omitted. The SIP URI specified by the user will be normalized meaning that for an example extra whitespaces will be removed and if the same URI parameter is specified several times only the first one will be kept.

  class CscfEosRouteTableEntry  

 

class CscfFaultIsolationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTroubleshootingGroupClass
+-CscfFaultIsolationClass

This is a container class for the CSCF Fault Isolation Framework related attributes.

This MO is created by the system.

Attributes
CscfFaultIsolationHexErrorCodeDT[0..10] ordered
cscfFaultIsolationHexErrorCode
This parameter specifies SIP hexadecimal error codes that will trigger the Fault Isolation Framework in CSCF to output logged Event History information when this error is generated by CSCF. The value of this parameter can be a specific HEX error code or a regular expression. If this parameter is not configured, the Fault Isolation for SIP hexadecimal error codes is disabled.
The Event History feature has to be enabled (cscfEventHistoryEnabled=true).
WARNING: if this attribute is misconfigured, it may cause unexpected performance drop.


Specification: FS Traceability and Troubleshooting in CSCF
Takes effect: ChangeTypeRuntimeType - Immediate
StringDefaultDT
key
mandatory
noNotification
restricted
cscfFaultIsolationId
This is the key attribute of the CscfFaultIsolation class. One instance of CscfFaultIsolation with the key cscfFaultIsolationId=default is created at startup. This instance cannot be deleted. No other instances can be created of this class.

Specification: FS Traceability and Troubleshooting in CSCF
CscfFaultIsolationSipErrorCodeDT[0..5] ordered
cscfFaultIsolationSipErrorCode
This parameter specifies SIP error codes that will trigger the Fault Isolation Framework in CSCF to output logged Event History information when this error is generated by CSCF. The value of this parameter can be a specific SIP error code or a range of SIP error codes which is in the range of 400-699. If this parameter is not configured, the Fault Isolation for SIP error codes is disabled.
The Event History feature (cscfEventHistoryEnabled=true) has to be enabled.


Dependencies: Range <Minimum value>-<Maximum value>: Minimum value has to be less than the Maximum value
Specification: FS Traceability and Troubleshooting in CSCF
Takes effect: ChangeTypeRuntimeType - Immediate

  class CscfFaultIsolationClass  

 

class CscfFunction

ManagedElement
+-CscfFunction
+-CSCF-Application [1..1]
+-CscfDomainRoutingApplication [1..1]
+-CscfEosApplication [1..1]
+-DIA-CFG-Application [1..1]
+-DNS-Application [1..1]
+-ExtNetSel-Application [0..]
+-ICMP-Application [1..1]
+-LdapClientApplication [1..1]
+-NumberNormalisation [1..1]
+-SigComp-Subsystem [1..1]

XYzFunction

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
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 CscfFunction  

 

class CscfGenericNumberPortability

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfGenericNumberPortability

This managed object that contains the configuration parameter that enables or disables the Generic Number Portabiltiy Feature.

Attributes
boolean
cscfGenericNumberPortabilityEnabled = false
This parameter controls the availability of the Generic Number Portability function. The parameter indicates whether the function is enabled or not.

- true = The Generic Number Portability function is enabled. In the originating S-CSCF any number portability parameters received in the incoming requests or received in the ENUM response are processed. Number portability routing information is used in the External Network Selection routing analysis. In the terminating I-CSCF, an ENUM query for a user not found in the HSS is only performed if this parameter and the cscfOnwardRoutingEnabled is set to true. If enabled, any number portability routing information received in the ENUM response is used in the External Network Selection routing analysis.

- false = The Generic Number Portability function is not enabled. In the originating S-CSCF, any number portability parameters received in the incoming requests or returned as part of the ENUM response are ignored and removed in the outgoing request. In the terminating I-CSCF, the Generic Number Portability function is not executed for a user not found in the HSS.


Takes effect: ChangeTypeRuntimeType - Session
integerKeyString
key
mandatory
noNotification
restricted
cscfGenericNumberPortabilityKey
This is the key attribute of the CscfGenericNumberPortability class. One instance of the CscfGenericNumberPortability with the key cscfGenericNumberPortabilityKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
boolean
scscfNpQueryOnReleaseEnabled = false
Enables the Number Portability Variant Query On Release QoR.
The parameter CscfGenericNumberPortabilityEnabled must be set to True to be able to set this parameter to True.
Changes to the parameter value take effect on new sessions only.
This parameter is NOT access aware.


Takes effect: ChangeTypeRuntimeType - Session

  class CscfGenericNumberPortability  

 

class CscfHssQuarantine

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfHssQuarantine

This is Managed Object Class for CSCF HSS Quarantine

This MO is created by the system.

Attributes
String0to00005DT[0..1]
cscfHssAutoRemoveFromQuarantineTime = ""
The time of day when all HSS's in quarantine are automatically removed from quarantine. If not set at all, the automatic removal from quarantine is turned off. The format is "hh:mm", for example: "02:15". It must be 5 characters. Possible values between "00:00" to "23:59" Default value not set at all, that is, the automatic removal from quarantine is turned off.
Fqdn0to100DT[0..] nonUnique ordered
cscfHssInQuarantineEntry
Each entry represents an HSS, currently placed in quarantine. It is only possible to remove an entry, not to add an entry or to change an existing entry. Removing an entry from the list will lead to the HSS being used immediately.
boolean
noNotification
cscfHssQuarantineEnabled = true
Attribute to enable or disable hssQuarantine feature
integerKeyString
key
mandatory
noNotification
restricted
cscfHssQuarantineKey
This is the key attribute of the CscfHssQuarantine class. One instance of the CscfHssQuarantine with the key cscfHssQuarantineKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfHssQuarantine  

 

class CscfIdentificationGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfIdentificationGroupClass
+-CscfTerminalIdentificationClass [1..1]

This is a container class for the CscfTerminalIdentity instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfIdentificationGroupId
This is the key attribute of the CscfIdentificationGroupClass. One instance of the CscfIdentificationGroupClass with the key CscfIdentificationGroupId=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfIdentificationGroupClass  

 

class CscfLicenseModelGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfLicenseModelGroup
+-CscfActiveUserLicenseModel [1..1]
+-ScscfWiFiCallingLicenseModel [1..1]

This section describes the CscfLicenseModelGroup class and related attributes.

This MO is created by the system.

Attributes
String0to00005DT
key
mandatory
noNotification
restricted
cscfLicenseModelGroupId
This is the key attribute of CscfLicenseModelGroup. One instance of CscfLicenseModelGroup with the key cscfLicenseModelGroupId =0 is created at startup. This instance can’t be deleted. No other instances can be created of this class.
boolean
scscfLicenseRefresh = false
This attribute refreshes/reloads all licenses in the system.

  class CscfLicenseModelGroup  

 

class CscfMaxMediaFlowTableClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMaxMediaFlowTablesContainer
+-CscfMaxMediaFlowTableClass

This is Managed Object Class for CSCF Maximum Media Flow Table

Attributes
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeApplication = 2
Defines the maximum number of the media type application allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeAudio = 2
Defines the maximum number of the media type audio allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeControl = 2
Defines the maximum number of the media type control allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeData = 2
Defines the maximum number of the media type data allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeImage = 2
Defines the maximum number of the media type image allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeMessage = 2
Defines the maximum number of the media type message allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeModel = 2
Defines the maximum number of the media type model allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeMultipart = 2
Defines the maximum number of the media type multipart allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeText = 2
Defines the maximum number of the media type text allowed for an IMS subscription.
MaxMediaTypeDT
cscfMaxFlowPerMediaTypeVideo = 2
Defines the maximum number of the media type video allowed for an IMS subscription.
String1to00064DT
key
mandatory
noNotification
restricted
cscfMaxMediaFlowTable
Defines the container key for the max media flow attributes.

  class CscfMaxMediaFlowTableClass  

 

class CscfMaxMediaFlowTablesContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMaxMediaFlowTablesContainer
+-CscfMaxMediaFlowTableClass [0..]

This is Managed Object Class for CSCF Maximum Media Flow Tables Container

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfMaxMediaFlowTables
System Created.

  class CscfMaxMediaFlowTablesContainer  

 

class CscfMediaAuthorizationPolicyContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMediaAuthorizationPolicyContainer
+-CscfMediaCodecDataTableContainer [0..1]
+-CscfMediaTypeBandwidthTableClass [0..1]

This is Managed Object Class for CSCF Media Authorization Policy Container

This MO is created by the system.

Attributes
GatingPolicyDT
cscfEarlyMediaGatingPolicy = OpenDownLinkGates
This attribute specifies the gating policy when AAR is sent prior to reception of 200 OK for the initial INVITE.
MaxBandwidthDT
cscfMaxDownLinkBandwidth = 16
CscfMaxDownLinkBandwidth is used to configure the maximum allowed downlink bandwidth on the SDP answer as part of a media authorization policy.
String0to00128DT[0..1]
cscfMaxMediaFlowTableName = ""
Identity of the max flow per media type table for P-CSCF Media Authorization.

Dependencies: The Managed Object Instance for the CscfMaxMediaFlowTable needs to be created before the cscfMaxMediaFlowTableName is created.
MaxBandwidthDT
cscfMaxUpLinkBandwidth = 16
CscfMaxUpLinkBandwidth is used to configure the maximum allowed uplink bandwidth on the SDP answer as part of a media authorization policy.
integerKeyString
key
mandatory
noNotification
restricted
cscfMediaAuthorizationPolicy
This is the key attribute of the CscfMediaAuthorizationPolicyContainer class. One instance of the CscfMediaAuthorizationPolicyContainer with the key cscfMediaAuthorizationPolicy=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
MediaAuthorizationPolicyDT
cscfMediaBearerAuthorizationPolicy = Inactive
Enables the P-CSCF to either activate or inactivate the Media Authorization, the Bearer authorization, the private address handling.
boolean
cscfMediaCodecAnalysisAccordingToBlackListLogic = true
When set to true, the black list is activated and when set to false, the white list is activated. Payload types configured in a black list are not allowed and will be rejected. Payload types configured in a white list are the only allowed once. All other payload types will be rejected.
MediaOnHoldBehaviorDT
cscfMediaOnHoldBehavior = NoFlowStatusChange
Determines the behavior upon media on hold. The configuration option applies equally for originating and terminating P-CSCF and is applicable only when P-CSCF is configured to perform bearer authorization.
String0to00128DT[0..1]
cscfPayloadBlackWhiteListName = ""
Identity of the payload black and white list for P-CSCF Media Authorization.
String0to00128DT
cscfRxDestHostAddress = NotConfigured
Host address of the Policy and Charging Rules Function (PCRF).
String0to00128DT[0..1]
cscfRxDestRealmAddress = ""
Realm address of the external the PCRF.
String0to00128DT[0..1]
cscfRxOrigHostAddress = ""
Host address of the P-CSCF.
String0to00128DT[0..1]
cscfRxOrigRealmAddress = ""
Realm address of the P-CSCF.
boolean
cscfUseBearerAuthIncludeApplicationId = false
This parameter specifies whether the CSCF includes or does not include the Application Identifier, if present, from the SIP signaling Accept-Contact header.
boolean[0..1]
pcscfRxSipSessionContinueEnabled = false
This attribute enables the P-CSCF to continue a SIP session regardless if there is an Rx session failure. This attribute is only applicable if the attribute CscfMediaBearerAuthorization is configured either to the value MediaAndBearerAuth or to the value MediaAndBearerAuthXprivaddr.
TimerMSec0to30000DT[0..1]
pcscfRxSipSessionContinueTimer = 30000
This attribute specifies the number of milliseconds that the P-CSCF waits for an AAA command after it has sent an AAR command to the PCRF. PcscfRxSipSessionContinueTimer is only applicable if PcscfRxSipSessionContinueEnabled is set to true. At SIP session initiation, if the P-CSCF receives an AAA command before the timer has expired, it stops the timer and proceeds with the SIP session according to the AAA command's result code. For a successful result code, the P-CSCF continues both the SIP session and the Rx session. Otherwise, the P-CSCF continues the SIP session without an Rx session. At SIP session initiation, if the timer expires before the P-CSCF has received an AAA command from the PCRF, the P-CSCF continues the SIP session without an Rx session. At SIP session modification, the P-CSCF continues both the SIP session and the Rx session (provided that an Rx session has been established successfully during session initiation), regardless of the timer expiry or the AAA command's result code. If the timer is set to 0, the P-CSCF does not send an AAR command to the PCRF, and continues the SIP session without initiating or modifying an Rx session. Recommendation: For the timer to be effective, the timer value should be set to a lower value (in seconds) than the Diameter timeout specified by the Diameter attributes maxRequestPendingTime and maxNumberOfRetries.

Dependencies: PcscfRxSipSessionContinueEnabled must be set to true.

  class CscfMediaAuthorizationPolicyContainer  

 

class CscfMediaCodecDataEntryClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMediaAuthorizationPolicyContainer
+-CscfMediaCodecDataTableContainer
+-CscfMediaCodecDataEntryClass

This class contains all the attributes related to the Cscf Media Codec Data Entry.

Attributes
MediaCodecDataDT
key
mandatory
noNotification
restricted
cscfMediaCodecDataEntry
The managed object that defines Max Flow per Media Type, which has the policy name as key.
CodecDefFramesPerPacketDT
cscfMediaCodecDefaultFramesPerPacket = 1
The number of frames per packet, and is set to one of the following:
- Configured default number of frames per packet, if ptime is not negotiated in the SDP.
- Value of ptime divided by the framed duration, if ptime is negotiated to the SDP.
Media0to160DT
cscfMediaCodecFrameSize = 20
CscfMediaFrameSize is used to configure the frame size. It is dependent on the payload type.
MediaFrameDurationDT
cscfMediaFrameDuration = 20
CscfMediaFrameDuration is used to configure the frame duration.
Media0to120DT
cscfMediaPacketOverhead = 40
CscfMediaPacketOverhead is used to configure the packet overhead, for example IP, UDP, or RTP.

  class CscfMediaCodecDataEntryClass  

 

class CscfMediaCodecDataTableContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMediaAuthorizationPolicyContainer
+-CscfMediaCodecDataTableContainer
+-CscfMediaCodecDataEntryClass [0..]

This is Managed Object Class for CSCF Media Codec Data Table Container

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfMediaCodecDataTable
This is the key attribute of the CscfMediaCodecDataTableContainer class. One instance of the CscfMediaCodecDataTableContainer with the key cscfMediaCodecDataTable=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfMediaCodecDataTableContainer  

 

class CscfMediaContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMaxMediaFlowTablesContainer [1..1]
+-CscfMediaAuthorizationPolicyContainer [1..1]
+-CscfPayloadBlackWhiteListsContainer [0..1]
+-CscfSmpAuthorizationPolicyContainer [0..1]

This is Managed Object Class for CSCF Media Container

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfMedia
This is the key attribute of the CscfMediaContainer class. One instance of the CscfMediaContainer with the key cscfMedia=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfMediaContainer  

 

class CscfMediaTypeBandwidthTableClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfMediaAuthorizationPolicyContainer
+-CscfMediaTypeBandwidthTableClass

This is Managed Object Class for CSCF Media Type Bandwidth Table

Attributes
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeApplication
Defines the maximum bandwidth of the media type application allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeAudio
Defines the maximum bandwidth of the media type audio allowed for an Internet Protocol Multimedia Subsystem (IMS) subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeControl
Defines the maximum bandwidth of the media type control allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeData
Defines the maximum bandwidth of the media type data allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeImage
Defines the maximum bandwidth of the media type image allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeMessage
Defines the maximum bandwidth of the media type message allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeModel
Defines the maximum bandwidth of the media type model allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeMultipart
Defines the maximum bandwidth of the media type multipart allowed for an IMS subscription.
MaxBandwidthDT[0..1]
cscfBandwidthPerMediaTypeText
Defines the maximum bandwidth of the media type text allowed for an IMS subscription.
MaxBandwidthDT
mandatory
cscfBandwidthPerMediaTypeVideo
Defines the maximum bandwidth of the media type video allowed for an IMS subscription.
integerKeyString
key
mandatory
noNotification
restricted
cscfMediaTypeBandwidthTable
This is the key attribute of the CscfMediaTypeBandwidthTableClass class.

  class CscfMediaTypeBandwidthTableClass  

 

class CscfMonitoredInterfaceClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMonitoredInterfaceGroupClass
+-CscfMonitoredInterfaceClass

This is a container class for CSCF Monitored Interface related attributes.

This MO is created by the system.

Attributes
Integer0to00001DT[0..1]
cscfAlarmOnSIP503Behavior = 0
This parameter is used to configure whether to raise the "CSCF, SIP Monitored Interface Unreachable" alarm when a destination is blacklisted due to receiving a SIP 503 response.
String0to65535DT
key
mandatory
noNotification
restricted
cscfMonitoredInterface
This is the key attribute of the CscfMonitoredInterfaceClass. One instance of the CscfMonitoredInterfaceClass with the key CscfMonitoredInterface=default is created at startup.
boolean
cscfMonitorEnabled = false
Defines if network monitoring of the unreachable SIP destinations should be performed or not.
MonitorFallbackTimerDT
cscfMonitorFallbackCheckTimer = 15
Defines the time interval between checks for fallback, that is, the frequency for sending SIP OPTIONS when monitoring an unreachable SIP destination.
Integer0to00100DT
cscfProactiveMonitoringInterval = 15
This attribute defines the period in seconds between each OPTIONS used for the periodic monitoring. Value 0 means that the periodic monitoring is disabled/discontinued.
SipMonitoringSuppressDestinationDT[0..100] nonUnique
cscfSipMonitoringSuppressDestinationEntry
This attribute defines one or several destination nodes which CSCF does not monitor by sending OPTIONS when blacklisted. This prevents the blacklisted destinations that do not support OPTIONS, from becoming permanently blacklisted. Monitoring suppression takes effect for both TCP and UDP transport protocol.

  class CscfMonitoredInterfaceClass  

 

class CscfMonitoredInterfaceGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMonitoredInterfaceGroupClass
+-CscfMonitoredInterfaceClass [1..1]
+-CscfProactiveMonitoredSipInterfaceGroup [1..1]

The purpose of this class is to have a logical group for configuration of interfaces to be monitored.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfMonitoredInterfaceGroup
This is the key attribute of the CscfMonitoredInterfaceGroupClass. One instance of the CscfMonitoredInterfaceGroupClass with the key CscfMonitoredInterfaceGroup=0 is created at startup.

  class CscfMonitoredInterfaceGroupClass  

 

class CscfNumPortability

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNumPortability
+-CscfNumPortabilityCountryCodeList [0..1]
+-CscfNumPortabilityPrefixList [0..1]

Note: This class is deprecated, use GNP instead.
This implementation of NumPort is a customer adaptation and the Genereic Number Portability is for common use.


This MO is created by the system.

Deprecated: 

Attributes
boolean
cscfNumPortabilityEnable = false
Note: This attribute is deprecated.

This parameter controls the availability of the proprietary Number Portability feature. This parameter and the CscfGenericNumberPortability parameter are mutually exclusive.


Deprecated: 

integerKeyString
key
mandatory
noNotification
restricted
cscfNumPortabilityKey
This is the key attribute of the CscfNumPortability class. One instance of the CscfNumPortability with the key cscfNumPortabilityKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

Deprecated: 

  class CscfNumPortability  

 

class CscfNumPortabilityCountryCodeList

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNumPortability
+-CscfNumPortabilityCountryCodeList

This is Managed Object Class for CSCF Number Portability Country Code List

This MO is created by the system.

Deprecated: 

Attributes
String0to00005DT[0..] nonUnique ordered
cscfNumPortabilityCountryCodeEntry
Note: This attribute is deprecated.

A list of country codes. An incoming number's country code is stripped before performing a Number Portability database lookup since the database lookup requires national significant numbers.


Deprecated: 

integerKeyString
key
mandatory
noNotification
restricted
cscfNumPortabilityCountryCodeListKey
This is the key attribute of the CscfNumPortabilityCountryCodeList class. One instance of the CscfNumPortabilityCountryCodeList with the key cscfNumPortabilityCountryCodeListKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

Deprecated: 

  class CscfNumPortabilityCountryCodeList  

 

class CscfNumPortabilityPrefixList

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNumPortability
+-CscfNumPortabilityPrefixList

This is Managed Object Class for CSCF Number Portability Prefix List

This MO is created by the system.

Deprecated: 

Attributes
String0to00020DT[0..] nonUnique ordered
cscfNumPortabilityPrefixEntry
Note: This attribute is deprecated.

A list of prefixes defining number ranges to be ported. A number is only considered for Number Portability database lookup if its prefix is found in the prefix list. All prefixes need to have a matching country code.


Deprecated: 

integerKeyString
key
mandatory
noNotification
restricted
cscfNumPortabilityPrefixListKey
This is the key attribute of the CscfNumPortabilityPrefixList class. One instance of the CscfNumPortabilityPrefixList with the key cscfNumPortabilityPrefixListKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

Deprecated: 

  class CscfNumPortabilityPrefixList  

 

class CscfNwIfContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-BcfNwIfs [1..1]
+-EatfNwIfContainer [1..1]
+-EcscfNwIfs [1..1]
+-IcscfNwIfs [1..1]
+-PcscfNwIfs [1..1]
+-ScscfNwIfs [1..1]

This is Managed Object Class for CSCF Network Interface Container

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfNwIfContainerKey
This is the key attribute of the CscfNwIfContainer class. One instance of the CscfNwIfContainer with the key cscfNwIfContainerKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfNwIfContainer  

 

class CscfNwTopologyClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwTopologyGroupClass
+-CscfNwTopologyClass

This is Managed Object Class for CSCF Network Topology

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfNwTopology
This is the key attribute of the CscfNwTopologyClass containing all the NW topology related parameters. One instance of the CscfNwTopologyClass with the key CscfNwTopology=default is created at startup. Depending on the number of Access Aware profiles, it is possible to create new instances. The default instance can not be deleted.
PcscfIpAddressDT[0..] nonUnique ordered
cscfPcscfIpAddressEntry
CscfPcscfIpAddressEntry is a list of IP addresses and/or IP address ranges used for finding the P-CSCF Via and with that the Proxy IP Address. The value can either be one specific IP address or a range of IP addresses expressed in CIDR notation. To turn off the support for multiple Via headers for Emergency calls, there should be no CscfPcscfIpAddressEntry configuration parameters defined. This parameter is NOT access aware.

  class CscfNwTopologyClass  

 

class CscfNwTopologyGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwTopologyGroupClass
+-CscfNwTopologyClass [1..1]

This is Managed Object Class for CSCF Network Topology Group

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfNwTopologyGroup
This is the key attribute of the CscfNwTopologyGroupClass containing all the CscfNwTopologyClass instances. One instance of the CscfNwTopologyGroupClass with the key CscfNwTopologyGroup=0 is created at startup. This instance can be created of this class.

  class CscfNwTopologyGroupClass  

 

class CscfOperatorAllocatedDomainRangeListClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfUnallocatedRoutingContainer
+-CscfOperatorAllocatedDomainRangeListClass

This is Managed Object Class for CSCF Operator Allocated Domain Range List

Attributes
String0to01024DT[0..] nonUnique ordered
cscfOperatorAllocatedDomainRangeEntry
Domain list of regular expressions, defining the domain ranges. They are applied to incoming requests addressing a SIP user and will be evaluated the same way as subdomain-based routing. If unset an empty string, or when set a regular expression on the form /&lt;regular expression%gt;/[i] (where i means ignore case when included). For example:/unalloc\.domainName\.com/i
integerKeyString
key
mandatory
noNotification
restricted
cscfOperatorAllocatedDomainRangeList
This is the key attribute of the CscfOperatorAllocatedDomainRangeListClass class. One instance of the CscfOperatorAllocatedDomainRangeListClass with the key cscfOperatorAllocatedDomainRangeList=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfOperatorAllocatedDomainRangeListClass  

 

class CscfOperatorAllocatedNumberRangeListClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfUnallocatedRoutingContainer
+-CscfOperatorAllocatedNumberRangeListClass

This is Managed Object Class for CSCF Operator Allocated Number Range List

Attributes
AllocatedNumberRangeDT[0..] nonUnique ordered
cscfOperatorAllocatedNumberRangeEntry
This parameter defines number ranges for telephone number prefixes. They are used to identify if unallocated number services apply to incoming requests addressing a telephone number.
integerKeyString
key
mandatory
noNotification
restricted
cscfOperatorAllocatedNumberRangeList
This is the key attribute of the CscfOperatorAllocatedNumberRangeListClass class. One instance of the CscfOperatorAllocatedNumberRangeListClass with the key cscfOperatorAllocatedNumberRangeList=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfOperatorAllocatedNumberRangeListClass  

 

class CscfPayloadBlackWhiteListClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfPayloadBlackWhiteListsContainer
+-CscfPayloadBlackWhiteListClass

This is Managed Object Class for CSCF Payload Black White List

Attributes
String0to00100DT[0..] nonUnique ordered
cscfPayloadBlackWhiteEntry
A multi-value attribute containing of payload types that are allowed, that is, white list logic. Note: The entered value is not checked and any value is valid.
String1to00100DT
key
mandatory
noNotification
restricted
cscfPayloadBlackWhiteList
MediaType is the media type specified for the media component and PayloadType is the RTP payload type. Formet = MediaType:PayloadType

  class CscfPayloadBlackWhiteListClass  

 

class CscfPayloadBlackWhiteListsContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfPayloadBlackWhiteListsContainer
+-CscfPayloadBlackWhiteListClass [0..]

This class contains all the attributes related to the Cscf Payload Black White Lists Container.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfPayloadBlackWhiteLists
This is the key attribute of the CscfPayloadBlackWhiteListsContainer class. One instance of the CscfPayloadBlackWhiteListsContainer with the key cscfPayloadBlackWhiteLists=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfPayloadBlackWhiteListsContainer  

 

class CscfPersonalProfileEntry

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfLicenseModelGroup
+-CscfActiveUserLicenseModel
+-CscfPersonalProfileEntry

This class contains all the attributes related to the CSCF Personal Profile Active User Licensing function.

This MO is created by the system.

Attributes
MultiDeviceDT[0..1]
cscfMultiDeviceNumberOfContacts = ""
If this attribute is present, the Multi Device feature is turned on. This attribute is the maximum number of contacts for a Personal User if there is a valid Multi Device feature license.
The attribute cscfMultiDeviceNumberOfContacts must be greater than cscfPersonalMaxNumOfContacts and must be lower than cscfAdvancedMaxNumOfContacts. Once created, this attribute must be removed to disable the Multi Device feature. Applicable only for the Personal Active User Profile.
PersonalActiveUserRangeDT
cscfPersonalMaxNumOfContacts = 2
This attribute is used to indicate the maximum number of Contacts for the Personal Active User Profile. The attribute cscfPersonalMaxNumOfContacts cannot be greater than cscfAdvancedMaxNumOfContacts or cscfMultiDeviceNumberOfContacts (if present).
PersonalActiveUserRangeDT
cscfPersonalMaxNumOfIMPUs = 3
This attribute is used to indicate the maximum number of IMPUs for the Personal Active User Profile. The attribute cscfPersonalMaxNumOfIMPUs cannot be greater than cscfAdvancedMaxNumOfIMPUs.
String0to65535DT
key
mandatory
noNotification
restricted
cscfPersonalProfileEntryId
This is the key attribute of CscfPersonalProfileEntry. One instance of the CscfPersonalProfileEntry with the key cscfPersonalProfileEntryId=personal is created at startup. This instance can’t be deleted. No other instances can be created of this class
MultiDeviceAdminStateDT
scscfMultiDeviceAdministrativeState = LOCKED
This attribute will lock and unlock the Multi Device feature.
MultiDeviceServiceStateDT
readOnly
scscfMultiDeviceServiceState = Disabled
The parameter can contain the values Enabled and Disabled.
The value Enabled indicates that the Multi Device feature is enabled and has cleared the licensing precedure.
The value Disabled indicates that either the Multi Device feature has not been enabled or the licensing procedure has not been successfully performed.

  class CscfPersonalProfileEntry  

 

class CscfPmConfig

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfPmConfigGroup
+-CscfPmConfig

This is Managed Object Class for Performance Management Configuration.

Attributes
string
key
mandatory
noNotification
restricted
cscfPmConfigId
This is the key attribute of the CscfPmConfig class containing Performance Management parameters. One instance of the CscfPmConfig class with the key cscfPmConfigId=default is created at startup. It is NOT possible to create new instances. The default instance cannot be deleted.
boolean
scscfMediaTypeCountersEnabled = false
This attribute is used to configure if media type counters should be incremented or not in S-CSCF.

  class CscfPmConfig  

 

class CscfPmConfigGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfPmConfigGroup
+-CscfPmConfig [1..1]

This is Managed Object Class for Performance Management Configuration Group.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfPmConfigGroupId
This is the key attribute of the CscfPmConfigGroup. One instance of the CscfPmConfigGroup with the key cscfPmConfigGroupId=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfPmConfigGroup  

 

class CscfProactiveMonitoredSipInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMonitoredInterfaceGroupClass
+-CscfProactiveMonitoredSipInterfaceGroup
+-CscfProactiveMonitoredSipInterface

This is a Managed Object Class for CSCF Proactive Monitored SIP Interface related attributes.

Attributes
ProactiveMonitoredSipInterfaceDT
key
mandatory
noNotification
restricted
cscfProactiveMonitoredSipInterfaceEntry
This is the key attribute of the CscfProactiveMonitoredSipInterface. It defines the SIP interface to be monitored. Each entry consists of a CSCF source transport address together with the destination IP address. Both source and destination address must use the same IP version (IPv4 or IPv6).

  class CscfProactiveMonitoredSipInterface  

 

class CscfProactiveMonitoredSipInterfaceGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMonitoredInterfaceGroupClass
+-CscfProactiveMonitoredSipInterfaceGroup
+-CscfProactiveMonitoredSipInterface [0..]

This is a container class for the CscfProactiveMonitoredSipInterface instances.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfProactiveMonitoredSipInterfaceGroupId
This is the key attribute of the CscfProactiveMonitoredSipInterfaceGroup. One instance of the CscfProactiveMonitoredSipInterfaceGroup with the key cscfProactiveMonitoredSipInterfaceGroupId=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfProactiveMonitoredSipInterfaceGroup  

 

class CscfProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfProfileGroupClass
+-CscfProfileClass

This is Managed Object Class for CSCF Profile

Attributes
String1to01024DT
mandatory
cscfAuthenticationPolicy
This attribute defines which authentication policy to use for this configuration profile. It shall be the name of an existing CscfAuthentication instance.
String0to65535DT
key
mandatory
noNotification
restricted
cscfProfile
This is the key attribute of the CscfProfileClass.
String1to01024DT
mandatory
cscfRegistrationPolicy
This attribute defines which registration policy to use for this configuration profile. It shall be the name of an existing CscfRegistration instance.

  class CscfProfileClass  

 

class CscfProfileGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfProfileGroupClass
+-CscfProfileClass [0..]

This is Managed Object Class for CSCF Profile Group

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfProfileGroup
This is the key attribute of the CscfProfileGroupClass. One instance of the CscfProfileGroupClass with the key CscfProfileGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfProfileGroupClass  

 

class CscfRegistrationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfRegistrationGroupClass
+-CscfRegistrationClass

This is Managed Object Class for CSCF Registration

Attributes
MaxContactsBehaviorDT
cscfMaxContactsBehavior = DISABLED
CscfMaxContactsBehavior=DISABLED means that the CSCF will not enforce any restriction on the number of contacts, and attribute CscfMaxNumberContactsPerUser is ignored. CscfMaxContactsBehavior=REJECT means that the CSCF will not accept the new registrations if the limit CscfMaxNumberContactsPerUser is exceeded. CscfMaxContactsBehavior=OVERWRITE means that the CSCF accept the new registrations at the expense of the oldest contacts for that user, if the limit CscfMaxNumberContactsPerUser is exceeded . This parameter is access aware.
MaxContactsBehaviorDT
cscfMaxContactsBehaviorIrs = DISABLED
CscfMaxContactsBehaviorIrs=0 (Disabled) means that the CSCF will not enforce any restriction on the number of contacts per IRS, and MaxNoOfContacts sent in the user profile from HSS is ignored.
CscfMaxContactsBehaviorIrs=1 (Reject) means that the CSCF will not accept the new registrations for the IRS if the limit set by MaxNoOfContacts in the user profile is exceeded.
CscfMaxContactsBehaviorIrs=2 (Overwrite) means that the CSCF accept the new registrations for the IRS at the expense of the contact with the shortest expire time within the IRS, if the limit set by MaxNoOfContacts in the user profile is exceeded.
If the value configured in CscfMaxNumberContactsPerUser is exceeded when a user tries to add a new contact the CscfMaxContactsBehavior takes precedence over the CscfMaxContactsBehaviorIrs.
This parameter is NOT access aware.
MaxContactsPerUserDT
cscfMaxNumberContactsPerUser = 100
Number of contacts that a user may have registered. This parameter is access aware.
String0to65535DT
key
mandatory
noNotification
restricted
cscfRegistration
This is the key attribute of the CscfRegistrationClass containing all the registration parameters. One instance of the CscfRegistrationClass with the key CscfRegistration=default is created at startup. It is possible to create new instances. The default instance can not be deleted.
RegistrationRefreshTimerDT
cscfRegistrationRefreshDefault = 30
Default registration refresh time in minutes. The CSCF will use this time in certain cases when no registration refresh time is provided and a default value is needed. This parameter is access aware.

This value can be between 1 and 32000 minutes. It must be less than or equal to CscfRegistrationRefreshMax and greater than or equal to CscfRegistrationRefreshMin.
RegistrationRefreshTimerDT
cscfRegistrationRefreshMax = 60
Maximum registration refresh time allowed by the CSCF in minutes. Any registration of refresh time specified greater than this value is reduced to this value. This parameter is access aware.

This value can be between 1 and 32000 minutes. It must be greater than or equal to CscfRegistrationRefreshDefault and CscfRegistrationRefreshMin. For standard compliance and interoperability, the CscfRegistrationRefreshMax must not be less than 60 minutes
RegistrationRefreshTimerDT
cscfRegistrationRefreshMin = 15
Minimum registration refresh time allowed by the CSCF in minutes. Any registration request with a refresh time below this value is rejected. This parameter is access aware.

This value can be between 1 and 32000 minutes. It must be less than or equal to CscfRegistrationRefreshDefault and CscfRegistrationRefreshMax. For standards compliance and interoperability, the CscfRegistrationRefreshMin must not exceed 60 minutes
HssBypassDT
cscfReRegWithHssBypass = NO_BYPASS
This parameter is used to control if HSS bypass is allowed in reregistration handling. When it is set to BYPASS_ IF_FAILED, P-CSCF will add the Service-Route content in the Route header when sending reregister request, and I-CSCF will send the request to the destination received in the Route header (if received) when I-CSCF fails to query HSS. This parameter is not access aware.
boolean
cscfSendLurOnReRegistration = false
This attribute determines if CSCF should send LUR message in case of reregistration. This parameter is not access aware.

Deprecated: 

UserContactIn3rdPartyRegDT
cscfUseUserContactIn3rdPartyReg = scscfDomain
For the 3rd party registration function - toggles the behavior of including the original contact information received in the register request. Otherwise use the ScscfDomainName. If indications to include register request and/or include register response exists in trigger data for the application server, the ScscfDomainName is always used regardless of the configuration of this parameter. This parameter is NOT access aware.
EmergencyRegistrationRefreshTimerDT
scscfEmergencyRegistrationRefreshDefaultPeriod = 5
The registration refresh time in minutes for a contact being registered for emergency calls. The CSCF will ignore the value set in the expires parameter sent by the UE and instead it will return the value of this configuration parameter back to the UE. This value can be between 1 and 32000 minutes. This parameter is access aware.
Integer0to65535DT
scscfExpireTimeForDeRegUponRtr = 0
If an RTR message of reason code "NEW_SERVER_ASSIGNED" or "SERVER_CHANGE" is received for a user who has an ongoing session, S-CSCF will not deregister the user until the time period defined in this parameter has expired. If the user does not have any ongoing sessions, the user will be deregistered immediately. A value of 0 second means that the S-CSCF will deregister the user immediately when the RTR message with the corresponding reason codes is received.
Maximum delay, in seconds, for deregistration of a user with ongoing sessions. This value can be between 0 and 65535 seconds.
RegistrationContactRestrictionDT[0..1]
scscfRegistrationContactRestriction = disabled
This attributes gives the possibility to set restrictions on the contact format "userinfo@FQDN" used at registration, to prevent the risks for loops in SIP networks as described in RFC 5393. Following formats are always accepted; "userinfo@IP-address", "IP-address" and "FQDN".

disabled: There are no restrictions.
untrustedGW: If the Register message is received from an untrusted gateway (not configured in "CscfTrustedGateway"), any attempt to register a contact using the format "userinfo@FQDN" is rejected.
enabled: All registrations with contact headers on format "userinfo@FQDN" are rejected
ShortenUserRegistrationTimeDT[0..1]
scscfShortenUserRegistrationTime = ""
When setting this attribute, S-CSCF immediately makes an attempt to shorten the user’s remaining registration time. The attribute is a string including the user’s private identification and a new reregistration time in minutes. If the user is registered in the S-CSCF and the provided reregistration time is shorter than the remaining registration time, the new reregistration time is set. If the user has subscribed to the reg event package, a NOTIFY request including the event attribute 'shortened' is sent. Independent of how the attribute is set, S-CSCF will directly add the string 'Executed: ' in front of the given string, just to acknowledge that the attribute was set and an attempt is made.
Note:
1, When the value of the new reregistration time is set to 0 minutes, the user with this specific private identity will be deregistered immediately in S-CSCF, and any on-going sessions of this user will be terminated.
2, This function shall not be used for bulk user deregistration.
UnregisteredProfileTimerDT
scscfUnregisteredProfileTimer = 720
This parameter is used to configure how long S-CSCF should keep unregistered user profile safter it has been downloaded from HSS.
boolean
scscfwImpuEnabled = false
This attribute determines if IP-PBX Registration is supported in the CSCF. This parameter is not access aware.

  class CscfRegistrationClass  

 

class CscfRegistrationEvent

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSubscriptionGroup
+-CscfRegistrationEvent

This is a container class containing registration event related attributes.

This MO is created by the system.

Attributes
RegEventEnabledDT
cscfRegistrationEventEnabled = disabled
The cscfRegistrationEventEnabled parameter is used for enabling or disabling the registration event functionality in the CSCF node. Furthermore, in the enabled configuration, the cscfRegistrationEventEnabled parameter indicates a particular enabled-mode for the registration event functionality.
boolean
cscfRegistrationEventFullStateNotification = true
This parameter specifies whether the registration information in the NOTIFY request will contain full state information or partial state information.
String0to65535DT
key
mandatory
noNotification
restricted
cscfRegistrationEventId
This is the key attribute of the CscfRegistrationEvent. One instance of the CscfRegistrationEvent with the key cscfRegistrationEventId=default is created at startup. This instance cannot be deleted.
RegEventMaxNotificationRateDT
cscfRegistrationEventMaximumNotificationRate = 5
This parameter specifies the minimum time spent between subsequent notifications sent for the same public user identity.
boolean
cscfRegistrationEventNotifyOnResubscribe = false
This parameter specifies if the S-CSCF will send notifications or not as answer to a refreshment of the subscription.
RegistrationEventRefreshTimerMaxDT
cscfRegistrationEventRefreshMax = 60
This parameter is used to set the maximum refresh time for Registration Event SUBSCRIBE requests. Any Registration Event SUBSCRIBE request received with a refresh time greater than what is specified in this parameter will be reduced to this value in the 200 OK. The time is defined in minutes and must be greater than the value of cscfRegistrationEventRefreshMin, and must be greater than or equal to the value of CscfRegistrationRefreshDefault + 3 minutes.
RegistrationEventRefreshTimerMinDT
cscfRegistrationEventRefreshMin = 15
This parameter is used to set the minimum refresh time for Registration Event SUBSCRIBE requests. Any Registration Event SUBSCRIBE request with a refresh time below this value (excluding 0) is rejected. The time is defined in minutes and must be less than the value of cscfRegistrationEventRefreshMax.
boolean
scscfExtendedRegistrationEventEnabled = false
This parameter controls the enabling and disabling of the Extended Registration Event Notification at the S-CSCF. When the Extended Registration Event Notification is enabled, S-CSCF includes additional information in the Registration Event Notification XML document. The exact content of the additional information is set using the scscfRegistrationEventExtendedContent parameter.

Takes effect: ChangeTypeRuntimeType - Immediate
Integer0to00001DT
scscfRegistrationEventExtendedContent = 0
This attribute is used to control the adding extension information in the Registration Event Notification XML file, such as, Feature-Caps header, IMPI information, PVNI header and PANI header.
This attribute is only applicable when scscfExtendedRegistrationEventEnabled is set to true. This attribute is not access aware.


Takes effect: ChangeTypeRuntimeType - Session

  class CscfRegistrationEvent  

 

class CscfRegistrationGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfRegistrationGroupClass
+-CscfRegistrationClass [1..]

This is Managed Object Class for CSCF Registration Group

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfRegistrationGroup
This is the key attribute of the CscfRegistrationGroupClass. One instance of the CscfRegistrationGroupClass with the key CscfRegistrationGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfRegistrationGroupClass  

 

class CscfResourceBrokerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfResourceBrokerClass

This is Managed Object Class for CSCF Resource Broker

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfResourceBroker
This is the key attribute of the CscfResourceBrokerClass class. One instance of the CscfResourceBrokerClass with the key cscfResourceBroker=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
ResourceBrokerEntryDT[0..500] ordered
cscfResourceBrokerEntry
I-CSCF uses the data configured in this parameter to select an S-CSCF if the query response from HSS contains a list of capabilities. I-CSCF matches the capabilities received from HSS with the capabilities configured in the parameter. The S-CSCF with the highest priority will be selected if several S-CSCF matches the capabilities received from HSS. I-CSCF will try the next matching S-CSCF in priority order if the selected S-CSCF is not reachable.

Takes effect: ChangeTypeRuntimeType - Immediate
boolean
icscfForcedFallbackEnabled = false
This is a parameter used to enable and disable the Fallback procedure. The Fallback procedure is enabled when this parameter is set to true. The Fallback procedure is disabled when this parameter is set to false. When the Fallback procedure is enabled, users will be transferred back to the original S-CSCF in the next registration request.
boolean
icscfLocalZonePolicyEnabled = false
This parameter is used for enabling and disabling the Local Zone Policy in I-CSCF. The feature enables an I-CSCF to only select S-CSCFs included in its local zone. When the I-CSCF receives a Diameter UAA with AVP Server-Name from the HSS, and the CscfResourceBrokerEntry is configured, the S-CSCF names within the CscfResourceBrokerEntry are compared with the received server name. If there is no match, the I-CSCF requests capabilities from HSS, and reselects an S-CSCF. If there is a match, I-CSCF selects the S-CSCF received in the Server-Name AVP. When the I-CSCF receives a Diameter UAA with AVP Server-Name from the HSS, and the CscfResourceBrokerEntry is NOT configured, the colocated S-CSCF (if any) is compared with the received server name. If there is no match, the I-CSCF requests capabilities from HSS and reselects an S-CSCF. If there is a match, I-CSCF selects the S-CSCF received in the Server-Name AVP.

  class CscfResourceBrokerClass  

 

class CscfRoutingClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfRoutingGroupClass
+-CscfRoutingClass

This is a container class for the CSCF routing related attributes.

This MO is created by the system.

Attributes
boolean
cscfHostportAsFqdnOnly = false
When the parameter is set to the value true, the hostport of the target SIP-URI set by the CSCF will be an FQDN only. In addition, none of the SIP parameters maddr or transport, nor port will be added by the CSCF under the headers Route, Record-Route, Path and Service-Route, nor under Contact containing an S-CSCF address for a Third Party Register request. Furthermore, when the S-CSCF Server Name is sent from the CSCF towards the HSS it will contain an FQDN only. The value of the parameter has no influence on the Gm interface. Note: This parameter cannot be set to false if an IPv6 address is specified for eatfNetworkInterfaceEntryId, EcscfNetworkInterfaceEntry, ScscfNetworkInterfaceEntry or IcscfNetworkInterfaceEntry.
String0to65535DT
key
mandatory
noNotification
restricted
cscfRouting
This is the key attribute of the CscfRoutingClass containing all the Routing parameters. One instance of the CscfRoutingClass with the key CscfRouting=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
DomainNameDT[0..] nonUnique ordered
eatfDomainNameEntry
This attribute is the domain name of the EATF. This is the fully qualified domain name of the EATF node, if one exists. It is possible to configure multiple domain names of the EATF. The purpose with this is to have the possibility to address the same EATF node with different names, used at, for example, load sharing or network redundancy. It shall be noted that outgoing messages from the EATF will always include the first configured domain name.
boolean
icscfScscfFailoverForNonInviteEnabled = false
This parameter defines if the I-CSCF selects another S-CSCF when a non-INVITE request (except REGISTER) has not received any response from S-CSCF before transaction timeout.
boolean
icscfSipToSipTransitEnabled = false
This attribute controls how to route IMS Transit (SIP->SIP) traffic when it is received in the terminating side of I-CSCF.

  class CscfRoutingClass  

 

class CscfRoutingGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfRoutingGroupClass
+-CscfCallerPreferencesClass [1..1]
+-CscfRoutingClass [1..1]

This is a container class for the CscfRouting instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfRoutingGroup
This is the key attribute of the CscfRoutingGroupClass. One instance of the CscfRoutingGroupClass with the key CscfRoutingGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfRoutingGroupClass  

 

class CscfSecurityAdmin

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSecurityAdminGroup
+-CscfSecurityAdmin

This is a container class for the CSCF security related attributes.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfSecurityAdminId
This is the key attribute of the CscfSecurityAdmin containing all the CSCF security parameters.
One instance of the CscfSecurityAdmin with the key cscfSecurityAdminId=default can be created. This instance can be deleted.
No other instances can be created.
TrustedAsDT[0..20] nonUnique ordered
scscfCallStatusAsEntry
Each entry holds an IP address of an Application Server that is allowed to send call status queries using MESSAGE message.

If the IP address of an Application Server that sends a call status query is not in the list of allowed Application Server, call status request is rejected.

  class CscfSecurityAdmin  

 

class CscfSecurityAdminGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSecurityAdminGroup
+-CscfSecurityAdmin [0..1]

This is a container class for CscfSecurityAdmin.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSecurityAdminGroupId
This is the key attribute of the CscfSecurityAdminGroup.
One instance of the CscfSecurityAdminGroup with the key cscfSecurityAdminGroupId=0 can be created.
This instance can be deleted. No other instances can be created.

  class CscfSecurityAdminGroup  

 

class CscfServiceInvocationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfServiceInvocationGroupClass
+-CscfServiceInvocationClass

This is a container class for the CSCF Service Invokation related attributes.

This MO is created by the system.

Attributes
TimerSec0to32DT
cscfASFailoverTimeInvite = 32
Number of seconds that the S-CSCF will be waiting for SIP response messages from the Application Server (AS) before trying next AS. Valid only for INVITE message. If this parameter is disabled (set to 0), CscfSipDefaultFailoverTimer will be used instead.
TimerSec0to32DT
cscfASFailoverTimeNonInvite = 32
Number of seconds that the S-CSCF will be waiting for SIP response messages from the AS before trying next AS. Valid only for non-INVITE messages. If this parameter is disabled (set to 0), CscfSipDefaultFailoverTimer will be used instead.

T1
String0to65535DT
key
mandatory
noNotification
restricted
cscfServiceInvocation
This is the key attribute of the CscfServiceInvocationClass containing all the ServiceInvocation parameters. One instance of the CscfServiceInvocationClass with the key CscfServiceInvocation=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
ClearAsCacheDT[0..10] nonUnique ordered
scscfClearAsCache
The parameter contains the IP addresses that shall be cleared from the AS-instance cache used by S-CSCF. It shall either be a list of specific IP addresses or the keyword "all" (all cached IP addresses shall be removed). The AS-cache is cleared per user when it is to be used or at the latest at the next reregistration. If the list or keyword is not manually deleted, it is automatically deleted after the longest period of the configured cscfRegistrationRefreshMax and scscfUnregisteredProfileTimer. Maximum 10 IP addresses can be set, and if more than 10 IP addresses are needed the keyword "all" has to be used.

Takes effect: ChangeTypeRuntimeType - Immediate
boolean
scscfExtendedDefaultHandlingEnabled = false
This parameter is used for selecting which SIP negative responses from the Application Server that should allow the SIP request to continue execution in the S-CSCF (SESSION_CONTINUED).

  class CscfServiceInvocationClass  

 

class CscfServiceInvocationGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfServiceInvocationGroupClass
+-CscfServiceInvocationClass [1..1]

This is a container class for the CscfServiceInvocation instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfServiceInvocationGroup
This is the key attribute of the CscfServiceInvocationGroupClass. One instance of the CscfServiceInvocationGroupClass with the key CscfServiceInvocationGroup =0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfServiceInvocationGroupClass  

 

class CscfServicePriorityClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfServicePriorityGroupClass
+-CscfServicePriorityClass

This section describes the CscfServicePriorityClass class and related attributes.

This MO is created by the system.

Attributes
GetsAnEntryDT[0..10] nonUnique
cscfGetsAnEntry
CscfGetsAnEntry is a multi value parameter used to detect a GETS-AN (Access Number) priority call. No instances of CscfGetsAnEntry signify that the GETS-AN detection is disabled. This parameter is NOT access aware.

Dependencies: This attribute only takes effect when CscfPrioritySupportEnabled is true.
boolean
cscfPrioritySupportEnabled = false
This attribute is used for enabling or disabling Priority Support in the CSCF node. This parameter is NOT access aware.
String0to65535DT
key
mandatory
noNotification
restricted
cscfServicePriority
This is the key attribute of the CscfServicePriorityClass containing all the priority parameters. One instance of the CscfServicePriorityClass with the key CscfServicePriority=default is created at startup. The default instance can not be deleted.
PriorityMappingDT
cscfTspPriorityMapping = p0:19;p1:17;p2:15;p3:12;p4:9;ec:14;nc:0
CscfTspPriorityMapping is used to map the external priorities of calls to CSCF internal priority levels. This parameter is NOT access aware.
ScscfAssignCalleePrioDT
scscfAssignCalleePriority = DISABLED
This parameter is used to control if terminating S-CSCF should add Resource Priority Header into a not already prioritized SIP request which is sent to a prioritized user before sending the request to next hop. This parameter is not access aware. This attribute only takes effect when the parameter CscfPrioritySupportEnabled is set to true.

Takes effect: ChangeTypeRuntimeType - Session
boolean
scscfPriorityAuthorizationEnabled = false
This attribute is used for enabling or disabling whether the S-CSCF is the node that will authorize the final priority for the request. This attribute only takes effect when CscfPrioritySupportEnabled is true. This parameter is NOT access aware.
PriorityPrefixDT[0..1]
scscfPriorityPrefix = ""
ScscfPriorityPrefix is used to indicate the priority prefix of a priority call. The default is set to &lt;Empty Value&gt; which signifies that the priority prefix deciphering is disabled. This attribute only takes effect when CscfPrioritySupportEnabled is true and ScscfPriorityAuthorizationEnabled is true. This parameter is NOT access aware.
boolean
scscfRejectIfNoPrioInProfileEnabled = false
This attribute is used for enabling or disabling whether the SIP request is rejected if there is no priority in the user's profile and a Resource-Priority Header (RPH) is received in the request. This attribute only takes effect when CscfPrioritySupportEnabled is "true" and ScscfPriorityAuthorizationEnabled is "true". This parameter is NOT access aware.

true: the SIP request is rejected if there is no priority in the user's profile and a Resource-Priority Header (RPH) is received in the request.

false: the SIP request is accepted if there is no priority in the user's profile and a Resource-Priority Header (RPH) is received in the request.

  class CscfServicePriorityClass  

 

class CscfServicePriorityGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfServicePriorityGroupClass
+-CscfServicePriorityClass [1..1]

This section describes the CscfServicePriorityGroupClass class and related attributes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
cscfServicePriorityGroup
This is the key attribute of the CscfServicePriorityGroupClass. One instance of the CscfServicePriorityGroupClass with the key CscfServicePriorityGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfServicePriorityGroupClass  

 

class CscfSipConfigDestProfile

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipProtocolGroupClass
+-CscfSipConfigDestProfileGroup
+-CscfSipConfigDestProfile

This section describes the CscfSipConfigDestProfile class and related attributes.

Attributes
BlacklistingThresholdDestDT
cscfBlacklistingSip503WithoutRetryAfterThresholdDest = default
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of 503 Response without Retry-After. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
BlacklistingThresholdDestDT
cscfBlacklistingSip503WithRetryAfterThresholdDest = default
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of 503 Response with Retry-After. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
BlacklistingThresholdDestDT
cscfBlacklistingSipTransactionTimeoutThresholdDest = default
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of SIP transaction timeout. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
BlacklistingThresholdDestDT
cscfBlacklistingTransportErrorThresholdDest = default
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of fatal transport error (socket error). This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
Fqdn0to1024DT[0..100] nonUnique ordered
cscfDestinationSipAddress
This attribute is used to indicate the destination address(es). Every entry in the list must be a FQDN. This attribute is not access aware.
DestinationUnavailabilityTimerDestDT
cscfDestinationUnavailabilityTimerDest = default
This attribute is used to configure the time in seconds that CSCF blacklists an unavailable destination in the network. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
TimerSec0to32DT
cscfFailoverTimeInviteDest = 0
This attribute is used to define the time in seconds to failover for Mw and Ma interfaces for INVITE requests. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
TimerSec0to32DT
cscfFailoverTimeNonInviteDest = 0
This attribute is used to define the time in seconds to failover for Mw and Ma interfaces for INVITE requests. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
TimerSec0to32DT
cscfFailoverTimeRegisterDest = 0
This attribute is used to define the time in seconds to failover for Mw and Ma interfaces for REGISTER requests. This attribute is applied for the list destinations mentioned in attribute cscfDestinationSipAddress. This attribute is not access aware.
string
key
mandatory
noNotification
restricted
cscfSipConfigDestProfileId
Primary key for each cscfSipConfigDestProfileId table entries. Those entries must be created by user.

  class CscfSipConfigDestProfile  

 

class CscfSipConfigDestProfileGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipProtocolGroupClass
+-CscfSipConfigDestProfileGroup
+-CscfSipConfigDestProfile [0..]

This class is a container for CscfSipConfigDestProfile table entries

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSipConfigDestProfileGroupId
Primary key for CscfSipConfigDestProfileGroup

  class CscfSipConfigDestProfileGroup  

 

class CscfSipErrorConfigurationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipErrorConfigurationClass
+-CscfSipErrorConfigurationTableClass [0..]

This class is the container of CscfSipErrorConfigurationTable entries.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSipErrorConfiguration
Primary key of CscfSipErrorConfigurationClass.

  class CscfSipErrorConfigurationClass  

 

class CscfSipErrorConfigurationEntryClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipErrorConfigurationClass
+-CscfSipErrorConfigurationTableClass
+-CscfSipErrorConfigurationEntryClass

This class describes an error configuration rule.

Attributes
SipErrorCodeDT[0..1]
cscfNewErrorCode
The new SIP error code to be set in the SIP error response. If CscfNewErrorCode, CscfNewRetryAfter, CscfNewSlogan and CscfNextTable are left empty then the rule becomes a “stop processing rule”.
SipErrorRetryAfterDT[0..1]
cscfNewRetryAfter
New value to be set in the Retry-After header in the mapped SIP response. If CscfNewErrorCode, CscfNewRetryAfter, CscfNewSlogan and CscfNextTable are left empty then the rule becomes a “stop processing rule”.

SipErrorSloganDT[0..1]
cscfNewSlogan
The new slogan that will be put as reason phrase in the mapped SIP response. If CscfNewErrorCode, CscfNewRetryAfter, CscfNewSlogan and CscfNextTable are left empty then the rule becomes a “stop processing rule”.
SipErrorNextTableDT[0..1]
cscfNextTable
If the rule matches, then processing will be continued in the table named by the content of the attribute. If this attribute is not empty, then the values entered into CscfNewErrorCode, CscfNewSlogan, CscfNewRetryAfter are considered to be empty, and the SIP response is not modified. If CscfNewErrorCode, CscfNewRetryAfter, CscfNewSlogan and CscfNextTable are left empty then the rule becomes a “stop processing rule”.

SipErrorConfigurationEntryDT
key
mandatory
noNotification
restricted
cscfSipErrorConfigurationEntry
Primary key of the entry, it should be composed of elements separated by “:” characters. The first element is equal to the CscfSipErrorConfigurationTableName attribute of the CscfSipErrorConfigurationTable, which contains the entry.

The second element is the required value of the field of the related SIP/Diameter message specified by the CscfFilteringCriteria1 attribute of the containing table. The second element corresponds to the required value of CscfFilteringCriteria2 attribute and so on, until the sixth field. There is a special meaning to the construct &lt;CscfSipErrorConfigurationTableName&gt;:default. If none of the entries match, then the system will look for this entry, which gives the possibility of a default processing route. If an entry matches, default rule is ignored, and processing is stopped.

Corresponding to the CscfFilteringCriteriaX fields of the containing table, the following values are considered as valid:

sip.errorcode := integer 300-699
sip.reason.protocol := string 'SIP'|'Q.850'
sip.reason.cause := integer > 0
diameter.message := string 'UAA'|'MAA'|'SAA'|'LIA'
diameter.resultcode := integer 3000..5999

  class CscfSipErrorConfigurationEntryClass  

 

class CscfSipErrorConfigurationTableClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipErrorConfigurationClass
+-CscfSipErrorConfigurationTableClass
+-CscfSipErrorConfigurationEntryClass [0..]

This class is the container of CscfSipErrorConfigurationEntry entries. Using the attributes, the operator is able to configure the SIP/Diameter properties that should be used for rule evaluation. There is a special table with primary key value of “root”, as this is the entry point for rule evaluation. If there is no table with that name, then the feature is disabled, no rewrite rules in other tables will apply. The error tables should be chained using CscfSipErrorConfigurationEntry elements referring to next hops by their CscfNextTable field.

Attributes
SipErrorFilteringCriteriaDT
mandatory
noNotification
restricted
cscfFilteringCriteria1
Name of the data, on which the related entry rules must be evaluated. This entry is obligatory to fill out.
The parameter has to be set at creation, later modification is not possible, because changing it would invalidate all contained CscfSipErrorConfigurationEntry elements.
String0to00032DT[0..1]
noNotification
restricted
cscfFilteringCriteria2
Name of the data, on which the related entry rules must be evaluated. The parameter has to be set at creation, later modification is not possible, because changing it would invalidate all contained CscfSipErrorConfigurationEntry elements. Possible values:
&lt;empty&gt; - unused field
sip.errorcode - SIP error code is considered as filter matching criteria
sip.reason.protocol - Protocol entry for reason header is considered as filter matching criteria
sip.reason.cause - Cause value from reason header is considered as filter matching criteria
diameter.message - Diameter message type is considered as filter matching criteria
diameter.resultcode - Diameter response code is considered as filter matching criteria
String0to00032DT[0..1]
noNotification
restricted
cscfFilteringCriteria3
Name of the data, on which the related entry rules must be evaluated. The parameter has to be set at creation, later modification is not possible, because changing it would invalidate all contained CscfSipErrorConfigurationEntry elements. Possible values:
&lt;empty&gt; - unused field
sip.errorcode - SIP error code is considered as filter matching criteria
sip.reason.protocol - Protocol entry for reason header is considered as filter matching criteria
sip.reason.cause - Cause value from reason header is considered as filter matching criteria
diameter.message - Diameter message type is considered as filter matching criteria
diameter.resultcode - Diameter response code is considered as filter matching criteria
String0to00032DT[0..1]
noNotification
restricted
cscfFilteringCriteria4
Name of the data, on which the related entry rules must be evaluated. The parameter has to be set at creation, later modification is not possible, because changing it would invalidate all contained CscfSipErrorConfigurationEntry elements. Possible values:
&lt;empty&gt; - unused field
sip.errorcode - SIP error code is considered as filter matching criteria
sip.reason.protocol - Protocol entry for reason header is considered as filter matching criteria
sip.reason.cause - Cause value from reason header is considered as filter matching criteria
diameter.message - Diameter message type is considered as filter matching criteria
diameter.resultcode - Diameter response code is considered as filter matching criteria
String0to00032DT[0..1]
noNotification
restricted
cscfFilteringCriteria5
Name of the data, on which the related entry rules must be evaluated. The parameter has to be set at creation, later modification is not possible, because changing it would invalidate all contained CscfSipErrorConfigurationEntry elements. Possible values:
&lt;empty%gt; - unused field
sip.errorcode - SIP error code is considered as filter matching criteria
sip.reason.protocol - Protocol entry for reason header is considered as filter matching criteria
sip.reason.cause - Cause value from reason header is considered as filter matching criteria
diameter.message - Diameter message type is considered as filter matching criteria
diameter.resultcode - Diameter response code is considered as filter matching criteria
SipErrorConfigurationTableDT
key
mandatory
noNotification
restricted
cscfSipErrorConfigurationTable
Name and primary key identifying the table. The value "root" is special, this is the name of the table, that is first looked up by the system. If no table named "root" is found then no mapping will occur, even if there are other configured mapping tables.

  class CscfSipErrorConfigurationTableClass  

 

class CscfSipMsgPreProcessing

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipMsgPreProcessing

This is Managed Object Class for CSCF SIP Message Pre-processing

This MO is created by the system.

Attributes
AltServiceIndicationContentTypeDT
cscfAltServiceIndicationContentType = application/3gpp-ims+xml
Note: This parameter is deprecated. Use PcscfAltServiceIndicationContentType instead.
This parameter indicates the type of content in the CscfAltServiceIndication parameter.


Deprecated: 

CompoundSipHeaderDT[1..] nonUnique ordered
cscfCompoundSipHeaderEntry = P-Associated-URI:default
This attribute lets the user decide if certain SIP headers are to be compounded when sent over the GM interface as one single-line comma separated list or according to default behavior.
boolean
cscfForceReqUriEscaping = false
This parameter specifies, if the illegal characters from CscfNonStandardSipUriUserCharacters are to be escaped.

If set to false, no special rules apply to Request-URI. This means that the SIP Framework will allow the configured illegal character in the Request-URI and in all other SIP URIs. If the Request-URI is modified, then the illegal character will be escaped when the message is proxied. This means it will appear as "% HexHex" (expression "#" is escaped as %23).

If set to true, the characters in Request-URI will be escaped. This means that the SIP Framework will ensure that any configured illegal character that appears in a Request-URI is always escaped when the request is proxied. In other words, it mustappear as "%HexHex" (exp. "#" is escaped as %23). Any illegal character in any other SIP URI will be escaped, if the SIP URI is modified.
MaxSipMessageSizeDT
cscfMaxSipMessageSizeTcp = 8192
The maximum size of a SIP message sent or received using TCP/UDP. Note:The TCP header, 20 bytes is not measured in the size. If exceeded, the message will be discarded and a SIP error message 513 will be sent back.
Note: It may take several minutes for changes to this parameter to take effect.
Note: The transport protocol to send a message on is determined according to RFC 3261 and RFC 3263 if not CscfSendRequestUdpOnly = true. As a consequence the transport protocol of the sent messages may differ from the transport protocol of the received messages.
Note: Since the CSCF generally adds information to the messages, the sent messages are usually larger than the received ones. As a consequence the CSCF may reject the request even though the incoming request is smaller than the maximum allowed size.
MaxSipMessageSizeDT
cscfMaxSipMessageSizeUdp = 8192
The maximum size of a SIP message sent or received using TCP/UDP.
Note: The UDP header, 8 bytes, is not measured in the size. If exceeded, the message will be discarded and a SIP error message 513 will be sent back.
Note: It may take several minutes for changes to this parameter to take effect.
Note: The transport protocol to send a message on is determined according to RFC 3261 and RFC 3263 if not CscfSendRequestUdpOnly = true. As a consequence the transport protocol of the sent messages may differ from the transport protocol of the received messages.
Note: Since the CSCF generally adds information to the messages, the sent messages are usually larger than the received ones. As a consequence the CSCF may reject the request even though the incoming request is smaller than the maximum allowed size.
String0to00256DT[0..1]
cscfNonStandardSipUriUserCharacters = ""
The user will be able to specify which illegal characters are to be treated in a special way. # [ ] ^ ` { | } are the only set of characters that can be used in the configuration. By default, this table is empty.

0-8 Characters: # = 0x23 [ = 0x5b ] = 0x5d ^ = 0x5e ` = 0x60 { = 0x7b | = 0x7c } = 0x7d

Note: Same value can only be used once. For example: Sip-uri subscriberId#@domain.com. This means that if the character "#" is configured for the parameter CscfNonStandardSipUriUserCharacters, the sip-uri containing this character will not be rejected by CSCF with a 400 response.
integerKeyString
key
mandatory
noNotification
restricted
cscfSipMsgPreProcessingKey
This is the key attribute of the CscfSipMsgPreProcessing class. One instance of the CscfSipMsgPreProcessing with the key cscfSipMsgPreProcessingKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfSipMsgPreProcessing  

 

class CscfSipOverloadControl

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipOverloadControlGroup
+-CscfSipOverloadControl

This is a container class for the SIP Overload Control related attributes.

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfSipOverloadControlId
This is the key attribute of the CscfSipOverloadControl containing Sip Overload Control parameters. One instance of the CscfSipOverloadControl with the key cscfSipOverloadControlId=default is created at startup. It is impossible to create new instances. This instance cannot be deleted.

Takes effect: ChangeTypeRebootType
boolean
cscfSipOverloadControlReactingEnabled = false
This attribute is used to configure if the SIP Overload Control reacting role is enabled or not for CSCF. This attribute is not access aware.
The change of this attribute may take up to 5 minutes to take effect.


Takes effect: ChangeTypeRuntimeType - Other
CscfSipOverloadControlReactingTrafficMeasurementIntervalDT
cscfSipOverloadControlReactingTrafficMeasurementInterval = 1000
This attribute defines the interval in milliseconds during which measuring the amount of outgoing SIP requests per destination is performed to forecast ongoing traffic priority mix of outgoing SIP requests. It is only applicable when cscfSipOverloadControlReactingEnabled is set to true. This attribute is not access aware.
The change of this attribute may take up to 5 minutes to take effect.


Takes effect: ChangeTypeRuntimeType - Other
CscfSipOverloadControlReactingTrafficPrioritiesDT
cscfSipOverloadControlReactingTrafficPriorities = 0:RphWps0,RphWps1;1:RphWps2,RphWps3;2:RphWps4;3:Emergency;6:Inside;15:Default
This attribute is used to map the outgoing SIP requests to SIP overload control reacting internal priority levels. This attribute is only applicable when cscfSipOverloadControlReactingEnabled is set to true. This attribute is not access aware.

Takes effect: ChangeTypeRuntimeType - Immediate
boolean
cscfSipOverloadControlReportingEnabled = false
This attribute is used to configure if the SIP Overload Control reporting is enabled or not for CSCF. This attribute is not access aware.
The change of this attribute may take up to 5 minutes to take effect.


Takes effect: ChangeTypeRuntimeType - Immediate
OverloadControlReportingFairnessBehaviorDT
cscfSipOverloadControlReportingFairnessBehavior = Sip503Response
This attribute defines if CSCF should reject an amount of incoming traffic from a node that does not support SIP overload control. The amount of incoming traffic is corresponding to the percentage level of how much traffic that a node supporting SIP overload control shall reduce traffic towards the CSCF node.
This attribute is only applicable when cscfSipOverloadControlReportingEnabled is set to true. This attribute is not access aware.


Takes effect: ChangeTypeRuntimeType – Immediate
Integer0to00100DT
cscfSipOverloadOnset = 75
This attribute is used to configure the average cluster resource utilization level in percentage that must be exceeded to activate the SIP overload control reporting function. This attribute is only applicable when cscfSipOverloadControlReportingEnabled is set to true. This attribute is not access aware.
The change of this attribute may take up to 5 minutes to take effect.


Takes effect: ChangeTypeRuntimeType - Immediate

  class CscfSipOverloadControl  

 

class CscfSipOverloadControlGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipOverloadControlGroup
+-CscfSipOverloadControl [1..1]

This is a Managed Object Class for the SIP Overload Control Configuration Group.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSipOverloadControlGroupId
This is the key attribute of the CscfSipOverloadControlGroup containing groups of Sip Overload Control parameters. One instance of the CscfSipOverloadControlGroup with the key cscfSipOverloadControlGroupId=0 is created at startup. It is impossible to create new instances. This instance cannot be deleted.

Takes effect: ChangeTypeRebootType

  class CscfSipOverloadControlGroup  

 

class CscfSipProtocolClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipProtocolGroupClass
+-CscfSipProtocolClass

This is a container class for the sip protocol related attributes.

This MO is created by the system.

Attributes
Integer0to00100DT
cscfBlacklistingBypassThrottle = 100
This parameter controls how much of initial SIP requests should be sent to destinations that have been blacklisted as unreachable for other reasons than transaction timeout. It is possible to define the percentage of requests that should be sent in this case.
If CscfBlacklistingBypassThrottle has the value 0, it means that CSCF will behave as recommended in standards, that is, send a 500 error if all destinations are blacklisted. How long a destination is blacklisted depends on the reason why it was blacklisted. If CscfBlacklistingBypassThrottle has the value 100, it means that no matter what the reason is, and for how long the node is blacklisted, the CSCF will try to send initial SIP requests towards it in 100% of the cases (that is, ignore the blacklisting completely).
If CscfBlacklistingBypassThrottle has another value, for example 70, it means that 70% of all requests will disregard the blacklisting and the initial SIP requests will be sent anyway.
Integer0to00100DT
cscfBlacklistingInsideDialogRequestBypassThrottle = 100
This parameter controls how much of inside dialogue SIP requests should be sent to destinations that have been blacklisted as unreachable. It is possible to define the percentage of inside dialogue SIP requests that should be sent in this case.
If cscfBlacklistingInsideDialogRequestBypassThrottle has the value 0, it means that CSCF will behave as recommended in standards, that is, send a 500 error if all destinations are blacklisted. How long a destination is blacklisted depends on the reason why it was blacklisted. If cscfBlacklistingInsideDialogRequestBypassThrottle has the value 100, it means that no matter what the reason is, and for how long the node is blacklisted, the CSCF will try to send inside dialogue SIP requests towards it in 100% of the cases (that is, ignore the blacklisting completely).
If cscfBlacklistingInsideDialogRequestBypassThrottle has another value, for example 70, it means that 70% of all requests will disregard the blacklisting and the requests will be sent anyway.
Integer0to2147483647DT
cscfBlacklistingSip503WithoutRetryAfterThreshold = 0
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of 503 Response without Retry-After.
Integer0to2147483647DT
cscfBlacklistingSip503WithRetryAfterThreshold = 0
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of 503 Response with Retry-After.
Integer0to00100DT[0..100] nonUnique
cscfBlacklistingSipTransactionTimeoutBypassThrottle = 100
This parameter controls how much of initial SIP requests should be sent to destinations that have been blacklisted as unreachable due to a SIP Transaction Timeout. It is possible to define the percentage of requests that should be sent in this case. If CscfBlacklistingSipTransactionTimeoutBypassThrottle has the value 0, it means that CSCF will behave as recommended in standards, that is, send a 500 error if all destinations are blacklisted. The unreachable destination transport address is blacklisted for a configurable period of time (CscfDestinationUnavailabilityTimer). If blacklisting reason is SIP Transaction Timeout and CscfBlacklistingSipTransactionTimeoutBypassThrottle has the value 100, it means that no matter for how long the node is blacklisted, the CSCF will try to send requests towards it in 100% of the cases (that is, ignore the blacklisting completely). If CscfBlacklistingSipTransactionTimeoutBypassThrottle has another value, for example 70, it means that 70% of all requests will disregard the blacklisting and the requests will be sent anyway. This parameter takes precedence over CscfBlacklistingBypassThrottle in case blacklisting reason is SIP Transaction Timeout.
NOTE: This parameter is a sequence with only one element. To change its value with the ECLI use one of these syntax:
cscfBlacklistingSipTransactionTimeoutBypassThrottle[@1]=<new_value>
cscfBlacklistingSipTransactionTimeoutBypassThrottle[<old_value>]=<new_value>
Integer0to2147483647DT
cscfBlacklistingSipTransactionTimeoutThreshold = 0
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of SIP transaction timeout.
Integer0to2147483647DT
cscfBlacklistingTransportErrorThreshold = 0
This parameter is used to configure the threshold value for blacklisting destinations due to the reason of fatal transport error (socket error).
DefaultQValueDT
cscfDefaultQValue = 0
This attribute is used to set the default value for the q-value parameter when it is absent. The value represents units of one thousandth. Some possible value examples are ”0”, ”1000”, ”500”, ”999”.
DestinationUnavailabilityTimerDT
cscfDestinationUnavailabilityTimer = 60
Defines the time in seconds that CSCF blacklists an unavailable destination in the network.
CscfMaxNoOfTcpConnectionsDT
cscfMaxNoOfTcpConnections = 0
0: no limitation on number of TCP connections towards a specific host
1-50: configures the maximum number of outbound TCP connections towards a specific host
CscfSip500RetryAfterDT
noNotification
cscfSip500RetryAfterMax = 200
This parameter defines the maximum value for the randomly-generated value for the Retry-After header in a SIP 500 response. This is used when an HSS request is throttled or when the response to the request is 3004 Diameter Too Busy.
CscfSip500RetryAfterDT
noNotification
cscfSip500RetryAfterMin = 20
This parameter defines the minimum value for the randomly-generated value for the Retry-After header in a SIP 500 response. This is used when an HSS request is throttled or when the response to the request is 3004 Diameter Too Busy.
TimerSec0to32DT
cscfSipDefaultFailoverTimer = 0
Defines the time in seconds to failover for all SIP requests for all interfaces except Mw and Ma. For Mw and Ma interfaces, the timer only applies to INVITE and REGISTER requests. Overrides the 64*T1 timer. Default value is 0, which means the timer is disabled.
TimerSec0to32DT
cscfSipDefaultNonInviteFailoverTimer = 0
Defines the time in seconds to failover for Mw and Ma interfaces for non-INVITE requests, except REGISTER. Overrides the 64*T1 timer. Default value is 0, which means the timer is disabled.

Takes effect: ChangeType-RunTimeType Session
String0to65535DT
key
mandatory
noNotification
restricted
cscfSipProtocol
This is the key attribute of the CscfSipProtocolClass containing all the sip protocol parameters. One instance of the CscfSipProtocolClass with the key CscfSipProtocol=default is created at startup. This instance can not be deleted.
CscfSipProtocolOwnNodeBehaviorDT
cscfWhiteListOwnNodeBehavior = Enabled
This attribute is used to configure if all own network interfaces and own domains should be white-listed. This list will be used to manage collocated CSCF instances. If a SIP request is to be sent to any entries in the white list, then the SIP overload control throttling can be bypassed.

Takes effect: ChangeTypeRuntimeType – Immediate
IcscfRedirectBehaviorDT
icscfRedirectBehavior = 0
This parameter controls how I-CSCF behaves when receiving a 300, 301 or 302 response to an initial non-REGISTER request.
PcscfRedirectBehaviorDT[0..1]
pcscfRedirectBehavior = 0
This parameter controls how terminating P-CSCF behaves when receiving a 3xx SIP response.
"Possible Values and Meanings:
0 Terminating P-CSCF maps all 3xx responses to 500 Internal Server Error before forwarding it upstream
1 Terminating P-CSCF forwards all 3xx responses transparently"

  class CscfSipProtocolClass  

 

class CscfSipProtocolGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSipProtocolGroupClass
+-CscfSipConfigDestProfileGroup [1..1]
+-CscfSipProtocolClass [1..1]

This is a container class for CscfSipProtocolClass instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSipProtocolGroup
This is the key attribute of the CscfSipProtocolGroupClass containing all the CscfSipProtocolClass instances. One instance of the CscfSipProtocolGroupClass with the key CscfSipProtocolGroup=0 is created at startup.

  class CscfSipProtocolGroupClass  

 

class CscfSmpAuthorizationPolicyContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfSmpAuthorizationPolicyContainer
+-CscfSmpAuthorizationPolicyEntry [0..]

This is Managed Object Class for CSCF SMP Authorization Policy Container

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSmpAuthorizationPolicy
This is the key attribute of the CscfSmpAuthorizationPolicyContainer class. One instance of the CscfSmpAuthorizationPolicyContainer with the key cscfSmpAuthorizationPolicy=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfSmpAuthorizationPolicyContainer  

 

class CscfSmpAuthorizationPolicyEntry

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfMediaContainer
+-CscfSmpAuthorizationPolicyContainer
+-CscfSmpAuthorizationPolicyEntry

This is Managed Object Class for CSCF SMP Authorization Policy Entry

Attributes
String1to00064DT
key
mandatory
noNotification
restricted
cscfSmpAuthorizationPolicyId
Holds the Media Authorization policy to be applied per SMP-ID. The value is matched with the value received for the tag SubscribedMediaProfileId in the User Profile provisioned in HSS. The value must be greater than or equal to 0 and it is recommended to be greater than 0, for example "1".
String0to01024DT
mandatory
cscfSmpMaxMediaFlowTableName
Identity of the max flow per media type table for S-CSCF SMP Authorization. If unset an empty string.
String0to01024DT
mandatory
cscfSmpPayloadBlackWhiteListName
Identity of the payload black and white list for SMP Authorization. If unset an empty string, or when set MediaType:PayloadType

  class CscfSmpAuthorizationPolicyEntry  

 

class CscfSubscriptionGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSubscriptionGroup
+-CscfDialogEvent [1..1]
+-CscfRegistrationEvent [1..]

This is a group class for subscription related parameters.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSubscriptionGroupId
This is the key attribute of the CscfSubscriptionGroup. One instance of the CscfSubscriptionGroup with the key cscfSubscriptionGroupId=0 is created at startup. This instance cannot be deleted.

  class CscfSubscriptionGroup  

 

class CscfSystemConfigClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSystemConfigGroupClass
+-CscfSystemConfigClass

This is a container class for the system related attributes.

This MO is created by the system.

Attributes
boolean
cscfEventHistoryEnabled = true
cscfEventHistoryEnabled is used to enable the Event History feature which prints-out extra state information when a capsule abortion occurs.

Note: Enabling this parameter reduces the capacity of the node.

This parameter is NOT access aware.
ProcessBehaviourDT
cscfProcessBehaviourAtClusterReconfiguration = IMMEDIATE
This parameter is used to indicate CSCF process termination behavior in case of cluster reconfiguration. Cluster reconfiguration happens when

- CSCF SW Upgrade
- CSCF Cluster Instance Lock (Virtual deployment locking of VM instance)
- CSCF Scale-In / Scale-Out (Virtual deployment only)

This parameter is NOT access aware.


Takes effect: Immediate
boolean
cscfPropCxGmCompatibilityEnabled = false
The parameter is used to enable the backward compatibility mode which eliminates some of the differences between Ericsson Cx and 3GPP Cx on the SIP interface. The parameter defaults to true if an upgrade was done from a release using Ericsson Cx. In all other cases the default value will be false. Setting the parameter to true has the following implications:
- Deregistering a user which is not registered in the HSS will result in a "200 OK" response.
- "503 CX Unable to Comply" will be used for diameter and HSS related problems.
- The response "500 No S-CSCF Available" will be sent if the resource broker list is exhausted.
- SESSION_TERMINATED will be used as default value for default handling.
- The first SIP URI will be used as default IMPU. If it is not available, the first Tel URI will be used.
- The Authentication-info header always contains the next-nonce directive.
- The verification of the algorithm directive of the Authorization or Proxy-Authorization header is not performed.
String0to65535DT
key
mandatory
noNotification
restricted
cscfSystemConfig
This is the key attribute of the CscfSystemConfigClass containing all the system parameters. One instance of the CscfSystemConfigClass with the key CscfSystemConfig=default is created at startup. This instance can not be deleted. No other instances can be created of this class.
boolean
eatfEnabled = false
Determines if the Emergency Access Transfer Function (EATF) application is available or not.
OperState
readOnly
eatfOperationalState = DISABLED
The attribute indicates the current operational state of the EATF. This operational state is based on the current configuration of the EATF and its ability to handle traffic. The following is required for eatfOperationalState to become ENABLED:

· eatfEnabled = true

· One UDP instance of the eatfNetworkInterfaceEntry including all prerequisite information for that interface must be configured.

· If a TCP instance of the eatfNetworkInterfaceEntry has been configured it must be configured with same IP address and port as the UDP interface.
ScscfRedundantScscfEntryDt[0..1]
scscfRedundantScscfEntry = ""
This attribute is used to enable redistribution of users in S-CSCF to Redundant Node by setting S-CSCF SIP URI for where to redirect the users when cscfAdministrativeState is set to "Shutting Down". The attribute should contain a valid SIP URI of the redundant S-CSCF that the shutting down S-CSCF uses to redirect the users. This attribute is not access aware.

Takes effect: ChangeTypeRuntimeType - Immediate
uint32
scscfRegisteredUsersThreshold = 0
This attribute is used to configure the threshold value for maximum number of currently registered users to be kept in the original S-CSCF when the Redistribution process is finished. This attribute is only used when cscfAdministrativeState is set to "Shutting Down". When scscfRegisteredUserThreshold is set = 0, the CSCF will automatically enter the administrative state "Locked" when the threshold is reach. For all other values the CSCF will automatically enter the administrative state "Unocked" when the threshold is reached. This attribute is not access aware.

Takes effect: ChangeTypeRuntimeType - Immediate
TcscfBehaviorDT
tcscfBehavior = DISABLED
This attribute will control if HSS (LIR) Lookup(s) are performed or not, on the terminating side of I-CSCF. Note that the attribute CscfISPBehavior must be configured to standalone I-CSCF when TcscfBehavior is enabled. This attribute is preparing to introduce a new Transit Function CSCF (also referred to T-CSCF).


Takes effect: ChangeTypeRuntimeType - Session

  class CscfSystemConfigClass  

 

class CscfSystemConfigGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfSystemConfigGroupClass
+-CscfSystemConfigClass [1..1]

A class for the system configuration. This is a container class for the CscfSystemConfigClass instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfSystemConfigGroup
This is the key attribute of the CscfSystemConfigGroupClass. One instance of the CscfSystemConfigGroupClass with the key CscfSystemConfigGroup=0 is created at startup. This instance can not be deleted. No other instances can be created of this class.

  class CscfSystemConfigGroupClass  

 

class CscfTelephonyClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTelephonyGroupClass
+-CscfTelephonyClass

This is a container class for the CSCF telephony related attributes.

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfTelephony
This is the key attribute of the CscfTelephonyClass containing all the Telephony parameters. One instance of the CscfTelephonyClass with the key CscfTelephony=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
PhoneContextHandlingDT
scscfAddPhoneContext = NO_MODIFICATION_OF_REQUEST_URI
This parameter defines the originating S-CSCF handling of the phone-context parameter at originating requests including a request-URI containing a local telephone number in a SIP URI or TEL URI form.

  class CscfTelephonyClass  

 

class CscfTelephonyGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTelephonyGroupClass
+-CscfTelephonyClass [1..1]

This is a container class for the CscfTelephony instance.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfTelephonyGroup
This is the key attribute of the CscfTelephonyGroupClass. One instance of the CscfTelephonyGroupClass with the key CscfTelephonyGroup =0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfTelephonyGroupClass  

 

class CscfTerminalIdentificationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfIdentificationGroupClass
+-CscfTerminalIdentificationClass

This is a container class for the CSCF terminal identity related attributes.

This MO is created by the system.

Attributes
boolean
cscfPublicGruuEnabled = false
This parameter is used to enable or disable the Public GRUU Support feature in CSCF. If it is set to true, the feature is enabled otherwise the feature is disabled. The default value is set to false.
String0to65535DT
key
mandatory
noNotification
restricted
cscfTerminalIdentificationId
This is the key attribute of the CscfTerminalIdentificationClass containing all the parameters. One instance of the CscfTerminalIdentificationClass with the key CscfTerminalIdentificationId=default is created at startup. It is NOT possible to create new instances. The default instance can not be deleted.
boolean[0..1]
scscfImpiBasedTerminalIdentificationEnabled = false
This parameter is used to enable and disable the IMPI Based Terminal Identification feature in S-CSCF. When the feature is enabled, the S-CSCF provides the IMPI to the Application Server via the Authorization Header during third party registration or the Proxy-Authorization header in non-register originating requests, and routes the message based on the IMPI contained in the sip instance feature tag received from the terminating request.
boolean[0..1]
scscfNwProvidedInstanceIdEnabled = false
This parameter is used to enable and disable the Network Provided Terminal Identity feature in S-CSCF. When the feature is enabled, the S-CSCF provides the Application Server a network generated sip instance feature tag with UUID to be used as terminal identity if the sip instance is not provided by the UE.

  class CscfTerminalIdentificationClass  

 

class CscfThrottledInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfThrottledInterfaceGroup
+-CscfThrottledInterface

This is a container class containing throttled interface related attributes

This MO is created by the system.

Attributes
CscfLowerThrottlingThresholdDT
noNotification
cscfLowerThrottlingThreshold = 5
This parameter defines the lower threshold (percentage of busy replies) at which point the throttling rate should be decreased. Its value must be less than that of cscfUpperThrottlingThreshold.
CscfThrottledInterfaceIdDT
key
mandatory
noNotification
restricted
cscfThrottledInterfaceId
This is the key attribute of the CscfThrottledInterface. One instance of the CscfThrottledInterface with the key
cscfThrottledInterfaceId=CxDx is created at startup. This instance cannot be deleted.
boolean
noNotification
cscfThrottlingEnabled = false
This parameter defines if the throttling function in CSCF is enabled or disabled on the interface.
CscfThrottlingRateDT
noNotification
cscfThrottlingRateDecrease = 15
This parameter defines the decrease in the throttling rate when the percentage of busy replies is below the lower threshold.
CscfThrottlingRateDT
noNotification
cscfThrottlingRateIncrease = 7
This parameter defines the increase in the throttling rate when the percentage of busy replies is above the upper threshold.
CscfThrottlingWindowLengthDT
noNotification
cscfThrottlingWindowLength = 4
This parameter defines the duration in seconds of the window over which measuring the percentage of busy replies received for all requests is performed to determine an overload situation.
CscfUpperThrottlingThresholdDT
noNotification
cscfUpperThrottlingThreshold = 15
This parameter defines the upper threshold (percentage of busy replies) at which point the throttling rate should be increased. Its value must be greater than that of cscfLowerThrottlingThreshold.

  class CscfThrottledInterface  

 

class CscfThrottledInterfaceGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfThrottledInterfaceGroup
+-CscfThrottledInterface [1..1]

This is a group class for throttled interfaces related parameters.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfThrottledInterfaceGroupId
This is the key attribute of the CscfThrottledInterfaceGroup. One instance of the CscfThrottledInterfaceGroup Class with the key cscfThrottledInterfaceGroupId=0 is created at startup. This instance can't be deleted.

  class CscfThrottledInterfaceGroup  

 

class CscfTroubleshootingGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTroubleshootingGroupClass
+-CscfFaultIsolationClass [1..1]
+-CscfUserDataManagementGroup [1..1]
+-CscfUserDataOutputClass [1..1]

This section describes the CscfTroubleshootingGroupClass class and related attributes.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
cscfTroubleshootingGroupId
This is the key attribute of the CscfTroubleshootingGroupClass. One instance of the CscfTroubleshootingGroupClass with the key cscfTroubleshootingGroupId=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class CscfTroubleshootingGroupClass  

 

class CscfUaRestriction

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfUaRestriction

This is Managed Object Class for CSCF UA Restriction

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
cscfUaRestrictionKey
This is the key attribute of the CscfUaRestriction class. One instance of the CscfUaRestriction with the key cscfUaRestrictionKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
String0to00005DT
cscfUserAgentRestrictionEnable = FALSE
If set to True, User Agent Restriction Function is activated. If set to False: User Agent Restriction Function is deactivated. Before changing the parameter to True, the CscfUserAgentWhiteList parameter must be configured.

Dependencies: CscfUserAgentWhiteList must be configured before setting this parameter to True.
UserAgentWhiteListDT[0..] nonUnique ordered
cscfUserAgentWhiteList
Each CscfUserAgentWhiteList entry consists of three parts, prio number, regexp, and modifier.
Prio number is a unique key defined as an integer used when sorting the white list.
The entry with the lowest priority number will be tested first followed by the one with the second lowest, and so on.
The second part of the record is the regular expression and the third part is an unsigned integer.
If the lowest bit in the modifier is set, the i-modifier for case-insensitive pattern matching is used, otherwise it is not.
This is the only supported modifier.

  class CscfUaRestriction  

 

class CscfUnallocatedRoutingContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfUnallocatedRoutingContainer
+-CscfOperatorAllocatedDomainRangeListClass [1..1]
+-CscfOperatorAllocatedNumberRangeListClass [1..1]

This is Managed Object Class for CSCF Unallocated Routing Container

This MO is created by the system.

Attributes
CscfUnallocatedPublicServiceIdentityDT[0..1]
cscfUnallocatedPublicServiceIdentity = ""
The identity will be substituted for the target address when the I-CSCF performs a second location query to the HSS and SLF when unallocated numbers have been identified. This parameter must be configured before the CscfUnallocatedRoutingEnabled can be set to true. Before CscfUnallocatedRoutingEnabled can be set to false the parameter must have a different value than "empty".
integerKeyString
key
mandatory
noNotification
restricted
cscfUnallocatedRoutingKey
This is the key attribute of the CscfUnallocatedRoutingContainer class. One instance of the CscfUnallocatedRoutingContainer with the key cscfUnallocatedRoutingKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class CscfUnallocatedRoutingContainer  

 

class CscfUserDataActions

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTroubleshootingGroupClass
+-CscfUserDataManagementGroup
+-CscfUserDataActions

This is the Managed Object Class for CSCF User Data Actions.

This MO is created by the system.

Actions
string
cscfUserDataDelete ( UserDataDeletePotDT pot , string key , UserDataDeleteModeDT mode );
WARNING: Please consult Ericsson Personnel before executing this action. This action can corrupt and damage the database.
This action deletes user specific data from the database. It takes three mandatory input parameters:
--pot <pot-name> --key <all | pot-key> --mode <NON_RECURSIVE>

Please refer to the description of the ”pot”, ”key” and ”mode” parameters for further details.

Below is an example of deleting an Implicit Registration Set POT:
cscfUserDataDelete --pot CscfImplicitRegistrationSetPot --key sip:u0000000000@cscf99.lab --mode NON_RECURSIVE

Parameters

Name: pot
Description: This parameter defines the keyed Persistent Object Type (POT) name to be deleted. Possible values and meanings are:
- CscfPrivateIdentificationPot: Private Identity POT
- CscfImplicitRegistrationSetPot: Implicit Registration Set POT
- CscfServiceProfilePot: Service Profile POT
- CscfPublicIdentificationPot: Public Identity POT
- CscfImpuReferencePot: Public Identity Reference POT
- CscfContactContainerPot: Contact Container POT
- CscfSipDigestAuthenticationChallengePot: SIP Digest Authentication Challenge POT
- CscfSipDigestAuthenticationNoncePot: SIP Digest Authentication Nonce POT
- CscfSipDigestAuthenticationVectorPot: SIP Digest Authentication Vector POT
- CscfAuthenticationBlacklistPot: Authentication Blacklist POT
- CscfAkaAuthenticationPot: Authentication and Key Agreement (AKA) Authentication POT
- CscfDialogueContainerPot: Dialogue Container POT
- CscfDialogueDataPot: Dialogue Data POT
- CscfOfflineChargingSession: Offline Charging Session POT



Name: key
Description: This parameter defines the key of the Persistent Object Type (POT) instance(s) to be deleted.
If "all" is used as key then all instances associated with the POT specified will be deleted. Note: It is strongly recommended that "all" shall only be used in test environment.
Selecting a specific POT instance to delete can be accomplished in two ways:
1. Use the POT key value in hexadecimal format which can be obtained from the "clurun.sh list_instances" command or DBN browser. The syntax for this method is to append a prefix "0x" in front of the hexadecimal string: --key 0x<hexadecimal string>.
2. Specify a given POT instance key information in clear text depending on the POT type as depicted below:
- CscfPrivateIdentificationPot: <IMPI>
- CscfImplicitRegistrationSetPot: <IMPU>
- CscfServiceProfilePot: <IMPU>
- CscfPublicIdentificationPot: <IMPU>
- CscfImpuReferencePot: <IMPU>
- CscfContactContainerPot: <IMPU#IMPI>
- CscfSipDigestAuthenticationChallengePot: <Call-ID>
- CscfSipDigestAuthenticationNoncePot: <Nonce>
- CscfSipDigestAuthenticationVectorPot: <IMPI>
- CscfAuthenticationBlacklistPot: only "all" is supported as clear-text key
- CscfAkaAuthenticationPot: <IMPI>
- CscfDialogueContainerPot: <IMPU1#IMPU2> where IMPU1 is the default IMPU and IMPU2 is the Service Profile Identity. If it happens that both IMPU1 and IMPU2 are the same, then put IMPU1#IMPU1 as key.
- CscfDialogueDataPot: only "all" is supported as clear-text key
- CscfOfflineChargingSession: only "all" is supported as clear-text key



Name: mode
Description: This parameter specifies how the Persistent Object Type (POT) instance(s) are deleted. Possible values and meanings are:
1: NON_RECURSIVE: delete only the POT instance specified by the key.
Even though only one mode is currently supported, other modes may be supported in the future.


Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfUserDataActionsId
This is the key attribute of the CscfUserDataActions. One instance of the CscfUserDataActions with the key cscfUserDataActionsId=default is created at startup. This instance cannot be deleted.

  class CscfUserDataActions  

 

class CscfUserDataManagementGroup

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTroubleshootingGroupClass
+-CscfUserDataManagementGroup
+-CscfUserDataActions [1..1]

This is a Managed Object Class class for CSCF User Data Management.

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfUserDataManagementGroupId
This is the key attribute of the CscfUserDataManagementGroup. One instance of the CscfUserDataManagementGroup with the key cscfUserDataManagementGroupId=0 is created at startup. This instance cannot be deleted.

  class CscfUserDataManagementGroup  

 

class CscfUserDataOutputClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfTroubleshootingGroupClass
+-CscfUserDataOutputClass

This section describes the CscfUserDataOutputClass class. This is a group class that holds a list of actions, which can be invoked via ECLI or NETCONF to print out user data.

This MO is created by the system.

Actions
string
cscfUserDataPrintImpi ( string impi , string option );
This action is used to print out user data based on the user’s private identity. This action takes two input parameters, which are IMPI and Option.

Format: Parameter1 (IMPI) Parameter2 (Option)

IMPI it is a string

Option:
I printout IRS data (including Private ID, IRS, Service Profile, Public ID, and Unregistered Data)
C printout Contact data (including IPsec data)
D printout Dialog data
A printout Authentication data (including CSCF Aka Authentication and CSCF SIP Digest Authentication Vector data)
ALL printout all user data
Option Combination printout user data based on the combination of multiple options, for example C/D/A. Within option combination, these options shall be separated by /.

Parameters

Name: impi
Description: private ID in the form of a Network Access Identifier (NAI) as defined in RFC 2486


Name: option
Description: option:

I: printout IRS data (including Private ID, IRS, Service Profile, Public ID, and Unregistered Data)
C: printout Contact data (including IPsec data)
D: printout Dialog data
A: printout Authentication data (including Cscf Aka Authentication and Cscf SIP Digest Authentication Vector data)
ALL: printout all user data
When there is combination of multiple options, these options shall be separated by slach charecater ('/')


string
cscfUserDataPrintImpu ( string impu , string option );
This action is used to print out user data based on the users public identity. This action takes two input parameters, which are IMPU and Option.

Format: Parameter1 (IMPU) Parameter2 (Option)

IMPU it is a string

Option:
I printout IRS data (including Private ID, IRS, Service Profile, Public ID, and Unregistered Data)
C printout Contact data (including IPsec data)
D printout Dialog data
A printout Authentication data (including CSCF Aka Authentication and CSCF SIP Digest Authentication Vector data)
ALL printout all user data
Option Combination printout user data based on the combination of multiple options, for example C/D/A. Within option combination, these options shall be separated by /.

Parameters

Name: impu
Description: public ID in sip uri or tel uri


Name: option
Description: option:

I: printout IRS data (including Private ID, IRS, Service Profile, Public ID, and Unregistered Data)
C: printout Contact data (including IPsec data)
D: printout Dialog data
A: printout Authentication data (including Cscf Aka Authentication and Cscf SIP Digest Authentication Vector data)
ALL: printout all user data
When there is combination of multiple options, these options shall be separated by slach charecater ('/')


Attributes
String0to65535DT
key
mandatory
noNotification
restricted
cscfUserDataOutputId
This is the key attribute of the CscfUserDataOutputClass. One instance of the CscfUserDataOutputClass with the key cscfUserDataOutputId=default is created at startup. The default instance can not be deleted.

  class CscfUserDataOutputClass  

 

class CustomRole

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

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

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

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

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

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

  class CustomRole  

 

class CustomRule

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

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

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

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

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

  class CustomRule  

 

class DIA-CFG-AccReqContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt
+-DIA-CFG-AccReqContainer
+-DIA-CFG-AppRouting [0..]

This MO is a container for Accounting Application Routing MOs.

Attributes
string
key
mandatory
noNotification
restricted
accReqContainerName
This attribute represents the name of the container.

  class DIA-CFG-AccReqContainer  

 

class DIA-CFG-Application

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-Configuration [0..1]
+-DIA-CFG-DictionaryContainer [0..1]
+-DIA-CFG-StackContainer [0..]

This MO is a main entry for all Diameter Application configuration.
It is configured at installation time and value not defined as DIA.


This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.

  class DIA-CFG-Application  

 

class DIA-CFG-AppRouting

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt
+-DIA-CFG-AuthReqContainer
+-DIA-CFG-AppRouting
ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt
+-DIA-CFG-AccReqContainer
+-DIA-CFG-AppRouting

This MO encapsulates routing information.
Depending on this information decision how to process (what action to be applied to and what destination to be used for routing) the incoming requests from a particular Diameter Application is made.

Attributes
dia_mim_DIA-CFG-AppRouting_action
mandatory
action
The routing action for requests from a certain realm and a given request type.
The routing action belongs to the Diameter application specified in the "requestedApp" attribute. All actions except none are valid when the isIncomingRequest is set to TRUE. Allowed values for this attribute:
0 = local: Diameter messages that resolve to a routing entry with the Local Action set to Local can be satisfied locally, and do not need to be routed to another server.
1 = relay: All Diameter messages within this category must be routed to a next hop server, without modifying any non-routing AVPs.
2 = proxy: All Diameter messages within this category must be routed to a next hop server.
3 = redirect: Diameter messages within this category must have the identity of the home Diameter server(s) appended, and returned to the sender of the message.
4 = none: Used when the isIncomingRequest field is set to FALSE, which means that the request is an outgoing message.
5 = other: Any other Diameter application, for example, Translator or any other future application.
boolean[0..1]
autoFailback = true
Flag to indicate if failback to primary destination shall be done as soon as it becomes available.
dia_mim_DIA-CFG-AppRouting_nodeIds[0..] nonUnique
nodeIds
One or more servers that the message is to be routed to.
If action=none, these servers must be defined as Peer Nodes. The nodeIds consists of an address list with an index, which is called the array index.
dia_mim_DIA-CFG-AppRouting_redirectNodeIds[0..] nonUnique
redirectNodeIds
One or more servers used for redirect agent functionality.
If action=redirect, these servers may be defined as any nodes or left empty. The redirectNodeIds consists of an address list with an index, which is called the array index.
string
key
mandatory
noNotification
restricted
requestedApp
Vendor's Diameter application whose messages are recognized by the Realm Routing Table (RRT).
The "appId" field is checked against the "supportedAuthAppIds" and the "supportedAcctAppIds" in Own Node if vendorId is 0, and against the "supportedVendorSpecificApp" in Own Node if vendorId is not 0. If it is not found, an error is issued, and the operation does not take place.
boolean[0..1]
noNotification
readOnly
secFailoverActive
Flag to indicate if failover to secondary destination has occurred.
string[0..] nonUnique
noNotification
readOnly
secFailoverDest
NodeId of the selected secondary destination.
string[0..] nonUnique
secondaryNodeIds
One or more servers for secondary destinations that the message is to be routed to.
The secondarynodeIds consists of an address list with an index, which is called the array index, and with a priority.

  class DIA-CFG-AppRouting  

 

class DIA-CFG-AuthReqContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt
+-DIA-CFG-AuthReqContainer
+-DIA-CFG-AppRouting [0..]

This MO is a container for Authorization and Authentication Application Routing MOs.

Attributes
string
key
mandatory
noNotification
restricted
authReqContainerName
This attribute represents the name of the container.

  class DIA-CFG-AuthReqContainer  

 

class DIA-CFG-AvpDef

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-DictionaryContainer
+-DIA-CFG-Vendor
+-DIA-CFG-AvpDef

This MO represents Diameter Attribute-Value Pair (AVP) definition.

Attributes
dia_mim_DIA-CFG-AvpDef_avpDataType
mandatory
avpDataType
This attribute is an enumeration that identifies the AVP data type.
Allowed values for this attribute:
0 = octetString
1 = integer32
2 = integer64
3 = unsigned32
4 = unsigned64
5 = float32
6 = float64
7 = diameterUri
8 = grouped
9 = address
10 = time
11 = uft8String
12 = diameterIdentity
13 = enumerated
14 = ipFilterRule
15 = qoSFilterRule
string
key
mandatory
noNotification
restricted
avpId
This attribute uniquely defines an AVP in the database.
The max length of this attribute is 10 characters and it's represented at the following format [vendorId:AVPCode], where
vendorId (Type: uint32, Value:key of DIA-CFG-Vendor,Example: 0)
AVPCode (Type: uint32,Example: 268)
Max length for avpId is 10 characters.
dia_mim_DIA-CFG-AvpDef_avpName
mandatory
avpName
This attribute is a string that identifies the AVP. Example: avpName="Authenticate".
dia_mim_DIA-CFG-AvpDef_groupedAvpList[0..] nonUnique
groupedAvpList
This attribute is a list of contained AVPs for Grouped AVP and number of their occurences.
The Diameter protocol allows AVP values of type Grouped. If this attribute is given any value and the DIA-CFG-AVPDef object to be created/updated is not of type grouped, an error is issued and the operation does not take place. Use of same AVPIds in the list leads to the same error. The attribute is represented at the following format [index:AVPId:minOcc:maxOcc], where
index (Type: uint) - array index
AVPId (Type: struct array) - [vendorId\\:AVPCode]
minOcc (Type: uint) - minimum number of occurrences
maxOcc (Type: uint) - maximum number of occurrences.
dia_mim_DIA-CFG-AvpDef_integerValueList[0..] nonUnique
integerValueList
This attribute is the list of all possible values of an enumerated AVP (avpData = 13).
Each value in the list consists of a numerical value and a name, which is a human readable string, to identify the meaning of the numerical value. Any attempt to create and update a DIA-CFG-AVPDef object or other data type than enumerated with this list not empty results in an error and the operation does not take place. Usage of the same valueNames or values in the list also leads to an error.
The attribute is represented at the following format [index:valueName:value], where
valueName (Type: string)
value (Type: int).


Precondition: ^.{1,234}$
dia_mim_DIA-CFG-AvpDef_mFlagRule[0..1]
mFlagRule = 4
The mandatory flag rule indicates whether support of the AVP is required.
This attribute corresponds to the M flag in the AVP header.
Allowed values of this attribute:
0 = must exist
1 = may exist
2 = should not exist
3 = must not exist
4 = undefined
dia_mim_DIA-CFG-AvpDef_pFlagRule[0..1]
pFlagRule = 4
The protected flag rule is used to indicate if the AVP is to be protected by a digital signature.
When set, the AVP is protected and the contents cannot be changed by agents without detection. This attribute corresponds to the P flag of the AVP header, known as the protected AVP bit.
Allowed values for this attribute:
0 = must exist
1 = may exist
2 = should not exist
3 = must not exist
4 = undefined
dia_mim_DIA-CFG-AvpDef_stackIds[1..] nonUnique
mandatory
stackIds
This attribute is a list of those stackIds that use this AVP.
In other words, it is a list of all applications using Diameter that are able to encode and decode this AVP.
This attribute represents at the following format [array index:stackId], where
index - integer value,
: - separator,
stackId - name of the stack.

  class DIA-CFG-AvpDef  

 

class DIA-CFG-Configuration

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-Configuration

This MO handles a common Diameter Application configuration.

Attributes
string
key
mandatory
noNotification
restricted
configuration
This attribute identifies the configuration.
By default the value of this attribute is defined as Diameter.
dia_mim_DIA-CFG-Configuration_loadRegulationPriority[0..1]
loadRegulationPriority = 9
This attribute defines priority level for load regulation function.
dia_mim_DIA-CFG-Configuration_maxCerWaitingTime[0..1]
maxCerWaitingTime = 30000
This attribute defines the maximum waiting time for Capabilities-Exchange-Request (CER).
The connection is closed and discarded if the CER is not received within this time.
dia_mim_DIA-CFG-Configuration_numberOfFrontEnds[0..1]
numberOfFrontEnds = 0
This attribute is the number of SCTP Front Ends to be used when transport layer is SCTP.
The total number of SCTP FE instances that are used by Diameter are defined by this attribute. The list of available SCTP FE instances can be found in a corresponding CIM file. The default value is set to 0 and max value is 2147483647.


Deprecated: This attribute is not applicable in vDicos because Diameter uses all FEs currently available on the node

boolean[0..1]
rerouteDueToError = false
Defines behavior for request answered with error.
If set to TRUE, then requests answered with error code present in DIA-CFG-Configuration rerouteErrorIds are rerouted.
The behavior is applied only for those Own Nodes which have its attribute rerouteDueToError=GLOBAL.
dia_mim_DIA-CFG-Configuration_rerouteErrorIds[0..1000] nonUnique
rerouteErrorIds = 3002,3004,3005,4002,3002,3004,3005,4002
Defines error codes for rerouting, activating by DIA-CFG-Configuration rerouteDueToError.

Default value is:
3002 (DIAMETER_UNABLE_TO_DELIVER)
3004 (DIAMETER_TOO_BUSY)
3005 (DIAMETER_LOOP_DETECTED)
4002 (DIAMETER_OUT_OF_SPACE)
dia_mim_DIA-CFG-Configuration_sctpHandlerLogLevel[0..1]
sctpHandlerLogLevel = 0
This attribute defines Log level for all SCTP connection handlers.
The SS7 traces have 10 logging levels:
0 (Emergency) - System is unusable
1 (Alert) - Action must be taken immediately
2 (Critical) - Critical condition
3 (Error) - Error condition
4 (Warning)- Warning condition
5 (Notice) - Normal but significant condition
6 (Info) - Informational
7 (Debug High) - Debug level messages
8 (Debug) - Debug level messages
9 (Debug Low) - Debug level messages.
dia_mim_DIA-CFG-Configuration_sctpListenerLogLevel[0..1]
sctpListenerLogLevel = 0
This attribute defines Log level for all SCTP connection listeners.
The SS7 traces have 10 logging levels:
0 (Emergency) - System is unusable
1 (Alert) - Action must be taken immediately
2 (Critical) - Critical condition
3 (Error) - Error condition
4 (Warning)- Warning condition
5 (Notice) - Normal but significant condition
6 (Info) - Informational
7 (Debug High) - Debug level messages
8 (Debug) - Debug level messages
9 (Debug Low) - Debug level messages.
dia_mim_DIA-CFG-Configuration_traceSctpHandler[0..1]
traceSctpHandler = FALSE
This attribute defines whether SS7 traces for all SCTP connection listeners are enabled or disabled.
Allowed values for this attribute:
"TRUE" - SS7 traces are enabled
"FALSE" - SS7 traces are disabled.
boolean[0..1]
traceSctpListener = false
This attribute defines whether SS7 traces for all SCTP connection listeners are enabled or disabled.
Allowed values for this attribute:
"TRUE" - SS7 traces are enabled
"FALSE" - SS7 traces are disabled.
dia_mim_DIA-CFG-Configuration_userDialogueTimeout[0..1]
userDialogueTimeout = 0
This attribute defines the timeout to prepare Handler process to User process termination.
Unit: milliseconds.
If set to 0, then graceful dialogue shutdown feature is disabled.

  class DIA-CFG-Configuration  

 

class DIA-CFG-Conn

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-PeerNodeContainer
+-DIA-CFG-NeighbourNode
+-DIA-CFG-Conn

This MO encapsulates a configuration for a particular Connection object.

Attributes
string[0..1]
noNotification
readOnly
blockReason
This attribute contains information if the connection is blocked for any reason.
string[0..] nonUnique
noNotification
readOnly
connectedAddress
This attribute contains the remote TCP or SCTP address that is used for this connection.
string
key
mandatory
noNotification
restricted
connId
Identifier of the Diameter connection, which is set at the creation of a connection.
It is not allowed to be modified.
dia_mim_DIA-CFG-Conn_dscp[0..1]
dscp = 64
Defines Diffserv Code Point (DSCP) value for the connection.

Deprecated: Replaced by dscpReference attribute

string[0..1]
dscpReference = Signaling
Defines DiffServ Category for a particular connection to a certain remote peer.
boolean[0..1]
enabled = false
Defines if this connection is allowed.
This boolean flag is set to "true" when the Diameter Node accepts a connection request from this Peer Node on this connection or when the Diameter Node sets up a connection toward this Peer Node connection depending on the value set in initiateConnection for the Peer Node). If you do not want any connection to be set up for this connection or no connection request is accepted on this connection, the flag is set to "false". The flag is also set to "false" if you want the connection to be disconnected.
dia_mim_DIA-CFG-Conn_ipAddressesList[0..] nonUnique
ipAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list that must be used for this connection when accessing the Peer Node when the TCP transport protocol is used. The addresses in the list must be defined in the corresponding address list of the Peer Node. The ipAddressesList consists of an address list with an index, which is called the array index. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for IPv6 addresses as well, and an error is issued, in case of invalid configuration. The attribute is represented at the following format [array index:ipAddress], where
array index (Type: uint)
ipAddress (Type: string)
string[0..1]
noNotification
readOnly
linkStatus
This attribute indicates the status of the connection.
Possible values: Initial, Up, Down, Suspect, Reopen, Congested.
string[0..1]
portNr = 0
This attribute is the remote port number used for communication with the Diameter Peer node.
The assigned port number is 3868, as specified in RFC 3588.
dia_mim_DIA-CFG-Conn_priority[0..1]
priority = 0
Priority of the connection.
Connection is primary if it has priority=0 and secondary if it has priority=1.
The connection priority is taken into account if distribution scheme of the peer is PRIO_BASED. If distribution scheme of the peer is LOADSHARED this attribute is ignored.
string[0..1]
noNotification
readOnly
processorName
This attribute defines processor name where the handler is running.
dia_mim_DIA-CFG-Conn_sctpAddressesList[0..] nonUnique
sctpAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list must be used for this connection when accessing the Peer Node when the SCTP transport protocol is used. The addresses in the list must be defined in the corresponding address list of the Peer Node. The sctpAddressesList consists of an address list with an index, which is called the array index. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for IPv6 addresses as well, and an error is issued, in case of invalid configuration. The attribute is represented at the following format [array index:ipAddress], where
array index (Type: uint)
ipAddress (Type: string)
dia_mim_DIA-CFG-Conn_sctpHandlerLogLevel[0..1]
sctpHandlerLogLevel = DEFAULT
This attribute defines Log level for all SCTP connection handlers that serves the connection.
The SS7 traces have 10 logging levels: from 0 (system is unusable) to 9 (max value of debug-level messages).
string[0..1]
noNotification
readOnly
ss7CpUserId
This attribute defines SS7 CP user ID, instance ID and Front End ID.
These values are used by handler if SCTP layer is used.
dia_mim_DIA-CFG-Conn_traceSctpHandler[0..1]
traceSctpHandler = DEFAULT
Defines whether SS7 traces for all SCTP connection handlers of the ConnId are enabled or disabled.
Allowed values for this attribute are TRUE, FALSE or DEFAULT, that is used to let the parent MOs define the configuration.
dia_mim_DIA-CFG-Conn_transportLayerType[0..1]
noNotification
readOnly
transportLayerType
This attribute defines the transport layer that is used for this connection.

  class DIA-CFG-Conn  

 

class DIA-CFG-DictionaryContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-DictionaryContainer
+-DIA-CFG-Vendor [0..]

This MO is a container for Diameter Vendor and AvpDef MOs.

Attributes
string
key
mandatory
noNotification
restricted
dictionaryContainerName
This attribute represents the name of the container.

  class DIA-CFG-DictionaryContainer  

 

class DIA-CFG-Drt

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt
+-DIA-CFG-AccReqContainer [0..]
+-DIA-CFG-AuthReqContainer [0..]

This MO represents an entry in Realm Routing Table (RRT).

Attributes
string
key
mandatory
noNotification
restricted
entryId
This attribute represents an entry in the RRT.
The RRT is realm based, and for a certain realm and a given stackId, there may be at most two RRTs, depending on the need of an application to process incoming traffic and generate outgoing messages. The entryId consists of the parts which are realm, stackId and isincomingRequest. The isIncomingRequest field is set to TRUE for routing incoming requests, and to FALSE for outgoing requests. If an entry is configured with "default" string for realm field then this entry is treated as Default RRT entry and used for the routing of messages with unknown realm. Default RRT entry can be created both for incoming and outgoing requests. Under DIA-CFG-AuthReqContainer or DIA-CFG-AccReqContainer, there is one AppRouting entry for each Application Id and Vendor Id combination supported for one stack instance. Length of realm is limited by 800 characters.
This attribute is represented at the following format: [realm:stackId:isIncomingRequest], where
realm (Type: string)
stackId (Type: string)
isIncomingRequest (Type: boolean)

  class DIA-CFG-Drt  

 

class DIA-CFG-NeighbourNode

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-PeerNodeContainer
+-DIA-CFG-NeighbourNode
+-DIA-CFG-Conn [0..]

This MO represents Peer Node's configuration.

Attributes
string[0..] nonUnique
noNotification
readOnly
connIds
This attribute is a list of those connections that are related to this Peer Node.
The attribute is represented at the following format [array index:stackId#hostId#connId].
string[0..1]
noNotification
readOnly
diaVendorId = 0
IANA assigned 'SMI Network Management Private Enterprise Code' for the vendor of the application.
dia_mim_DIA-CFG-NeighbourNode_distributionScheme[0..1]
distributionScheme = LOADSHARED
This attribute determines selection method to choose a connection to the Peer node.

If set to LOADSHARED randomly selected connection will be used for initial traffic and retransmissions (with T-bit set).
If set to PRIO_BASED priority of connection is taken into account. Primary connection (if available) will be used for initial traffic. Secondary connection (if available) will be used for retransmission (with T-bit set). In case of several retransmissions secondary and primary connection (or secondary and primary groups of connections) are used in round-robin manner.

Valid values: ^(LOADSHARED|PRIO_BASED)$
dia_mim_DIA-CFG-NeighbourNode_dscp[0..1]
dscp = 64
Defines Diffserv Code Point (DSCP) value for all the connections with the neighbour node.

Deprecated: Replaced by dscpReference attribute

string[0..1]
dscpReference = Signaling
Defines DiffServ Category for all connections to a certain remote peer node.
Value is used if this option is not explicitly set to a particular connection associated with this remote peer.
boolean[0..1]
enabled = true
Defines if this nodeId can have connections with other Nodes.
This boolean flag is set to TRUE when the Diameter Node accepts connection requests from this Peer Node or when the Diameter Node sets up connections toward this Peer Node (depending on the value set in initiateConnection). If no connection is set up or no connection request is accepted, the flag is set to FALSE. The flag is also set to FALSE if all connections for this Peer Node are disconnected.
string[0..1]
noNotification
readOnly
firmwareRevision
This attribute is the revision of the Diameter product running on this node.
boolean[0..1]
initiateConnection = false
This flag is set to "true" when the Diameter Node initiates a connection with this Peer Node.
If the Diameter Node is waiting for connect requests from this Peer Node, the flag is set to "false".
dia_mim_DIA-CFG-NeighbourNode_ipAddressesList[0..] nonUnique
ipAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list makes the Peer node accessible when using the TCP transport protocol. This list is checked to find out if any of the IP addresses in the list are repeated, and if so, an error is issued, and the operation does not take place. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for Ipv6 addresses as well, and an error is issued, in case of invalid configuration. The attribute is represented at the following format [array index:ipAddress], where
array index (Type: uint)
ipAddress (Type: string)
boolean[0..1]
noNotification
readOnly
isDynamic
This flag indicates if a Peer Node has been dynamically created.
Dynamic creation took place upon reception of a Capabilities-Exchange-Request (CER) from that Peer Node.
boolean[0..1]
isIPv6Supported = true
This flag indicates if a Peer Node supports IPv6 addresses.
If the Peer Node doesn't support IPv6 addresses, only IPv4 addresses will be sent to the Peer Node in CER/CEA messages.
string
key
mandatory
noNotification
restricted
nodeId
This attribute is the identifier of the node.
It is composed of hostId and stackId. The hostId is a string that identifies the DIA-CFG-NeighbourNode object and its length is limited by 800 characters. The stackId identifies Own Node for which the Peer Node is defined.
string[0..1]
portNr = 3868
This attribute is the remote port number used for communication with the Diameter Peer node.
The assigned port number is 3868, as specified in RFC 3588.
string[0..1]
noNotification
readOnly
productName
This attribute is the name of the Diameter product running on this node.
string[0..1]
noNotification
readOnly
realm
Determines Neighbour Node realm which is used for message routing.
The string in the Network Access Identifier (NAI) that immediately follows the @ character. NAI realm names are required to be unique, and are carried on the administration of the DNS name space. Diameter makes use of the realm, also referred to as domain, to determine if the messages can be satisfied locally, or if they must be proxied. The attribute realm is treated as case insensitive.
dia_mim_DIA-CFG-NeighbourNode_sctpAddressesList[0..] nonUnique
sctpAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list makes the Peer node accessible when using the SCTP transport protocol. This list is checked to find out if any of the SCTP addresses in the list are repeated, and if so, an error is issued, and the operation does not take place. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for IPv6 addresses as well, and an error is issued, in case of invalid configuration. The attribute is represented at the following format [array index:ipAddress], where
array index (Type: uint)
ipAddress (Type: string)
dia_mim_DIA-CFG-NeighbourNode_sctpHandlerLogLevel[0..1]
sctpHandlerLogLevel = DEFAULT
Defines Log level for all SCTP connection handlers that serve connections with the neighbor node.
The SS7 traces have 10 logging levels: from 0 (system is unusable) to 9 (max value of debug-level messages).
dia_mim_DIA-CFG-NeighbourNode_sctpWouldBlockBufferSize[0..1]
sctpWouldBlockBufferSize = 4000000
The attribute defines the size of Diameter internal buffer when the SCTP transport protocol is used.
This buffer is used for storing outgoing messages in case when Common Part connection between Handler Process and SCTP Front End is "would blocked". The attribute should be set to a value that is greater than the size of one Diameter message.
It is applied only at the connection startup.
string[0..] nonUnique
noNotification
readOnly
supportedAcctAppIds
List of application codes that the stackId supports for an Accounting request.
string[0..] nonUnique
noNotification
readOnly
supportedAuthAppIds
List of application codes that the stackId supports for an Authentication request.
string[0..] nonUnique
noNotification
readOnly
supportedVendorsIds
List of all vendor Ids whose AVPs are supported by the Diameter Node.
string[0..] nonUnique
noNotification
readOnly
supportedVendorSpecificApps
List of application codes that the stackId supports for Authentication and Accounting requests.
This attribute is to be used when there are proprietary Diameter applications.
dia_mim_DIA-CFG-NeighbourNode_tcpCongestionCeaseLevel[0..1]
tcpCongestionCeaseLevel = 75
This attribute defines the congestion cease threshold as a percentage of tcpCongestionRaiseLevel.
When the Diameter internal send buffer fill level becomes lower than the defined cease threshold - a congestion cease indication is issued.
It is run-time reconfigurable.
dia_mim_DIA-CFG-NeighbourNode_tcpCongestionRaiseLevel[0..1]
tcpCongestionRaiseLevel = 85
This attribute defines the congestion raise threshold as a percentage of tcpSendBufferSize.
When the Diameter internal send buffer fill level reaches the defined raise threshold - a congestion indication is raised.
It is run-time reconfigurable.
dia_mim_DIA-CFG-NeighbourNode_tcpReceiveBufferSize[0..1]
tcpReceiveBufferSize = 2000000
This attribute defines the size of Diameter internal buffer for incoming Diameter messages.
It is used only in case when the TCP transport protocol is used. The attribute should be set to a value that is greater than the size of one Diameter message.
It is applied only at the connection startup.
dia_mim_DIA-CFG-NeighbourNode_tcpSendBufferSize[0..1]
tcpSendBufferSize = 4000000
This attribute defines the size of Diameter internal buffer for outgoing Diameter messages.
It is used only in case when the TCP transport protocol is used. The attribute should be set to a value that is greater than the size of one Diameter message.
It is applied only at the connection startup.
dia_mim_DIA-CFG-NeighbourNode_tcpSocketReceiveBufferSize[0..1]
tcpSocketReceiveBufferSize = 800000
This attribute defines the size of TCP socket internal buffer for incoming Diameter messages.
The attribute should be set to a value that is greater than the size of one Diameter message.
It is applied only at the connection startup.
dia_mim_DIA-CFG-NeighbourNode_tcpSocketSendBufferSize[0..1]
tcpSocketSendBufferSize = 500000
This attribute defines the size of TCP socket internal buffer for outgoing Diameter messages.
The attribute should be set to a value that is greater than the size of one Diameter message.
It is applied only at the connection startup
dia_mim_DIA-CFG-NeighbourNode_traceSctpHandler[0..1]
traceSctpHandler = DEFAULT
Defines whether SS7 traces for all SCTP connection handlers of the NodeId are enabled or disabled.
Allowed values for this attribute are TRUE, FALSE or DEFAULT, that is used to let the parent MOs define the configuration.
dia_mim_DIA-CFG-NeighbourNode_transportLayerType[0..1]
transportLayerType = 0
This attribute defines the transport layer to be used when setting up a connection to this node.
Allowed values for this attribute:
0 = Not defined
1 = TCP
2 = SCTP
3 = First SCTP, then TCP

  class DIA-CFG-NeighbourNode  

 

class DIA-CFG-OwnNodeConfig

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-OwnNodeConfig

This MO encapsulates the configuration of Own Node.

Attributes
boolean[0..1]
allowConnectFromUnknownNode = false
Indicates if connection with dynamically discovered peer nodes is allowed.
In other words, the attribute indicates if the stackId is allowed to attend requests from nodes that are not in the DIA-CFG-NeighbourNode object list. It is possible to set up only one connection from each of these nodes, the multiple connections functionality is not available. From the moment you set this value to "false", connection to new dynamically discovered nodes is rejected, but existing connections with previous dynamic nodes are preserved. By default this attribute is set to "false".
dia_mim_DIA-CFG-OwnNodeConfig_applicationPriorityList[0..] nonUnique
applicationPriorityList
This attribute defines a list of priority levels.
The list assigned to Application IDs to provide a preferential treatment of some Diameter Applications over others when load regulation takes place. If load regulation is disabled on Diameter level, i.e. the value of loadRegulationEnabled is set to FALSE, the attribute is not applied. If load regulation is enabled on Diameter level, but the attribute is not defined, the value of the attribute loadRegulationPriority of DIA-CFG-Configuration MO is used as a priority level. If load regulation is enabled on Diameter level and the list is defined, the priority level from the list corresponding to the Application ID fetched for the incoming Request is used. The value for application Id appId must be configured in one of following attributes of DIA-CFG-OwnNodeConfig MO: supportedAcctAppIds, supportedAuthAppIds or supportedVendorSpecifcApps. The value for priority prio must be in the range from 0 to 19.
The attribute is represented at the following format [array index:appId:prio] where
array index (Type: uint )
appId (Type: uint )
prio (Type: uint )
string[0..1]
diaVendorId = 0
IANA assigned 'SMI Network Management Private Enterprise Code' for the vendor of the application.
If the "diaVendorId" is not set, the default diaVendorId = 0 is used.
dia_mim_DIA-CFG-OwnNodeConfig_disconnectCause[0..1]
disconnectCause = 2
This attribute defines the disconnect cause that will be used in DPR message sent by Diameter stack.
Possible values for disconnectCause are 0 - REBOOTING, 1 - BUSY, 2 - DO_NOT_WANT_TO_TALK_TO_YOU
dia_mim_DIA-CFG-OwnNodeConfig_dscp[0..1]
dscp = 0
Defines Diffserv Code Point (DSCP) value for all the connections with the own node.

Deprecated: Replaced by dscpReference attribute

string[0..1]
dscpReference = Signaling
Defines DiffServ Category for all connections to all peer nodes.
Value is used for connections over TCP and SCTP if this option is not explicitly set on Peer or Connection level.
boolean[0..1]
enabled = false
This boolean is set to "true" when the node is considered configured and active.
It is set to "false" when the node is considered not configured and not active.
boolean[0..1]
excludeCongestedConnections = false
This attribute indicates if congested connections are excluded from routing.
If all connections become congested, then a message is not forwarded to Diameter transport layer and Diameter Application is notified about that fact by means of an API callback.
Set to FALSE indicates that the feature should not be used.
string[0..1]
firmwareRevision
This attribute is the revision of the Diameter product running on this node.
string
mandatory
hostId
This attribute is a unique string that corresponds to the Node Identifier.
It is formatted as a FQDN. The attribute hostId is treated as case insensitive. Length of this attribute is limited by 800 characters.
dia_mim_DIA-CFG-OwnNodeConfig_ipAddressesList[0..] nonUnique
ipAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list makes your own node accessible when using the TCP transport protocol. This list is checked to find out if any of the IP addresses in the list are repeated. If so, an error is issued, and the operation does not take place. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for IPv6 addresses as well, and an error is issued, in case of invalid configuration. Fields: [array index:ipAddress], where
array index (Type: uint)
ipAddress (Type: string)
boolean[0..1]
loadRegulationEnabled = false
Defines if Load Regulation mechanism is enabled or not.
If set to "true", the diameter stack checks the processor load when an incoming request is received. If an overload situation prevails, the incoming request is rejected. Depending on the setting of the attribute "sendErrorAtOverload", an answer with the DIAMETER_TOO_BUSY error code may be sent to the other node.
string[0..1]
maxInboundSctpStreams = 1
Defines the maximum number of inbound streams to be used in an established SCTP association.
string[0..1]
maxNumberOfRetries = 3
This attribute is the maximum number of times the system retries to send a request.
string[0..1]
maxOutboundSctpStreams = 1
Defines the maximum number of outbound streams to be used in an established SCTP association.
dia_mim_DIA-CFG-OwnNodeConfig_maxRequestPendingTime[0..1]
maxRequestPendingTime = 10
This attribute is the maximum waiting time before a message is retransmitted or discarded.
Unit: seconds.
The value of this attribute must be in the range [0-3600].
dia_mim_DIA-CFG-OwnNodeConfig_portNr
portNr = 0
Local listener port number that remote diameter nodes are using for communication with this node.
If a new value is found in any other DIA-CFG-OwnNodeConfig MO and they have any identical address in the address list, an error is issued, and the operation does not take place. If the port number is not set (default value = 0), no listener for the node is active.
The value of this attribute must be in the range [0-65535]. The portNr value defined by IETF is 3868.
string
mandatory
productName
This attribute is the name of the Diameter product running on this node.
At creation the product name is set to Ericsson Diameter Stack. Change this value to the real name of the Diameter product running on this node.
string
mandatory
realm
Determines Own Node realm which is used for message routing.
This attribute is the string in the FQDN format. Realm names are required to be unique, and are carried on the administration of the Domain Name System (DNS) name space. The attribute realm is treated as case insensitive.
dia_mim_DIA-CFG-OwnNodeConfig_rerouteDueToError[0..1]
rerouteDueToError = GLOBAL
Defines Own Node behavior for requests answered with error.
ON - requests answered with error code present in Own Node rerouteErrorIds are rerouted.
OFF - requests answered with error code are not rerouted.
GLOBAL - rerouting behavior is based on values of rerouteDueToError and rerouteErrorIds attributes in DIA-CFG-Configuration MO. In this case, value of Own Node rerouteErrorIds attribute is ignored.
dia_mim_DIA-CFG-OwnNodeConfig_rerouteErrorIds[0..1000] nonUnique
rerouteErrorIds = 3002,3004,3005,4002,3002,3004,3005,4002
Defines error codes for rerouting, activating by Own Node rerouteDueToError attribute.

Default value is:
3002 (DIAMETER_UNABLE_TO_DELIVER)
3004 (DIAMETER_TOO_BUSY)
3005 (DIAMETER_LOOP_DETECTED)
4002 (DIAMETER_OUT_OF_SPACE)
dia_mim_DIA-CFG-OwnNodeConfig_sctpAddressesList[0..] nonUnique
sctpAddressesList
This attribute is a list of IPv4 and/or IPv6 addresses (string).
This list makes your own node accessible when using the SCTP transport protocol. This list is checked to find out if any of the SCTP addresses in the list are repeated, and if so, an error is issued, and the operation will not take place. IP addresses in the list can be optionally supplemented by VPN (ALB) name suffix, separated by semicolon (";"). Note that either all or none IP addresses should have that suffix. To use Diameter over SCTP all the IP addresses contained in this list shall be configured for all SCTP (front end) instances (see "Configuring SS7, SCTP", in SS7CAF area). If one (or more) address in the address list is not in the SCTP configuration, no successful initialization can be done. It is possible to configure IPv6 addresses, even if IPv6 support is deactivated. Full validation is performed for IPv6 addresses as well, and an error is issued, in case of invalid configuration. The attribute is represented at the following format [array index:ipAddress] or [array index:ipAddress;ALB], where
array index (Type: uint)
ipAddress (Type: string)
ALB (type: string)
dia_mim_DIA-CFG-OwnNodeConfig_sctpEndPointProfile[0..1]
sctpEndPointProfile = 0
This attribute defines which SCTP Configuration Group (CG) to be used by Diameter service.
Referred Configuration Group is defined in SCTP configuration file. Run-time change of the attribute doesn't impact already established Diameter connections.
dia_mim_DIA-CFG-OwnNodeConfig_sctpHandlerLogLevel[0..1]
sctpHandlerLogLevel = DEFAULT
Defines Log level for all SCTP connection handlers that serve connections with the own node.
The SS7 traces have 10 logging levels: from 0 (system is unusable) to 9 (max value of debug-level messages). Allowed values for this attribute are digits from 0 to 9 or DEFAULT.
boolean[0..1]
sendErrorAtOverload = true
Determines whether error answer will be sent to other node in case of overload or not.
If set to "true", an error answer is sent to the other node if an incoming request is rejected due to a processor overload situation. The answer has the DIAMETER_TOO_BUSY error code. If set to "false", the request is discarded.
dia_mim_DIA-CFG-OwnNodeConfig_shutdownTime[0..1]
shutdownTime = 0
This attribute is the time elapsed between sending DPR and receiving DPA.
string
key
mandatory
noNotification
restricted
stackId
This attribute stores the Diameter stack identifier assigned to the Own Node object.
string[0..] nonUnique
supportedAcctAppIds
This attribute is a list of the Diameter applications that support Accounting requests.
Possible values must correspond to those defined in the Base Protocol RFC or Diameter application RFCs. This list is checked to find out if any of the Accounting application Ids in the list are repeated. If so, an error is issued, and the operation does not take place.
string[0..] nonUnique
supportedAuthAppIds
This attribute is a list of applications that support Authentication or Authorization requests.
Possible values must correspond to those defined in the Base Protocol RFC or Diameter application RFCs. This list is checked to find out if any of the Authentication or Authorization application Ids in the list are repeated. If so, an error is issued, and the operation does not take place.
string[1..] nonUnique
mandatory
supportedVendorsIds
This attribute is a list of all vendor Ids whose AVPs are supported by the Diameter Node.
All vendor Identifiers in this list must correspond to vendors already defined in the database, otherwise an error is issued, and the operation does not take place. The list is also checked to find out if any of the vendor Identifiers in the list are repeated. If so, an error is issued, and the operation does not take place.
string[0..] nonUnique
supportedVendorSpecificApps
List of application codes that the server supports for Authentication and Accounting requests.
Use this attribute when there are proprietary Diameter applications.
The attribute is represented at the following format [array index:vendorId:authAppId:acctAppId], where
array index (Type: uint)
vendorId (Type: uint)
authAppId (Type: uint)
acctAppId (Type: uint)
dia_mim_DIA-CFG-OwnNodeConfig_tcTimer[0..1]
tcTimer = 30
Defines time elapsed between connect attempts when the connection to a peer node has failed.
Unit: seconds.
The value of this attribute must be in the range [0-3600].
dia_mim_DIA-CFG-OwnNodeConfig_traceSctpHandler[0..1]
traceSctpHandler = DEFAULT
Defines whether SS7 traces for all SCTP connection handlers of the StackId are enabled or disabled.
Allowed values for this attribute are TRUE, FALSE or DEFAULT, that is used to let the parent MOs define the configuration.
dia_mim_DIA-CFG-OwnNodeConfig_transportLayerType[0..1]
transportLayerType = 0
This attribute defines the transport layer to be used when setting up a connection to this node.
Allowed values for this attribute:
0 = Not defined
1 = TCP
2 = SCTP
3 = First SCTP, then TCP.
dia_mim_DIA-CFG-OwnNodeConfig_watchdogTimeIdle[0..1]
watchdogTimeIdle = 30
Defines maximum time (at seconds) without activity, before a Device-Watchdog-Request (DWR) is sent.
The attribute must be set to a value that corresponds with the values configured for the other nodes in the network (make sure it is not possible for a node to have 3 expired DWR timers before all the other nodes have had at least 1 expired DWR timer). The value must be in the range:[1/3 of the highest value in the network; 3 times the lowest value in the network]. It is recommended to use the same value for all configured nodes in the network.
Unit: seconds.
The value of this attribute must be in the range [6-60].

  class DIA-CFG-OwnNodeConfig  

 

class DIA-CFG-PeerNodeContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-PeerNodeContainer
+-DIA-CFG-NeighbourNode [0..]

This MO is a container for Peer Nodes' configuration.

Attributes
string
key
mandatory
noNotification
restricted
peerNodeContainerId
This attribute is the identifier of the container.
string[0..1]
peerNodeContainerName
This attribute represents the name of the container.

  class DIA-CFG-PeerNodeContainer  

 

class DIA-CFG-RoutingContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-RoutingContainer
+-DIA-CFG-Drt [0..]

This MO is a container for Realm Routing Tables.

Attributes
string
key
mandatory
noNotification
restricted
routingContainerId
This attribute is the identifier of the container.
string[0..1]
routingContainerName
This attribute represents the name of the container.

  class DIA-CFG-RoutingContainer  

 

class DIA-CFG-StackContainer

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-StackContainer
+-DIA-CFG-OwnNodeConfig [0..]
+-DIA-CFG-PeerNodeContainer [0..]
+-DIA-CFG-RoutingContainer [0..]

This MO is a container for Own Node's and corresponding Peer Node's configuration.

Attributes
string[0..1]
noNotification
readOnly
listenerSS7CpUserId
Defines SS7 FE ID, CP User ID, CP Instance ID, that are used by listener if SCTP layer is used.
The attribute is represented at the following format [sctpInstanceFEId:cpUserId:cpUserInstanceId], where
sctpInstanceFEId (Type: unit) - Instance identity of Sctp Front End
cpUserId (Type: unit) - Common Part's user identity
cpUserInstanceId (Type: unit) - Instance identity of Common Part's user. There can be several instances of a user.
string
key
mandatory
noNotification
restricted
stackContainerId
This attribute is the identifier of the container.
string[0..1]
stackContainerName
This attribute represents the name of the container.

  class DIA-CFG-StackContainer  

 

class DIA-CFG-Vendor

ManagedElement
+-CscfFunction
+-DIA-CFG-Application
+-DIA-CFG-DictionaryContainer
+-DIA-CFG-Vendor
+-DIA-CFG-AvpDef [0..]

This MO represents a vendor Diameter Application.

Attributes
string
key
mandatory
noNotification
restricted
diaVendorId
This attribute uniquely defines a vendor in the database.
It is the IANA assigned 'SMI Network Management Private Enterprise Codes' value 4. Value 0 corresponds to the Internet Engineering Task Force (IETF) adopted AVP values.
dia_mim_DIA-CFG-Vendor_diaVendorName
mandatory
diaVendorName
This attribute is a string that identifies the vendor. The default value is set to "Diameter".
dia_mim_DIA-CFG-Vendor_stackIds[0..] nonUnique
noNotification
readOnly
stackIds
This attribute is a list of those stackIds that use this diaVendorId.
It represents at the following format [array index:stackId], where
index - integer value,
: - separator,
stackId - name of the stack.

  class DIA-CFG-Vendor  

 

class DNS-Application

ManagedElement
+-CscfFunction
+-DNS-Application

The DNS Managed Object (MO) represents the top level of the DNS Resolver

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
DnsMaxNumberCachedRecordsDT
dnsCacheSize = 20000
This attribute defines the maximum number of cached resource records.
DnsDscpValueDT
dnsDscpValue = CS0
This attribute defines the DSCP(Differentiated Services Code Point) value used for all DNS sockets,this applies both TCP and UDP sockets used by DNS Resolver.
DnsDscpValue accepts a decimal value in the range 0..63 or the following names as specified in IANA registry( for decimal values and RFC references, refer https://www.iana.org/assignments/dscp-registry/dscp-registry.xhtml#dscp-registry-1)

-Class Selector(CS) code points : CS0(0),CS1(8),CS2(16),CS3(24),CS4(32),CS5(40),CS6(48),CS7(56) -for more information on these names, refer to RFC2474.
-Assured Forwarding(AF) code points: AF11(10),AF12(12),AF13(14),AF21(18),AF22(20),AF23(22),AF31(26),AF32(28),AF33(30),AF41(34),AF42(36),AF43(38) -for more information on these names, refer to RFC2597.
-Expedited Forwarding code points : EF(46) -for more information on these names, refer to RFC3246.
-Capacity Admitted Voice Traffic code points: VOICE-ADMIT(44) -for more information on these names, refer to RFC5865.

Format: [0..63] or [names as specified in IANA registry]
Access : Read-Write
Change effect: Immediate
Dependencies : None
Requirement: Optional


Specification: RFC2474,RFC2597,RFC3246,RFC5865
DnsExpiredCacheBehaviorDT
dnsExpiredCacheBehavior = REMOVED
This attribute defines the life cycle management of cached resource records.
DnsLocalAddressDT[0..10] nonUnique ordered
dnsLocalAddress = 0.0.0.0
The IP address of the local host. Used as source IP address in DNS queries.

Note1: If no attributes have been specified the system will select a local address.
Note2: To make the system less vulnerable to cache poisoning it is recommended that multiple entries are specified.
DnsRetransmissionTimerDT
dnsRetransmissionTimer = 10
This attribute defines the retransmission timer for the DNS stack, to retransmit queries to the external DNS server.
DnsServerEntryDT[0..] nonUnique ordered
dnsServerEntry = 0:0.0.0.0
This attribute defines the following properties of a DNS server:

- lookup
- priority
- address
- port

address is mandatory. The address is either an IPv4 address or an IPv6 address enclosed in square brackets. It is possible to configure several attributes. There may be a mix of IPv4 and IPv6 attributes.

port is optional. No colon (':') separator shall be used if port is left out. If not configured, port is assigned a default value of 53 by the system.

Example: 10.1.1.1
[::6]:53

lookup is optional. No colon (':') separator shall be used if lookup is left out. When a DNS Server is configured with a specific lookup, the DNS Server is dedicated to handle DNS queries for that lookup. If lookup is not specified, the server is considered as a general server handling all sorts of DNS queries for which no specific DNS server is applicable. Several lookups can be specified for a given server.

Example: 10.1.1.1
[::6]:53
http:[2000::4:1]
tel:[2000::4:1]

priority is optional. No colon (':') separator shall be used if priority is left out. The priority controls which distribution mechanism to be used. Two distribution mechanisms are supported: Primary/Standby and Load Sharing. If a Primary/Standby distribution mechanism is required, the Primary Server shall be assigned the lowest priority value; the first Standby server shall be assigned the second lowest priority value; the second Standby server shall be assigned the third lowest priority value; etc. The Primary/Standby distribution mechanism is relevant to DNS servers of the same lookup (or no lookup). If a Load Sharing distribution mechanism is required, the same priority value shall be assigned to these DNS Servers. These servers form a load sharing group. The load sharing distribution mechanism is relevant to DNS servers of the same lookup (or no lookup). In case priority is not specified, Primary/Standby distribution mechanism will apply, and the system will assign a priority (next available value) for that lookup.

Example: 0:10.1.1.1
1:[::6]:53
http:0:[2000::4:1]
tel:0:[2000::4:1]

Within each lookup both distribution mechanisms can be applied as it is possible to specify several load sharing groups for a certain lookup. Then the servers with the same lowest priority constitute a Primary group, the servers with the same second lowest priority constitute a Standby group, etc.

Example: 0:10.1.1.1
0:10.1.1.2
0:10.1.1.3
1:[::6]:53
1:[::7]
http:0:[2000::4:1]
http:0:[2000::4:2]
http:1:[2000::4:3]
http:1:[2000::4:4]
http:2:[2000::4:5]
http:2:[2000::4:6]
tel:0:[2000::4:1]
tel:0:[2000::4:2]
tel:0:[2000::4:3]
tel:1:[2000::4:4]
tel:1:[2000::4:5]

Note: Attribute DnsServerEntry is used together with attribute DnsLocalAddress. This means that some entries of DnsServerEntry may be ruled out. A DnsServerEntry entry is ruled out if the IP version does not match the IP version of any DnsLocalAddress entry. For example if multiple DnsServerEntry entries have been specified with a mix of IPv4/IPv6 entries while attribute DnsLocalAddress only consists of IPv4 addresses, then none of the IPv6 entries for DnsServerEntry will be used.
uint32[0..1]
noNotification
groupId = 0
Relevant only in TSP.
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
uint32[0..1]
noNotification
ownerId = 0
Relevant only in TSP.
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
integer[0..1]
noNotification
permissions = 9
Relevant only in TSP.
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN[0..1]
noNotification
shareTree = nodeName=jambala
Relevant only in TSP.
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class DNS-Application  

 

class EatfNetworkInterfaceEntry

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-EatfNwIfContainer
+-EatfNetworkInterfaceEntry

This is a class for Emergency Access Transfer Function (EATF) network interface entry attributes.

Attributes
NetworkInterfaceDT
key
mandatory
noNotification
restricted
eatfNetworkInterfaceEntryId
This attribute defines the network interface the Emergency Access Transfer Function (EATF) uses to receive and send SIP traffic. To add an interface the eatfEnabled parameter must also first be set to "true". One UDP transport address is mandatory for the eatfOperationalState parameter to become ENABLED and domain name entries must be in the internal DNS table as well. A TCP transport address can optionally be added and must be configured with the same port-nr and IP-address as the UDP interface for eatfOperationalState to become ENABLED. One IPv4 and/or one IPv6 address can be specified for each transport type. Maximum one UDP and one TCP interface per IP address type (IPv4 and IPv6) can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
Note: A prerequisite for adding this network interface is that the eatfDomainNameEntry already has been configured with at least one domain.
Note: A prerequisite for specifying an IPv6 address in this parameter is that the parameter CscfHostportAsFqdnOnly is set to "true".


Dependencies: The parameter eatfEnabled must first be set to "true", and eatfDomainNameEntry must be configured with at least one domain. For specifying an IPv6 address is that CscfHostportAsFqdnOnly is set to "true".
NetworkInterfaceStatusDT
readOnly
eatfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
Note: The value NO_TRAFFIC_DIRECTION_SET indicates the initial state. Although the function of assigning traffic direction has been deprecated, for backwards compatibility reason, this value is kept.

  class EatfNetworkInterfaceEntry  

 

class EatfNwIfContainer

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-EatfNwIfContainer
+-EatfNetworkInterfaceEntry [0..]

This is Managed Object Class for E-CSCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
eatfNwIfContainerId
This is the key attributes of the EatfNwIfContainer class.

  class EatfNwIfContainer  

 

class Ecscf

ManagedElement
+-CscfFunction
+-CSCF-Application
+-Ecscf

This is Managed Object Class for E-CSCF

This MO is created by the system.

Attributes
boolean
ecscfEnabled = false
Determines if the E-CSCF application is available or not.
integerKeyString
key
mandatory
noNotification
restricted
ecscfKey
This is the key attribute of the Ecscf class. One instance of the Ecscf with the key ecscfKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
OperState
readOnly
ecscfOperationalState = DISABLED
The attribute indicates the current operational state of the E-CSCF. This operational state is based on the current configuration of the E-CSCF and its ability to handle traffic. The following is required for EcscfOperationalState to become 1 (enabled):
- EcscfEnabled = true.
- One UDP instance of the EcscfNetworkInterfaceEntry including all prerequisite information for that interface must be configured.
- If a TCP instance of the EcscfNetworkInterfaceEntry has been configured it must be configured with same IP address and port as the UDP interface.

  class Ecscf  

 

class EcscfChargingClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass [0..]
+-EcscfChargingTriggersClass [1..1]

This is Managed Object Class for E-CSCF Charging

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
ecscfCharging
This is the key attribute of the EcscfChargingClass class. One instance of the EcscfChargingClass with the key ecscfCharging=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class EcscfChargingClass  

 

class EcscfChargingProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfChargingTransactionInfoClass [0..1]
+-EcscfOfflineChargingProfileClass [0..1]

This is Managed Object Class for E-CSCF Charging Profile

Attributes
ChargingCaseEcscfDT
ecscfChargingCase = NoCharging
Defines how a node must use the CDF (offline) addresses that a user is provisioned with.
String1to00256DT
key
mandatory
noNotification
restricted
ecscfChargingProfile
Defines a reference to the corresponding charging trigger for this profile.

  class EcscfChargingProfileClass  

 

class EcscfChargingProfilesClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass [0..]

This is Managed Object Class for E-CSCF Charging Profiles

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
ecscfChargingProfiles
This is the key attribute of the EcscfChargingProfilesClass class. One instance of the EcscfChargingProfilesClass with the key ecscfChargingProfiles=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class EcscfChargingProfilesClass  

 

class EcscfChargingRequestUriTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass
+-EcscfChargingRequestUriTriggerClass

This class contains all the attributes related to E-CSCF Charging Request URI Trigger

Attributes
String0to00128DT[0..1]
ecscfChargingRequestUri = ""
Regular expression for request URI.
Format: /.regexp/
String0to00100DT
key
mandatory
noNotification
restricted
ecscfChargingRequestUriTrigger
Defines the name of the trigger.
boolean
ecscfChargingRequestUriTriggerConditionNegated = false
Defines whether the individual instance is negated (that means non logical expression).

  class EcscfChargingRequestUriTriggerClass  

 

class EcscfChargingSessionCaseTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass
+-EcscfChargingSessionCaseTriggerClass

This class contains all the attributes related to E-CSCF Charging Session Case Trigger

Attributes
ChargingSessionCaseDT[0..1]
ecscfChargingSessionCase
Trigger condition based on the session case. The value is an enumeration of session cases.
String0to00128DT
key
mandatory
noNotification
restricted
ecscfChargingSessionCaseTrigger
Defines the name of the trigger.
Format: &lt;triggerName&gt;:&lt;groupId&gt;
boolean
ecscfChargingSessionCaseTriggerConditionNegated = false
Defines if this instance of the EcscfChargingSessionCase is negated.

  class EcscfChargingSessionCaseTriggerClass  

 

class EcscfChargingSipHeaderTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass
+-EcscfChargingSipHeaderTriggerClass

This class contains all the attributes related to E-CSCF Charging SIP Header Trigger

Attributes
String0to00128DT[0..1]
ecscfChargingSipHeader = ""
Defines the SIP header to be part of the charging trigger evaluation.
Format: "sipHeader".
String0to02048DT[0..1]
ecscfChargingSipHeaderContent = ""
The regular expression for matching the SIP header content.
String0to00128DT
key
mandatory
noNotification
restricted
ecscfChargingSipHeaderTrigger
Defines the name of the trigger.
Format: &lt;triggerName&gt;:&lt;groupId&gt;
boolean
ecscfChargingSipHeaderTriggerConditionNegated = false
Defines whether the individual instance is negated (that means non logical expression).

  class EcscfChargingSipHeaderTriggerClass  

 

class EcscfChargingSipMethodTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass
+-EcscfChargingSipMethodTriggerClass

This is Managed Object Class for E-CSCF Charging SIP Method Trigger

Attributes
ChargingSipMethodEcscfDT[0..1]
ecscfChargingSipMethod = ""
The attribute is only allowed for INVITE. Trigger condition based on the method in the SIP request. This must match before evaluating other point triggers.
String0to00100DT
key
mandatory
noNotification
restricted
ecscfChargingSipMethodTrigger
Defines the name of the trigger.
boolean
ecscfChargingSipMethodTriggerConditionNegated = false
Defines whether the individual instance is negated (that means non logical expression).

  class EcscfChargingSipMethodTriggerClass  

 

class EcscfChargingTransactionInfoClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfChargingTransactionInfoClass
+-EcscfChargingTransactionTypeClass [0..1]

This is Managed Object Class for E-CSCF Charging Transaction Info

Attributes
String1to00100DT
key
mandatory
noNotification
restricted
ecscfChargingTransactionInfoId
Key attribute defines the name of the Charging Profile. Defines a reference to the corresponding transaction information for this profile.

  class EcscfChargingTransactionInfoClass  

 

class EcscfChargingTransactionTypeClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfChargingTransactionInfoClass
+-EcscfChargingTransactionTypeClass

This is Managed Object Class for E-CSCF Charging Transaction Type

Attributes
String0to00256DT[0..] nonUnique ordered
ecscfChargingTransactionDataRequestEntry
This parameter is used for specifying the Header field name to be matched in a SIP Request (for example User-Agent). The value of the matched Header will be included as part of applicable ACR and CCR.
String0to00256DT[0..] nonUnique ordered
ecscfChargingTransactionDataResponseEntry
This parameter is used for specifying the Header field name to be matched in a SIP Response (for example Contact). The value of the matched Header will be included as part of applicable ACR and CCR.
String1to00100DT
key
mandatory
noNotification
restricted
ecscfChargingTransactionTypeId
This parameter specifies what kind of transaction type is of interest, for example, SIP or Diameter. This release supports SIP as the only transaction type. Format: &lt;profileName&gt;:SIP

  class EcscfChargingTransactionTypeClass  

 

class EcscfChargingTriggerGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass
+-EcscfChargingRequestUriTriggerClass [0..1]
+-EcscfChargingSessionCaseTriggerClass [0..1]
+-EcscfChargingSipHeaderTriggerClass [0..1]
+-EcscfChargingSipMethodTriggerClass [0..]

This is Managed Object Class for E-CSCF Charging Trigger Group

Attributes
String1to01024DT
key
mandatory
noNotification
restricted
ecscfChargingTriggerGroup
This is the key attribute of EcscfChargingTriggerGroupClass.

Dependencies: The value should be in the format [triggerName]:[groupId]
String0to00100DT[0..1]
ecscfChargingTriggerGroupId
Defines the Id of the charging trigger group where the actual elements composing the trigger are defined.

  class EcscfChargingTriggerGroupClass  

 

class EcscfChargingTriggerGroupsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass
+-EcscfChargingTriggerGroupClass [0..]

This is Managed Object Class for E-CSCF Charging Trigger Groups

Attributes
String0to01024DT
mandatory
ecscfChargingProfileName
The parameter defines a reference to the corresponding AVP profile for this charging trigger.
boolean
ecscfChargingTriggerConditionTypeCNF = true
Defines how the sets of CPT expressions are linked:
true: linked by OR
false: linked by AND
String0to00100DT
key
mandatory
noNotification
restricted
ecscfChargingTriggerName
The parameter identifies an individual trigger.
Integer0to01024DT
ecscfChargingTriggerPriority = 1024
Defines the order in which triggers are evaluated. For a given request the highest priority trigger i evaluated first.

  class EcscfChargingTriggerGroupsClass  

 

class EcscfChargingTriggersClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingTriggersClass
+-EcscfChargingTriggerGroupsClass [0..]

This is Managed Object Class for E-CSCF Charging Triggers

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
ecscfChargingTriggers
This is the key attribute of the EcscfChargingTriggersClass class. One instance of the EcscfChargingTriggersClass with the key ecscfChargingTriggers=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class EcscfChargingTriggersClass  

 

class EcscfNetworkInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-EcscfNwIfs
+-EcscfNetworkInterface

This is Managed Object Class for E-CSCF Network Interface

Attributes
NetworkInterfaceDT
key
mandatory
noNotification
restricted
ecscfNetworkInterfaceEntry
This attribute defines the network interface the E-CSCF uses to receive and send SIP traffic. To add an interface the EcscfEnabled parameter must also first be set to true. One UDP transport address is mandatory for the EcscfOperationalState parameter to become ENABLED and domain name entries must be in the internal DNS table as well. A TCP transport address can optionally be added and must be configured with the same port-nr and IP-address as the UDP interface for EcscfOperationalState to become ENABLED. One IPv4 and/or one IPv6 address can be specified for each transport type. Maximum one UDP and one TCP interface per IP address type (IPv4 and IPv6) can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
Note: A prerequisite for adding this network interface is that the EcscfDomainNameEntry already has been configured with at least one domain.
Note: A prerequisite for specifying an IPv6 address in this parameter is that the parameter CscfHostportAsFqdnOnly is set to "true".


Dependencies: EcscfEnabled must first be set to "true". EcscfDomainNameEntry must be configured with at least one domain. For specifying an IPv6 address is that CscfHostportAsFqdnOnly is set to "true".
NetworkInterfaceStatusDT[0..1]
readOnly
ecscfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
Note: The value NO_TRAFFIC_DIRECTION_SET indicates the initial state. Although the function of assigning traffic direction has been deprecated, for backwards compatibility reason, this value is kept.

  class EcscfNetworkInterface  

 

class EcscfNwIfs

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-EcscfNwIfs
+-EcscfNetworkInterface [0..]

This is Managed Object Class for E-CSCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
ecscfNwIfContainerKey
This is the key attribute of the EcscfNwIfs class. One instance of the EcscfNwIfs with the key ecscfNwIfContainerKey=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class EcscfNwIfs  

 

class EcscfOfflineChargingAVPsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingCauseClass [0..1]
+-EcscfOfflineChargingEricssonServiceInformationClass [0..1]
+-EcscfOfflineChargingEventTypeClass [0..1]
+-EcscfOfflineChargingInterOperatorIdentifierClass [0..1]
+-EcscfOfflineChargingSDPMediaComponentClass [0..1]
+-EcscfOfflineChargingServiceInformationClass [0..1]
+-EcscfOfflineChargingTimeStampsClass [0..1]

This is Managed Object Class for E-CSCF Offline Charging AVPs

This MO is created by the system.

Attributes
String0to00070DT
ecscfOfflineChargingAccessNetworkInformation = start=true;interim=true;stop=true;event=true;cache=false
Access-Network-Information AVP, code 1263.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingAVP
The name of the Profile.
String0to00070DT
ecscfOfflineChargingCalledAssertedIdentity = start=false;interim=false;stop=false;event=false
The Called-Asserted-Identity AVP (AVP code 1250) holds the SIP URI and/or TEL URI.

start=true;interim=true;stop=true;event=true

Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingCalledPartyAddress = start=true;interim=true;stop=true;event=true
Called-Party-Address AVP, code 832.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false. The value does not change during the charging session.
String0to00070DT
ecscfOfflineChargingCallingPartyAddress = start=true;interim=true;stop=true;event=true
The Calling-Party-Address AVP (AVP code 831) holds the addresses (SIP URI and/or TEL URI) which identifies the party (Public User Identity or Public Service Identity) initiating a SIP transaction.

start=true;interim=true;stop=true;event=true

Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingEventNTPTimestamp = start=false;interim=false;stop=false;event=false
Event-NTP-Timestamp AVP, code 340.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingEventTimestamp = start=true;interim=true;stop=true;event=true
Event-Timestamp AVP, code 55.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingImsChargingIdentifier = start=true;interim=true;stop=true;event=true
IMS-Charging-Identifier AVP, code 841.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingRoleOfNode = start=false;interim=false;stop=false;event=false
Role-of-node AVP, code 829.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingSDPSessionDescription = start=false;interim=false;stop=false;cache=false
SDP-Session-Description AVP, code 842.

start=true;interim=true;stop=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingServedPartyIpAddress = start=false;interim=false;stop=false;event=false
Served-Party-IP-Address AVP, code 848.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingSIPRingingTimestamp = start=false;interim=false;stop=false
SIP-Ringing-Timestamp AVP, code 338.

start=true;interim=true;stop=true
The ACR must have the value true or false.
String0to00070DT
ecscfOfflineChargingUserSessionId = start=false;interim=false;stop=false;event=false
User-Session-ID AVP, code 830.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.

  class EcscfOfflineChargingAVPsClass  

 

class EcscfOfflineChargingCauseClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingCauseClass

This is Managed Object Class for E-CSCF Offline Charging Cause

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingCause
The name of the Profile.
String0to00070DT
ecscfOfflineChargingCauseCode = stop=true;event=true
Cause-Code AVP, code 861.

stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingNodeFunctionality = stop=true;event=true
Node-Functionality AVP, code 862.

stop=true;event=true
Each ACR record type must have the value true or false.

  class EcscfOfflineChargingCauseClass  

 

class EcscfOfflineChargingEricssonServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingEricssonServiceInformationClass

This is Managed Object Class for E-CSCF Offline Charging Ericsson Service Information

This MO is created by the system.

Attributes
String0to00070DT
ecscfOfflineChargingCalledPartyOriginalAddress = start=false;interim=false;stop=false;event=false;cache=false
Called-Party-Original-Address AVP, code 286.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false. The value does not change during the charging session.
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingEricssonServiceInformation
The name of the Profile.
String0to00070DT
ecscfOfflineChargingImsServiceIdentification = start=false;interim=false;stop=false;event=false;cache=false
IMS-Service-Identifiaction AVP, code 284.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingInstanceId = start=false;interim=false;stop=false;event=false
This parameter is used to configure whether Instance-Id AVP, code 3402, is included in an ACR. Instance-Id AVP contains a URN generated by the device that uniquely identifies itself amongst all other devices. E-CSCF includes the sip.instance found in the Contact header of a request in the Instance-Id AVP

Each ACR record type must have the value true or false. For example, Start=false;Interim=false;Stop=false;Event=false;
String0to00070DT
ecscfOfflineChargingRelatedImsChargingIdentifier = interim=false;stop=false;event=false
Related-IMS-Charging-Identifier AVP, code 2711.

interim=false;stop=false;event=false
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingSIPRequestTimestampFraction = start=false;interim=false;stop=false;event=false
This parameter defines the offline charging request types for which the SIP-Request-Timestamp-Fraction AVP has to be sent.

start=true;interim=true;stop=true;event=true
Each request type must have its value set to true or false.
String0to00070DT
ecscfOfflineChargingSIPResponseTimestampFraction = start=false;interim=false;event=false
This parameter defines the offline charging request types for which the SIP-Response-Timestamp-Fraction AVP (code 2302) has to be sent.

start=true;interim=true;event=true
Each ACR record type must have its value set to true or false. The value stop=true/false is deprecated and ignored when present.
String0to00070DT[0..1]
ecscfOfflineChargingTransactionInfo = start=false;interim=false;stop=false;event=false
This parameter defines the offline charging request types for which the Transaction-Info/Transaction-Type/Transaction-Data-Name/Transaction-Data-Value AVPs has to be sent.

start=true;interim=true;stop=true;event=true
Each request type must have its value set to true or false.

  class EcscfOfflineChargingEricssonServiceInformationClass  

 

class EcscfOfflineChargingEventTypeClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingEventTypeClass

This is Managed Object Class for E-CSCF Offline Charging Event Type

This MO is created by the system.

Attributes
String0to00070DT
ecscfOfflineChargingContentDisposition = start=false;interim=false;stop=false;event=false;cache=false
Content-Disposition AVP, code 828.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingContentLength = start=false;interim=false;stop=false;event=false;cache=false
Content-Length AVP, code 827.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingContentType = start=false;interim=false;stop=false;event=false;cache=false
Content-Type AVP, code 826.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingEvent = event=false
Event AVP, code 825.

event=true
Each ACR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingEventType
The name of the Profile.
String0to00070DT
ecscfOfflineChargingSIPMethod = start=false;interim=false;stop=false;event=false;cache=false
SIP-Method AVP, code 824.

start=true;interim=true;stop=true;event=true;cache=true
Each ACR record type must have the value true or false.

  class EcscfOfflineChargingEventTypeClass  

 

class EcscfOfflineChargingInterOperatorIdentifierClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingInterOperatorIdentifierClass

This is Managed Object Class for E-CSCF Offline Charging Inter-operator Identifier

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingInterOperatorIdentifier
The name of the Profile.
String0to00070DT
ecscfOfflineChargingOriginatingIOI = start=false;interim=false;stop=false;event=false
Originating-IOI AVP, code 839.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingTerminatingIOI = start=false;interim=false;stop=false;event=false
Terminating-IOI AVP, code 840.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.

  class EcscfOfflineChargingInterOperatorIdentifierClass  

 

class EcscfOfflineChargingOmits

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingOmits
+-EcscfOfflineChargingOmitVendor [0..]

This class allows multiple instances of E-CSCF offline charging omit profile. This class is valid only for CSCF offline charging implementation according to 3GPP Release 12 (Variant-2).

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingOmitsId
This is the key attribute of class EcscfOfflineChargingOmits.
The key should be the same as the key for the parent class EcscfOfflineChargingProfile.


Dependencies: The same profileName as the parent EcscfOfflineChargingProfile
Takes effect: ChangeTypeRuntimeType – New Session

  class EcscfOfflineChargingOmits  

 

class EcscfOfflineChargingOmitVendor

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingOmits
+-EcscfOfflineChargingOmitVendor

This class allows configuration of an instance of an E-CSCF offline charging omit profile. The profile is keyed on a vendor ID and composed of a list of AVP codes defined by the associated vendor. The combination of the vendor ID and an AVP code in the profile uniquely identifies an AVP to be omitted, that is, not to be generated. This class is valid only for E-CSCF Variant-2 offline charging implementation. It is ignored in Variant-1 offline charging.

Attributes
DiameterAvpCodeDT[0..] ordered
ecscfOfflineChargingOmitAVP
This is an attribute of class EcscfOfflineChargingOmitVendor which defines an omit profile in Variant-2. It is ignored in Variant-1 offline charging. This attribute specifies the code of an AVP to be omitted. The AVP which is uniquely identified by the AVP code together with the vendor ID in the omit profile is omitted and will not be generated by the E-CSCF in the ACR records.

Dependencies: This attribute must be defined within the EcscfOfflineChargingOmitVendor class identified with the desired vendor Id in key attribute ecscfOfflineChargingOmitVendorId.
Takes effect: ChangeTypeRuntimeType – New Session
StringCscfOfflineOmitVendorIdDT
key
mandatory
noNotification
restricted
ecscfOfflineChargingOmitVendorId
This is the key attribute of class EcscfOfflineChargingOmitVendor which defines an omit profile in Variant-2. It is ignored in Variant-1 offline charging. The value of this attribute contains a vendor ID string. All AVPs which are uniquely identified by the AVP codes together with the vendor ID in the omit profile are omitted and will not be generated by the E-CSCF in the ACR records.

Format: [profileName]:[vendorId] where [profileName] is the name of the E-CSCF offline charging profile and vendorId is a vendor ID. The combined string identifies an omit profile within the E-CSCF offline charging profile. The possible vendor ID value can be
- 0 for IETF Diameter
- 193 for Ericsson
- 10415 for 3GPP


Dependencies: The value should be in the format [profileName]:[vendorId]
Takes effect: ChangeTypeRuntimeType – New Session

  class EcscfOfflineChargingOmitVendor  

 

class EcscfOfflineChargingProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass [0..1]
+-EcscfOfflineChargingOmits [0..1]

This is Managed Object Class for E-CSCF Offline Charging Profile

Attributes
Fqdn0to1024orEmptyDT[0..1]
ecscfChargingDefaultDestinationRealm
Defines the default destination realm.
boolean
ecscfChargingEnabledCancel = false
This attribute determines if the CSCF generates a charging event related to a CANCEL message.
boolean
noNotification
ecscfChargingEnabledNon2xx = false
Note: This parameter is deprecated. Use EcscfOfflineChargingEnabled3xx and EcscfOfflineChargingEnabled4xx5xx6xx instead. This attribute determines if the CSCF generates a charging event
related for a non 2XX final response for an INVITE message.


Deprecated: 

PreferredPartyAddressDT
ecscfChargingPreferredCallingPartyAddress = both
Configure what information is preferred in Calling-Party-Address, SIP URI and/or TEL-URI. What is available is used, if the preferred does not exist. Valid values: noPrefer, preferSIP, preferTEL, both.

Deprecated: 

boolean
ecscfOfflineChargingEnabled3xx = false
This attribute determines if the E-CSCF generates a charging event for a 3XX final response (except 3xx received from LRF via SIP Ml Interface, in such case, no matter what value this parameter is set, there is no charging event generated by E-CSCF).
boolean
ecscfOfflineChargingEnabled4xx5xx6xx = false
This attribute determines if the E-CSCF generates a charging event for a 4XX, 5XX and 6XX final response (except 4xx, 5xx or 6xx received from LRF via SIP Ml Interface, in such case, no matter what value this parameter is set, there is no charging event generated by E-CSCF).
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingProfile
The name of the Profile.
OfflineChargingProfileVariant
ecscfOfflineChargingProfileVariant = VARIANT_1
This attribute is used to select the variant of E-CSCF offline charging support. The value is either VARIANT_1 or VARIANT_2 for E-CSCF offline charging support Variant-1 or Variant-2, respectively. VARIANT_1 is configured for E-CSCF offline charging support which is according to 3GPP specifications mainly prior to release 12. VARIANT_2 is configured for E-CSCF offline charging support which is according to 3GPP release 12 specifications. Variant configuration can be performed during traffic. Changes to the parameter value take effect on new sessions only.

Dependencies: NA
Takes effect: ChangeTypeRuntimeType – New Session
ServiceContextDT
ecscfOfflineChargingServiceContextId = 12.32260@3gpp.org
This attribute is configured to define the string value of the Service-Context-Id AVP (#461) according to the 3GPP defined format. The value identifies the standard and the revision on which the offline charging service is based. This attribute is defined for E-CSCF Variant-2 offline charging implementation only. It is ignored in Variant-1 offline charging.

Dependencies: NA
Takes effect: ChangeTypeRuntimeType – New Session

  class EcscfOfflineChargingProfileClass  

 

class EcscfOfflineChargingSDPMediaComponentClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingSDPMediaComponentClass

This is Managed Object Class for E-CSCF Offline Charging SDP Media Component

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingSDPMediaComponent
The name of the Profile.
String0to00070DT
ecscfOfflineChargingSDPMediaDescription = start=false;interim=false;stop=false;cache=false
Media-Description AVP, code 845.

start=true;interim=true;stop=true;cache=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingSDPMediaName = start=false;interim=false;stop=false;cache=false
Media-Name AVP, code 844.

start=true;interim=true;stop=true;cache=true
Each ACR record type must have the value true or false.

  class EcscfOfflineChargingSDPMediaComponentClass  

 

class EcscfOfflineChargingServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingServiceInformationClass

This class contains all the attributes related to the Ecscf Offline Charging Service Information.

This MO is created by the system.

Deprecated: 

Attributes
String0to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingServiceInformation
The name of the Profile.

Deprecated: 

  class EcscfOfflineChargingServiceInformationClass  

 

class EcscfOfflineChargingTimeStampsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-EcscfChargingClass
+-EcscfChargingProfilesClass
+-EcscfChargingProfileClass
+-EcscfOfflineChargingProfileClass
+-EcscfOfflineChargingAVPsClass
+-EcscfOfflineChargingTimeStampsClass

This is Managed Object Class for E-CSCF Offline Charging Timestamps

This MO is created by the system.

Attributes
String0to00070DT
ecscfOfflineChargingSIPRequestTimestamp = start=true;interim=true;stop=true;event=true
SIP Request-Timestamp AVP, code 834.

start=true;interim=true;stop=true;event=true
Each ACR record type must have the value true or false.
String0to00070DT
ecscfOfflineChargingSIPResponseTimestamp = start=true;interim=true;event=true
This parameter defines the offline charging request types for which the SIP-Response-Timestamp AVP (code 835) has to be sent.

start=true;interim=true;event=true
Each ACR record type must have the value true or false. The value stop=true/false is deprecated and ignored when present.
String1to00256DT
key
mandatory
noNotification
restricted
ecscfOfflineChargingTimeStamps
The name of the Profile.

  class EcscfOfflineChargingTimeStampsClass  

 

class EmergencyUnlock

ManagedElement
+-SystemFunctions
+-Lm
+-EmergencyUnlock

Emergency Unlock state information.

This MO is created by the system.

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

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

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

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

The value is NULL if the activation state is INACTIVE.

  class EmergencyUnlock  

 

class EnrollmentAuthority

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

Represents a Certification or Registration Authority for certificate enrollment.

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

 

class EnrollmentServer

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

Represents an enrollment server.

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

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

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

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


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

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

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

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 EnrollmentServer  

 

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 EnrollmentServerGroup  

 

class EricssonFilter

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

Provides configuration of features supported by the Ericsson LDAP schema.

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


This MO is created by the system.

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

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

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

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

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

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

Attribute ericssonUserAuthenticationScope behavior:

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

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

Attribute ericssonUserAuthorizationScope behavior:

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

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

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

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

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

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

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

ericssonUserAuthorizationScope: ApplicationOperator
ericssonUserAuthorizationScope: *:ApplicationOperator

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

  class EricssonFilter  

 

class 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 Evip  

 

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 EvipAlb  

 

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 EvipAlbs  

 

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 EvipCluster  

 

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 EvipCommand  

 

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 EvipCommandDefinition  

 

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 EvipDeclarations  

 

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 EvipErsipParams  

 

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 EvipFee  

 

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 EvipFees  

 

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 EvipFlowPolicies  

 

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 EvipFlowPolicy  

 

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 EvipLbe  

 

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 EvipLbes  

 

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 EvipNode  

 

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 EvipParam  

 

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 EvipParams  

 

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 EvipPayload  

 

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 EvipPortRange  

 

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 EvipPortRanges  

 

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 EvipProtocol  

 

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 EvipRoutingSetup  

 

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 EvipSe  

 

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 EvipSelectionPolicies  

 

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 EvipSelectionPolicy  

 

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 EvipSes  

 

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 EvipSupervisedRemoteGateway  

 

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 EvipTargetPool  

 

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 EvipTargetPools  

 

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 EvipVip  

 

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 EvipVips  

 

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 EvipXfrmSelectionPolicies  

 

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 EvipXfrmSelectionPolicy  

 

class ExtNetSel-Application

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCalledTablesClass [1..1]
+-ExtNetSelCallingPartyHeaderPriorityTableClass [1..1]
+-ExtNetSelCallingTablesClass [1..1]
+-ExtNetSelCicTablesClass [1..1]
+-ExtNetSelMatchTables [1..1]
+-ExtNetSelPoolsClass [1..1]
+-ExtNetSelRegexMTblClass [1..1]
+-ExtNetSelRegexTableClass [1..1]
+-ExtNetSelRnTablesClass [1..1]
+-ExtNetSelSipMessageTables [1..1]
+-ExtNetSelTablesClass [1..1]
+-ExtNetSelUtcTables [1..1]
+-ExtNetSelWeightTables [1..1]

This is the root class and basic container for the configuration parameters related to the External-Network-Selection function in CSCF.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
ExtNetSelActiveConfigDT
extNetSelectionActiveConfiguration = ExtNetSelection
The parameter is used to specify which of the two ENS configuration instances that should be active and used for traffic. It is only possible to change the ExtNetSelectionActiveConfiguration parameter to an ENS configuration instance that has the synchronization state set to synchronized (ExtNetSelectionSynchronizationState). Changes to this parameter in one configuration instance will be mirrored in the other instance.
String0to00128DT[0..1]
extNetSelectionDefaultPoolName = ""
This attribute defines the External Network Pool to use when a loop or other error is encountered during the selection process.

Dependencies: ExtNetSelPoolTableEntry must be configured before this parameter can be set.
ExtNetSelInitialTableNameDT
mandatory
extNetSelectionInitialTableName
This parameter should be configured with the name of the ENS table to indicate where to start the pool selection process. The referenced table must be configured before this parameter can be changed.

Format: A defined ENS navigation and matching table or the predefined value not_configured. For example: calling:[tableName], P-Asserted-Identity:[tableName], CIC:[tableName], RN:[tableName] or called:[tableName]. Setting the parameter to the value not_configured indicates that this instance of the configuration will not be used. The default value for ExtNetSelection is calling:default and the default value for ExtNetSelection2 is not_configured.

valid values are (((calling|CIC|RN|called|P-Asserted-Identity|sdp-media|Request-URI|callingPartyDomain|Request-URI-Match|Event|P-Access-Network-Info|SIP-Method|SipMessage|EnsExactString|EnsDateMatchTable|EnsTimeMatchTable|weight):.+) | not configured)
uint32
extNetSelectionMaxTables = 25
This attribute defines the maximum number of navigation and matching tables allowed to be invoked for routing analyses. This attribute is used for ENS loop detection. When the number of navigation and matching tables invoked in an ENS session exceeds this limit, an alarm will be raised.
This attribute is included in both ENS applications. A change of the value in one application will be mirrored in the attribute in the other application.
ExtNetSelSynchStateDT
readOnly
extNetSelectionSynchronizationState = not_synchronized
The parameter is updated by the system and shows the synchronization state of the configuration instance which the parameter is part of.
boolean
extNetSelectionTablesSynchronization = false
Setting ExtNetSelectionTablesSynchronization to true synchronizes the configuration instance which the parameter belongs to. The parameter will be automatically set to false when the synchronization has finished. Modifications to the configuration instance are only allowed when the parameter is set to false. The synchronized data will only be used for traffic handling when the configuration instance is active.

  class ExtNetSel-Application  

 

class ExtNetSelCalledTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCalledTablesClass
+-ExtNetSelCalledTableClass
+-ExtNetSelCalledTableEntryClass [0..]

This is Managed Object Class for External Network Selection CalledTables

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelCalledTable
The name of the table that includes all ExtNetSelCalledTableEntry's. This table must be configured before the ExtNetSelCalledTableEntry. Multiple Called Party tables can be configured in the node however the default Called Party Table is always available.

  class ExtNetSelCalledTableClass  

 

class ExtNetSelCalledTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCalledTablesClass
+-ExtNetSelCalledTableClass
+-ExtNetSelCalledTableEntryClass

This is Managed Object Class for External Network Selection CalledTableEntry

Attributes
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelCalledTableEntry
This attribute defines the start range of the called table and the associated ExtNetSelCalledTable. Note that when the + sign is used, it must be escaped. For example, TableName:\+46 or TableName:default.

Format: tableName:startRange where tableName must match a value in ExtNetSelCalledTable and where startRange must match a value in ExtNetSelCalledTableStartRange.
ExtNetSelNextTableNameDT[0..1]
extNetSelCalledTableNextTableName
This parameter can be configured to the name of the ENS table where to continue the pool selection process. The referenced table must be configured before this parameter can be changed. This parameter is mutually exclusive with ExtNetSelCalledTablePoolName.

Format: [criteria]:[tableName].

valid pattern : (((calling|called|RN|CIC|P-Asserted-Identity|sdp-media|Request-URI|SipMessage|EnsExactString|EnsDateMatchTable|EnsTimeMatchTable):.+)?)
String0to00128DT[0..1]
extNetSelCalledTablePoolName = ""
Defines the external network pool to use. The ExtNetSelPoolTableEntry must have been configured before this parameter can be set. This parameter is mutually exclusive with ExtNetSelCalledTableNextTableName
String0to00128DT[0..1]
extNetSelCalledTableStartRange = ""
This attribute defines the number range to match the PSTN number of the called party. The number range is either all hex digits or a plus sign followed by hex digits. A number range with a plus sign and an equal number range without a plus sign are handled as different number ranges.

Format: [+]range, for example +46. The format of the number is "+" followed by hex digits
Example: +4675

  class ExtNetSelCalledTableEntryClass  

 

class ExtNetSelCalledTablesClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCalledTablesClass
+-ExtNetSelCalledTableClass [0..]

This is Managed Object Class for External Network Selection CalledTables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelCalledTables
Key attribute to ExtNetSelCalledTablesClass

  class ExtNetSelCalledTablesClass  

 

class ExtNetSelCallingPartyHeaderPriorityTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCallingPartyHeaderPriorityTableClass
+-ExtNetSelCallingPartyHeaderPriorityTableEntryClass [0..]

This table specifies a prioritized list of header names that are used by the CallingPartyDomain Table. A single instance of the table is created at system startup; table instances can not be added or deleted.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelCallingPartyHeaderPriorityTable
Key attribute to ExtNetSelCallingPartyHeaderPriorityTableClass

  class ExtNetSelCallingPartyHeaderPriorityTableClass  

 

class ExtNetSelCallingPartyHeaderPriorityTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCallingPartyHeaderPriorityTableClass
+-ExtNetSelCallingPartyHeaderPriorityTableEntryClass

Each table entry specifies a SIP header name and an associated priority.

Attributes
Integer0to65535DT
extNetSelCallingPartyHeaderPriority = 1
This attribute specifies the priority of the ExtNetSelCallingPartyHeaderPriorityTableEntryClass instance. Every ExtNetSelCallingPartyHeaderPriorityTableEntryClass instance has to have a unique priority.
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelCallingPartyHeaderPriorityTableEntry
This parameter specifies a SIP header name. It is the key attribute of ExtNetSelCallingPartyHeaderPriorityTableEntryClass

  class ExtNetSelCallingPartyHeaderPriorityTableEntryClass  

 

class ExtNetSelCallingTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCallingTablesClass
+-ExtNetSelCallingTableClass
+-ExtNetSelCallingTableEntryClass [0..]

This is Managed Object Class for External Network Selection CallingTable

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelCallingTable
The name of the table that includes all ExtNetSelCallingTableEntry's. This table must be configured before ExtNetSelCallingTableEntry. Multiple Calling party tables can be configured in the node however the default Calling party Table is always available.

  class ExtNetSelCallingTableClass  

 

class ExtNetSelCallingTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCallingTablesClass
+-ExtNetSelCallingTableClass
+-ExtNetSelCallingTableEntryClass

This is Managed Object Class for External Network Selection CallingTableEntry

Attributes
ExtNetSelTableNameDT[0..1]
extNetSelCalledPartyTableName = ""
This parameter can be configured to the name of an existing ExtNetSelCalledTable. If left empty, the attribute will not be used.

Dependencies: ExtNetSelCalledTable must be configured before this parameter can be changed.
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelCallingTableEntry
This attribute defines the name of ExtNetSelCallingTable name and the number range. Note: The + sign must be escaped here, for example, TableName:021 or TableName:default. The string must follow the pattern [ExtNetSelCallingTableName]:[range], where the range part must match the value of the ExtNetSelCallingTableStartRange attribute.

he string must follow the pattern [ExtNetSelCallingTableName]:[range], where the range part must match the value of the ExtNetSelCallingTableStartRange attribute
ExtNetSelNextTableNameDT[0..1]
extNetSelCallingTableNextTableName = ""
This parameter can be configured to the name of the ENS table where to continue the pool selection process. The referenced table must be configured before this parameter can be changed. This parameter is mutually exclusive with ExtNetSelCalledPartyTableName.

Format: [criteria]:[tableName].
A defined ENS navigation and matching table. For example: calling:[tableName], P-Asserted-Identity:[tableName], CIC:[tableName], RN:[tableName] or called:[tableName].
ExtNetSelCallingTableStartRangeDT
mandatory
extNetSelCallingTableStartRange
This attribute defines the number range to match the telephone number of the calling party. The format of the number is digits or "+" followed by digits Example: +4675.

Takes effect: ChangeTypeUpgradeType - The configuration instance becomes active when the attribute extNetSelectionTablesSynchronization is set to true
ExtNetSelTableNameDT[0..1]
extNetSelCicTableName = ""
This parameter can be configured to the name of an existing ExtNetSelCicTable. If left empty, the attribute will not be used.


Dependencies: ExtNetSelCicTable must be configured before this parameter can be changed.
ExtNetSelTableNameDT[0..1]
extNetSelRnTableName = ""
This parameter can be configured to the name of an existing ExtNetSelRnTable. If left empty, the attribute will not be used.

Dependencies: ExtNetSelRnTable must be configured before this parameter can be changed.

  class ExtNetSelCallingTableEntryClass  

 

class ExtNetSelCallingTablesClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCallingTablesClass
+-ExtNetSelCallingTableClass [0..]

This is Managed Object Class for External Network Selection CallingTables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelCallingTables
Key attribute to ExtNetSelCallingTablesClass

  class ExtNetSelCallingTablesClass  

 

class ExtNetSelCicTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCicTablesClass
+-ExtNetSelCicTableClass
+-ExtNetSelCicTableEntryClass [0..]

This managed object class holds the data for the Carrier Identification Code(CIC) tables.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelCicTable
This attribute identifies the name of the CIC Table that includes all the ExtNetSelCicTableEntry's in that table. This table must be configured before the ExtNetSelCicTableEntry.

  class ExtNetSelCicTableClass  

 

class ExtNetSelCicTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCicTablesClass
+-ExtNetSelCicTableClass
+-ExtNetSelCicTableEntryClass

This managed object class holds the data for the CIC table entries

Attributes
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelCicTableEntry
This attribute defines the start range of the CIC table and the associated ExtNetSelCicTable. Note that when the + sign is used, it must be escaped. for example, TableName:\+46 or TableName:default.

Format: tableName:startRange where tableName must match a value in ExtNetSelCicTable, and where startRange must match a value in ExtNetSelCicTableStartRange.
ExtNetSelNextTableNameDT[0..1]
extNetSelCicTableNextTableName = ""
This parameter can be configured to the name of the ENS table where to continue the pool selection process. The referenced table must be configured before this parameter can be changed. This parameter is mutually exclusive with ExtNetSelCicTablePoolName.

Format: [criteria]:[tableName].

valid pattern : (((calling|called|RN|CIC|P-Asserted-Identity|sdp-media|Request-URI|SipMessage|EnsExactString|EnsDateMatchTable|EnsTimeMatchTable|weight):.+)?)
ExtNetSelTableNameDT[0..1]
extNetSelCicTablePoolName = ""
This attribute defines the External Network Pool to use for the CIC entry. This parameter is mutually exclusive with the ExtNetSelCicTableNextTableName. "ignore" is a deprecated value that will cause CIC to be removed from the request URI. If left empty, the attribute will not be used.

Dependencies: ExtNetSelPoolTableEntry must be configured before this parameter can be set.
ExtNetSelRnAndCICTableStartRangeDT
mandatory
extNetSelCicTableStartRange
This attribute defines the number range to match the CIC parameter. The format of the number is '+' followed by hex digits. Example: +4675.

  class ExtNetSelCicTableEntryClass  

 

class ExtNetSelCicTablesClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelCicTablesClass
+-ExtNetSelCicTableClass [0..]

This is Managed Object Class for External Network Selection CicTables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelCicTables
Key attribute to ExtNetSelCicTablesClass

  class ExtNetSelCicTablesClass  

 

class ExtNetSelMatchTable

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelMatchTables
+-ExtNetSelMatchTable
+-ExtNetSelMatchTableEntry [0..]

This class allows configuration of an instance of a Match table.

Attributes
EnsExactStringDT
key
mandatory
noNotification
restricted
extNetSelMatchTableId
Key attribute of ExtNetSelMatchTable. This attribute identifies the name of a Match table.

supported length (1..128) constraint. ((EnsExactString):.+)
ExtNetSelMatchTableModeDT
extNetSelMatchTableMode = CASE_INSENSITIVE
This attribute enables or disables case sensitivity during string match operations. When set to CASE_SENSITIVE, case sensitive match operation is enabled. When set to CASE_INSENSITIVE, case sensitive match operation is disabled.

  class ExtNetSelMatchTable  

 

class ExtNetSelMatchTableEntry

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelMatchTables
+-ExtNetSelMatchTable
+-ExtNetSelMatchTableEntry

This class allows configuration of an instance of a Match table entry. The table must have one entry with the keyword default.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
extNetSelMatchTableEntryId
Key attribute of ExtNetSelMatchTableEntry. This attribute defines either the configured operand of a matching entry or the keyword default.
ExtNetSelMatchandUtcTableResultDT
mandatory
extNetSelMatchTableResult
This attribute defines the next table or pool to continue ENS operation when the corresponding entry is selected. The next table or pool must be configured first before they are referenced by this attribute.

  class ExtNetSelMatchTableEntry  

 

class ExtNetSelMatchTables

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelMatchTables
+-ExtNetSelMatchTable [0..]

This class is defined to allow configuration of multiple instances of Match tables.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelMatchTablesId
Key attribute of ExtNetSelMatchTables.

  class ExtNetSelMatchTables  

 

class ExtNetSelPoolsClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelPoolsClass
+-ExtNetSelPoolTableEntryClass [0..]

This is Managed Object Class for External Network Selection Pools

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelPools
Key attribute to ExtNetSelPoolsClass

  class ExtNetSelPoolsClass  

 

class ExtNetSelPoolTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelPoolsClass
+-ExtNetSelPoolTableEntryClass

This is Managed Object Class for External Network Selection PoolTableEntry

Attributes
EOSAdditionalRouteDT[0..4] nonUnique
extNetSelAdditionalRoute
This attribute is a list of any additional Route-URIs (Route headers to be added to the outgoing SIP request. The format is n:sip: &lt;FQDN&gt;;[:&lt;port&gt;;][;lr] or n:sip;&lt;IP Address&gt;; [:&lt;port&gt;;][;lr] where “n” is the order indicator of the Route-URI. Each additional Route-URI must have a unique value for “n” in the range of 1-9. The order indicators do not need to be sequential. The “lr” parameter should be included in the parameter value but if not specified will be implicitly set by system and added to the applicable Route-URI. The SIP-URI specified will be normalized meaning that for an example extra white spaces will be removed and if the same URI-parameter is specified several times only the first one will be kept.

Note: In the special case were an emergency call is invoked through an S-CSCF this parameter will NOT be used for adding any additional route-headers to the SIP-message.


Dependencies: extNetSelectionTablesSynchronization is set to true.
ExtNetSelEOSCaseDT[0..1]
extNetSelEosCase
This parameter can be configured to support crankback for BGCF traffic cases in CSCF. Crankback is selecting and trying alternate route when a timeout or an error response is received from the destination configured in ExtNetSelPoolURI . The value of ExtNetSelEosCase may not begin with a decimal digit (0-9). These values are reserved for internal EOS Cases. If an empty string, the crankback is disabled.

Dependencies: ExtNetSelectionTablesSynchronization must be set to true.
ExtNetSelPoolModeDT[0..1]
extNetSelPoolMode = ALLOCATED_NUMBER
This attribute defines if the pool is considered to be in allocated number mode.
Prerequirement for changing ExtNetSelPoolMode to ALLOCATED_NUMBER is a configured ExtNetSelPoolURI.
Prerequirement for changing ExtNetSelPoolMode to UNALLOCATED_NUMBER is a configured ExtNetSelUnallocatedNrResponseCode.
Note: When changing pool mode all data in the pool which is not used in the new pool mode will automatically be erased.
String1to00032DT
key
mandatory
noNotification
restricted
extNetSelPoolTableEntry
The entry represents a unique name of the external network pool. At least one digit or letter. All digits and letters are valid.
ExtNetSelPoolTimeoutDT
extNetSelPoolTimeout = 0
Defines the time in milliseconds when a breakout gateway needs to respond to a request before it is considered as unreachable. If this parameter is disabled (set to 0), CscfSipDefaultFailoverTimer will be used instead.
ExtNetSelPoolUriDT[0..20] nonUnique ordered
extNetSelPoolURI
This attribute defines the SIP URI of the external network pool. The attribute must be configured when ExtNetSelPoolMode is set to 0. The usage of multiple instances can only be used for emergency calls handled by the S-CSCF.

The parameter contains two parts separated by the delimiter ":". First a priority followed by a request-URI. The priority must be a positive integer and be unique among the ExtnetSelPoolURI attributes within the same class instance. The lowest value represents the highest priority. If only one instance of the attribute is used, the priority does not have to be stated, and will automatically be set = 1. The request-URI shall be on format “sip:&lt;FQDN&gt;[:port][;lr]”. The FQDN is mandatory, port number and the loose routing tag are optional. Port Number must be between 1024 and 49151. Example: 1:sip:pool.x.com:5060;lr
String0to00128DT[0..1]
extNetSelTrunkGroupAndContext = ""
TrunkGroup defines a group of trunks that connects to the same target switch or network. Context defines a namespace on the TrunkGroup by a global number or any number of its leading digits, for example, +33. The TrunkGroup and Context must be separated with ':', for example tgrp-1:+33, or the string must be empty which means that both TrunkGroup and Context are undefined.
ExtNetSelUnallocatedResponseCodeDT[0..1]
extNetSelUnallocatedNrResponseCode = 500
This is the response code sent back if a lookup is matching the pool and the pool is an unallocated number pool. This attribute is relevant when ExtNetSelPoolMode is set to 1. Only SIP response codes are valid.
String0to00128DT[0..1]
extNetSelUnallocatedNrResponsePhrase = ""
This is the response phrase sent back if a lookup is matching the pool and the pool is an unallocated number pool. It represents an appropriate reason phrase for the selected error code defined in ExtNetselUnallocatedNrResponseCode. This attribute is relevant when ExtNetSelPoolMode is set to 1.

Dependencies: ExtNetSelPoolMode is set to 1.

  class ExtNetSelPoolTableEntryClass  

 

class ExtNetSelRegexMTblClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRegexMTblClass
+-ExtNetSelRegexMTblEntryClass [0..]

This is Managed Object Class for External Network Selection RegexMTbl

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelRegexMTbl
Key attribute to ExtNetSelRegexMTblClass.

  class ExtNetSelRegexMTblClass  

 

class ExtNetSelRegexMTblEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRegexMTblClass
+-ExtNetSelRegexMTblEntryClass

This is Managed Object Class for External Network Selection RegexMTblEntry

Attributes
String0to00256DT
mandatory
extNetSelRegexM
This parameter defines a regular expression to be used on an "original value". The "original value" is either a Request URI, a SIP Event or a PANI header. The regular expression is a "Match Operand" to a "Match Operation". The regular expression contains a match rule. POSIX 1003.2 extended regular expression is used, with the exception that "\d" is not supported. It is possible to either consider or ignore case when applying a regular expression.

The format contains two parts: /<regex>/[i] where <regex> specifies the matching rule of the "original value". The optional "i" specifies that the matching shall ignore case. An omitted "i" makes the matching case sensitive.
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelRegexMTblEntry
This parameter defines a name of a regular expression. The name is referenced from a ExtNetSelMatchOperand.A unique name for the regular expression. At least one digit or letter. All digits and letters are valid

  class ExtNetSelRegexMTblEntryClass  

 

class ExtNetSelRegexTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRegexTableClass
+-ExtNetSelRegexTableEntryClass [0..]

This is Managed Object Class for External Network Selection RegexTables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelRegexTable
Key attribute to ExtNetSelRegexTableClass.

  class ExtNetSelRegexTableClass  

 

class ExtNetSelRegexTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRegexTableClass
+-ExtNetSelRegexTableEntryClass

This is Managed Object Class for External Network Selection RegexTableEntry

Attributes
String0to00256DT
mandatory
extNetSelRegExpression
This parameter defines a regular expression to be used on an "original value". The "original value" is a Request URI and the regular expression is a "Modify Operand" to a "Modify Operation". The regular expression contains a match and substitution rule separated by "/". POSIX 1003.2 extended regular expression is used, with the exception that "\d" is not supported. It is possible to either consider or ignore case when applying a regular expression. If hexadecimal digits (that is, over-decadic) are to be matched on the "original value", it is recommended to set the case insensitive option to "i" because the over-decadic digits may be converted between upper and lower case by the network.

The format contains three parts, using "/" as separator: /[regex]/[string]/(i) Where [regex] specifies the matching rule of the "original value", and [string] specifies the modification rule of the "original value". The optional "i" specifies that the matching shall ignore case. An omitted "i" makes the matching case sensitive.
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelRegexTableEntry
This parameter defines a unique name of a regular expression. The name is referenced from a modify-regex operation. At least one digit or letter. All digits and letters are valid.

  class ExtNetSelRegexTableEntryClass  

 

class ExtNetSelRnTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRnTablesClass
+-ExtNetSelRnTableClass
+-ExtNetSelRnTableEntryClass [0..]

This managed object class holds the data for the Routing Number (RN) tables.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelRnTable
This attribute identifies the name of the Routing Number Table that includes all the ExtNetSelRnTableEntry's in that table. This table must be configured before the ExtNetSelRnTableEntry.

  class ExtNetSelRnTableClass  

 

class ExtNetSelRnTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRnTablesClass
+-ExtNetSelRnTableClass
+-ExtNetSelRnTableEntryClass

This managed object class holds the data for the RN table entries

Attributes
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelRnTableEntry
This attribute defines the start range of the Routing Number and the associated ExtNetSelRnTable. Note that when the + sign is used, it must be escaped. for example, TableName:\+46 or TableName:default.

Format: "tableName:startRange" where tableName must match a value in ExtNetSelRnTable, and where startRange must match a value in ExtNetSelRnTableStartRange.
ExtNetSelNextTableNameDT[0..1]
extNetSelRnTableNextTableName = ""
This parameter can be configured to the name of the ENS table where to continue the pool selection process. The referenced table must be configured before this parameter can be changed. This parameter is mutually exclusive with the ExtNetSelRnTablePoolName.

Format: [criteria]:[tableName].

valid pattern : (((calling|called|RN|CIC|P-Asserted-Identity|sdp-media|Request-URI|SipMessage|EnsExactString|EnsDateMatchTable|EnsTimeMatchTable|weight):.+)?)
String0to00128DT[0..1]
extNetSelRnTablePoolName = ""
This attribute defines the External Network Pool to use for RN entry. The ExtNetSelPoolTableEntry must be configured before this parameter can be set. This parameter is mutually exclusive with ExtNetSelRnTableNextTableName.
ExtNetSelRnAndCICTableStartRangeDT
mandatory
extNetSelRnTableStartRange
This attribute defines the number range to match the Routing Number parameter. The format of the number is '+' followed by hex digits Example: +4675.

  class ExtNetSelRnTableEntryClass  

 

class ExtNetSelRnTablesClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelRnTablesClass
+-ExtNetSelRnTableClass [0..]

This is Managed Object Class for External Network Selection RnTables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelRnTables
Key attribute to ExtNetSelRnTablesClass

  class ExtNetSelRnTablesClass  

 

class ExtNetSelSipMessageTable

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelSipMessageTables
+-ExtNetSelSipMessageTable
+-ExtNetSelSipMessageTableEntry [0..3]

This class allows configuration of an instance of a SIPMessage table.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelSipMessageTableId
Key attribute of ExtNetSelSipMessageTable. It identifies the name of a SIP message table.

  class ExtNetSelSipMessageTable  

 

class ExtNetSelSipMessageTableEntry

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelSipMessageTables
+-ExtNetSelSipMessageTable
+-ExtNetSelSipMessageTableEntry

This class allows configuration of an instance of a SIPMessage table entry. The table must have one matching entry, one entry with the keyword OperandNotExist and one entry with the keyword default.

Attributes
ExtNetSelSipMessageEntryDT
key
mandatory
noNotification
restricted
extNetSelSipMessageTableEntryId
Key attribute of ExtNetSelSipMessageTableEntry. This attribute identifies the operand which is a SIP message protocol element, the keyword OperandNotExist or the keyword default.
String0to00128DT[0..1]
extNetSelSipMessageTableMatchOperand
This attribute provides a reference to a regular expression defined in the RegEx Matching table or Regular Expression table. If match-regex is the configured match operation, the regular expression must first be defined in extNetSelRegexMTbl before this reference is made. If match-extract is the configured match operation, the regular expression must first be defined in ExtNetSelRegexTbl before this reference is made. This attribute is not applicable to the OperandNotExist or default entry.
ExtNetSelSipMessageMatchOperationDT[0..1]
extNetSelSipMessageTableMatchOperation
This attribute identifies the operation desired for the matching entry. Supported values are match-regex and match-extract. This attribute is not applicable to the OperandNotExist or default entry.
ExtNetSelMatchandUtcTableResultDT
mandatory
extNetSelSipMessageTableResult
This attribute defines the next table or pool to continue ENS operation when the corresponding entry is selected. The next table or pool must be configured first before they are referenced by this attribute.

  class ExtNetSelSipMessageTableEntry  

 

class ExtNetSelSipMessageTables

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelSipMessageTables
+-ExtNetSelSipMessageTable [0..]

This class is defined to allow configuration of multiple instances of SIPMessage tables.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelSipMessageTablesId
Key attribute of ExtNetSelSipMessageTables

  class ExtNetSelSipMessageTables  

 

class ExtNetSelTableClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelTablesClass
+-ExtNetSelTableClass
+-ExtNetSelTableEntryClass [0..]

This is Managed Object Class for External Network Selection Table

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelTable
This attribute identifies the name of the ENS Table. This table must be configured before the ExtNetSelTableEntry.

The string must follow the pattern [criteria]:[tableName]. Supported values for [criteria] are "P-Asserted-Identity", "sdp-media", "Request-URI" or "callingPartyDomain". Examples: P-Asserted-Identity:sweden or sdp-media:multimedia or Request-URI:sweden or callingPartyDomain:sweden.

  class ExtNetSelTableClass  

 

class ExtNetSelTableEntryClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelTablesClass
+-ExtNetSelTableClass
+-ExtNetSelTableEntryClass

This managed object class holds the data for the External Network Selection table entries

Attributes
String0to00128DT
key
mandatory
noNotification
restricted
extNetSelTableEntry
This attribute identifies the associated ExtNetSelTable and the ExtNetSelTableOperand.

Format: [tableName]:[operand] where tableName must match a value in ExtNetSelTable. [tableName]:default indicates the entry selected when no match is found. [tableName]:OperandNotExist indicates the entry selected when the selection criteria was not received. The [operand] field other than "default" is not used when the ExtNetSelTable [criteria] is "sdp-media". For example: P-Asserted-Identity:Sweden:telia.se or sdp-media:multimedia or sdp-media:multimedia:default or callingPartyDomain:default:cscf.com.
String0to00128DT[0..] nonUnique ordered
extNetSelTableMatchOperand
This attribute identifies the "Match Operand" used with the "Match Operation" defined by ExtNetSelMatchOperation to select the ExtNetSelTableResult. The value depends on the "Match Operation". For "match-exact-domainname", the allowed values are a domainname, OperandNotExist or Default.
ExtNetSelTableMatchOpDT[0..1]
extNetSelTableMatchOperation
This attribute identifies the "Match Operation" performed with "Match Operand" to select the ExtNetSelTableResult.

Allowed format is "match-exact-domainname", "match-method", "match-regex" or empty string. The format "match-exact-domainname" is used when the ExtNetSelTable [criteria] is "P-Asserted-Identity", "Request-URI" or "callingPartyDomain". This attribute is not used when the ExtNetSelTable [criteria] is "sdp-media".
String0to00128DT[0..1]
extNetSelTableModifyOperand = ""
This attribute identifies the "Modify Operand" to be used with the "Modify Operation" defined by ExtNetSelTableModifyOperation to select a regular expression. For modify-regex, the allowed values are names of a regular expression, defined by ExtNetSelRegexTableEntry.
ExtNetSelTableModifyOpDT[0..1]
extNetSelTableModifyOperation
This attribute identifies the "Modify Operation" performed with "Modify Operand" to modify the selection criterion.
Allowed format is “modify-regex” or empty.
ExtNetSelTableResultDT
mandatory
extNetSelTableResult
Format: pool:[poolName] or [criteria]:[tableName].

valid pattern : ((pool|calling|called|RN|CIC|P-Asserted-Identity|sdp-media|Request-URI|SipMessage|EnsExactString|EnsDateMatchTable|EnsTimeMatchTable|callingPartyDomain|Event|P-Access-Network-Info|Request-URI-Match|SIP-Method|weight):.+)

This attribute identifies:
- The external Network Pool to use if the external network selection process is complete (ExtNetSelPoolTableEntry).
- The name of a next table where to continue the external network selection process (ExtNetSelTable, ExtNetSelCicTable, ExtNetSelRnTable, ExtNetSelCalledTable, ExtNetSelCallingTable or ExtNetSelWeightTable).
- The referenced pool or table must be configured before this parameter can be changed.

  class ExtNetSelTableEntryClass  

 

class ExtNetSelTablesClass

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelTablesClass
+-ExtNetSelTableClass [0..]

This is Managed Object Class for External Network Selection Tables

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelTables
Key attribute to ExtNetSelTablesClass

  class ExtNetSelTablesClass  

 

class ExtNetSelUtcTable

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelUtcTables
+-ExtNetSelUtcTable
+-ExtNetSelUtcTableEntry [0..]

This class allows configuration of an instance of a UTC match table.

Attributes
ExtNetSelUtcTableIdDT
key
mandatory
noNotification
restricted
extNetSelUtcTableId
Key attribute of ExtNetSelUtcTable. This attribute identifies the name of a UTC match table.

valid value pattern : ((EnsDateMatchTable|EnsTimeMatchTable):.+)

  class ExtNetSelUtcTable  

 

class ExtNetSelUtcTableEntry

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelUtcTables
+-ExtNetSelUtcTable
+-ExtNetSelUtcTableEntry

This class allows configuration of an instance of a UTC match table entry. The table must have one entry with the keyword default.

Attributes
String1to00128DT
key
mandatory
noNotification
restricted
extNetSelUtcTableEntryId
Key attribute of ExtNetSelUtcTableEntry. This attribute identifies the name of a matching entry or the keyword default.
ExtNetSelMatchandUtcTableResultDT
mandatory
extNetSelUtcTableResult
This attribute defines the next table or pool to continue ENS operation when the corresponding entry is selected. The next table or pool must be configured first before they are referenced by this attribute.
String0to00128DT[0..1]
extNetSelUtcTableStartOperand
This attribute defines the start operand of the match range, inclusively. This attribute is not applicable to the default entry.
String0to00128DT[0..1]
extNetSelUtcTableStopOperand
This attribute defines the stop operand of the match range, inclusively. The stop operand value is equal to or larger than the start operand value in a matching entry with the exception when a UTC time range spans over a day boundary, for example 23:00:00 – 02:00:00. This attribute is not applicable to the default entry.

  class ExtNetSelUtcTableEntry  

 

class ExtNetSelUtcTables

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelUtcTables
+-ExtNetSelUtcTable [0..]

This class is defined to allow configuration of multiple instances of UTC match tables.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelUtcTablesId
Key attribute of ExtNetSelUtcTables.

  class ExtNetSelUtcTables  

 

class ExtNetSelWeightTable

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelWeightTables
+-ExtNetSelWeightTable

This class enables the possibility to have a weighted distribution to subsequent ENS classes. The weighting allows analysis to continue in a subsequent ENS class based on a proportional basis.

Attributes
extNetSelWeightEntryDT[0..20] nonUnique ordered
extNetSelWeightEntry
The parameter is a multi-value parameter where each value consists of two parts; <weight> and <next table>.

The weight field specifies a relative weight for a specific extNetSelWeightEntry compared to other entries in the same table. Larger weights result a percentage higher probability of being selected. The range of this number is 0-65535. Weight 0 can be used when temporarily disabling an entry. In case no extNetSelWeightEntry parameter values are set or all of them are set with weight 0, the SIP request is routed to the gateway identified in the extNetSelectionDefaultPoolName parameter. If extNetSelectionDefaultPoolName is not defined, the SIP request is rejected with a 500 (PSTN Gateway unreachable) error response.
extNetSelWeightTableIdDT
key
mandatory
noNotification
restricted
extNetSelWeightTableId = ""
Key to the instance of ExtNetSelWeightTable

  class ExtNetSelWeightTable  

 

class ExtNetSelWeightTables

ManagedElement
+-CscfFunction
+-ExtNetSel-Application
+-ExtNetSelWeightTables
+-ExtNetSelWeightTable [0..]

This class is defined to allow configuration of multiple instances of Weight tables.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
extNetSelWeightTablesId = ""
Key attribute of ExtNetSelWeightTables

  class ExtNetSelWeightTables  

 

class FeatureKey

ManagedElement
+-SystemFunctions
+-Lm
+-FeatureKey

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

This MO is created by the system.

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

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

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

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

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

  class FeatureKey  

 

class FileGroup

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

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

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

Parameters

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


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

  class FileGroup  

 

class FileGroupPolicy

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

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

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

  class FileGroupPolicy  

 

class FileInformation

..
+-FileGroup
+-FileInformation

An instance of FileInformation represents a file.


This MO is created by the system.

Deprecated: 

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

Deprecated: 

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

Deprecated: 

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

Deprecated: 

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


Deprecated: 

  class FileInformation  

 

class FileM

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

The top class of the the FileM model.

This MO is created by the system.

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

  class FileM  

 

class FileMConfigData

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

Hidden MOC for fileM configuration

This MO is created by the system.

Filter: filemData

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

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

Filter: filemData

  class FileMConfigData  

 

class Filter

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

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

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

Example of use with POSIX group objects as authorization profile:

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

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

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


This MO is created by the system.

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

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

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

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

  class Filter  

 

class Fm

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

The root MOC of the Fault Management branch.

This MO is created by the system.

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

  class Fm  

 

class FmAlarm

ManagedElement
+-SystemFunctions
+-Fm
+-FmAlarm

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


This MO is created by the system.

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


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

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


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

  class FmAlarm  

 

class FmAlarmModel

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

This is a container for grouping FM alarm types.


This MO is created by the system.

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

  class FmAlarmModel  

 

class FmAlarmType

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

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


This MO is created by the system.

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


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


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


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


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

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


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

  class FmAlarmType  

 

class 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 Host  

 

class ICMP-Application

ManagedElement
+-CscfFunction
+-ICMP-Application

The ICMP Managed Object (MO) represents the top level of the ICMP-Application.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
IcmpBarringTimeDT
icmpBarringTime = 20
Defines the time to regard destinations as unreachable.
boolean
icmpEnabled = false
Defines whether or not the ICMP function is enabled.
IcmpIntermittentToleranceDT
icmpIntermittentTolerance = 5
Number of ICMP messages to disregard before destinations are registered as unreachable.

  class ICMP-Application  

 

class IcscfDynamicUserIdentitySupportClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-IcscfDynamicUserIdentitySupportGroupClass
+-IcscfDynamicUserIdentitySupportClass

This is a container class for the CSCF Dynamic User Identity Support feature related attributes. One instance of the IcscfDynamicUserIdentitySupportClass with the key IcscfDynamicUserIdentitySupport=default is created at startup. This instance cannot be deleted. No other instances can be created of this class.

This MO is created by the system.

Attributes
String0to65535DT
key
mandatory
noNotification
restricted
icscfDynamicUserIdentitySupport
This is the key attribute of the IcscfDynamicUserIdentitySupportClass class. This is a container class for the CSCF Dynamic User Identity Support feature related attributes. One instance of the IcscfDynamicUserIdentitySupportClass with the key IcscfDynamicUserIdentitySupport=default is created at startup. This instance cannot be deleted. No other instances can be created of this class.
String0to01024DT[0..100] nonUnique
icscfDynamicUserIdentitySupportDomainEntry
This parameter contains regular expression rules (for example /one.att.net/i or the negation NOT:/[one.att.net/i) used to match the external domain of the terminating user of a terminating request. If there is a match, the terminating user belongs to a supported external domain and Dynamic User Identity Support is invoked for the terminating request. A maximum of 100 regular expression entries are allowed. The regular expressions and the negated regular expressions are forming two groups accordingly. Evaluation is done using OR connection inside the groups and AND connection between the two groups. If one of the groups hasn't got any element, only the other group will be taken into consideration when evaluating the entries.

If unset an empty string, or when set a regular expression on the form [NOT:]/&lt;regular expression&gt;/[i] (where i means ignore case when included)
For example:/.*\.domainName\.com/i
boolean
icscfDynamicUserIdentitySupportEnabled = false
This parameter is used to enable and disable the Dynamic User Identity Support feature in the I-CSCF. It can be set to true or false. If it is set to true, Dynamic User Identity Support is enabled. If it is set to false, Dynamic User Identity Support is disabled.

  class IcscfDynamicUserIdentitySupportClass  

 

class IcscfDynamicUserIdentitySupportGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-IcscfDynamicUserIdentitySupportGroupClass
+-IcscfDynamicUserIdentitySupportClass [1..1]

A group class for IcscfDynamicUserIdentitySupportClass. One instance of the IcscfDynamicUserIdentitySupportGroupClass with the key IcscfDynamicUserIdentitySupportGroup=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
icscfDynamicUserIdentitySupportGroup
This is the key attribute of the IcscfDynamicUserIdentitySupportGroupClass. One instance of the IcscfDynamicUserIdentitySupportGroupClass with the key IcscfDynamicUserIdentitySupportGroup=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class IcscfDynamicUserIdentitySupportGroupClass  

 

class IcscfNetworkInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-IcscfNwIfs
+-IcscfNetworkInterface

This is Managed Object Class for I-CSCF Network Interface

Attributes
NetworkInterfaceDT
key
mandatory
noNotification
restricted
icscfNetworkInterfaceEntry
This attribute defines the network interface the I-CSCF uses to receive and send SIP traffic. To add an interface the parameter CscfISPBehavior must also first be set to a behavior that support this interface. One UDP transport address is mandatory for the CscfISPOperationalState parameter to become ENABLED and domain name entries must be in the internal DNS table as well. A TCP transport address can optionally be added and must be configured with the same port-nr and IP-address as the UDP interface for CscfISPOperationalState to become ENABLED. One IPv4 and one IPv6 address can be specified for each transport type. Maximum one UDP and one TCP interface per IP address type (IPv4 and IPv6) can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
Note: A prerequisite for adding this network interface is that the IcscfDomainNameEntry already has been configured with at least one domain.
Note: A prerequisite for specifying an IPv6 address is that the parameter CscfHostportAsFqdnOnly is set to true.
NetworkInterfaceStatusDT[0..1]
readOnly
icscfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
Note: The value NO_TRAFFIC_DIRECTION_SET indicates the initial state. Although the function of assigning traffic direction has been deprecated, for backwards compatibility reason, this value is kept.

  class IcscfNetworkInterface  

 

class IcscfNwIfs

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-IcscfNwIfs
+-IcscfNetworkInterface [0..]

This is Managed Object Class for I-CSCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
icscfNwIfContainerKey
This is the key attribute of the IcscfNwIfs MO.

  class IcscfNwIfs  

 

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.
Evip_Ipsec_Ikev1_Ikev1PolicyProfile_dpdKeepAliveInterval
restricted
dpdKeepAliveInterval = 30
dpdKeepAliveInterval defines the time interval between R_U_THERE messages sent to the IKE peer.
Evip_Ipsec_Ikev1_Ikev1PolicyProfile_dpdTime
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.
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.
Evip_Ipsec_Ikev1_Ikev1PolicyProfile_phase1SaLifetime
restricted
phase1SaLifetime = 180
Lifetime for Phase 1 SA.
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 Ikev1PolicyProfile  

 

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 Ikev1Session  

 

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.
Evip_Ipsec_Ikev2PolicyProfile_dpdKeepAliveInterval
restricted
dpdKeepAliveInterval = 30
The keep alive interval with which INFORMATIONAL exchanges are sent to the peer.
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.
Evip_Ipsec_Ikev2PolicyProfile_ikeSaLifetime
restricted
ikeSaLifetime = 180
Lifetime for IKE SA.
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 Ikev2PolicyProfile  

 

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 Ikev2Session  

 

class IntegrationUnlock

ManagedElement
+-SystemFunctions
+-Lm
+-IntegrationUnlock

Integration Unlock state information.

This MO is created by the system.

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

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

  class IntegrationUnlock  

 

class 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 IpsecPolicy  

 

class IpsecProposalProfile

ManagedElement
+-Transport
+-Host
+-IpsecProposalProfile

Configuration information for Ipsec policies.

References from:
IpsecPolicy; Phase2Policy;
Attributes
ChildSaLifetime
mandatory
restricted
childSaLifetime
Lifetime for the negotiated ChildSAs.
IpsecProposal[1..] nonUnique ordered
mandatory
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 IpsecProposalProfile  

 

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 IpsecTunnel  

 

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 KeyFileInformation  

 

class KeyFileManagement

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

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

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


This MO is created by the system.

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

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

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

Parameters

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

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

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

The generic URI syntax is defined by RFC 3986.




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



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

  class KeyFileManagement  

 

class Ldap

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

Contains the configurable information on primary and secondary LDAP directories.

This MO is created by the system.

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

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

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

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

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

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

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

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

Authorization profiles are used by authorization methods.

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

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

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

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

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

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

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

  class Ldap  

 

class LdapAuthenticationMethod

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

Root MOC of the LDAP Authentication Method.

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


This MO is created by the system.

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

  class LdapAuthenticationMethod  

 

class LdapClientApplication

ManagedElement
+-CscfFunction
+-LdapClientApplication
+-LdapClientUserGroup [1..1]

One instance of the LdapClientApplication with the key applicationName=LdapClientApplication is created at startup. This instance cannot be deleted. No other instances can be created of this class.

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.

  class LdapClientApplication  

 

class LdapClientUser

ManagedElement
+-CscfFunction
+-LdapClientApplication
+-LdapClientUserGroup
+-LdapClientUser
+-LdapServerEntry [0..20]

This is a container class for the LDAP client user related attributes.

Attributes
String1to65535DT
key
mandatory
noNotification
restricted
ldapClientUserId
This is the key attribute of the LdapClientUser class.
Integer0to00010DT
ldapServerMaxNumberOfRetries = 3
This attribute defines the maximum number of resending of an LDAP request until declaring the LDAP server unavailable by the LDAP client. If the value is set to 0, the LDAP client will not resend the request to the same LDAP server. It will send the request to the next available LDAP server.
LdapServerResponseTimeDT
ldapServerResponseTime = 500
This attribute defines the maximum time that the LDAP client will wait for the response to an LDAP request. When this time expires, the LDAP client resends the request to the LDAP server.
LdapServerUnavailableTimeDT
ldapServerUnavailableTime = 30
This attribute defines the time for the LDAP client to consider an LDAP server unavailable after a connection failure. Within this time, the LDAP client will not connect to the unavailable LDAP server. The value of 0 means that the LDAP server will never be considered unavailable. The maximum is 86400 seconds (24 hours).

  class LdapClientUser  

 

class LdapClientUserGroup

ManagedElement
+-CscfFunction
+-LdapClientApplication
+-LdapClientUserGroup
+-LdapClientUser [1..1]

A group class for LdapClientUser. One instance of the LdapClientUserGroup with the key ldapClientUserGroupId=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
ldapClientUserGroupId
This is the key attribute of the LdapClientUserGroup class.

  class LdapClientUserGroup  

 

class LdapServerEntry

ManagedElement
+-CscfFunction
+-LdapClientApplication
+-LdapClientUserGroup
+-LdapClientUser
+-LdapServerEntry

This is a container class for the LDAP server related attributes. The maximum number of class instance is 20.

Attributes
String1to01024DT
mandatory
ldapServerAdminPassword
This attribute indicates the LDAP server password.
LdapServerUserNameDT
mandatory
ldapServerAdminUsername
This parameter is used to store the Distinguished User Name of the LDAP server. The Admin Name DN used in the BIND command is the concatenation of the attributes ldapServerAdminUsername and ldapServerRootDn, separated by a comma. If the value of the ldapServerRootDn is changed, the Root DN part of the Admin Name will be set to the same value.
LdapServerEntryIdDT
key
mandatory
noNotification
restricted
ldapServerEntryId
This attribute is the key of LdapServerEntry, which is used to store the LDAP server address in IP V4 or V6 address format with port, that is, IPaddress:port.
Integer1to00100DT
mandatory
ldapServerPriority
A parameter used to store the priority of the configured LDAP server. The lower the value of this parameter represents the higher priority of the related LDAP server. Each server must be configured with a unique priority. The highest priority server is used as the primary server. The TCP connection is setup per LDAP server for all servers.
When the primary server is unavailable, the server with the next highest priority will be used. When the primary server is recovered, the next and subsequent requests will be sent to the primary server again even though the current server is still available.
If the priority of the servers is changed due to reconfiguration, the primary server will be reselected if the priority of the current primary server is not the highest one in the list.
LdapServerRootDT
mandatory
ldapServerRootDn
This attribute indicates the root distinguished name of the LDAP server.
LdapServerVersionDT
ldapServerVersion = v3
This attribute defines LDAP version supported by the LDAP server.

  class LdapServerEntry  

 

class Legacy

ManagedElement
+-Legacy

Introduced to support deprecated types

Filter: hidden

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

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

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

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

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

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

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

Filter: hidden

  class Legacy  

 

class Lm

ManagedElement
+-SystemFunctions
+-Lm
+-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 Lm  

 

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 LocalAuthenticationMethod  

 

class LocalAuthorizationMethod

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

The Root MOC of the Local Authorization method.

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


This MO is created by the system.

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

  class LocalAuthorizationMethod  

 

class LogicalFs

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

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


This MO is created by the system.

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

  class LogicalFs  

 

class ManagedElement

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

 

class ManagedObject

ManagedObject

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

Interface Only: This MO cannot be created.

References from:
AccountPolicy; CliTls; ComputeResourceRole; EnrollmentAuthority; EnrollmentServerGroup; FileGroup; Ikev1PolicyProfile; Ikev2PolicyProfile; Ldap; NetconfTls; NodeCredential; PasswordPolicy; PasswordQuality; PmMeasurementCapabilities; Role; RoleUpgrade; Snmp; SwVersionMain; TrustCategory; TrustedCertificate;
  class ManagedObject  

 

class MeasurementReader

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

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

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

  class MeasurementReader  

 

class MeasurementType

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

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


This MO is created by the system.

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

  class MeasurementType  

 

class NeLSConfiguration

ManagedElement
+-SystemFunctions
+-Lm
+-NeLSConfiguration

Network License Server (NeLS) configuration parameters.

This MO is created by the system.

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

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

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

First reconnection attempt occurs randomly between 3 to 5 minutes.

Subsequent attempts occur with the delay specified by retryInterval.

  class NeLSConfiguration  

 

class NetconfSsh

ManagedElement
+-SystemFunctions
+-SysM
+-NetconfSsh

Represents the Netconf configuration management service over Secure Shell.

This MO is created by the system.

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

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

  class NetconfSsh  

 

class NetconfTls

ManagedElement
+-SystemFunctions
+-SysM
+-NetconfTls

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

This MO is created by the system.

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

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

  class NetconfTls  

 

class NodeCredential

ManagedElement
+-SystemFunctions
+-SecM
+-CertM
+-NodeCredential
+-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.
SEC_CertM_NodeCredential_enrollmentTimer[0..1]
enrollmentTimer = 60
The enrollment poll timer in minutes.

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

The alarm severity is raised to MINOR in case the remaining time to expiry is reduced to the one third of the configured threshold.
The alarm severity is raised to MAJOR in case the remaining time to expiry is reduced to the one tenth of the configured threshold or one week.
The alarm is cleared and a certificate not available alarm is raised when the certificate expires.
KeyInfo[0..1]
keyInfo
Specifies the key type and length that is used for the next enrollment.

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 NodeCredential  

 

class NtpServer

ManagedElement
+-SystemFunctions
+-SysM
+-NtpServer

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

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

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

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

  class NtpServer  

 

class NumberNormalisation

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile [0..255]

The NumberNormalisation Managed Object (MO) represents the top level of the Number Normalization application

This MO is created by the system.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormTableSyncDT
numberNormalisationTableSync = PASSIVE
After changes in the NumberNormalisation attribute, the confirmation is made permanent through setting the numberNormalisationTableSync to SYNCHRONIZING. This means the Number Normalization will be notified that new configuration shall be used. The application creates new tables of the configuration and then sets the numberNormalisationTableSync to PASSIVE when it is ready. When numberNormalisationTableSync is SYNCHRONIZING, no configuration is allowed in the Number Normalization. It is not allowed to set the table sync parameter to SYNCHRONIZING more frequently than every 15 seconds. Note that a user cannot set the value to PASSIVE. It can only be set to PASSIVE by the application itself.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumberNormalisation  

 

class NumNormContext

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormContext


The NumNormContext MO serves as a structural MO for context data

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormContext
NumNormContext key, defines the name of the context.
NumNormString0to00064DT
numNormContextNsnIndex
Defines the string for the index to the NSN data. The string must be set to the same value as the numNormNsnDataIndex attribute in the NumNormNsnData MO.
NumNormString0to00064DT
numNormContextOsnIndex
Defines the string for the index to the OSN data. The string must be set to the same value as the numNormOsnDataIndex attribute in the NumNormOsnData MO.
NumNormString1to00255DT
mandatory
numNormContextRule
Defines the string of the context rules consisting of a '+' sign followed by digits or a domain name.
NumNormString0to00032DT
numNormContextSubAreaCode
Defines the string ($AC) for the area code(AC) that must be added to the local number as part of the substitution expression. For a local number, the substitution expression will prepend +CC$AC to it during normalization. Example: $AC=8 for Stockholm.
NumNormString0to00064DT
numNormContextSubRulesIndex
Defines the string for the index to the substitution rules. The string must be set to the same value as the numNormSubstitutionRuleIndex attribute in the NumNormSubstitutionRule MO.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormContext  

 

class NumNormDefaultContext

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormDefaultContext


NumNormDefaultContext MO serves as a structural MO for
default context data

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormDefaultContext
NumNormDefaultContext key. The default context is only used if no other context is found within the same profile.
NumNormString0to00032DT
numNormDefaultCountryCode
The DefaultCountryCode is a string that will replace the variable $CC in the substitution rule. Note that the variable $CC can only be present in rules used by a DefaultContext.
NumNormString0to00064DT
numNormDefaultDenormalizationSubRulesIndex
Defines the string for the index to the substitution rules for number denormalization. The string must be set to the same value as the numNormDenormalizationSubstitutionRuleIndex attribute in the NumNormDenormalizationSubstitutionRule MO.

NumNormString0to00032DT
numNormDefaultInternationalDiallingPrefix
This value is a string that will replace the variable $IDP in the substitution rule. Note that the variable $IDP can only be present in rules used by a DefaultContext.
NumNormString0to00032DT
numNormDefaultNationalDiallingPrefix
This value is a string that will replace the variable $NDP in the substitution rule. Note that the variable $NDP can only be present in rules used by a DefaultContext.
NumNormString0to00064DT
numNormDefaultNsnIndex
Defines the string for the index to the NSN data. The string must be set to the same value as the numNormNsnDataIndex attribute in the NumNormNsnData MO.
NumNormString0to00064DT
numNormDefaultOsnIndex
Defines the string for the index to the OSN data. The string must be set to the same value as the numNormOsnDataIndex attribute in the NumNormOsnData MO.
NumNormString0to00064DT
numNormDefaultSubRulesIndex
Defines the string for the index to the substitution rules for number normalization. The string must be set to the same value as the numNormSubstitutionRuleIndex attribute in the NumNormSubstitutionRule MO.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormDefaultContext  

 

class NumNormDenormalizationSubstitutionRule

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormDenormalizationSubstitutionRule

NumNormDenormalizationSubstitutionRule MO serves as a structural MO for the number denormalization substitution rules data.

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormDenormalizationSubstitutionRule
NumNormDenormalizationSubstitutionRule key, defines the name of the number denormalization substitution rule.
NumNormSubstitutionString1to000255DT[0..128] nonUnique ordered
numNormDenormalizationSubstitutionRuleData
The numNormDenormalizationSubstitutionRuleData defines the substitution rule data for number denormalization and has the following format:

Order:Substitution-rule-expression:Terminal-match, where
Order is an unsigned integer and it defines which substitute rule is being matched first. The lowest number has the highest priority in matching.

Subsitution-rule-expression is a POSIX 1003.2 extended regular expression. The regular expression is encapsulated with a starting "/" and an ending "/".

Terminal-match is a boolean flag indicating if the expression is terminal or not. If terminal-match, the matching results will be returned directly; otherwise, further matching will be performed.

Valid input expression: "(0|[1-9][0-9]*):/.*/:(true|false)"

Example:
0: /^\$PC(.*)$/\1/:TRUE
If the number begins with $PC, delete $PC from the number.
E.g. +46812345 will become 12345 if $PC=+468.
1: /^\$CC(.*)$/$NDP\1/:TRUE
If the number begins with $CC, replace $CC with $NDP.
E.g. +461812345 will become 01812345 if $CC=+46 and $NDP=0.
2: /^\+(.*)$/$IDP\1/:TRUE
If the number begins with +, replace + with $IDP. E.g. the number +8612345 will become 008612345 if $IDP=00, where $PC is the phone-context; $CC is the country code; $NDP is the national dialing prefix; $IDP is the international dialing prefix.
NumNormString0to00064DT
numNormDenormalizationSubstitutionRuleIndex
Defines the string for the index to the number denormalization substitution rules. The string must be set to the same value as the numNormDefaultDenormalizationSubRulesIndex attribute in the NumNormDefaultContext MO.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormDenormalizationSubstitutionRule  

 

class NumNormNsnData

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormNsnData


NumNormNsnData MO serves as a structural MO for national
significant number(NSN) data

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormNsnData
NumNormNsnData key, defines the name of the NsnData.
NumNormString0to00064DT
numNormNsnDataIndex
Defines the string for the index to the NSN data. The string must be set to the same value as the numNormContextNsnIndex attribute in the NumNormContext MO.
NumNormDataString1to00128DT[0..255] nonUnique ordered
numNormNsnDataNumbers
Defines an array of 255 possible NSN numbers associated with a country (or profile). The NSN are significant to all contexts.

0: NSN context=+CC or domain name
1: NSN Num#1
2: NSN Num#2
...
n: NSN Num#n

The first string defines the context to be associated with the returned local number format NSN number. If the NSN number was in global format then no context is associated. The context is followed by a list of NSN numbers. Num: can contain two types of data. Either a simple regular expression or a substitution rule. The simple regular expression always matches the complete number by internally prepending "^" and appending "$" to the configured expression. Substitution rules are configured according to numNormSubstitutionRuleData except that no variables can be used.

Valid input expression: "(0|[1-9][0-9]*):.*"

Examples:
1: 112.* Match anything beginning with 112
2: \+46133 Match the global number +46133
3: /^0046133$/+46133/ Match 0046133 and substitute 00 with +
4: .{3} Match any 3 digit number
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormNsnData  

 

class NumNormOsnData

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormOsnData


NumNormOsnData MO serves as a structural MO for operator
specific number(OSN) data

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormOsnData
NumNormOsnData key, defines the name of the Osn data context.
NumNormDataString1to00128DT[0..255] nonUnique ordered
numNormOsnDataContextAndNumbers
Defines an array of 255 possible OSN numbers.

0: OSN context0
1: OSN Num#1
2: OSN Num#2
...
n: OSN Num#n

The first string defines the context to be associated with the returned local number format OSN number. If the OSN number was in global format then no context is associated. The context is followed by a list of OSN numbers. Num: can contain two types of data. Either a simple regular expression or a substitution rule. The simple regular expression always matches the complete number by internally prepending "^" and appending "$" to the configured expression. Substitution rules are configured according to numNormSubstitutionRuleData except that no variables can be used.

Valid input expression: "(0|[1-9][0-9]*):.*"

Examples:
1: 112.* Match anything beginning with 112
2: \+46133 Match the global number +46133
3: /^0046133$/+46133/ Match 0046133 and substitute 00 with +
4: .{3} Match any 3 digit number
NumNormString0to00064DT
noNotification
numNormOsnDataIndex
Defines the string for the index to the OSN data. The string must be set to the same as in the numNormContextOsnIndex attribute in the NumNormContext MO.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormOsnData  

 

class NumNormProfile

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormContext [0..1000]
+-NumNormDefaultContext [0..1]
+-NumNormDenormalizationSubstitutionRule [0..255]
+-NumNormNsnData [0..255]
+-NumNormOsnData [0..255]
+-NumNormSubstitutionRule [0..255]


The NumNormProfile MO serves as a structural MO for profile data.
255 possible profiles may be configured. A NumNormProfile can have
maximum 1000 underlying objects (sum of all types): NumNormContext,
NumNormSubstitutionRule, NumNormOsnData, NumNormNsnData.

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormProfile
NumNormProfile key, defines the name of the profile.
NumNormString0to00128DT[0..128] nonUnique ordered
numNormProfileContext
Defines an array of 128 possible contexts associated with a profile set up. The numNormProfileContext attribute consists of an array of strings defining the Country Code (CC), Country-Code Top-level Domain (ccTLD), or nth Level Domain (nthLD) name. (If using stockholm.ericsson.se, then .se is the ccTLD and stockholm.ericsson.se is the nthLD, where n=3). If a phone-context is present in the input URI then the CC, nthTLD, or ccTLD is used to search the profile context values to decide if this is the profile to use. If no phone-context is present in the input URI, then nthLD name or ccTLD in the provided context is used to search the profile context values to decide if this is the profile to use. No two profiles may have the same CC, nthLD, or ccTLD.
NumNormString0to00128DT[0..128] nonUnique ordered
numNormProfileDomNameEr
Defines an array of up to 128 domain names for which user=phone error correction is applicable. The user=phone error correction is applied only if the numNormProfileUserEqPhoneEr parameter is set. Examples: operator1.com, +468
NumNormString0to00032DT
numNormProfileName
Defines the profile name in a string for which the Number Normalization data will be defined.
NumNormInsertUserEqualPhoneDT
numNormProfileUserEqPhoneEr = DO_NOT_ADD_USER_PHONE
The numNormProfileUserEqPhoneEr attribute defines if the Number Normalization function inserts user=phone parameter if it is missing in the received SIP URI. If set, user=phone parameter is inserted. This attribute is valid only for the configured list of domain names given by numNormProfileDomNameEr.
NumNormString0to00128DT
noNotification
numNormProfileWarningText
[Deprecated and will be removed later when possible] This attribute should not be used. Defines the warning text string that defines the nature of the Number Normalization failure. The XDMS uses this to inform the user of the nature of the failure.


Obsolete: 

uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormProfile  

 

class NumNormSubstitutionRule

ManagedElement
+-CscfFunction
+-NumberNormalisation
+-NumNormProfile
+-NumNormSubstitutionRule


NumNormSubstitutionRule MO serves as a structural MO for
substitution rules data

Attributes
uint32
noNotification
groupId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator.
NumNormstring1to00256DT
key
mandatory
noNotification
restricted
numNormSubstitutionRule
NumNormSubstitutionRule key, defines the name of the substitution rule.
NumNormSubstitutionString1to000255DT[0..128] nonUnique ordered
numNormSubstitutionRuleData
The numNormSubstitutionRuleData defines the substitution rule data and has the following format:
Order:Substitution-rule-expression:Terminal-match, where

Order is an unsigned integer and it defines which substitute rule is being matched first. The lowest number has the highest priority in matching.

Subsitution-rule-expression is a POSIX 1003.2 extended regular expression. The regular expression is encapsulated with a starting "/" and an ending "/".

Terminal-match is a boolean flag indicating if the expression is terminal or not. If terminal-match, the matching results will be returned directly; otherwise, further matching will be performed.

Valid input expression: "(0|[1-9][0-9]*):/.*/:(true|false)"

Example: Terminal regular expressions for local, national, and international number. The $AC variable is used for the local numbers only:
0: /^00(.*)$/+\1/ :TRUE
If the number starts with '00', replace '00' with '+';
1: /^0(.*)$/+46\1/:TRUE
If the number starts with '0', replace '0' with '+46';
2: /^(.*)$/+46$AC\1/:TRUE
Otherwise prepend '+46$AC', where $AC = numNormContextSubAreaCode for the matching NumNormContext.

Example: Terminal regular expressions for OSN number:
0:/^123;phone-context=OSN Domain(.*)$/+\1/:FALSE
If number starts with '123', replace '123' with '123;Phone-context=OSN Domain'.
NumNormString0to00064DT
numNormSubstitutionRuleIndex
Defines the string for the index to the substitution rules. The string must be set to the same value as the numNormContextSubRuleIndex attribute in the NumNormContext MO.
uint32
noNotification
ownerId = 0
Independently from the permissions, this attribute can always be modified by the MO
owner and by the Super Administrator
integer
noNotification
permissions = 9
The operations allowed for the group members and for other administrators are represented
as a bitmap: groupRead(1), groupUpdate(2), groupManage(4), otherRead(8), otherUpdate(16),
otherManage(32). Read permission means to read the MO attributes and to see the children of the MO;
write permission allows to modify the MO attributes and manage permission allows to create and
delete children of the MO. The owner of the MO has all the permissions. The attribute can only be
modified by the owner of the MO or by the Super Administrator. By default, the MO is created with the
permissions determined by the defaultPermissions attribute of the owner administrator.
DN
noNotification
shareTree = nodeName=jambala
This attribute refers to a container object and implies that all administrators defined
under this shareTree value have the privileges set as share permissions over the container and its leaf object. Obsolete, must not be used.

  class NumNormSubstitutionRule  

 

class PasswordPolicy

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

Configures properties of password policy.

References from:
UserAccount;
References to:
ManagedObject; PasswordQuality;
Attributes
SecLA_PasswordPolicy_expireWarning[0..1]
expireWarning = 7
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.
SecLA_PasswordPolicy_failureCountInterval[0..1]
failureCountInterval = 1800
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.
SecLA_PasswordPolicy_historyLength[0..1]
historyLength = 12
Specifies the number of passwords remembered by the ME to avoid the reuse of old passwords.

No value means old passwords are not recorded.
SecLA_PasswordPolicy_lockoutDuration[0..1]
lockoutDuration
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.
SecLA_PasswordPolicy_maxAge[0..1]
maxAge = 90
Password maximum age in days.

Specifies the number of days after a password is considered expired. No value means passwords never expire.
SecLA_PasswordPolicy_maxFailure[0..1]
maxFailure = 3
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.
SecLA_PasswordPolicy_minAge[0..1]
minAge = 15
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.
SecLA_PasswordPolicy_minLength
minLength = 10
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 PasswordPolicy  

 

class PasswordQuality

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

Configures the dimensions of password quality checking.

References from:
AdministratorAccount; PasswordPolicy;
References to:
ManagedObject;
Attributes
SecLA_PasswordQuality_minDigit[0..1]
minDigit
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.
SecLA_PasswordQuality_minLower[0..1]
minLower
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.
SecLA_PasswordQuality_minOther[0..1]
minOther
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.
SecLA_PasswordQuality_minPoints
minPoints = 3
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.
SecLA_PasswordQuality_minUpper[0..1]
minUpper
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 PasswordQuality  

 

class PcscfNetworkInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-PcscfNwIfs
+-PcscfNetworkInterface
+-PcscfRfc2543Compatibility [0..1]

This is Managed Object Class for P-CSCF Network Interface

Attributes
boolean
pcscfDisableConnectionOrientedTransportLoadDist = false
If set to true, the CSCF will reuse open TCP connections, if any, when sending requests to the UE's server port. This feature is configured on the terminating P-CSCF interface and is limited to the terminating P-CSCF TCP port only.

Deprecated: 

String0to65535DT
key
mandatory
noNotification
restricted
pcscfNetworkInterfaceEntry
This attribute defines the network interface the P-CSCF uses to receive and send SIP traffic. The P-CSCF must be configured with at least two UDP interfaces, one interface for Gm traffic between the UE and the P-CSCF, the other for Mw traffic between the P-CSCF and the I/S-CSCF. Optionally a protected IPSec interfaces can be added as well. It is also possible to create TCP interfaces of all the above mentioned types of interfaces. If this is done they need to be configured with the same ports, traffic direction and IP-addresses as the corresponding UDP interface. Maximum one UDP and one TCP interface per interface type (Gm and Mw) can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
Note: A prerequisite for adding this network interface is that the PcscfDomainNameEntry already has been configured with at least one domain.


Dependencies: PcscfDomainNameEntry must be configured with at least one domain.
PcscfNwIfProtectionDT
pcscfNetworkInterfaceProtection = None
This attribute defines which sort of protection to be used for the interface.


Dependencies: If the parameter is set to None, PcscfPcPortEntry can not be configured. If the parameter is set to IPSec, 3 PcscfPcPortEntry have to be configured for the interface.
NetworkInterfaceStatusDT[0..1]
readOnly
pcscfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
NetworkInterfaceTrafficDirDT[0..1]
pcscfNetworkInterfaceTrafficDir
This attribute defines if this interface is used for originating or terminating traffic. The value of this parameter can only be set when the PcscfNetworkInterfaceEntry is created. If changes are needed the PcscfNetworkInterfaceEntry needs to be removed and added again.
PcPortEntryDT[0..] nonUnique ordered
pcscfPcPortEntry
The port numbers to be used for the client ports.
String0to00010DT[0..] nonUnique ordered
readOnly
pcscfPcPortStatusEntry
This parameter specifies the status for a certain client port in an IPSec interface. The list can only be displayed for interfaces where PcscfNetworkInterfaceProtection parameter is set to "IPSec". The value "N/A" is shown when PcscfNetworkInterfaceProtection is not set to "IPSec".

The format is &lt;Port-nr&gt;:&lt;status&gt;, where status is one of:
0 = OK
1 = No traffic direction set
2 = Port already in use
3 = Port open failed
4 = Partial failure
5 = Policy error
PsPortStatusDT[0..1]
readOnly
pcscfPsPortStatus
This parameter specifies the status for the ps-port in an IPSec interface.

  class PcscfNetworkInterface  

 

class PcscfNwIfs

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-PcscfNwIfs
+-PcscfNetworkInterface [0..]

This is Managed Object Class for P-CSCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
pcscfNwIfContainerKey
This is key attribute of PcscfNwIfs Managed Object Class

  class PcscfNwIfs  

 

class PcscfRfc2543Compatibility

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-PcscfNwIfs
+-PcscfNetworkInterface
+-PcscfRfc2543Compatibility

This is Managed Object Class for P-CSCF RFC 2543 Compatibility

This MO is created by the system.

Attributes
boolean
pcscfDisableMsgLargerThanMtuUdpFallback = false
If set to true, the CSCF will not fall back from TCP to UDP in case TCP was selected because the message was larger than MTU. Note: This is the only fallback case that will be disabled when changing this parameter. The CSCF will still fall back from TCP to UDP in other cases, for example, if the DNS returns both TCP and UDP destinations. This feature is configured on the terminating P-CSCF interface and is therefore limited to the P-CSCF Gm port only.
String1to00256DT
key
mandatory
noNotification
restricted
pcscfRfc2543CompatibilityKey
This entry is created automatically for all TCP terminating P-CSCF interfaces. It will not have any effect if created manually for a non-terminating P-CSCF interface. String is representing a 3 part key in the form: Protocol:address:port

Protocol : address
Address: an IPv4 dotted decimal address or a fully qualified domain name
Port: 1024 - 49151.

  class PcscfRfc2543Compatibility  

 

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 Phase2Policy  

 

class Pm

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

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


This MO is created by the system.

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

  class Pm  

 

class PmGroup

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

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


This MO is created by the system.

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


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

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


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

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

  class PmGroup  

 

class PmJob

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

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

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

  class PmJob  

 

class PmMeasurementCapabilities

ManagedElement
+-SystemFunctions
+-Pm
+-PmMeasurementCapabilities

Contains the measurement capabilities of the ME.

This MO is created by the system.

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


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

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


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

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

  class PmMeasurementCapabilities  

 

class PmThresholdMonitoring

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

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

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

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

  class PmThresholdMonitoring  

 

class Role

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

Authorization roles that may be assigned to users.

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


This MO is created by the system.

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

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

  class Role  

 

class 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 Role  

 

class RoleUpgrade

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

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

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

  class RoleUpgrade  

 

class Rule

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

The rules that define the access control to objects.

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


This MO is created by the system.

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

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

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

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

Examples:

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

  class Rule  

 

class Schema

ManagedElement
+-SystemFunctions
+-SysM
+-Schema

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

This MO is created by the system.

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

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

Parameters

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


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

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

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

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

  class Schema  

 

class ScscfChargingAsInvolvementTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingAsInvolvementTriggerClass

This class contains all the attributes related to the S-CSCF Charging AS Involvement Trigger

Attributes
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingAsInvolvementTrigger
Defines the trigger name, in the format &lt;triggerName&gt;:&lt;groupId&gt;.
boolean
scscfChargingAsInvolvementTriggerConditionNegated = false
Defines if this instance of the ScscfChargingAsInvolvement is negated.

  class ScscfChargingAsInvolvementTriggerClass  

 

class ScscfChargingClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass [0..1]
+-ScscfChargingTriggersClass [0..1]

This is Managed Object Class for S-CSCF Charging

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfCharging
This is the key attribute of the ScscfChargingClass class. One instance of the ScscfChargingClass with the key scscfCharging=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.

  class ScscfChargingClass  

 

class ScscfChargingProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfChargingTransactionInfoClass [0..1]
+-ScscfOfflineChargingProfileClass [0..1]
+-ScscfOnlineChargingProfileClass [0..1]

This is Managed Object Class for S-CSCF Charging Profile

Attributes
ChargingCaseScscfDT
scscfChargingCase = NoCharging
Defines how a node must use the CDF (offline) and OCS (online) addresses that a user is provisioned with.
String1to00256DT
key
mandatory
noNotification
restricted
scscfChargingProfile
Key attribute defines the name of the Charging Profile. Defines a reference to the corresponding charging trigger for this profile.

  class ScscfChargingProfileClass  

 

class ScscfChargingProfilesClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass [0..]

This is Managed Object Class for S-CSCF Charging Profiles

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfChargingProfiles
This is key attribute for ScscfChargingProfilesClass

  class ScscfChargingProfilesClass  

 

class ScscfChargingRequestUriTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingRequestUriTriggerClass

This class contains all the attributes related to S-CSCF Charging Request URI Trigger

Attributes
String0to00128DT[0..1]
scscfChargingRequestUri
Defines the content of the request URI to be part of the charging trigger evaluation.
Format: /.regexp/
String0to00128DT
key
mandatory
noNotification
restricted
scscfChargingRequestUriTrigger
This is the key attribute of ScscfChargingRequestUriTriggerClass.

Dependencies: This key attribute has format: <triggerName>:<groupId>:<requestUriId>, where the first part of the key <triggerName>:<groupId> must match the key attribute of the parent Managed Object Class ScscfChargingTriggerGroupClass
boolean
scscfChargingRequestUriTriggerConditionNegated = false
Defines if this instance of the ScscfChargingRequestUri is negated.

  class ScscfChargingRequestUriTriggerClass  

 

class ScscfChargingRoamingStatusTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingRoamingStatusTriggerClass

This class contains all the attributes related to S-CSCF Charging Roaming Status Trigger

Attributes
ChargingRoamingStatusDT[0..1]
scscfChargingRoamingStatus
Defines which roaming condition of the UE the charging trigger may match.
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingRoamingStatusTrigger
Defines the trigger name, in the format &lt;triggerName&gt;:&lt;groupId&gt;.
boolean
scscfChargingRoamingStatusTriggerConditionNegated = false
Defines if this instance of the ScscfChargingRoamingStatus is negated.

  class ScscfChargingRoamingStatusTriggerClass  

 

class ScscfChargingSessionCaseTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingSessionCaseTriggerClass

This class contains all the attributes related to S-CSCF Charging Session Case Trigger

Attributes
ChargingSessionCaseDT[0..1]
scscfChargingSessionCase
Defines which session case (originating or terminating) the charging trigger may match.
String0to00128DT
key
mandatory
noNotification
restricted
scscfChargingSessionCaseTrigger
Defines the trigger name.
Format: &lt;triggerName&gt;:&lt;groupId&gt;
boolean
scscfChargingSessionCaseTriggerConditionNegated = false
Defines if this instance of the ScscfChargingSessionCase is negated.

  class ScscfChargingSessionCaseTriggerClass  

 

class ScscfChargingSipHeaderTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingSipHeaderTriggerClass

This is Managed Object Class for S-CSCF Charging SIP Header Trigger

Attributes
String0to00128DT[0..1]
scscfChargingSipHeader = ""
Defines the SIP header to be part of the charging trigger evaluation.
Format: "sipHeader".
String0to02048DT[0..1]
scscfChargingSipHeaderContent = ""
The regular expression for matching the SIP header content.
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingSipHeaderTrigger
Defines the trigger name, in the format &lt;triggerName&gt;:&lt;groupId&gt;:&lt;SipHeader&gt;.
boolean
scscfChargingSipHeaderTriggerConditionNegated = false
Defines if this instance of the ScscfChargingSipHeader is negated.

  class ScscfChargingSipHeaderTriggerClass  

 

class ScscfChargingSipMethodTriggerClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingSipMethodTriggerClass

This is Managed Object Class for S-CSCF Charging SIP Method Trigger

Attributes
ChargingSipMethodScscfDT[0..1]
scscfChargingSipMethod = ""
Trigger condition based on the method in the SIP request. This must match before evaluating other point triggers.
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingSipMethodTrigger
Defines the trigger name, in the format &lt;triggerName&gt;:&lt;groupId&gt;:&lt;sipMethod&gt;.
boolean
scscfChargingSipMethodTriggerConditionNegated = false
Defines if this instance of the ScscfSipMethod is negated.

  class ScscfChargingSipMethodTriggerClass  

 

class ScscfChargingTransactionInfoClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfChargingTransactionInfoClass
+-ScscfChargingTransactionTypeClass [0..1]

This is Managed Object Class for S-CSCF Charging Transaction Info

Attributes
String1to00100DT
key
mandatory
noNotification
restricted
scscfChargingTransactionInfo
Key attribute defines the name of the Charging Profile. Defines a reference to the corresponding transaction information for this profile.

  class ScscfChargingTransactionInfoClass  

 

class ScscfChargingTransactionTypeClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfChargingTransactionTypeClass
ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfChargingTransactionInfoClass
+-ScscfChargingTransactionTypeClass

This is Managed Object Class for S-CSCF Charging Transaction Type

Attributes
String0to00256DT[0..] nonUnique ordered
scscfChargingTransactionDataRequestEntry
This parameter is used for specifying the Header field name to be matched in a SIP Request (for example User-Agent). The value of the matched Header will be included as part of applicable ACR and CCR.
String0to00256DT[0..] nonUnique ordered
scscfChargingTransactionDataResponseEntry
This parameter is used for specifying the Header field name to be matched in a SIP Response (for example Contact). The value of the matched Header will be included as part of applicable ACR and CCR.
String1to00100DT
key
mandatory
noNotification
restricted
scscfChargingTransactionType
This parameter specifies what kind of transaction type is of interest, for example, SIP or Diameter. This release supports SIP as the only transaction type. Format: &lt;profileName&gt;:SIP

  class ScscfChargingTransactionTypeClass  

 

class ScscfChargingTriggerGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass
+-ScscfChargingAsInvolvementTriggerClass [0..1]
+-ScscfChargingRequestUriTriggerClass [0..1]
+-ScscfChargingRoamingStatusTriggerClass [0..1]
+-ScscfChargingSessionCaseTriggerClass [0..1]
+-ScscfChargingSipHeaderTriggerClass [0..1]
+-ScscfChargingSipMethodTriggerClass [0..]

This is Managed Object Class for S-CSCF Charging Trigger Group

Attributes
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingTriggerGroup
This is the key attribute of ScscfChargingTriggerGroupClass.

Dependencies: The value should be in the format [triggerName]:[groupId]

  class ScscfChargingTriggerGroupClass  

 

class ScscfChargingTriggerGroupsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass
+-ScscfChargingTriggerGroupClass [0..1]

This is Managed Object Class for S-CSCF Charging Trigger Groups

Attributes
String0to01024DT
mandatory
scscfChargingProfileName
The parameter defines a reference to the corresponding AVP profile for this charging trigger.
boolean
scscfChargingTriggerConditionTypeCNF = false
Defines how the charging triggers expressions are logically linked.
true: linked by OR false: linked by AND.
String1to01024DT
key
mandatory
noNotification
restricted
scscfChargingTriggerName
The parameter identifies an individual trigger.
Integer0to01024DT
scscfChargingTriggerPriority = 1024
Defines the order in which triggers are evaluated. For a given request the highest priority trigger is evaluated first. Every trigger has to have different priority.

  class ScscfChargingTriggerGroupsClass  

 

class ScscfChargingTriggersClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingTriggersClass
+-ScscfChargingTriggerGroupsClass [0..]

This is Managed Object Class for S-CSCF Charging Triggers

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfChargingTriggers
This is key attribute of ScscfChargingTriggersClass

  class ScscfChargingTriggersClass  

 

class ScscfIfcClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfSharedIfcClass
+-ScscfIfcClass
+-ScscfSptGroupClass [0..]

This is Managed Object Class for S-CSCF IFC

Attributes
IfcAsNameDT
mandatory
scscfIfcAsName
This parameter captures the address of the Application Server (AS) in the SIP-URI format and must include "lr" parameter indicating loose routing. It is used for routing to the AS when iFC criteria is matched during traffic.
boolean
scscfIfcConditionTypeCNF = true
This parameter specifies if the Conjunctive Normal Form (CNF) is used for this iFC. When set to true, CNF is applied otherwise Disjunctive Normal Form (DNF) is used. The default value is true.
IfcDefaultHandlingDT
scscfIfcDefaultHandling = SESSION_CONTINUED
This parameter determines whether the dialogue should be released if the Application Server could not be reached. It can take on either SESSION_CONTINUED or SESSION_TERMINATED as value. The default value is SESSION_CONTINUED.
boolean
scscfIfcEnabled = true
This parameter captures the state of the iFC. When disabled (false), this iFC is ignored during traffic.
boolean
scscfIfcIncludeRegisterRequest = false
This parameter indicates whether the S-CSCF is to include the incoming REGISTER request in the body of the 3rd party REGISTER to the Application Server if Shared iFC is enabled and if the trigger of the Shared iFC is matched. When the ScscfIfcIncludeRegisterRequest is true, the REGISTER request received by S-CSCF will be included in the message body of the 3rd party REGISTER request and the configuration parameter CscfUseUserContactIn3rdpartyReg will lose effectiveness. When it is false, the register request is not included in the 3rd party REGISTER request.
boolean
scscfIfcIncludeRegisterResponse = false
This parameter indicates whether the S-CSCF is to include the 200 OK response to the incoming REGISTER request in the body of the 3rd party REGISTER to the Application Server if Shared iFC is enabled and if the trigger of the Shared iFC is matched. When the ScscfIfcIncludeRegisterResponse is true, the response for the REGISTER request will be included in the message body in the 3rd party REGISTER request and the configuration parameter CscfUseUserContactIn3rdpartyReg will lose effectiveness. When it is false, the response is not included in the 3rd party REGISTER request.
String1to01024DT
key
mandatory
noNotification
restricted
scscfIfcName
This parameter identifies a locally defined Initial Filter Criteria.
IfcPriorityDT
mandatory
scscfIfcPriority
This parameter captures the priority of the iFC. The priorities of all iFC instances associated with a given SiFC set must be unique.

  class ScscfIfcClass  

 

class ScscfNetworkInterface

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-ScscfNwIfs
+-ScscfNetworkInterface

This is Managed Object Class for S-CSCF Network Interface

Attributes
NetworkInterfaceDT
key
mandatory
noNotification
restricted
scscfNetworkInterfaceEntry
This attribute defines the network interface the S-CSCF uses to receive and send SIP traffic. To add an interface the parameter CscfISPBehavior must also first be set to a behavior that support this interface. One UDP transport address with traffic direction Irrelevant is mandatory for the CscfISPOperationalState parameter to become ENABLED and domain name entries must be in the internal DNS table as well. A TCP transport address can optionally be added but must be configured with the same port-nr, traffic direction and IP-address as the UDP interface for CscfISPOperationalState to become ENABLED. One IPv4 and/or one IPv6 address can be specified for each transport type. Maximum one UDP and one TCP interface per IP address type (IPv4 and IPv6) can be added. It is required to put the node in locked state when removing network interface entries. However, it is not required to put the node in locked state when adding network interface entries.
Note: A prerequisite for adding this network interface is that the ScscfDomainNameEntry already has been configured with at least one domain.
Note: A prerequisite for specifying an IPv6 address is that the parameter CscfHostportAsFqdnOnly is set to true.
NetworkInterfaceStatusDT[0..1]
readOnly
scscfNetworkInterfaceStatus = NO_TRAFFIC_DIRECTION_SET
This attribute indicates the current status of the network interface.
Note: The value NO_TRAFFIC_DIRECTION_SET indicates the initial state. Although the function of assigning traffic direction has been deprecated, for backwards compatibility reason, this value is kept.

  class ScscfNetworkInterface  

 

class ScscfNodeDefaultIfc

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfNodeDefaultIfc

The class contains the configuration parameters required for the node default IFC feature.

This MO is created by the system.

Attributes
boolean
noNotification
scscfNodeDefaultIfcEnabled = false
This parameter defines if S-CSCF is configured to support Node Default Ifc feature. When enabled the feature Node Default Ifc is executed during the traffic.
String0to65535DT
key
mandatory
noNotification
restricted
scscfNodeDefaultIfcId
This is the key attribute of the ScscfNodeDefaultIfc. This instance cannot be deleted.
DefaultNodeSifcDT[0..1]
scscfNodeDefaultSifcSet = ""
This parameter captures the Shared IFC set Id belonging to Node Default IFC feature.

  class ScscfNodeDefaultIfc  

 

class ScscfNwIfs

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfNwIfContainer
+-ScscfNwIfs
+-ScscfNetworkInterface [0..]

This is Managed Object Class fro S-CSCF Network Interfaces

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfNwIfContainerKey
This is key attribute of ScscfNwIfs Managed Object Class

  class ScscfNwIfs  

 

class ScscfOfflineChargingAVPsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingCauseClass [0..1]
+-ScscfOfflineChargingEricssonServiceInformationClass [0..1]
+-ScscfOfflineChargingEventTypeClass [0..1]
+-ScscfOfflineChargingInterOperatorIdentifierClass [0..1]
+-ScscfOfflineChargingSDPMediaComponentClass [0..1]
+-ScscfOfflineChargingServiceInformationClass [0..1]
+-ScscfOfflineChargingSIPReasonClass [0..1]
+-ScscfOfflineChargingSubscriptionIdClass [0..1]
+-ScscfOfflineChargingTimeStampsClass [0..1]

This is Managed Object Class for S-CSCF Offline Charging AVPs

This MO is created by the system.

Attributes
String0to00070DT
scscfOfflineChargingAccessNetworkInformation = start=false;interim=false;stop=true;event=false;cache=false
Access-Network-Information AVP, code 1263.

start=true;interim=true;stop=true;event=true;cache=The Cache parameter is deprecated.
Only cache=false is valid.
Each possible ACR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingAVP
The name of the Profile.
String0to00070DT
scscfOfflineChargingCalledAssertedIdentity = start=false;interim=false;stop=false;event=false
The Called-Asserted-Identity AVP (AVP code 1250) holds the SIP URI and/or TEL URI.

start=true;interim=true;stop=true;event=true.
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingCalledPartyAddress = start=true;interim=true;stop=true;event=true
Called-Party-Address AVP, code 832.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingCallingPartyAddress = start=true;interim=true;stop=true;event=true
The Calling-Party-Address AVP (AVP code 831) holds the addresses (SIP URI and/or TEL URI) which identifies the party (Public User Identity or Public Service Identity) initiating a SIP transaction.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingCarrierSelectRoutingInfo = start=false;interim=false;stop=false;event=false
This parameter controls whether the Carrier Select Routing Information AVP, code 2023, is sent in the charging records.

start=true;interim=true;stop= true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingEventNTPTimestamp = start=false;interim=false;stop=false;event=false
Event-NTP-Timestamp AVP, code 340.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingEventTimestamp = start=true;interim=true;stop=true;event=true
Event-Timestamp AVP, code 55.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingGPRSRoamingStatus = start=false;interim=false;stop=false;event=false
GPRS-Roaming-Status AVP, code 333.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingImsChargingIdentifier = start=true;interim=true;stop=true;event=true
IMS-Charging-Identifier AVP, code 841.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingNumberPortabilityRoutingInfo = start=false;interim=false;stop=false;event=false
This parameter controls whether the Number Portability Routing Information AVP, code 2024, is sent in the charging records.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingRoleOfNode = start=true;interim=true;stop=true;event=true
Role-of-Node AVP, code 829.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSDPSessionDescription = start=true;interim=true;stop=true;cache=false
SDP-Session-Description AVP, code 842.

start=true;interim=true;stop=true;cache=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingServedPartyIpAddress = start=true;interim=true;stop=true;event=true
Served-Party-IP-Address AVP, code 848. This AVP only appears in this ACR generated from the originating S-CSCF.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSIPRingingTimestamp = start=false;interim=false;stop=false
SIP-Ringing-Timestamp AVP, code 338.

start=true;interim=true;stop=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingUserName = start=true;interim=true;stop=true;event=true
User-Name AVP, code 1.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingUserSessionId = start=true;interim=true;stop=true;event=true
User-Session-Id AVP, code 830.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingAVPsClass  

 

class ScscfOfflineChargingCauseClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingCauseClass

This is Managed Object Class for S-CSCF Offline Charging Cause

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingCause
The name of the Profile.
String0to00070DT
scscfOfflineChargingCauseCode = stop=true;event=true
Cause-Code AVP, code 861. Related with ScscfOfflineChargingNodeFunctionality.

stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingNodeFunctionality = stop=true;event=true
Node-Functionality AVP, code 862. Related with ScscfOfflineChargingCauseCode.

stop=true;event=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingCauseClass  

 

class ScscfOfflineChargingEricssonServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingEricssonServiceInformationClass

This is Managed Object Class for S-CSCF Offline Charging Ericsson Service Information

This MO is created by the system.

Attributes
String0to00070DT
scscfOfflineChargingAuthenticationMethod = start=false;interim=false;stop=false;event=false
This parameter controls whether the Authentication-Method AVP, code 1261, is sent in the charging records.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingCalledPartyOriginalAddress = start=false;interim=false;stop=false;event=false;cache=true
Called-Party-Original-Address AVP, code 286.

start=true;interim=true;stop=true;event=true;cache=true
The Cache parameter is deprecated. Only cache=true is valid. Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingDialAroundIndicator = start=false;interim=false;stop=false;event=false
This parameter controls whether the Dial-Around-Indicator AVP, code 1160, is sent in the charging records.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
ChargingOfflineDiscDirectionDT
scscfOfflineChargingDisconnectDirection = stop=false
Disconnect-Direction AVP, code 1305.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingEricssonServiceInformation
The name of the Profile.
String0to00070DT
scscfOfflineChargingImsServiceIdentification = start=false;interim=false;stop=false;event=false;cache=false
IMS-Service-Identification AVP, code 284.

start=true;interim=true;stop=true;event=true;cache=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSIPRequestTimestampFraction = start=false;interim=false;stop=false;event=false
This parameter defines the offline charging request types for which the SIP-Request-Timestamp-Fraction AVP has to be sent.

start=true;interim=true;stop=true;event=true
Each request type must have its value set to true or false.
String0to00070DT
scscfOfflineChargingSIPResponseTimestampFraction = start=false;interim=false;event=false
This parameter defines the offline charging request types for which the SIP-Response-Timestamp-Fraction AVP (code 2302) has to be sent.

start=true;interim=true;event=true
Each ACR record type must have its value set to true or false. The value stop=true/false is deprecated and ignored when present.
String0to00070DT
scscfOfflineChargingTransactionInfo = start=false;interim=false;stop=false;event=false
This parameter defines the offline charging request types for which the Transaction-Info/Transaction-Type/Transaction-Data-Name/Transaction-Data-Value AVPs has to be sent.

start=true;interim=true;stop=true;event=true
Each request type must have its value set to true or false.

  class ScscfOfflineChargingEricssonServiceInformationClass  

 

class ScscfOfflineChargingEventTypeClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingEventTypeClass

This is Managed Object Class for S-CSCF Offline Charging Event Type

This MO is created by the system.

Attributes
String0to00070DT
scscfOfflineChargingContentDisposition = start=true;interim=true;stop=true;event=true;cache=false
Content-Disposition AVP, code 828.

start=true;interim=true;stop=true;event=true;cache=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingContentLength = start=true;interim=true;stop=true;event=true;cache=false
Content-Length AVP, code 827.

start=true;interim=true;stop=true;event=true;cache=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingContentType = start=true;interim=true;stop=true;event=true;cache=false
Content-Type AVP, code 826.

start=true;interim=true;stop=true;event=true;cache=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingEvent = event=true
Event AVP, code 825.

event=true
Each possible ACR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingEventType
The name of the Profile.
String0to00070DT
scscfOfflineChargingSIPMethod = start=true;interim=true;stop=true;event=true;cache=false
SIP-Method AVP, code 824.

start=true;interim=true;stop=true;event=true;cache=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingEventTypeClass  

 

class ScscfOfflineChargingInterOperatorIdentifierClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingInterOperatorIdentifierClass

This is Managed Object Class for S-CSCF Offline Charging Inter-operator Identifier

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingInterOperatorIdentifier
The name of the Profile.
String0to00070DT
scscfOfflineChargingOriginatingIOI = start=true;interim=true;stop=true;event=true
Originating-IOI AVP, code 839.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingTerminatingIOI = start=true;interim=true;stop=true;event=true
Terminating-IOI AVP, code 840.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingInterOperatorIdentifierClass  

 

class ScscfOfflineChargingOmits

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingOmits
+-ScscfOfflineChargingOmitVendor [0..]

This class allows multiple instances of S-CSCF offline charging omit profile. This class is valid only for CSCF offline charging implementation according to 3GPP Release 12 (Variant-2).

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingOmitsId
This is the key attribute of class ScscfOfflineChargingOmits.
The key should be the same as the key for the parent class ScscfOfflineChargingProfile.


Dependencies: The same profileName as the parent ScscfOfflineChargingProfile
Takes effect: ChangeTypeRuntimeType – New Session

  class ScscfOfflineChargingOmits  

 

class ScscfOfflineChargingOmitVendor

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingOmits
+-ScscfOfflineChargingOmitVendor

This class allows configuration of an instance of an S-CSCF offline charging omit profile. The profile is keyed on a vendor ID and composed of a list of AVP codes defined by the associated vendor. The combination of the vendor ID and an AVP code in the profile uniquely identifies an AVP to be omitted, that is, not to be generated. This class is valid only for S-CSCF Variant-2 offline charging implementation. It is ignored in Variant-1 offline charging.

Attributes
DiameterAvpCodeDT[0..] ordered
scscfOfflineChargingOmitAVP
This is an attribute of class ScscfOfflineChargingOmitVendor which defines an omit profile in Variant-2. It is ignored in Variant-1 offline charging. This attribute specifies the code of an AVP to be omitted. The AVP which is uniquely identified by the AVP code together with the vendor ID in the omit profile is omitted and will not be generated by the S-CSCF in the ACR records.

Dependencies: This attribute must be defined within the ScscfOfflineChargingOmitVendor class identified with the desired vendor Id in key attribute scscfOfflineChargingOmitVendorId.
Takes effect: ChangeTypeRuntimeType – New Session
StringCscfOfflineOmitVendorIdDT
key
mandatory
noNotification
restricted
scscfOfflineChargingOmitVendorId
This is the key attribute of class ScscfOfflineChargingOmitVendor which defines an omit profile in Variant-2. It is ignored in Variant-1 offline charging. The value of this attribute contains a vendor ID string. All AVPs which are uniquely identified by the AVP codes together with the vendor ID in the omit profile are omitted and will not be generated by the S-CSCF in the ACR records.

Format: [profileName]:[vendorId] where [profileName] is the name of the S-CSCF offline charging profile and vendorId is a vendor ID. The combined string identifies an omit profile within the S-CSCF offline charging profile. The possible vendor ID value can be
- 0 for IETF Diameter
- 193 for Ericsson
- 10415 for 3GPP


Dependencies: The value should be in the format [profileName]:[vendorId]
Takes effect: ChangeTypeRuntimeType – Immediate (for new sessions)

  class ScscfOfflineChargingOmitVendor  

 

class ScscfOfflineChargingProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass [0..1]
+-ScscfOfflineChargingOmits [0..1]

This is Managed Object Class for S-CSCF Offline Charging Profile

Attributes
Fqdn0to1024orEmptyDT[0..1]
scscfChargingDefaultDestinationRealm
Defines the CDF realm address used in case no user profile with a CDF address is available.
boolean
scscfChargingEnabledCancel = false
This attribute determines if the CSCF generates a charging event for a CANCEL message.
boolean
noNotification
scscfChargingEnabledNon2xx = false
Note: This parameter is deprecated. Use ScscfOfflineChargingEnabled3xx and ScscfOfflineChargingEnabled4xx5xx6xx instead. This attribute determines if the CSCF generates a charging event related for a non 2XX final response.

Deprecated: 

PreferredPartyAddressDT[0..1]
scscfChargingPreferredCalledPartyAddress = noPrefer
Deprecated. This parameter is not used.

Deprecated: 

PreferredPartyAddressDT
scscfChargingPreferredCallingPartyAddress = both
Configure what information is preferred in Calling-Party-Address, SIP URI and/or TEL-URI. What is available is used if the preferred does not exist. Valid values: noPrefer, preferSIP, preferTEL, both

Deprecated: 

CallingPartyCallFwdDT
scscfOfflineChargingCallingPartyCallFwd = B_Party
This parameter is used in the session forward case and determines the output of the Calling-Party-Address AVP. Either the forwarding B-party or the original A-Party can be selected.
boolean
scscfOfflineChargingEnabled3xx = false
This attribute determines if the S-CSCF generates a charging event for a 3XX final response.
boolean
scscfOfflineChargingEnabled4xx5xx6xx = false
This attribute determines if the S-CSCF generates a charging event for a 4XX, 5XX and 6XX final response.
boolean
scscfOfflineChargingEnabledAuthenticationChallenge = true
This attribute determines if the S-CSCF generates an offline charging event for an authentication challenge of an originating request.
boolean
scscfOfflineChargingEnabledNonTimeBasedAcrInterim = true
An attribute to enable ACR[INTERIM] sent by S-CSCF due to re-INVITE and UPDATE request.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingProfile
The name of the Profile.
OfflineChargingProfileVariant
scscfOfflineChargingProfileVariant = VARIANT_1
This attribute is used to select the variant of S-CSCF offline charging support. The value is either VARIANT_1 or VARIANT_2 for S-CSCF offline charging support Variant-1 or Variant-2, respectively. VARIANT_1 is configured for S-CSCF offline charging support which is according to 3GPP specifications mainly prior to release 12. VARIANT_2 is configured for S-CSCF offline charging support which is according to 3GPP release 12 specifications. Variant configuration can be performed during traffic. Changes to the parameter value take effect on new sessions only.

Dependencies: NA
Takes effect: ChangeTypeRuntimeType – New Session
ServiceContextDT
scscfOfflineChargingServiceContextId = 12.32260@3gpp.org
This attribute is configured to define the string value of the Service-Context-Id AVP (#461) according to the 3GPP defined format. The value identifies the standard and the revision on which the offline charging service is based.
This attribute is defined for S-CSCF Variant-2 offline charging implementation only. It is ignored in Variant-1 offline charging.


Dependencies: NA
Takes effect: ChangeTypeRuntimeType – New Session

  class ScscfOfflineChargingProfileClass  

 

class ScscfOfflineChargingPSInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingServiceInformationClass
+-ScscfOfflineChargingPSInformationClass

This is Managed Object Class for S-CSCF Offline Charging PS Information

This MO is created by the system.

Attributes
String0to00070DT
scscfOfflineCharging3gppSgsnMccMnc = start=true;interim=true;stop=true;event=true
3gppSgsnMccMnc holds the Mobile Country Code (MCC) and the Mobile Network Code (MNC) used by an operator. The value is downloaded from HSS in the user profile. The MCC consists of 3 digits and the MNC consists of two or three digits depending on the value of the MCC. 3GPP-SGSN-MCC-MNC AVP, code 18.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingPSInformation
The name of the Profile.

  class ScscfOfflineChargingPSInformationClass  

 

class ScscfOfflineChargingSDPMediaComponentClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingSDPMediaComponentClass

This is Managed Object Class for S-CSCF Offline Charging SDP Media Component

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingSDPMediaComponent
The name of the Profile.
String0to00070DT
scscfOfflineChargingSDPMediaDescription = start=true;interim=true;stop=true;cache=false
Media-Description AVP, code 845. Note: When setting the cache, will be configured to the same value.

start=true;interim=true;stop=true;cache=true
Each possible ACR record type must have the value true or false
String0to00070DT
scscfOfflineChargingSDPMediaName = start=true;interim=true;stop=true;cache=false
Media-Name AVP, code 844. Note: When setting the cache, will be configured to the same value.

start=true;interim=true;stop=true;cache=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingSDPMediaComponentClass  

 

class ScscfOfflineChargingServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingServiceInformationClass
+-ScscfOfflineChargingPSInformationClass [0..1]

This is Managed Object Class for S-CSCF Offline Charging Service Information

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingServiceInformation
The name of the Profile.

  class ScscfOfflineChargingServiceInformationClass  

 

class ScscfOfflineChargingSIPReasonClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingSIPReasonClass

This is Managed Object Class for S-CSCF Offline Charging SIP Reason

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingSIPReason
The name of the Profile.
String0to00070DT
scscfOfflineChargingSIPReasonCause = stop=false;event=false
SIP-Reason-Cause AVP, code 336.

stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSIPReasonText = stop=false;event=false
SIP-Reason-Text AVP, code 337.

stop=true;event=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingSIPReasonClass  

 

class ScscfOfflineChargingSubscriptionIdClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingSubscriptionIdClass

This is Managed Object Class for S-CSCF Offline Charging Subscription ID

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingSubscriptionId
The name of the Profile.
String0to00070DT
scscfOfflineChargingSubscriptionIdData = start=true;interim=true;stop=true;event=true
Subscription-Id-Data with AVP code 444. Note: When setting the value, will be configured to the same value.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSubscriptionIdType = start=true;interim=true;stop=true;event=true
Subscription-Id-Type AVP, code 450. Note: When setting the value, will be configured to the same value.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.

  class ScscfOfflineChargingSubscriptionIdClass  

 

class ScscfOfflineChargingTimeStampsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOfflineChargingProfileClass
+-ScscfOfflineChargingAVPsClass
+-ScscfOfflineChargingTimeStampsClass

This is Managed Object Class for S-CSCF Offline Charging Timestamps

This MO is created by the system.

Attributes
String0to00070DT
scscfOfflineChargingSIPRequestTimestamp = start=true;interim=true;stop=true;event=true
SIP-Request-Timestamp AVP, code 834.

start=true;interim=true;stop=true;event=true
Each possible ACR record type must have the value true or false.
String0to00070DT
scscfOfflineChargingSIPResponseTimestamp = start=true;interim=true;event=true
This parameter defines the offline charging request types for which the SIP-Response-Timestamp AVP (code 835) has to be sent.

start=true;interim=true;event=true
Each ACR record type must have the value true or false. The value stop=true/false is deprecated and ignored when present.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOfflineChargingTimeStamps
The name of the Profile.

  class ScscfOfflineChargingTimeStampsClass  

 

class ScscfOnlineChargingAVPsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingEricssonServiceInformationClass [0..1]
+-ScscfOnlineChargingServiceInformationClass [0..1]
+-ScscfOnlineChargingSIPReasonClass [0..1]
+-ScscfOnlineChargingSubscriptionIdClass [0..1]

This is Managed Object Class for S-CSCF Online Charging AVPs

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingAVP
The name of the Profile.
String0to00070DT
scscfOnlineChargingEventNTPTimestamp = initial=false;update=false;terminate=false
Event-NTP-Timestamp AVP, code 340.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingEventTimestamp = initial=true;update=true;terminate=true
Event-Timestamp AVP, code 55.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingGPRSRoamingStatus = initial=false;update=false;terminate=false
GPRS-Roaming-Status AVP, code 333.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingQuotaDeductionStart = initial=false;update=false;terminate=false
Quota-Deduction-Start AVP, code 339.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSIPRingingTimestamp = initial=false;update=false;terminate=false;cache=false
SIP-Ringing-Timestamp AVP, code 338.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingTerminationCause = terminate=true
Termination-Cause AVP, code 295.

terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingUserName = initial=true;update=true;terminate=true
User-Name AVP, code 1.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingAVPsClass  

 

class ScscfOnlineChargingEricssonServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingEricssonServiceInformationClass

This is Managed Object Class for S-CSCF Online Charging Ericsson Service Information

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineChargingAuthenticationMethod = initial=false;update=false;terminate=false
This parameter controls whether the Authentication-Method AVP, code 1261, is sent in the charging records.

initial=false;update=false;terminate=false
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCalledPartyOriginalAddress = initial=false;update=false;terminate=false
Called-Party-Original-Address AVP code 286.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingDialAroundIndicator = initial=false;update=false;terminate=false
This parameter controls whether the Dial-Around-Indicator AVP, code 1160, is sent in the charging records.

initial=false;update=false;terminate=false
Each CCR record type must have the value true or false.
ChargingOnlineDiscDirectionDT
scscfOnlineChargingDisconnectDirection = terminate=false
Disconnect-Direction AVP, code 1305.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingEricssonServiceInformation
The name of the Profile.
String0to00070DT
scscfOnlineChargingImsServiceIdentification = initial=false;update=false;terminate=false
IMS-Service-Identification AVP, code 284.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSIPRequestTimestampFraction = initial=true;update=true;terminate=true
This parameter defines the online charging request types for which the SIP-Request-Timestamp-Fraction AVP has to be sent.

initial=true;update=true;terminate=true
Each request type must have its value set to true or false.
String0to00070DT
scscfOnlineChargingSIPResponseTimestampFraction = update=true
This parameter defines the online charging request types for which the SIP-Response-Timestamp-Fraction AVP has to be sent.

update=true
Each request type must have its value set to true or false.
String0to00070DT
scscfOnlineChargingTransactionInfo = initial=false;update=false;terminate=false
This parameter defines the online charging request types for which the This parameter defines the offline charging request types for which the Transaction-Info/Transaction-Type/Transaction-Data-Name/Transaction-Data-Value AVPs has to be sent.

Each request type must have its value set to true or false.

  class ScscfOnlineChargingEricssonServiceInformationClass  

 

class ScscfOnlineChargingEventTypeClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingEventTypeClass

This is Managed Object Class for S-CSCF Online Charging Event Type

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineChargingEvent = initial=true;update=true;terminate=true;cache=false
Event AVP, code 825.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingEventType
The name of the Profile.
String0to00070DT
scscfOnlineChargingSIPMethod = initial=true;update=true;terminate=true;cache=false
SIP-Method AVP, code 824.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingEventTypeClass  

 

class ScscfOnlineChargingIMSInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingEventTypeClass [0..1]
+-ScscfOnlineChargingInterOperatorIdentifierClass [0..1]
+-ScscfOnlineChargingMessageBodyClass [0..1]
+-ScscfOnlineChargingSDPMediaComponentClass [0..1]
+-ScscfOnlineChargingTimeStampsClass [0..1]

This managed object that contains the configuration parameters for the S-CSCF online charging IMS Information AVP

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineChargingAccessNetworkInformation = initial=false;update=false;terminate=false;cache=false
Access-Network-Information, code 1263.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCalledAssertedIdentity = update=false;terminate=false
The Called-Asserted-Identity AVP (AVP code 1250) holds the SIP URI and/or TEL URI.

update=true;terminate=true.

Each possible CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCalledPartyAddress = initial=true;update=true;terminate=true;cache=false
Called-Party-Address AVP, code 832.

initial=true;update=true;terminate=true;cache=false
The Cache parameter is deprecated. Only cache=false is valid. Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCallingPartyAddress = initial=true;update=true;terminate=true;cache=false
The Calling-Party-Address AVP (AVP code 831) holds the addresses (SIP URI and/or TEL URI) which identifies the party (Public User Identity or Public Service Identity) initiating a SIP transaction.

initial=true;update=true;terminate=true;cache=false
The Cache parameter is deprecated. Only cache=false is valid. Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCarrierSelectRoutingInfo = initial=false;update=false;terminate=false
This parameter controls whether the Carrier Select Routing Information AVP, code 2023, is sent in the charging records.

initial=false;update=false;terminate=false
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingCauseCode = terminate=true
Cause-Code AVP, code 861.

terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingImsChargingIdentifier = initial=true;update=true;terminate=true
IMS-Charging-Identifier AVP, code 841.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingIMSInformation
The name of the Profile.
String0to00070DT
scscfOnlineChargingNodeFunctionality = initial=true;update=true;terminate=true
Node-Functionality AVP, code 862.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingNumberPortabilityRoutingInfo = initial=false;update=false;terminate=false
This parameter controls whether the Number Portability Routing Information AVP, code 2024, is sent in the charging records.

initial=false;update=false;terminate=false
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingRoleOfNode = initial=true;update=true;terminate=true
Role-Of-Node AVP, code 829.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSDPSessionDescription = initial=true;update=true;terminate=true;cache=false
SDP-Session-Description AVP, code 842.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingUserSessionId = initial=true;update=true;terminate=true
User-Session-Id AVP, code 830.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingIMSInformationClass  

 

class ScscfOnlineChargingInterOperatorIdentifierClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingInterOperatorIdentifierClass

This is Managed Object Class for S-CSCF Online Charging Inter-operator Identifier

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingInterOperatorIdentifier
The name of the Profile.
String0to00070DT
scscfOnlineChargingOriginatingIOI = initial=true;update=true;terminate=true
Originating-IOI AVP, code 839.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingTerminatingIOI = initial=true;update=true;terminate=true
Terminating-IOI AVP, code 840.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingInterOperatorIdentifierClass  

 

class ScscfOnlineChargingMessageBodyClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingMessageBodyClass

This is Managed Object Class for S-CSCF Online Charging Message Body

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineChargingContentDisposition = initial=false;update=false;terminate=false
Content-Disposition AVP, code 828.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingContentLength = initial=false;update=false;terminate=false
Content-Length AVP, code 827.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingContentType = initial=false;update=false;terminate=false
Content-Type AVP, code 826.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingMessageBody
The name of the Profile.
String0to00070DT
scscfOnlineChargingOriginator = initial=false;update=false;terminate=false
Originator AVP, code 864.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingMessageBodyClass  

 

class ScscfOnlineChargingProfileClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfChargingTransactionTypeClass [0..1]
+-ScscfOnlineChargingAVPsClass [0..1]

This is Managed Object Class for S-CSCF Online Charging Profile

Attributes
Fqdn0to1024orEmptyDT[0..1]
scscfOnlineChargingDefaultOCSAddress
Defines the OCS realm address used in case no user profile with a charging address is available.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingProfile
Key attribute defines the name of the Charging Profile. Defines a reference to the corresponding charging trigger for this profile.
QuotaDecrementStartDT
scscfOnlineChargingQuotaDecrementStart = Invite
Defines the point in time at which quota (session time only) decrement must be started.
QuotaRoundingMechanismDT
scscfOnlineChargingQuotaRoundingMechanism = Nearest
Determines the mechanism used when deducting the time quota.
boolean
scscfOnlineChargingReportMidCallSDPToOCS = true
Determines whether a change in SDP received mid-session is reported to the OCS.
ChargingServiceContextIdDT
scscfOnlineChargingServiceContextId = 6.32260@3gpp.org
Determines the content of the Service-Context-Id AVP used for the purpose of version handling of the interface.
Integer0to00100DT
scscfOnlineChargingTransmissionTimerTx = 10
Defines the maximum time that the S-CSCF will wait for a credit control answer from the OCS.
CreditControlFailureHandlingDT
scscfOnlineLocalCreditControlFailureHandling = Continue
Determines the behavior of the S-CSCF with regards to the continuation or not of the session when no answer is received from the OCS system.
boolean
scscfOnlineWaitForCreditControlAnswer = true
Determines wether the session can proceed or not (INVITE forwarding) awaiting the answer from the OCS system.

  class ScscfOnlineChargingProfileClass  

 

class ScscfOnlineChargingPSInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingPSInformationClass

This is Managed Object Class for S-CSCF Online Charging PS Information

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineCharging3gppSgsnMccMnc = initial=true;update=true;terminate=true
3GPP-SGSN-MCC-MNC AVP, code 18.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingPSInformation
The name of the Profile.

  class ScscfOnlineChargingPSInformationClass  

 

class ScscfOnlineChargingSDPMediaComponentClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingSDPMediaComponentClass

This is Managed Object Class for S-CSCF Online Charging SDP Media Component

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingSDPMediaComponent
The name of the Profile.
String0to00070DT
scscfOnlineChargingSDPMediaDescription = initial=true;update=true;terminate=true;cache=false
SDP-Media-Description AVP, code 845.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSDPMediaName = initial=true;update=true;terminate=true;cache=false
SDP-Media-Name AVP, code 844.

initial=true;update=true;terminate=true;cache=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingSDPMediaComponentClass  

 

class ScscfOnlineChargingServiceInformationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass [0..1]
+-ScscfOnlineChargingPSInformationClass [0..1]

This is Managed Object Class for S-CSCF Online Charging Service Information

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingServiceInformation
The name of the Profile.

  class ScscfOnlineChargingServiceInformationClass  

 

class ScscfOnlineChargingSIPReasonClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingSIPReasonClass

This is Managed Object Class for S-CSCF Online Charging SIP Reason

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingSIPReason
The name of the Profile.
String0to00070DT
scscfOnlineChargingSIPReasonCause = terminate=false
SIP-Reason-Cause AVP, code 336.

terminate=true
Each possible CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSIPReasonText = terminate=false
SIP-Reason-Text AVP, code 337.

terminate=true
Each possible CCR record type must have the value true or false.

  class ScscfOnlineChargingSIPReasonClass  

 

class ScscfOnlineChargingSubscriptionIdClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingSubscriptionIdClass

This is Managed Object Class for S-CSCF Online Charging Subscription ID

This MO is created by the system.

Attributes
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingSubscriptionId
The name of the Profile.
String0to00070DT
scscfOnlineChargingSubscriptionIdData = initial=true;update=true;terminate=true
Subscription-Id-Data AVP, code 444. Note: When setting the value, will be configured to the same value.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.
String0to00070DT
scscfOnlineChargingSubscriptionIdType = initial=true;update=true;terminate=true
Subscription-Id-Type AVP, code 450. Note: When setting the value, will be configured to the same value.

initial=true;update=true;terminate=true
Each CCR record type must have the value true or false.

  class ScscfOnlineChargingSubscriptionIdClass  

 

class ScscfOnlineChargingTimeStampsClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfChargingClass
+-ScscfChargingClass
+-ScscfChargingProfilesClass
+-ScscfChargingProfileClass
+-ScscfOnlineChargingProfileClass
+-ScscfOnlineChargingAVPsClass
+-ScscfOnlineChargingServiceInformationClass
+-ScscfOnlineChargingIMSInformationClass
+-ScscfOnlineChargingTimeStampsClass

This is Managed Object Class for S-CSCF Online Charging Timestamps

This MO is created by the system.

Attributes
String0to00070DT
scscfOnlineChargingSIPRequestTimestamp = initial=true;update=true;terminate=true
SIP-Request-Timestamp AVP, code 834.

initial=true;update=true;terminate=true
Each request type must have its value set to true or false.
String0to00070DT
scscfOnlineChargingSIPResponseTimestamp = update=true
SIP-Response-Timestamp AVP, code 835.

update=true
Each request type must have its value set to true or false.
String1to00256DT
key
mandatory
noNotification
restricted
scscfOnlineChargingTimeStamps
The name of the Profile.

  class ScscfOnlineChargingTimeStampsClass  

 

class ScscfRestorationClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfRestorationGroupClass
+-ScscfRestorationClass

This is a container class for the S-CSCF Restoration related attributes.

Attributes
boolean
scscfPcscfRestorationEnabled = false
This parameter is used to enable or disable the support of P-CSCF Restoration and SIP MESSAGE based P-CSCF Restoration in S-CSCF. This parameter is NOT access aware.


Takes effect: ChangeTypeRuntimeType – Immediate
PcscfRestorationSipErrorCodesDT[0..] ordered
scscfPcscfRestorationSipErrorCodes
This parameter contains a list of SIP error response codes within the range of 400 to 699. If a SIP error response code from a terminating P-CSCF or generated by S-CSCF matches an entry in the list, P-CSCF restoration procedure is triggered. If scscfPcscfRestorationEnabled is not enabled, the configured value(s) of this parameter is not in effect. If this parameter is not configured and scscfPcscfRestorationEnabled is enabled, the P-CSCF restoration is triggered when the P-CSCF is blacklisted for other reasons than SIP 503 with or without Retry-After header. This parameter is NOT access aware.

Takes effect: ChangeTypeRuntimeType – Immediate
String0to65535DT
key
mandatory
noNotification
restricted
scscfRestoration
This is the key attribute of the ScscfRestorationClass containing all the Restoration parameters. One instance of the ScscfRestorationClass with the key ScscfRestoration=default is created at startup. Depending on the number of Access Aware profiles, it is possible to create new instances. This instance can not be deleted. No other instances can be created of this class.

boolean
scscfRestorationOriginatingNonRegisterAllowed = true
When Restoration Procedure is enabled, ScscfRestorationOriginatingNonRegisterAllowed is used to determine the action to be taken by S-CSCF when an originating non-Register request from a user who is not registered at the S-CSCF is received. This parameter is NOT access aware.

If the Restoration Procedure is enabled and an originating non-Register request is received and if the user is not found in S-CSCF and if this parameter is set to false, S-CSCF rejects the request with a 504 Response Code. Otherwise, if this parameter is set to true, S-CSCF processes the request but without performing authentication, that is, ignoring the setting of the Authentication Policy configuration. Authentication will resume for each contact individually when each contact successfully reregisters.
RestorationProcedureTypeDT
scscfRestorationProcedure = DISABLED
ScscfRestorationProcedure is used to enable and disable the Restoration feature in S-CSCF. Furthermore, in the enabled configuration, the ScscfRestorationProcedure parameter indicates a particular enabled-mode for the restoration functionality, with or without Subscription-Info. This parameter is NOT access aware.

  class ScscfRestorationClass  

 

class ScscfRestorationGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfRestorationGroupClass
+-ScscfRestorationClass [1..1]

A class for the S-CSCF Restoration Procedure. This is a container class
for the ScscfRestorationClass instances.


This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfRestorationGroup
This is the key attribute of the ScscfRestorationGroupClass containing all the ScscfRestorationClass instances. One instance of the ScscfRestorationGroupClass with the key ScscfRestorationGroup=0 is created at startup. This instance can't be deleted. No other instances can be created of this class.

  class ScscfRestorationGroupClass  

 

class ScscfSharedIfcClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfSharedIfcClass
+-ScscfIfcClass [0..]

This is Managed Object Class for S-CSCF Shared IFC

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfSharedIfcId
This parameter captures the identity of the SiFC set as an integer. This number matches the value included in the user profile received via the Cx interface.

  class ScscfSharedIfcClass  

 

class ScscfSharedIfcGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfNodeDefaultIfc [0..1]
+-ScscfSharedIfcClass [0..]

This is Managed Object Class for S-CSCF Shared IFC Group

This MO is created by the system.

Attributes
boolean
scscfSharedIfcEnabled = false
This parameter defines if the CSCF is configured to support SiFC feature.
integerKeyString
key
mandatory
noNotification
restricted
scscfSharedIfcGroup
This is the key attribute of the ScscfSharedIfcGroupClass. One instance of the ScscfSharedIfcGroupClass with the key ScscfSharedIfcGroup=0 is created at startup. This instance cannot be deleted. No other instances can be created of this class.
boolean
scscfSharedIfcSynchronization = false
This parameter when set to true will initiate the synchronization process to put the SiFC configuration data in service. The parameter is automatically set to false by the application when the synchronization process is complete.

  class ScscfSharedIfcGroupClass  

 

class ScscfSptClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfSharedIfcClass
+-ScscfIfcClass
+-ScscfSptGroupClass
+-ScscfSptClass

This is Managed Object Class for S-CSCF SPT

Attributes
boolean
scscfSptConditionNegated = false
This parameter indicates if the result of the Service Point Trigger (SPT) evaluation is negated.
String1to01024DT
key
mandatory
noNotification
restricted
scscfSptName
This parameter captures the identity of a Service Point Trigger (SPT) included in the Group.
String0to01024DT[0..1]
scscfSptTriggerContext
This parameter captures the context associated with the trigger type. The trigger context takes on different meanings depending on the trigger type. When the trigger type is METHOD, the trigger context captures the SIP method name. When the trigger type is HEADER, the trigger context captures the SIP header name. When trigger type is SESSION_CASE, the trigger context must be set to one of the following keywords: ORIGINATING_REGISTERED, ORIGINATING_UNREGISTERED,TERMINATING_REGISTERED, TERMINATING_UNREGISTERED, ORIGINATING_CDIV. And finally, when the trigger type is REQUEST_URI, the trigger context must be empty.
SptTriggertypeDT
mandatory
scscfSptTriggerType
This parameter indicates the type of Service Point Trigger. The system supports 4 types namely, REQUEST_URI, METHOD, HEADER and SESSION_CASE.
String0to01024DT[0..] nonUnique ordered
scscfSptTriggerValue
This parameter captures the value that will be used to match the condition that fires the trigger. The trigger value takes on different meanings depending on the type of trigger. When the trigger type is METHOD and trigger context is REGISTER, the trigger value defines the Registration Type for this SPT. The Registration Type can either be empty or assumes 3 possible values, namely INITIAL_REGISTRATION, RE_REGISTRATION and DE_REGISTRATION. When the trigger type is REQUEST_URI, the trigger value captures the Request-URI string that defines the trigger. When trigger type is HEADER, the trigger value captures the header content. And finally, when trigger type is SESSION_CASE, the trigger value must be empty.

  class ScscfSptClass  

 

class ScscfSptGroupClass

ManagedElement
+-CscfFunction
+-CSCF-Application
+-ScscfSharedIfcGroupClass
+-ScscfSharedIfcClass
+-ScscfIfcClass
+-ScscfSptGroupClass
+-ScscfSptClass [0..]

This is Managed Object Class for S-CSCF SPT Group

Attributes
integerKeyString
key
mandatory
noNotification
restricted
scscfSptGroupId
This parameter captures the identity in integer form of a Service Point Trigger (SPT) Group instance included in the iFC.

  class ScscfSptGroupClass  

 

class ScscfWiFiCallingLicenseModel

ManagedElement
+-CscfFunction
+-CSCF-Application
+-CscfLicenseModelGroup
+-ScscfWiFiCallingLicenseModel

This is the basic container for the configuration parameters related to the CSCF Wi-Fi License feature.

This MO is created by the system.

Attributes
MultiDeviceAdminStateDT
scscfWiFiCallingAdministrativeState = LOCKED
This attribute locks or unlocks the Wi-Fi Calling Feature State. The Wi-Fi Calling Feature State represents the administrative state of the Wi-Fi Calling Feature.
String0to00010DT
key
mandatory
noNotification
restricted
scscfWiFiCallingLicenseModelId
This is the key attribute of ScscfWiFiCallingLicenseModel.
One instance of ScscfWiFiCallingLicenseModel with the key scscfWiFiCallingLicenseModelId=default is created at startup. This instance can’t be deleted. No other instances can be created of this class.
MultiDeviceServiceStateDT
readOnly
scscfWiFiCallingServiceState = Disabled
This read only attribute displays the Wi-Fi Calling Service State. The Wi-Fi Calling Service State represents the operational state of the Wi-Fi Calling feature.

  class ScscfWiFiCallingLicenseModel  

 

class SecM

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

Security Management root MOC.

This MO is created by the system.

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

  class SecM  

 

class SigComp-Subsystem

ManagedElement
+-CscfFunction
+-SigComp-Subsystem

The SigComp Managed Object (MO) represents the top level of the SigComp-Subsystem.

Attributes
string
key
mandatory
noNotification
restricted
applicationName
The name of the application. The attribute name and value of is used in the applications RDN.
SigCompAlgorithmDT
sigCompCompressionAlgorithm = LZBS
Specifies Compression Algorithm.

Allowed Combinations of Compression Algorithms andTypes:
Algorithm - Types
LZBS - Basic, Stateless, Dynamic, Shared, USD_EXT
LZBS_8k - Basic, Stateless, Dynamic, Shared, USD_EXT
Deflate - Basic, Stateless, Dynamic, Shared
Dual_LZBS - USD_EXT_DYN
SigCompTypeDT
sigCompCompressionType = Dynamic
Specifies Compression Type.

Allowed Combinations of Compression Types and Algorithms:
Types - Algorithm
Basic - LZBS, LZBS_8k, Deflate
Stateless - LZBS, LZBS_8k, Deflate
Dynamic - LZBS, LZBS_8k, Deflate
Shared - LZBS, LZBS_8k, Deflate
USD_EXT - LZBS, LZBS_8k
USD_EXT_DYN - Dual_LZBS

  class SigComp-Subsystem  

 

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.
ComSnmp_Snmp_engineId[0..1]
engineId
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 Snmp  

 

class SnmpTargetV1

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

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

Attributes
IPAddress
mandatory
address
Host address or DNS name for the SNMP trap target.
BasicAdmState
administrativeState = UNLOCKED
Administrative state for the SNMP target.
When LOCKED, 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.
ComSnmp_SnmpTargetV1_networkPrefixLength[0..1]
networkPrefixLength
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.
ComSnmp_SnmpTargetV1_port
port = 162
UDP port number for this SNMP trap target.
string
key
mandatory
noNotification
restricted
snmpTargetV1Id
Holds the name used when identifying the MO.

  class SnmpTargetV1  

 

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.
ComSnmp_SnmpTargetV2C_networkPrefixLength[0..1]
networkPrefixLength
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.
ComSnmp_SnmpTargetV2C_port
port = 162
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 SnmpTargetV2C  

 

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.
ComSnmp_SnmpTargetV3_port
port = 162
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 SnmpTargetV3  

 

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.
ComSnmp_SnmpTargetV3Dtls_port
port = 10162
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 SnmpTargetV3Dtls  

 

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 SnmpViewV1  

 

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 SnmpViewV2C  

 

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 SnmpViewV3  

 

class Ssh

ManagedElement
+-SystemFunctions
+-SecM
+-Ssh

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

This MO is created by the system.

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

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

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

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

  class Ssh  

 

class 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
SecLA_SshPublicKey_publicKeyContent
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.
string
key
mandatory
noNotification
restricted
sshPublicKeyId
The value component of the RDN.

  class SshPublicKey  

 

class SwInventory

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

A singleton class which has only structural purpose.

This MO is created by the system.

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

  class SwInventory  

 

class SwItem

ManagedElement
+-SystemFunctions
+-SwInventory
+-SwItem

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


This MO is created by the system.

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

  class SwItem  

 

class SwM

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

The root structural element of SW management activities.

This MO is created by the system.

References to:
SwVersion; SwVersionMain; UpgradePackage;
Actions
boolean
cancel ( );
Cancel can be invoked during any long-lasting operation.
It stops the operation and restores the consistent state that existed before the long-lasting operation started. The action returns immediately after invocation. The consequences of the action can be tracked by attribute progressReport. The action returns false if the action is refused by the ME. In all other cases, it returns true.
uint16
createUpgradePackage ( string uri , EcimPasswordString password );
Creates a new UpgradePackage MO that represents a UP specified by a URI.
This action includes all activities to initialize the UP MO. After the UP MO is created, all descriptive information is available, for example, administrativeData, number or names of activation step data. This action can be invoked when there is no other action in progress on this MO. The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport . The action returns 0 if the action cannot start for any reason, for example, another parallel action is in progress. The action also returns 0 if the ME cannot handle the URI, for example, it does not support the protocol specified in the URI. In all other cases, it returns the id of the action. The action id is different and unique for every invocation of the action.

Parameters

Name: uri
Description: Contains a URI that points to a directory that contains the UP content.
The generic URI syntax is defined by RFC 2396. The URI must not contain any password. The password must be provided in the second parameter of this action. The URI can be local absolute, for example, file:///data/dir/subdir. It can also be remote, for example, sftp://hostname/dir/subdir.



Name: password
Description: A password to the server that provides the UP.
If authentication is not password-based, this parameter is ignored.


boolean
removeSoftwareVersion ( SwVersion swVersion );
Removes a SW version as much as possible.
It does not disturb node functionality. Files shared with other SW versions are not deleted.
The active SW version cannot be removed. This action can only be invoked when there is no other action in progress on this MO. The action returns false if any of these conditions are violated.

Parameters

Name: swVersion
Description: The value component of the RDN of the SwVersion MO in ECIM_SWIM to be removed.

boolean
removeSwVersion ( SwVersionMain swVersion );
Action removeSwVersion is deprecated, it is recommended to use action removeSoftwareVersion.

Removes a SW version as completely as possible without disturbing node functionality.

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

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

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


Deprecated: Action has been removed from ECIM SWM 4.2, deprecated in CmwSwM 5.1


Parameters

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


boolean
removeUpgradePackage ( UpgradePackage upgradePackage );
Removes an UpgradePackage.
This action removes the UpgradePackage MO specified as action parameter. It also removes all files temporarily stored in the ME and associated with the UP. The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport. This action can be invoked when there is no other action in progress on this MO. The action returns false if the action could not start for any reason, for example, another parallel action is in progress. In all other cases, it returns true.

Parameters

Name: upgradePackage
Description: An UpgradePackage MO to be removed.

Attributes
ActionCapabilityState
readOnly
actionCapable = CAPABLE
Shows whether the Software Management function is in a state of readiness to execute actions.
The Managed Element sets it to WAIT during any operations and maintenance activity that causes one or more of the Software Management function related actions to become unavailable. The Management System should wait until the state returns to CAPABLE before invoking any Software Management action.
string[0..1]
readOnly
actionCapableInfo
Additional information relating to actionCapable.
Provides free-text information if available about the managed element operation or maintenance activity causing actionCapable to be at state WAIT.
SwVersionMain[1..]
readOnly
activeSwVersion
Reference to the active software version(s) actively controlling the behavior of the managed element.

Deprecated: Attribute has been removed from ECIM SWM 4.2, deprecated in CmwSwM 5.1

uint32
noNotification
alarmBeforeTimeout = 180
alarmBeforeTimeout is the time in seconds an alarm is sent out before a fallback occurs.
uint32
noNotification
automaticBackup = 1
automaticBackup is set to true(1) if ECIM SwM shall perform backup at activate() action otherwise set to false(0).
uint32
noNotification
automaticRestore = 1
automaticRestore is set to true(1) if ECIM SwM shall automatically perform fallback operation at certain events otherwise set to false(0).

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

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

ExecMethod[0..1]
noNotification
execMethod
The default execution method.
int16
fallbackTimer = 1200
Maximum interval in seconds within which the next action must be invoked to avoid fallback.
The maximum number of seconds allowed to elapse between the finish of an activation step and the start of the next new activate() action or new confirm() action. This attribute holds the value to which attribute timeRemainingBeforeFallback is set after the action activate() is successfully completed. -1 means infinity. In this case, the start value of timeRemainingBeforeFallback must also be set to -1 when the timer starts, even though no countdown ever starts (it remains always -1).
string[0..1]
readOnly
localFileStorePath
URI of the directory where the UPs are stored on the ME.
AsyncActionProgress[0..1]
readOnly
reportProgress
Represents the progress report, including the result, of the ongoing action.
This MO supports only one action execution at a time.
string[0..1]
noNotification
readOnly
subType
subType is any string value identifying the type of node from a ECIM SwM perspective.
string
key
mandatory
noNotification
restricted
swMId
Holds the name used when identifying the MO.
SwMTimeoutFallbackCapability[0..1]
noNotification
readOnly
timeoutFallbackCapability = SUPPORTED
Shows whether fallback capability is supported or not.
If fallback capability is not supported, setting SwM fallbackTimer has no effect and automatic fallback does not occur.
int16
noNotification
readOnly
timeRemainingBeforeFallback = -1
Remaining number of seconds before performing fallback.
Value -1 indicates an infinite number of seconds. Fallback means that the system returns to state PREPARE_COMPLETED .
string[0..1]
userLabel
Used for free-text description.

  class SwM  

 

class SwVersion

ManagedElement
+-SystemFunctions
+-SwInventory
+-SwVersion

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


This MO is created by the system.

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

  class SwVersion  

 

class SwVersionMain

ManagedElement
+-SystemFunctions
+-SwM
+-SwVersionMain

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

Such MO may be created after activating an UP.

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

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







This MO is created by the system.

Deprecated: Class has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

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


Deprecated: Attribute has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

string
readOnly
name
Everyday name of the SW version.

It may contain any longer textual description.


Deprecated: Attribute has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

int64[0..1]
readOnly
size
Amount of disk space in KB that will be freed if this SW version is deleted.

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



Deprecated: Attribute has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

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

Both SW Inventory SwVersion MOC and SwM SwVersionMain MOC represent overall software version of the ME.


Deprecated: Attribute has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

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

Deprecated: Attribute has been removed from ECIM SwM 4.2, deprecated in CmwSwM 5.1

  class SwVersionMain  

 

class SysM

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

This is the System Management MO.

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


This MO is created by the system.

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

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

  class SysM  

 

class SystemFunctions

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

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

This MO is created by the system.

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

  class SystemFunctions  

 

class ThresholdMonitoring

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

Specifies a threshold for housekeeping files in a file group.

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

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

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

  class ThresholdMonitoring  

 

class Tls

ManagedElement
+-SystemFunctions
+-SecM
+-Tls

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

This MO is created by the system.

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

Applied on the cipher suites listed in attribute supportedCiphers. The result is shown in attribute enabledCiphers.
Cipher[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 Tls  

 

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 Transport  

 

class TrustCategory

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

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

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

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

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

  class TrustCategory  

 

class TrustedCertificate

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

Represents a trusted certificate.

This MO is created by the system.

References from:
CertM; EnrollmentAuthority; TrustCategory;
References to:
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 TrustedCertificate  

 

class UpgradePackage

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

Controls the change process of the software configuration of a ME.
An instance of UpgradePackage (UP) represents a specific change
of software configuration from the existing one to the new one identified by the attribute administrativeData. The execution of the change process described by UP class is the normal way to change the content of the SW inventory. An UP can be seen as a modification agent. It can add new, remove, or modify functionality. The sequence in which a Software upgrade executes is as follows:
1. Prepare
2. Verify, which is optional
3. Activate
4. Confirm
When the upgrade package MO is created the upgrade control file is downloaded to specify the administrative data and the activation steps for this upgrade.


This MO is created by the system.

References from:
SwM;
Actions
boolean
activate ( );
Current upgrade package is taken into operation fully or partially.
Partial activation occurs if the UCF defines activation steps and attribute ignoreBreakPoints is false. The ME upgrade engine notifies the operator that the activation step is completed. The next activation step starts when the operator invokes an activate action. Each UP must have at least 1 activation step. When attribute ignoreBreakPoints=true, all activation steps are executed in sequence. When an activation step is complete, the ME executes the next activation step. That means there is no operator invocation when an activation step is complete. The time for observation of correct operation of the ME, after each completed step, is always monitored by a supervision timer. The invocation of activate() can be monitored by a supervision timer. If the supervision timer expires before invocation of activate() or confirm(), the activation fails and the ME falls back to state PREPARE_COMPLETED. The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport. The action returns false if the action could not start for any reason, for example, another parallel action is in progress. In all other cases, it returns true. This action can be invoked when the state is PREPARE_COMPLETED or ACTIVATION_STEP_COMPLETED. If the action is invoked in a state where the action has no meaning, ME is expected to return an error message.
boolean
cancel ( );
Cancel can be invoked during any long-lasting operation.
Stops the operation and restores the consistent state that existed before the long-lasting operation started. Furthermore, cancel() can also be invoked when the UP is in state WAITING_FOR_COMMIT or ACTIVATION_STEP_COMPLETED without having a long-lasting operation in progress. Calling cancel() in this state orders the ME to restore the state that existed before the activation procedure started. The action returns immediately after invocation. The consequences of the action can be tracked by attribute progressReport. The action returns false if the action is refused by the ME. If the action is invoked in a state where the action has no meaning, the ME is expected to return false. In all other cases, it returns true. This action can be invoked when the UP state is PREPARE_IN_PROGRESS, ACTIVATION_IN_PROGRESS, ACTIVATION_STEP_COMPLETED, or WAITING_FOR_COMMIT.
boolean
commit ( );
Action commit is deprecated, it is recommended to use action confirm.

Stops the activation supervision timer (fallback timer) and confirms the upgrade.

The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport.
The action returns false if the action could not start for any reason, for example, another parallel action is in progress. In all other cases, it returns true.
This action can be invoked when the state is WAITING_FOR_COMMIT.

The CoreMW implementation of the commit action has always been ansynchronous.
This is an deviation from the ECIM SwM commit which was an synchronous action.


Deprecated: Action has been removed from ECIM SWM 4.2, deprecated in CmwSwM 5.1

boolean
confirm ( );
Stops the activation fallback timer and confirms the upgrade.
The action returns when the synchronous action is completed. This action can be invoked when the state is WAITING_FOR_COMMIT. The action returns true on success, false on failure.
boolean
prepare ( );
Prepares the Managed Element for activation of the current upgrade package.
Executing prepare() does not have any negative impact on the in-service performance of the Managed Element. The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport. The action returns false if the action could not start for any reason, for example, another parallel action is in progress. In all other cases, it returns true.
boolean
verify ( );
Verifies the ability to activate the current upgrade package.
The action returns immediately after invocation. The progress of the action can be tracked by attribute progressReport. The action returns false if the action could not start for any reason, for example, another parallel action is in progress. In all other cases, it returns true. This action can be invoked when the state is PREPARE_COMPLETED. If the action is invoked in a state where the action has no meaning, the ME is expected to return an error message.This action can be called as an option in the whole upgrade procedure. The action can be called more than once if required.

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

The default -1 value denotes that the activation timer is disabled.
ActivationStep[1..]
readOnly
activationStep
List of activation steps in the activation procedure.
It is possible to stop after each step, perform supervision, and continue with the procedure.The upgrade procedure consists of at least one activation step.
ProductData[1..]
readOnly
administrativeData
The product identification of the software versions that are activated when an upgrade is completed.
If the resulting software version after activation is unknown or uncertain, the administrativeData can be empty.
DateTime
readOnly
created
Date and time this Upgrade Package instance is created.
uint16[0..1]
noNotification
readOnly
creatorActionId = 0
The Id of the action that created this UpgradePackage MO.
Default value 0 shows that the ME does not record this information.
ExecMethod[0..1]
noNotification
execMethod
The execution method of a specific UpgradePackage.
boolean
ignoreBreakPoints = true
Influences the behavior of the activate() action.
False means there is a breakpoint between each activation step. Activation process stops at each breakpoint. True means execution ignores breakpoints between activation steps and instead executes the end-to-end activation process. This invokes all activation steps in sequence, assuming no errors occur.
EcimPassword[0..1]
password
Password to the server that provides the UpgradePackage.
AsyncActionProgressWithSteps[0..1]
readOnly
reportProgress
Represents the progress report, including the result, of the ongoing action.
This MO supports only one action execution at a time.
UpgradePackageState
readOnly
state
Current state of Upgrade Package.
string
key
mandatory
noNotification
restricted
upgradePackageId
Holds the name used when identifying the MO.
string[0..1]
uri
A URI that points to the directory where the UP can be found.
The URI can be local, for example, file://data/dir/subdir. It can also be remote, for example, ftp://hostname/dir/subdir.
string[0..1]
userLabel
Free-text description of the Upgrade Package.

  class UpgradePackage  

 

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 UserAccount  

 

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 UserAccountM  

 

class UserManagement

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

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

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

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

The generic behavior of TBAC for authorization is as follows:

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

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

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

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

  class UserManagement