Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DtcClusterTMMapping

Add-DtcClusterTMMapping

microsoft.dtc.powershell.dll, msft_dtcclustertmmappingtask_v1.0.cdxml

Synopsis

Adds a cluster DTC mapping.

Syntax

Add-DtcClusterTMMapping [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-ClusterResourceName] [-Local] [-Name] [-Service] [<CommonParameters>]

Add-DtcClusterTMMapping [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-ClusterResourceName] [-ComPlusAppId] [-Local] [-Name] [<CommonParameters>]

Add-DtcClusterTMMapping [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-ClusterResourceName] [-ExecutablePath] [-Local] [-Name] [<CommonParameters>]

Detailed Description

The Add-DtcClusterTMMapping cmdlet adds a cluster Distributed Transaction Coordinator (DTC) mapping. This cmdlet is supported on clustered computers only.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ClusterResourceName <String>

Specifies the name of a cluster DTC resource. This cmdlet associates this mapping with the resource that the name specifies.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ComPlusAppId <String>

Specifies the COM+ application identifier to associate with this mapping.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ExecutablePath <String>

Specifies the path of the application to associate with this mapping.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Local <Boolean>

Specifies whether the application type is local. If you specify a value of $False, the application is a clustered resource. If the application type is local, the application maps to the Local DTC instance and the cmdlet ignores the value of the ClusterResourceName parameter.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the name of the DTC mapping to add.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Service <String>

Specifies the name of the Windows service to associate with this mapping.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Create a cluster mapping

This command creates a DTC cluster Transaction Manager (TM) mapping.

PS C:\> Add-DtcClusterTMMapping -ClusterResourceName "DtcResource1" -ExecutablePath "C:\TestApp\App.exe" -Local $False -Name "LocalTestAppMapping"

Online Version
Get-DtcClusterTMMapping
Remove-DtcClusterTMMapping
Set-DtcClusterTMMapping