class VtasIcb

ManagedElement
+-MtasFunction
+-MtasVtp
+-VtasServices
+-VtasMmt
+-VtasCb
+-VtasIcb

The VtasIcb MO represents the Incoming Communication Barring (ICB) service in an MTAS node. To activate the ICB service, set the vtasCbAdministrativeState attribute to UNLOCKED (1).

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
vtasIcb
This attribute defines the primary key of VtasIcb and this section describes the VtasIcb attributes.
MtasQ850CauseValueNumeric0to127DT
vtasIcbAnnCauseValue = 0
This attribute defines which Q.850 Cause Value Code that is to be included a Reason header that is to be included in the SIP 183 Session Progress sent by the ICB service from the terminating MTAS before the announcement is played.

Takes effect: New session
MtasUint00000to065535DT
vtasIcbAudioAnnounceCode = 0
This attribute defines the code that corresponds to the desired audio announcement to be played to the originating party when a communication is barred due to ICB.

Takes effect: New session
MtasUint00000to065535DT
vtasIcbAVAudioCode = 0
This attribute defines the code that corresponds to the desired audio announcement component of an audio-video pair to be played to the originating party when a communication is barred due to ICB.

Takes effect: New session
MtasUint00000to065535DT
vtasIcbAVVideoCode = 0
This attribute defines the code that corresponds to the desired video announcement component of an audio-video pair to be played to the originating party when a communication is barred due to ICB.

Takes effect: New session
MtasString0to255DT[0..255]
vtasIcbBlackList
This attribute defines the setting of the global ICB black list for the node. It is a list of strings and each entry is substring matched with the P-Aserted-Identity header in the SIP request. When there is a match the communication is barred.

Takes effect: New session
MtasEstablishedAnnRulesDT
vtasIcbDndEstablishedAnnRules = USR_AND_OP_RULES
This attribute defines for which barring rules annoucements are played on established session for the DND Communication Barring service.


Takes effect: New session
OperState
vtasIcbDndEstablishedAnnUseReliable183 = DISABLED
This attribute defines whether to disable or enable sending reliable 183 for announcements played on established dialogue for the DND Communication Barring service.

Takes effect: New session
OperState
vtasIcbDndPlayEarlyMedia = ENABLED
This attribute defines the method of playing announcements for the DND Communication Barring service.

Takes effect: New session
VtasDropBackDT
vtasIcbDropBack = USE_OTP_VALUES
This attribute defines whether the Virtual Telephony Provider (VTP) want to use the values of the corresponding Operating Telephony Provider (OTP) attributes in MtasIcb.
When this attribute is set to "Use own values", the initial values of the other attributes in VtasIcb are all set to the values of the corresponding attributes in MtasIcb, and the behavior of MTAS for the served users belonging to this VTP is determined by the values of the attributes of VtasIcb.
When this attribute is set to "Use OTP values", the behavior of MTAS for the served users belonging to this VTP is determined by the values of the attributes of MtasIcb.


Takes effect: New session
MtasTimerHours00000to065535DT
vtasIcbDynamicBlackListEntryLife = 4368
This attribute defines the lifetime of each entry in the operator part of the Dynamic Black List. Setting this attribute to 0 has the special meaning that DBL entries have infinitive lifetime, leading to that MTAS never automatically deletes the entries.

Takes effect: New session
MtasIncomingIdentitySourceDT
vtasIcbDynamicBlackListIdSource = P_ASSERTED_IDENTITY_HEADERS
This attribute defines which identities associated with a recent incomming call are strored in an entry of the Dynamic Black List.
- When this attribute is set to P_ASSERTED_IDENTITY_HEADERS (0), MTAS stores the URIs supplied in the P-Asserted-Identity headers.
- When it is set to FROM_HEADER (1), MTAS stores the URI supplied in the From header.
- When it is set to P_ASSERTED_IDENTITY_AND_FROM_HEADERS (2), MTAS stores the URI supplied in both the P-Asserted-Identity and the From headers.


Takes effect: New session
MtasIcbDynamicBlackListMaxLengthDT
vtasIcbDynamicBlackListMaxLength = 10
This attribute defines the maximum number of entries in the operator part of Dynamic Black List.

Takes effect: New session
MtasEstablishedAnnRulesDT
vtasIcbEstablishedAnnRules = USR_AND_OP_RULES
This attribute defines for which barring rules annoucements are played on established session for the ICB service.

Takes effect: New session
OperState
vtasIcbEstablishedAnnUseReliable183 = DISABLED
This attribute defines whether to disable or enable sending reliable 183 for announcements played on established dialogue for the ICB service.

Takes effect: New session
BasicAdmState
vtasIcbPlayAudioAnnouncement = LOCKED
This attribute defines whether to disable or enable the call barred service audio announcement when a communication is barred due to ICB.

Takes effect: New session
OperState
vtasIcbPlayEarlyMedia = ENABLED
This attribute defines the method of playing announcements for the ICB service.

Takes effect: New session
BasicAdmState
vtasIcbPlayVideoAnnouncement = LOCKED
This attribute defines whether to disable or enable the call barred service video announcement when a communication is barred due to ICB.

Takes effect: New session
MtasSipErrorMessagesDT[0..1]
vtasIcbRejectCode = 603
The attribute is used to set/change the ICB response code.

Takes effect: New session
BasicAdmState
vtasIcbUseFromHeader = LOCKED
This attribute defines whether to disable or enable the use of the From header when matching ICB rules.

Takes effect: New session
MtasUint00000to065535DT
vtasIcbVideoOnlyCode = 0
This attribute defines the code that corresponds to the desired video announcement, without an associated audio announcement, to be played to the originating party when a communication is barred due to ICB.

Takes effect: New session
MtasString0to255DT[0..255]
vtasIcbWhiteListDomainIncl
This attribute defines a list of strings where each string represents the host part of a non-numerical URI that Incoming Communication Barring (ICB) is not allowed to bar.
- If the first character in the string is a "*" this is to be treated as a wildcard character and a rightmost match of the domain name from the remote identity will be performed with the rest of the characters in the string.
- If the first character in the string is not a "*" then the domain name from the remote identity must exactly match the included string.


Takes effect: New session
MtasString0to255DT[0..255]
vtasIcbWhiteListNumExcl
This attribute defines the leftmost parts of the normalized numbers that are excluded from the Incoming Communication Barring (ICB) Global White List.
A string representing a global number will be prefixed by a "+". Each string begins with one of the strings in attribute MtasIcbWhiteListNumIncl. This is not policed.


Takes effect: New session
MtasString0to255DT[0..255]
vtasIcbWhiteListNumIncl
This attribute defines a list of strings where each string represents a leftmost part of normalized numbers that Incoming Communication Barring (ICB) is not allowed to bar.
A string representing a global number will be prefixed by a "+".


Takes effect: New session

  class VtasIcb