IMS Service Level Tracing Management Object

3GPP TS 24.323 V9.0.0 (2009-12)
Technical Specification
3rd Generation Partnership Project;
Technical Specification Group Core Network and Terminals;
3GPP IP Multimedia Subsystem (IMS) service level tracing management object (MO)
(Release 9)


	 EMBED Word.Picture.8  
The present document has been developed within the 3rd Generation Partnership Project (3GPP TM) and may be further elaborated for the purposes of 3GPP.	 
The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.	 
This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
Specifications and reports for implementation of the 3GPP TM system should be obtained via the 3GPP Organizational Partners' Publications Offices.



Keywords
UMTS, IMS, SIP, Multimedia, Management, GSM, LTE

3GPP
Postal address

3GPP support office address
650 Route des Lucioles - Sophia Antipolis
Valbonne - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Internet
http://www.3gpp.org

Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© 2009, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
All rights reserved.

UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
GSM® and the GSM logo are registered and owned by the GSM Association
Contents
 TOC \o "1-9" Foreword	 PAGEREF _Toc225243272 \h 4
1	Scope	 PAGEREF _Toc225243273 \h 5
2	References	 PAGEREF _Toc225243274 \h 5
3	Definitions and abbreviations	 PAGEREF _Toc225243275 \h 5
3.1	Definitions	 PAGEREF _Toc225243276 \h 5
3.2	Abbreviations	 PAGEREF _Toc225243277 \h 5
4	IMS service level tracing management object	 PAGEREF _Toc225243278 \h 6
5	Management object parameters	 PAGEREF _Toc225243279 \h 8
5.1	General	 PAGEREF _Toc225243280 \h 8
5.2	Node: /	 PAGEREF _Toc225243281 \h 8
5.3	//Name	 PAGEREF _Toc225243282 \h 8
5.4	//Debug_info_List/	 PAGEREF _Toc225243283 \h 8
5.5	//Debug_info_List/	 PAGEREF _Toc225243284 \h 8
5.6	//Debug_info_List//Debug_config/	 PAGEREF _Toc225243285 \h 9
5.7	//Debug_info_List//Debug_config/Address_of_record	 PAGEREF _Toc225243286 \h 9
5.8	//Debug_info_List//Debug_config/Session_List/	 PAGEREF _Toc225243287 \h 9
5.9	//Debug_info_List//Debug_config/Session_List/	 PAGEREF _Toc225243288 \h 9
5.10	//Debug_info_List//Debug_config/Session_List//Session/	 PAGEREF _Toc225243289 \h 10
5.11	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/	 PAGEREF _Toc225243290 \h 10
5.12	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/From	 PAGEREF _Toc225243291 \h 10
5.13	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/To	 PAGEREF _Toc225243292 \h 10
5.14	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/ICSI	 PAGEREF _Toc225243293 \h 11
5.15	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/IARI	 PAGEREF _Toc225243294 \h 11
5.16	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Method	 PAGEREF _Toc225243295 \h 11
5.17	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Time	 PAGEREF _Toc225243296 \h 12
5.18	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Debug_ID	 PAGEREF _Toc225243297 \h 12
5.19	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/	 PAGEREF _Toc225243298 \h 12
5.20	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Time	 PAGEREF _Toc225243299 \h 12
5.21	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Time_period	 PAGEREF _Toc225243300 \h 13
5.22	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Reason	 PAGEREF _Toc225243301 \h 13
5.23	//Debug_info_List//Debug_config/Session_List//Session/Control/	 PAGEREF _Toc225243302 \h 13
5.24	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List/	 PAGEREF _Toc225243303 \h 14
5.25	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List//	 PAGEREF _Toc225243304 \h 14
5.26	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List//Interface	 PAGEREF _Toc225243305 \h 14
5.27	//Debug_info_List//Debug_config/Session_List//Session/Control/Depth	 PAGEREF _Toc225243306 \h 14
5.28	//Debug_info_List//Debug_config/Session_List//Session/Control/Debug_ID	 PAGEREF _Toc225243307 \h 15
Annex A (informative):	Management object DDF	 PAGEREF _Toc225243308 \h 16
Annex B (informative):	Change history	 PAGEREF _Toc225243309 \h 27

Foreword
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x	the first digit:
1	presented to TSG for information;
2	presented to TSG for approval;
3	or greater indicates TSG approved document under change control.
y	the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
z	the third digit is incremented when editorial only changes have been incorporated in the document.
1	Scope
This document defines the IMS service level tracing management object. The management object is compatible with OMA Device Management protocol specifications, version 1.2 and upwards, and is defined using the OMA DM Device Description Framework as described in the Enabler Release Definition OMA-ERELD _DM-V1_2 [3].
The IMS service level tracing management object consists of relevant parameters that can be managed for IMS service level tracing capabilities.
2	References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific.
For a specific reference, subsequent revisions do not apply.
For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document.
[1]	3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2]	3GPP TS 23.003: "Numbering, addressing and identification".
[3]	OMA-ERELD-DM-V1_2-20070209-A: "Enabler Release Definition for OMA Device Management, Version 1.2".
[4]	XML Schema Part 2: Datatypes Second Edition, W3C Recommendation 28 October 2004, http://www.w3.org/TR/xmlschema-2/
[5]	draft-dawes-sipping-debug-event-00 (May 2008): "A Session Initiation Protocol (SIP) Event Package for Debugging".
Editor's note: The above document cannot be formally referenced until it is published as an RFC.
[6]	3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management".
3	Definitions and abbreviations
3.1	Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] apply.
3.2	Abbreviations
For the purposes of the present document, the following abbreviations apply:
CN	Core Network
DDF	Device Description Framework
DM	Device Management
IMS	IP Multimedia core network Subsystem
IP	Internet Protocol
MO	Management Object
OMA	Open Mobile Alliance
SIP	Session Initiation Protocol
UE	User Equipment
4	IMS service level tracing management object
The IMS service level tracing management object is used to manage configuration settings of the UE for IMS service level tracing. The management object covers parameters for IMS service level trace related capabilities. The management object enables the management of the settings on behalf of the end user.
The management object Identifier is: urn:oma:mo:ext-3gpp-ims_slt:1.0.
Protocol compatibility: This MO is compatible with OMA DM 1.2.
The following nodes and leaf objects are possible under the Service Level Tracingnode:
 EMBED Visio.Drawing.11  
Figure 1: The 3GPP Service Level Tracing Management Object
5	Management object parameters
5.1	General
This clause describes the parameters for the IMS service level tracing management object.
5.2	Node: /
This interior node acts as a placeholder for one or more accounts for a fixed node.
-	Occurrence: OneOrMore
-	Format: node
-	Access Types: Get
-	Values: N/A
The interior node is mandatory if the UE supports one or more IMS service level tracing capabilities. Support for a UE is defined by the related roles as defined by the related IMS service level tracing service, as listed in clause 4 of this specification.
NOTE:	One node is normally used. 
5.3	//Name
The Name leaf is a name for the 3GPP service level tracing settings.
-	Occurrence: ZeroOrOne
-	Format: chr
-	Access Types: Get
-	Values: 
5.4	//Debug_info_List/
The Debug-info_List node acts as a placeholder for control and configuration of IMS service level tracing. 
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.5	//Debug_info_List/
This run-time node acts as a placeholder for one or more debugging configurations containing control and configuration of IMS service level tracing.
-	Occurrence: One 
-	Format: node
-	Access Types: Get
-	Values: N/A
5.6	//Debug_info_List//Debug_config/ 
The Debug-config node acts as a placeholder for control and configuration of IMS service level tracing.
-	Occurrence: ZeroOrMore
-	Format: node
-	Access Types: Get
-	Values: N/A
5.7	//Debug_info_List//Debug_config/Address_of_record 
The Address_of_record leaf represents one public user identity.
-	Occurrence: One
-	Format: chr
-	Access Types: Get, Replace
-	Values: 
This public user identity is the identity used to subscribe to SIP debugging configuration from the debug-event package.
The format of the public user identity is defined by 3GPP TS 23.003 [2].
EXAMPLE:	sip: [email protected]
5.8	//Debug_info_List//Debug_config/Session_List/
The Session_List interior node is used to allow a reference to a list of different SIP sessions to be debugged.
-	Occurrence: One
-	Format: node
-	Access Types: Get
-	Values: N/A
5.9	//Debug_info_List//Debug_config/Session_List/
This run-time node acts as a placeholder for one or more descriptions of SIP sessions to be debugged. 
-	Occurrence: One
-	Format: node
-	Access Types: Get
-	Values: N/A
5.10	//Debug_info_List//Debug_config/Session_List//Session/ 
The Session interior node is used to allow a reference to events that start and stop logging of SIP signalling, and to control what is logged. 
-	Occurrence: One
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.11	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/ 
The Start_trigger interior node is used to allow a reference to events that start logging of SIP signalling. 
-	Occurrence: One
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.12	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/From 
The From leaf represents an address in the From: SIP header field.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.13	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/To 
The To leaf represents an address in the To: SIP header field.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.14	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/ICSI 
The ICSI leaf represents an IMS communication service identifier.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
The format of the IMS commuication service identifier is defined by 3GPP TS 24.229 [5].
EXAMPLE:	urn:urn-7:3gpp-service.ims.icsi.mmtel 
5.15	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/IARI 
The IARI leaf represents an IMS application reference identifier.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
The format of the IMS application reference identifier is defined by 3GPP TS 24.229 [5].
EXAMPLE:	urn:urn-7:3gpp-application.ims.iari.mmtel-app- 
5.16	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Method 
The Method leaf represents a SIP method.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
The SIP method names are listed in 3GPP TS 24.229 [5].
EXAMPLE:	MESSAGE
5.17	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Time 
The Method leaf represents a SIP method.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
Date and time is described by the standard type 'dateTime' for an XML schema [4].
EXAMPLE:	2009-05-09T15:00:00-05:00 to indicate 3:00 pm on May 9th, 2009 for Eastern Standard Time, which is 5 hours behind Coordinated Universal Time (UTC).
5.18	//Debug_info_List//Debug_config/Session_List//Session/Start_trigger/Debug_ID 
The Debug_ID leaf represents represents an identifier that allows trace logging to be correlated across IMS entities.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: <6-digit hexadecimal number>
The format of the trace reference is 3 octets in hexadecimal format, as defined by 3GPP TS 32.422 [6].
EXAMPLE:	7BA614
5.19	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/ 
The Stop_trigger interior node is used to allow a reference to events that stop logging of SIP signalling.
-	Occurrence: One 
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.20	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Time 
The Time leaf represents a time at which SIP logging is stopped.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
Date and time is described by the standard type 'dateTime' for an XML schema [4].
EXAMPLE:	2009-05-09T15:00:00-05:00 to indicate 3:00 pm on May 9th, 2009 for Eastern Standard Time, which is 5 hours behind Coordinated Universal Time (UTC).
5.21	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Time_period
The Time_period leaf represents a time duration of logging SIP signalling. When the duration has expired, logging stops.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: 
Time period is described by the standard type 'duration' for an XML schema [4].
5.22	//Debug_info_List//Debug_config/Session_List//Session/Stop_trigger/Reason 
The Reason leaf represents a named event that causes logging SIP signalling to stop.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get, Replace
-	Values: "dialog_established" or "session_end"
5.23	//Debug_info_List//Debug_config/Session_List//Session/Control/ 
The Control interior node is used to allow a reference to parameters that control what SIP signalling is logged.
-	Occurrence: One 
-	Format: node
-	Access Types: Get, Replace
-	Values: N/A
5.24	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List/
The Interface_List interior node is used to allow a reference to a list of different interfaces for which SIP signalling is to be logged.
-	Occurrence: One
-	Format: node
-	Access Types: Get
-	Values: N/A
5.25	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List//
This run-time node acts as a placeholder for one or more identifiers of interfaces for which SIP signalling is to be logged.
-	Occurrence: One
-	Format: node
-	Access Types: Get
-	Values: N/A
5.26	//Debug_info_List//Debug_config/Session_List//Session/Control/Interface_List//Interface 
The Interface leaf identifies an interfaces for which SIP signalling is to be logged.
-	Occurrence: One 
-	Format: node
-	Access Types: Get
-	Values: 
5.27	//Debug_info_List//Debug_config/Session_List//Session/Control/Depth 
The Depth leaf indicates which SIP requests and responses are to be logged.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get
-	Values: "maximum" or "minimum"
5.28	//Debug_info_List//Debug_config/Session_List//Session/Control/Debug_ID 
The Debug_ID leaf contains an identifier that is common to all logged SIP requests and responses for one logging session.
-	Occurrence: ZeroOrOne
-	Format: node
-	Access Types: Get
-	Values: .
EXAMPLE:	722330A4D7 
Annex A (informative):
Management object DDF
This DDF is the standardized minimal set. A vendor can define it’s own DDF for the complete device. This DDF can include more features than this minimal standardized version.




	1.2
	--The device manufacturer--
	--The device model--
	
		IMS service level tracing
		
			
				
			
			IMS service level trace configuration parameters
			
				
			
			
				
			
			The IMS service level tracing management object.
			
				
			
		
		
			Name
			
				
					
				
				
					
				
				
					
				
				
					
				
				User displayable name for the node.
				
					text/plain
				
			
		
		
		
			Debug_info_List
			
			
				
					
				
				
					
				
				
					
				
				
					
				
				List of debug configurations, one per debug session.
				
					
				
			
			
			
				
				
					
						
					
					
						
					
					
						
					
					
						
					
					The "name" node for a debug configuration object.
					
					
						
					
				
				
				
					Debug_config
					
						
							
							
						
						
							
						
						
							
						
						
							
						
						Configuration for debugging for one address of record.
						
							
						
					
					
					
					Address_of_record
					
						
							
							
						
						
							
						
						
							
						
						
							
						
						The address of record to be traced.
						
							text/plain
						
					
					
					
					
					
					
					Session_List
					
						
							
							
						
						
							
						
						
							
						
						
							
						
						Debug configuration parameters, one configuration object per session.
						
							
						
					
					
					
					
					
					
						
							
						
						
							
						
						
							
						
						
							
						
						The "name" node for a list of sessions to be traced.
						
						
							
						
					
					
					
					
					Session
					
						
							
						
						
							
						
						
							
						
						
							
						
						The configuration of a single debug session.
						
						
							
						
					
					
					
					
					Start_trigger
					
						
							
						
						
							
						
						
							
						
						
							
						
						The description of a start trigger for a debug session.
						
						
							
						
					
					
					
					
					From
					
						
							
						
						
							
						
						
							
						
						
							
						
						The SIP From header field in a debug session.
						
						
							text/plain
						
					
					
					 
					
					
					
					To
					
						
							
						
						
							
						
						
							
						
						
							
						
						The SIP To header field in a debug session.
						
						
							text/plain
						
					
					
					 
					
					
					
					ICSI
					
						
							
						
						
							
						
						
							
						
						
							
						
						The IMS service identifier (ICSI) in a session to be traced.
						
						
							text/plain
						
					
					
					
					
					
					
					IARI
					
						
							
						
						
							
						
						
							
						
						
							
						
						The IMS application reference (IARI) in a session to be traced.
						
						
							text/plain
						
					
					
					
					
					
					
					
					Method
					
						
							
						
						
							
						
						
							
						
						
							
						
						The SIP method that starts a debug session.
						
						
							text/plain
						
					
					
					
					
					
					
					ICSI
					
						
							
						
						
							
						
						
							
						
						
							
						
						The Time of day to start a debug session.
						
						
							text/plain
						
					
					
					
					
					
					
					Debug_ID
					
						
							
						
						
							
						
						
							
						
						
							
						
						The identity used to match logging of session across SIP entities.
						
						
							text/plain
						
					
					
					
					
					
					
					
					
					Stop_trigger
					
						
							
						
						
							
						
						
							
						
						
							
						
						Description of the event that stops an ongoing tracing session.
						
						
							
						
					
					
					
					
					Time
					
						
							
						
						
							
						
						
							
						
						
							
						
						The time at which to stop a debugging session.
						
						
							text/plain
						
					
					
					
					
					
					
					Time_period
					
						
							
						
						
							
						
						
							
						
						
							
						
						The time period after which a debugging session is stopped.
						
						
							text/plain
						
					
					
					
					
					
					
					Reason
					
						
							
						
						
							
						
						
							
						
						
							
						
						The reason to stop a debugging session. Values are dialog_established and session_end
						
						
							text/plain
						
					
					
					
					
					
					
					
					
					Control
					
						
							
						
						
							
						
						
							
						
						
							
						
						Control information for a tracing session including depth of trace and interfaces to trace.
						
						
							
						
					
					
					
					
					Interface_list
					
						
							
						
						
							
						
						
							
						
						
							
						
						List of interfaces for which SIP signalling will be logged.
						
						
							
						
					
					
					
					
					
						
							
						
						
							
						
						
							
						
						
							
						
						The "name" node for a list of interfaces.
						
						
							
						
					
					
					
					
					Interface
					
						
							
						
						
							
						
						
							
						
						
							
						
						The interface for which SIP signalling will be logged
						
						
							text/plain
						
					
					
					
					
					
					
					
					
					
					
					
					Depth
					
						
							
						
						
							
						
						
							
						
						
							
						
						The depth of logging for a debug session, values are minimum and maximum.
						
						
							text/plain
						
					
					
					 
					
					
					
					Debug_ID
					
						
							
						
						
							
						
						
							
						
						
							
						
						The identity used to match logging in a debug session across entities.
						
						
							text/plain
						
					
					
					
					
					
					
					
					
					
					
					
					
				
				
			
			
		
		
		
		
		
		
		
			Ext
			
			
				
					
					
				
				
					
				
				
					
				
				
					
				
				A collection of all Extension objects.
				
					
				
			
		
		

		
	
	


Annex B (informative):
Change history

Change history
DateTSG #TSG Doc.CRRevSubject/CommentOldNewWG doc2008-05Version 0.0.0: Preliminary proposal0.0.0C1-0818562008-05Version 0.0.1: Corrected preliminary proposal0.0.1C1-0819562008-05Version 0.0.2: Corrected wrong capitalizations0.0.2C1-0820402008-06Version 0.0.2: Added specification number0.0.32008-06CT1#54Parameters for service level trace0.0.30.1.0C1-0827542008-09Version 1.0.0 created for presentation to TSG CT#41 for information0.1.01.0.02008-10Version 1.1.0 created incorporating C1-084097, C1-084098 for presentation to TSG CT#42 for approval. 1.0.01.1.02008-11Version 2.0.0 created for presentation to TSG CT#42 for approval1.1.02.0.02008-12CT#42Version 8.0.0 created after approval in CT#422.0.08.0.02009-03CT#43CP-0901350001urn for the Trace MO registered by OMNA and minor corrections and cleanups8.0.08.1.0C1-0901982009-12CT#46Upgrade to Rel-98.1.09.0.0








 STYLEREF ZA 3GPP TS 24.323 V9.0.0 (2009-12)
 PAGE 27
 STYLEREF ZGSM Release 9


3GPP