class MtasSip

ManagedElement
+-MtasFunction
+-MtasSip

The MtasSip MO represents the SIP function in an MTAS node.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
mtasSip
This attribute defines the primary key of MtasSip and this section describes the MtasSip attributes.
MtasSipCallOutOfBlueRoutingDT
mtasSipCallOutOfBlueRouting = S_CSCF
This attribute defines the MTAS behavior for terminating Call out of the Blue requests towards a CSCF.
- If the S-CSCF supports User Unrelated ISC Routing, than the terminating Call out of the Blue can be sent to an S-CSCF where the user is not registered.
- If User Unrelated ISC Routing is not supported, such request is sent to I-CSCF.


Dependencies: This attribute must not be allowed to be set to I_CSCF (1) if mtasSipIcscfName is empty.
Takes effect: New session
MtasTimerSec00000to000180DT
mtasSipCancel2FinalResponseTimer = 5
This attribute defines the maximum time allowed after MTAS receives a 200 OK to a CANCEL message and does not receive a final response to the invite transaction. The value 0 should be avoided due to robustness issues. Note that if the value 0 is used and the call setup time reaches 10 minutes, then the Node Control function "Hanging Process Supervision" will terminate the process unconditionally and tear down the call setup.

Takes effect: New session
MtasUint01024to065535DT
mtasSipCnamePort = 5088
The attribute defines the port on which MTAS listens for SIP messages from the Calling Name Server.

Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document: MTAS, SIP Management, Reference.
Takes effect: (Unlock) of MtasFunction
MtasSipSessionExpiryDT
mtasSipDefaultMinSE = 900
This attribute defines the minimum time accepted by the MTAS between refresh of a session.
Recommended to be equal to the CSCF setting.


Dependencies: The value of the mtasSipDefaultMinSE attribute must be less or equal to the value of the mtasSipDefaultSessExpiry attribute.
Takes effect: New session
MtasSipSessionExpiryDT
mtasSipDefaultSessionExpiry = 1800
This attribute defines the duration between refresh of a session suggested by the MTAS. Recommended to be equal to the CSCF setting.

Takes effect: New session
MtasBooleanDT
mtasSipDisableLargeMsgCheck = false
This attribute defines if the MTAS is to apply a large message check for outgoing SIP messages.
The transport is not to be changed to TCP in case the message is larger than 1300 bytes and the large message check is disabled.


Takes effect: New session
MtasSipResponseTimerDT
mtasSipFailoverTimeInvite = 3
This attribute specifies the number of seconds that the MTAS will be waiting for the first SIP response messages from the CAT-S, I-CSCF or External MRFC before trying next server address received from DNS. This attribute is valid only for the initial INVITE messages.
Setting the parameter to 0 means that the RFC 3261 standard value (64*T1) will be used.


Dependencies: The value of this attribute can not be larger than 64*T1 where T1 is the value of mtasSipTimerT1. mtasSipFailoverTimeInvite can not be greater than mtasSipTimerB.
Takes effect: New session
MtasSipResponseTimerDT
mtasSipFailoverTimeNonInvite = 3
This attribute specifies the number of seconds that the MTAS will be waiting for SIP response messages from the I-CSCF or External MRFC before trying next server address received from DNS. The attribute is valid for all messages except initial INVITE. Setting the attribute to 0 means that the RFC 3261 standard value (64*T1) will be used.

Dependencies: The value of this attribute can not be larger than 64*T1 where T1 is the value of mtasSipTimerT1. mtasSipFailoverTimeNonInvite can not be greater than mtasSipTimerF.
Takes effect: New session
MtasUint01024to065535DT
mtasSipGlsPort = 5089
Not Used.This attribute defines the port number on which the Redirect Server listens to incoming requests.

Deprecated: 

Dependencies: The mtasFunctionAdministrativeState must be set to LOCKED (0) in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document: MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasString0to255DT[0..1]
mtasSipIcscfName
This attribute defines the domain name, host name, or IP address and optional port for the I-CSCF to be used by the MTAS for routing SIP messages, for example, icscf.operator.net or 10.1.2.3:5070.
The appended <port> is defined as "0", or 4 to 5 digits forming a number with the highest value 1024:65535. Port = 0 means that a domain name is specified, so the port to use is fetched from DNS with SRV lookup.
Numerical IPv6 addresses must be enclosed with brackets for example [1080::8:800:200c:417A]:8080. When port is not specified MTAS uses the 5060 default SIP port.


Dependencies: Dependency between this attribute and mtasSipCallOutOfBlueRouting, mtasCcAdministrativeState, mtasDtmAdministrativeState and mtasParlayX3pccAdministrativeState. This attribute must not be allowed to be empty if mtasSipCallOutOfBlueRouting is set to I-CSCF (1) or if mtasCcAdministrativeState is set to UNLOCKED (1) or if mtasDtmAdministrativeState is set to UNLOCKED (1) or mtasParlayX3pccAdministrativeState is set to UNLOCKED (1).
Takes effect: New session
MtasSipInvite2FinalResponseTimerDT
mtasSipInvite2FinalResponseTimer = 192
This attribute defines the maximum time allowed after MTAS sends an INVITE message and does not receive or generate a final response. The value 0 should be avoided due to robustness issues. Note that if the value 0 is used and the call setup time reaches 10 minutes, then the Node Control function "Hanging Process Supervision" will terminate the process unconditionally and tear down the call setup.

Dependencies: If mtasSipInvite2FinalResponseTimer is enabled (> 0), mtasSipInvite2FinalResponseTimer has to be at least 10 seconds longer than mtasMmtNoReplyTimer and mtasMmtOrigNoReplyTimer.MtasSipInvite2FinalResponseTimer should be at least 10 sec more than the value of mtasSipTimerB. The value of mtasMrfOperationTimer shall not be greater than mtasSipInvite2FinalResponseTimer.
Takes effect: New session
MtasUint00000to000063DT
mtasSipIpDscpMarking = 0
This attribute defines the Differentiated Services Control Point (DSCP) value which is used for SIP traffic classification.

Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change.
Takes effect: (Unlock) of MtasFunction
MtasIPVersionDT
mtasSipIpVersion = IPV4
This attribute defines how to select the IP version to use for interfaces ISC, Ma and Mr.

Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change.
Takes effect: (Unlock) of MtasFunction
MtasString0to255DT[0..10]
mtasSipOptionsUri
This attribute defines the list of request URIs that is allowed to be used for the invocation of the function. If the list is empty (default value) then no invocation will be done.
The general format of the attribute is "sip:[<user>@]<host>[:<port>]" at maximum 64 characters. No parameters, headers, password etc. are allowed.
Either the URI could include:
- The MTAS OPTIONS Node Name URI (subdomain-based PSI), consisting of a subdomain and possibly a user name. Example: "sip:mtas1@factory.operator.net".
- It can also be possible to use a "sip:<host>[:<port>]". Example: "sip:192.168.1.5:1234".


Dependencies: Should not match any of the other addresses configured in MTAS.
Takes effect: New session
BasicAdmState
mtasSipOriginatingAsChaining = LOCKED
This attribute specifies the behavior for originating services after re-targeting of a session (for example CDiv and FCD) and when initiating call out of blue sessions to a target.
When disabled; after re-targeting originating services are invoked internally in MTAS, AS chaining for originating is not possible.
When enabled; after re-targeting originating services are invoked for the servered user in a new originatind session in MTAS, AS chaining for originating services is then possible.
This applies to originating services for registeredand unregistered user


Dependencies: The mtasSipSupportPServedUserHeader must be enabled before this attribute is enabled.
This attribute must be disabled before the mtasSipSupportPServedUserHeader is disabled.
Takes effect: Not applicable
MtasUint01024to065535DT
mtasSipPresencePort = 5086
This attribute defines the port on which MTAS listens for SIP messages from the Presence Server.

Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP
and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document:
MTAS, SIP Management, Reference.
Takes effect: (Unlock) of MtasFunction
MtasSipProtocolMtasOrigCallDT
mtasSipProtocolMtasOrigCall = UDP
This attribute defines which protocol that the MTAS is to use for originating sessions.

Takes effect: New session
MtasUint00001to065535DT
mtasSipPsiPort = 5060
This attribute defines the port number to which SIP messages with a PSI identifying a service on the own node
are routed to. The packets are routed as specified in RFC 3263 not as a result of triggers


Dependencies: When a DNS "SRV" lookup is used to locate the MTAS as specified in RFC 3263, then the SIP port number SIP services must match this number. The mtasFunctionAdministrativeState
must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then
insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document:
MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasUint01024to065535DT
mtasSipRsPort = 5089
Not Used.This attribute defines the port number on which the Redirect Server listens to incoming requests.


Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document: MTAS, SIP Management. The value of this parameter should be: Equal to 5060 if no port number is specified in the mtasLocationFunctionAddress parameter on the MMTel node. Equal to the port number specified in the mtasLocationFunctionAddress parameter on the MMTel node if this number is not zero. Equal to the port number specified in DNS server if the mtasLocationFunctionAddress parameter on the MMTel defines zero port number.
Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipSccOrigPort = 5160
This attribute specifies the port on which the SCC AS listens for originating traffic.
This port number must match the one in the trigger in the HSS.


Dependencies: mtasFunctionAdministrativeState has to be locked to be able to change the originating port.
This attribute must not have the same value as any other attribute that defines a port number.

Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipSccOrigUnregPort = 5161
This attribute specifies the port on which the SCC AS listens for originating unregistered traffic.
This port number must match the one in the trigger in the HSS.


Dependencies: mtasFunctionAdministrativeState has to be locked to be able to change the originating port.
This attribute must not have the same value as any other attribute that defines a port number.

Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipSccTermPort = 5162
This attribute specifies the port on which the SCC AS listens for terminating traffic.
This port number must match the one in the trigger in the HSS.


Dependencies: mtasFunctionAdministrativeState has to be locked to be able to change the terminating port.
This attribute must not have the same value as any other attribute that defines a port number.

Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipSccTermUnregPort = 5163
This attribute specifies the port on which the SCC AS listens for terminating unregistered traffic.
This port number must match the one in the trigger in the HSS.


Dependencies: mtasFunctionAdministrativeState has to be locked to be able to change the terminating unregistered port.
This attribute must not have the same value as any other attribute that defines a port number.

Takes effect: (Unlock) of MtasFunction
MtasSipSdpAns200DT
mtasSipSdpAns200 = DO_NOT_ADD
This attribute defines the repetition of the SDP answer in the 200 OK response to the initial INVITE where the SDP answer has previously been provided in a reliable provisional response.
This attribute is only to be modified when the MTAS is initially deployed. Modification following system deployment will result in modified message sequences which may impact traffic.


Takes effect: New session
MtasSipServerUserAgentHeaderDT
mtasSipServerUserAgentHeader = ALL
This attribute defines when to insert the SIP Server and User-Agent headers.
If configured to 0 (none), MTAS will pass through any received Server and/or User-Agent headers. A Server/User-Agent header will be inserted on the UA-C side (if received on the UA-S side).
If configured to 1 (request), MTAS will insert User-Agent header for SIP requests on the UA-C side. A Server header will be inserted on the UA-C side (if received on the UA-S side).
If configured to 2 (all), MTAS will insert User-Agent header for SIP requests and Server header for SIP responses on the UA-C side.
The format of the SIP User-Agent and Server headers is "Ericsson MTAS" followed by SW Product Number and R-state.
Example: "Ericsson MTAS - CXP9011263/5 R6D"


Takes effect: New session
MtasSipSteppingOLineSessionVersionDT
mtasSipSteppingOLineSessionVersion = DISABLED
This attribute defines the MTAS behaviour on reINVITE and UPDATE transaction for stepping the O Line Session-Version when forwarding the Sip message. When MTAS receives the message which has unmodofied SDP body but stepped O Line session-version, then based on the value of this attribute, it decides when forwarding the message out, if the O Line session-version should be stepped or not

Dependencies: None
Takes effect: New session
MtasUint00001to065535DT
mtasSipStPort = 5090
This attribute is the port for receiving all SIP traffic related to ST AS.


Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document: MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasBooleanDT
mtasSipSuperviseAllSessions = true
This attribute defines whether all sessions will have at least one dialog supervised by Session-Timers even if not negotiated in the signaling.

Dependencies: This attribute has no effect if
mtasSipDefaultSessionExpiry is set to 0.
Takes effect: New session
BasicAdmState
mtasSipSupportPServedUserHeader = UNLOCKED
This attribute specifies if the P-Served-User headers shall be supported.
When supported the served user will be determined from the P-Served-User header when available. Otherwise the served user is determined form the P-Asserted-Id for originating sessions and from the Request URI for terminating sessions, according RFC 5502 and 3GPP TS 24.229 Release 8 Section 5.7.1.3A.
When the P-Served-User header is supported and the received P-Served-User header contains the "sescase" and "regstate" parameters, MTAS determines the session case and registration state based on the received values.


Deprecated: 

Dependencies: This attribute must be enabled before the mtasSipOriginatingAsChaining attribute is enabled. The mtasSipOriginatingAsChaining attribute must be disabled before this attribute is disabled.

Takes effect: New session
MtasTimerSec00030to003600DT
mtasSipTcpConnectionTimeout = 60
This attribute defines the time-out value when outgoing TCP connections will be closed if they have been idle since the last
time-out, and incoming TCP connections are closed, if they have been idle during two time-outs.


Dependencies: Must not be lower than 32 times the value of the T1 timer, described in the
mtasSipTimerT1 attribute. In effect after a time-out.
Takes effect: Immediate
MtasUint00001to000064DT
mtasSipTimerB = 64
This parameter specifies the multiplication factor of mtasSipTimerT1 for the value of SIP Timer B. The formula used to calculate the value of SIP timer B is (mtasSipTimerB * mtasSipTimerT1).

Dependencies: The value of this attribute can not be larger than 64*T1 where T1 is the value of mtasSipTimerT1. MtasSipInvite2FinalResponseTimer should be at least 10 sec more than the value of mtasSipTimerB. mtasSipFailoverTimeInvite can not be greater than mtasSipTimerB.
Takes effect: New session
MtasUint00001to000064DT
mtasSipTimerF = 64
This parameter specifies the multiplication factor of mtasSipTimerT1 for the value of SIP Timer F. The formula used to calculate the value of SIP timer F is (mtasSipTimerF * mtasSipTimerT1).

Dependencies: The value of this attribute can not be larger than 64*T1 where T1 is the value of mtasSipTimerT1. mtasSipFailoverTimeNonInvite can not be greater than mtasSipTimerF.
Takes effect: New session
MtasSipTimerT1DT
mtasSipTimerT1 = 500
This attribute defines the T1 timer in accordance to RFC 3261. T1 is an estimate of the
SIP signaling round-trip time. Nearly all of the SIP transaction timers scale with
T1, and changing T1 adjusts their values. Recommended to be equal to the CSCF
setting in order to avoid signaling overhead. Under most circumstances the T1 timer
is set to the default value of 500 milliseconds. For guidelines how to set T1 in
exceptional cases, see RFC 3261 section 17.1.1.2.


Dependencies: The 64*(value of this attribute) can not be shorter than the value of attributes mtasSipFailoverTimeInvite and mtasSipFailoverTimeNonInvite. The value of mtasSipTimerT1 can not be larger than mtasSipTimerT2.
Takes effect: New session
MtasTimerMSec00200to032000DT
mtasSipTimerT2 = 4000
This attribute defines the value of the SIP transaction timer T2.

Dependencies: The value of mtasSipTimerT1 can not be larger than mtasSipTimerT2.
Takes effect: New session
MtasUint00001to065535DT
mtasSipTrafficOriginatingIpPort = 5082
This attribute defines the port number on which the MTAS listens for originating traffic. The port
number must be equal to the trigger information stored in the HSS.


Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP
and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document:
MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipTrafficOrigUnregIpPort = 5087
This attribute defines the port number on which MTAS listens for originating unregistered traffic. The port number must be equal to the trigger information stored in HSS.


Dependencies: MtasFunction administrative state must be locked in order to allow change.
To open traffic for a new port number, remove VIP Mappings for the old UDP and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number.

Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipTrafficTerminatingIpPort = 5083
This attribute defines the port number on which the MTAS listens for terminating traffic.
The port number must be equal to the trigger information stored in the HSS.


Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP
and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document:
MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasUint00001to065535DT
mtasSipTrafficTermUnregIpPort = 5084
This attribute defines the port number on which the MTAS listens for terminating unregistered traffic.
The port number must be equal to the trigger information stored in the HSS.


Dependencies: The mtasFunctionAdministrativeState must be locked in order to allow change. To open traffic for a new port number, remove VIP Mappings for the old UDP
and TCP port number and then insert VIP Mappings with the same data for the new UDP and TCP port number. To change SIP Ports, refer to the following document:
MTAS, SIP Management.
Takes effect: (Unlock) of MtasFunction
MtasSipTransportInContactDT
mtasSipTransportInContact = KEEP
This attribute defines which transport to be included in the Contact header.
Keep indicates that the same transport is to be used as the message that caused this message to be sent.


Takes effect: New session
BasicAdmState
mtasSipUeSessionTimerSupport = UNLOCKED
This attribute defines whether Session Timer Procedures are applicable to User Equipment sessions or not. If it is LOCKED (0), MTAS does not include Session Timer related headers in the sent SIP messages (both requests and responses). This attribute may only be disabled in networks where 422 Session Interval Too Small responses are not used.

Takes effect: New session

  class MtasSip