MSDTC Connection Manager: Oletx Management Protocol

[MS-CMOM]:

MSDTC Connection Manager: OleTx Management Protocol

Intellectual Property Rights Notice for Open Specifications Documentation

§  Technical Documentation. Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions.

§  Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation.

§  No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.

§  Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .

§  License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map.

§  Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit www.microsoft.com/trademarks.

§  Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.

Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it.

Support. For questions and support, please contact .

Revision Summary

Date / Revision History / Revision Class / Comments /
7/20/2007 / 0.1 / Major / MCPP Milestone 5 Initial Availability
9/28/2007 / 1.0 / Major / Updated and revised the technical content.
10/23/2007 / 1.1 / Minor / Revised a Windows Behavior note.
11/30/2007 / 1.1.1 / Editorial / Revised a Windows Behavior note.
1/25/2008 / 1.1.2 / Editorial / Changed language and formatting in the technical content.
3/14/2008 / 2.0 / Major / Updated and revised the technical content.
5/16/2008 / 2.0.1 / Editorial / Changed language and formatting in the technical content.
6/20/2008 / 3.0 / Major / Updated and revised the technical content.
7/25/2008 / 4.0 / Major / Updated and revised the technical content.
8/29/2008 / 4.0.1 / Editorial / Changed language and formatting in the technical content.
10/24/2008 / 4.1 / Minor / Clarified the meaning of the technical content.
12/5/2008 / 5.0 / Major / Updated and revised the technical content.
1/16/2009 / 6.0 / Major / Updated and revised the technical content.
2/27/2009 / 7.0 / Major / Updated and revised the technical content.
4/10/2009 / 8.0 / Major / Updated and revised the technical content.
5/22/2009 / 9.0 / Major / Updated and revised the technical content.
7/2/2009 / 10.0 / Major / Updated and revised the technical content.
8/14/2009 / 11.0 / Major / Updated and revised the technical content.
9/25/2009 / 12.0 / Major / Updated and revised the technical content.
11/6/2009 / 13.0 / Major / Updated and revised the technical content.
12/18/2009 / 14.0 / Major / Updated and revised the technical content.
1/29/2010 / 14.0.1 / Editorial / Changed language and formatting in the technical content.
3/12/2010 / 15.0 / Major / Updated and revised the technical content.
4/23/2010 / 15.1 / Minor / Clarified the meaning of the technical content.
6/4/2010 / 15.2 / Minor / Clarified the meaning of the technical content.
7/16/2010 / 15.3 / Minor / Clarified the meaning of the technical content.
8/27/2010 / 16.0 / Major / Updated and revised the technical content.
10/8/2010 / 16.1 / Minor / Clarified the meaning of the technical content.
11/19/2010 / 16.2 / Minor / Clarified the meaning of the technical content.
1/7/2011 / 17.0 / Major / Updated and revised the technical content.
2/11/2011 / 18.0 / Major / Updated and revised the technical content.
3/25/2011 / 19.0 / Major / Updated and revised the technical content.
5/6/2011 / 19.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/17/2011 / 19.1 / Minor / Clarified the meaning of the technical content.
9/23/2011 / 19.1 / None / No changes to the meaning, language, or formatting of the technical content.
12/16/2011 / 20.0 / Major / Updated and revised the technical content.
3/30/2012 / 20.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/12/2012 / 20.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/25/2012 / 20.0 / None / No changes to the meaning, language, or formatting of the technical content.
1/31/2013 / 20.0 / None / No changes to the meaning, language, or formatting of the technical content.
8/8/2013 / 21.0 / Major / Updated and revised the technical content.
11/14/2013 / 21.0 / None / No changes to the meaning, language, or formatting of the technical content.
2/13/2014 / 21.0 / None / No changes to the meaning, language, or formatting of the technical content.
5/15/2014 / 21.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/30/2015 / 22.0 / Major / Significantly changed the technical content.
10/16/2015 / 22.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/14/2016 / 22.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/1/2017 / 22.0 / None / No changes to the meaning, language, or formatting of the technical content.

Table of Contents

1 Introduction 7

1.1 Glossary 7

1.2 References 9

1.2.1 Normative References 9

1.2.2 Informative References 10

1.3 Overview 10

1.3.1 Management Client Role 10

1.3.2 Management Server Role 11

1.3.3 Common Scenarios 11

1.3.3.1 Setting and Enabling a Configuration Setting 11

1.3.3.2 Subscribing to Transaction Monitoring Information 12

1.4 Relationship to Other Protocols 13

1.5 Prerequisites/Preconditions 13

1.6 Applicability Statement 14

1.7 Versioning and Capability Negotiation 14

1.7.1 Versioning and Capability Negotiation for the OleTx Transports Protocol 14

1.7.2 Versioning and Capability Negotiation for the Registry Protocol 14

1.7.3 Versioning and Capability Negotiation for the Service Control Manager Remote Protocol 14

1.8 Vendor-Extensible Fields 14

1.9 Standards Assignments 14

2 Messages 15

2.1 Transport 15

2.1.1 Messages, Connections, and Sessions 15

2.1.2 MS-CMP and MS-CMPO Initialization 15

2.2 Message Syntax 15

2.2.1 Protocol Versioning 15

2.2.1.1 OleTx Transaction Protocol Message Versions 15

2.2.1.2 Registry Protocol Versions 15

2.2.1.2.1 Versioning Support of the Registry Keys 16

2.2.1.2.1.1 Versioning Support of the Functional Registry Key Values 16

2.2.1.2.1.2 Versioning Support of the Security Access Registry Key Values 16

2.2.1.2.1.3 Versioning Support of the RPC Security Registry Key Values 16

2.2.1.2.1.4 Versioning Support of the Endpoint Registry Key Values 17

2.2.1.2.2 Registry Path and Access Protocol of the Registry Key Values 17

2.2.1.2.2.1 Registry Path and Access Protocol of the Functional Registry Key 17

2.2.1.2.2.2 Registry Path and Access Protocol of the Security Access Registry Key 18

2.2.1.2.2.3 Registry Path and Access Protocol of the RPC Security Registry Key 18

2.2.1.2.2.4 Registry Path and Access Protocol of the Transaction Manager Contact Registry Keys 18

2.2.1.2.2.5 Registry Path and Access Protocol of the Transaction Manager Endpoint Registry Keys 19

2.2.2 OleTx Multiplexing Protocol Message Syntax 19

2.2.2.1 Connection Types 20

2.2.2.2 Data Structures 20

2.2.2.2.1 DtcUITranListElement 20

2.2.2.3 Enumerations 21

2.2.2.3.1 TRACKING_STATUS 21

2.2.2.3.2 UPDATE_LIMIT 23

2.2.2.3.3 SHOW_LIMIT 23

2.2.2.3.4 TRACE_LEVEL 23

2.2.2.3.5 TRACE_SEVERITY_LEVEL 24

2.2.2.4 Connection Type Details 24

2.2.2.4.1 CONNTYPE_TXUSER_DTCUIC 24

2.2.2.4.1.1 MTAG_HELLO 25

2.2.2.4.1.2 MSG_DTCUIC_TRACELIMIT 25

2.2.2.4.1.3 MSG_DTCUIC_UPDATELIMIT 25

2.2.2.4.1.4 MSG_DTCUIC_SHOWLIMIT 26

2.2.2.4.1.5 MSG_DTCUIC_STATS 26

2.2.2.4.1.6 MSG_DTCUIC_TRANLIST 28

2.2.2.4.1.7 MSG_DTCUIC_TRACE 29

2.2.2.4.1.8 MSG_DTCUIC_TRACESTRING 30

2.2.3 Registry Keys and Values 32

2.2.3.1 Enumerations 32

2.2.3.1.1 RPC_NETWORK_PROTOCOL 32

2.2.3.2 Functional Registry Key Values 32

2.2.3.3 Security Access Registry Key Values 33

2.2.3.4 RPC Security Registry Key Values 33

2.2.3.5 Transaction Manager Contact Registry Keys 34

2.2.3.5.1 Subkey Values for the "HKEY_CLASSES_ROOT\CID\<GUID>" Keys 34

2.2.3.6 Transaction Manager Endpoint Registry Keys 35

2.2.3.6.1 Subkey Values for the "EndpointRegistryPath\MSDTCUIS_GUID"\CustomProperties Key 35

2.2.4 Service Names Used with the Service Control Manager Remote Protocol Transport 36

3 Protocol Details 37

3.1 Common Details 37

3.1.1 Abstract Data Model 37

3.1.2 Timers 37

3.1.3 Initialization 37

3.1.4 Protocol Versioning Details 38

3.1.5 Higher-Layer Triggered Events 38

3.1.6 Message Processing Events and Sequencing Rules 38

3.1.7 Timer Events 38

3.1.8 Other Local Events 38

3.2 Management Client Role 38

3.2.1 Abstract Data Model 38

3.2.1.1 CONNTYPE_TXUSER_DTCUIC Initiator States 38

3.2.1.1.1 Idle 39

3.2.1.1.2 Active 39

3.2.1.1.3 Ended 40

3.2.2 Timers 40

3.2.3 Initialization 40

3.2.4 Protocol Versioning Details 41

3.2.4.1 Determining the Version of the Registry Protocol 41

3.2.4.2 Determining the Management Server Cluster Resource ID 42

3.2.5 Higher-Layer Triggered Events 43

3.2.5.1 Connecting to the Management Server 43

3.2.5.2 Testing the Connection 43

3.2.5.3 Setting the Update Limit on the Management Server 44

3.2.5.4 Setting the Show Limit on the Management Server 44

3.2.5.5 Setting the Trace Limit on the Management Server 44

3.2.5.6 Disconnecting from the Management Server 44

3.2.5.7 Reading from a Registry Key of the Management Server 45

3.2.5.8 Writing to a Registry Key of the Management Server 45

3.2.6 Message Processing Events and Sequencing Rules 45

3.2.6.1 CONNTYPE_TXUSER_DTCUIC as Initiator 45

3.2.6.1.1 Receiving an MSG_DTCUIC_TRACESTRING, MSG_DTCUIC_TRACE, MSG_DTCUIC_STATS, or MSG_DTCUIC_TRANLIST Message 46

3.2.6.1.2 Connection Disconnected 46

3.2.7 Timer Events 46

3.2.8 Other Local Events 46

3.3 Management Server Role 46

3.3.1 Abstract Data Model 46

3.3.1.1 Connection States 47

3.3.1.1.1 CONNTYPE_TXUSER_DTCUIC Acceptor States 47

3.3.1.1.1.1 Idle 48

3.3.1.1.1.2 Active 48

3.3.1.1.1.3 Ended 49

3.3.1.2 Registry Keys (Public) 49

3.3.1.2.1 Functional Registry Keys 49

3.3.1.2.2 Security Access Registry Keys 50

3.3.1.2.3 RPC Security Registry Keys 50

3.3.1.2.4 "EndpointRegistryPath\MSDTCUIS_GUID\CustomProperties" Registry Key 51

3.3.2 Timers 51

3.3.2.1 Update Timer 51

3.3.3 Initialization 52

3.3.4 Higher-Layer Triggered Events 52

3.3.4.1 Trace 52

3.3.4.2 Trace String 53

3.3.4.3 Update Transaction Stats 53

3.3.5 Message Processing Events and Sequencing Rules 55

3.3.5.1 CONNTYPE_TXUSER_DTCUIC as Acceptor 55

3.3.5.1.1 Receiving an MTAG_HELLO Message 55

3.3.5.1.2 Receiving an MSG_DTCUIC_UPDATELIMIT Message 55

3.3.5.1.3 Receiving an MSG_DTCUIC_SHOWLIMIT Message 55

3.3.5.1.4 Receiving an MSG_DTCUIC_TRACELIMIT Message 55

3.3.5.1.5 Connection Disconnected 55

3.3.6 Timer Events 56

3.3.6.1 Update Timer 56

3.3.7 Other Local Events 57

3.3.7.1 Incoming Connection Request 57

3.3.7.2 Service Control Events 58

4 Protocol Examples 59

4.1 Simple Management Client Scenario 59

4.1.1 Beginning a Management Client 59

4.1.2 Adjusting the Update Limit 62

4.1.3 Adjusting the Show Limit 63

4.2 Enabling XA Transactions Scenario 63

4.2.1 Setting the XaTransactions Registry Key on the Remote Machine 63

4.2.2 Restarting the Transaction Manager on the Remote Machine 65

4.2.2.1 Stopping the Transaction Manager Service 65

4.2.2.2 Starting the Transaction Manager Service 66

5 Security 68

5.1 Security Considerations for Implementers 68

5.2 Index of Security Parameters 68

6 Appendix A: Product Behavior 69

7 Change Tracking 71

8 Index 72

1  Introduction

This specification specifies the MSDTC Connection Manager: OleTx Management Protocol, which enables the remote management of a transaction manager.

Remote management allows a user to do the following:

§  Subscribe to and receive transaction monitoring information by using the OleTx Transports Protocol [MS-CMPO].

§  Get and set transaction manager configuration information contained in registry keys by using the Windows Remote Registry Protocol [MS-RRP] or the Failover Cluster: Management API (ClusAPI) Protocol [MS-CMRP]. Collectively, these two protocols are referred to herein as the Registry Protocol.

§  Manage the life cycle of the transaction manager by using the Service Control Manager Remote Protocol [MS-SCMR].

Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.

1.1  Glossary

This document uses the following terms:

authenticated user: A built-in security group specified in [MS-WSO] whose members include all users that can be authenticated by a computer.

client: A computer on which the remote procedure call (RPC) client is executing.

cluster registry root key: The root key of the cluster registry. The root key is described in [MS-RRP] section 3.1.1.1.1.

cluster resource: A resource as defined in [MS-CMRP].

cluster resource ID: A Unicode string representing the globally unique ID (GUID) of a cluster resource as specified in [MS-CMRP] section 3.1.4.2.15.