Distributed Transaction Coordinator (DTC) Cmdlets
Applies To: Windows Server 2012 R2 Preview
Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.
Distributed Transaction Coordinator (DTC) Cmdlets
This reference provides cmdlet descriptions and syntax for all Microsoft Distributed Transaction Coordinator (MSDTC) -specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.
| Cmdlet | Description |
|---|---|
Add-DtcClusterTMMapping adds a Cluster DTC Mapping. |
|
Complete-DtcDiagnosticTransaction invokes the Commit process if the specified transaction is the root transaction; otherwise it invokes the Complete method on the transaction object specified by DtcDiagnosticTransaction. |
|
Get-Dtc enumerates DTC instances specified by the DtcName parameter, running on the host. |
|
Get-DtcAdvancedHostSetting queries the DTC host level properties that are stored in the registry. |
|
Get-DtcAdvancedSetting queries the DTC instance specific properties that are stored in the registry. |
|
Get-DtcClusterDefault retrieves the default cluster server. |
|
Get-DtcClusterTMMapping retrieves Cluster DTC Mapping data. |
|
Get-DtcDefault enumerates the Default DTC service running on the host. |
|
Get-DtcLog retrieves the Log File settings for the DTC instance specified by the DtcName parameter. |
|
Get-DtcNetworkSetting retrieves the DTC network and security configuration settings for the DTC service specified by the DtcName parameter. |
|
Get-DtcTransaction retrieves information of transactions being handled by the DTC service specified by the DtcName Parameter. |
|
Get-DtcTransactionStatistics retrieves a summary of transactions being handled by the specified DTC service. |
|
Get-DtcTransactionsTraceSession retrieves the DTC transactions trace session specific setting of the host. |
|
Get-DtcTransactionsTraceSetting retrieves the DTC transactions trace setting of the host. |
|
Install-Dtc installs the local transactions coordinator. |
|
Join-DtcDiagnosticResourceManager enlists a given diagnostic Resource Manager (RM) for a specified transaction object. |
|
New-DtcDiagnosticTransaction creates a new transaction in a Transaction Manager (TM) on the specified host. |
|
Receive-DtcDiagnosticTransaction propagates a transaction from a given Diagnostic Resource manager (RM). |
|
Remove-DtcClusterTMMapping removes a Cluster DTC Mapping. |
|
Reset-DtcLog resets the Log File of the DTC service specified by the DtcName parameter. |
|
Send-DtcDiagnosticTransaction propagates a transaction to a specified Diagnostic Resource Manager (RM). |
|
Set-DtcAdvancedHostSetting queries the DTC host level properties that are stored in the registry. |
|
Set-DtcAdvancedSetting sets the DTC instance specific properties that are stored in the registry. |
|
Set-DtcClusterDefault sets the cluster default transactions coordinator. |
|
Set-DtcClusterTMMapping modifies an existing Cluster DTC Mapping. |
|
Set-DtcDefault sets the default transactions coordinator. |
|
Set-DtcLog modifies the Log File settings of the DTC instance specified by the DtcName parameter. |
|
Set-DtcNetworkSetting modifies the DTC network and security configuration for the DTC service specified by the DtcName parameter. Set-DtcNetworkSetting will restart the DTC service. |
|
Set-DtcTransaction modifies the state of a transaction in the DTC host level properties stored in the registry. |
|
Set-DtcTransactionsTraceSession modifies the DTC transactions trace setting of the host. |
|
Set-DtcTransactionsTraceSetting modifies the DTC transactions trace setting of the host. |
|
Start-Dtc starts the DTC service specified by the DtcName parameter. |
|
Start-DtcDiagnosticResourceManager starts running a Diagnostic Resource Manager (RM) as a Windows PowerShell background job. |
|
Start-DtcTransactionsTraceSession starts a new DTC transactions trace session for the host. |
|
Stop-Dtc stops the DTC instance specified by the DtcName parameter. |
|
Stop-DtcDiagnosticResourceManager stops and removes a DiagnosticResourceManagerJob that is running as a Windows PowerShell background job. |
|
Stop-DtcTransactionsTraceSession stops the currently active DTC transactions trace session on the host. |
|
Performs a test on two specified computers to determine whether they can participate in networked transactions. |
|
Undo-DtcDiagnosticTransaction invokes the Abort process on the specified transaction. |
|
Uninstall-Dtc uninstalls the local transactions coordinator. |
|
Write-DtcTransactionsTraceSession writes the data in the currently active DTC transactions trace session into the log file. |
Note
To list all the cmdlets that are available, use the Get-Command -Module MsDtc cmdlet.
For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:
● Get-Help <cmdlet name> -Detailed
● Get-Help <cmdlet name> -Examples
● Get-Help <cmdlet name> -Full
More Information
For more information about the cmdlets, see the following: