Skip to content

Latest commit

 

History

History
253 lines (197 loc) · 6.42 KB

Set-DtcClusterTMMapping.md

File metadata and controls

253 lines (197 loc) · 6.42 KB
Raw
external help file Module Name ms.date online version schema title
MSFT_DtcClusterTMMappingTask_v1.0.cdxml-help.xml
MsDTC
10/29/2017
2.0.0
Set-DtcClusterTMMapping

Set-DtcClusterTMMapping

SYNOPSIS

Modifies an existing cluster DTC mapping.

SYNTAX

ServiceSet

Set-DtcClusterTMMapping -Name <String> [-ClusterResourceName <String>] [-Local <Boolean>] -Service <String>
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ResourceNameSet

Set-DtcClusterTMMapping -Name <String> -ClusterResourceName <String> [-Local <Boolean>]
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

LocalSet

Set-DtcClusterTMMapping -Name <String> [-ClusterResourceName <String>] -Local <Boolean>
 [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ExeSet

Set-DtcClusterTMMapping -Name <String> [-ClusterResourceName <String>] [-Local <Boolean>]
 -ExecutablePath <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

ComPlusSet

Set-DtcClusterTMMapping -Name <String> -ComPlusAppId <String> [-ClusterResourceName <String>]
 [-Local <Boolean>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Set-DtcClusterTMMapping cmdlet modifies an existing cluster Distributed Transaction Coordinator (DTC) mapping. This cmdlet is supported on clustered computers only.

EXAMPLES

Example 1: Modify a DTC cluster mapping

PS C:\> Set-DtcClusterTMMapping -ExecutablePath "C:\TestApp\SampleApp.exe" -Name "LocalTestAppMapping" -ClusterResourceName "DtcResource2"

This command modifies an existing DTC cluster TM mapping.

PARAMETERS

-AsJob

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: Session

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClusterResourceName

Specifies the name of a cluster DTC resource. This cmdlet sets the TM mapping of the resource that the name specifies.

Type: String
Parameter Sets: ServiceSet, LocalSet, ExeSet, ComPlusSet
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String
Parameter Sets: ResourceNameSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComPlusAppId

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

Type: String
Parameter Sets: ComPlusSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExecutablePath

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

Type: String
Parameter Sets: ExeSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Local

Specifies whether the application type is local. If you specify a value of $False, the application is a clustered resource.

Type: Boolean
Parameter Sets: ServiceSet, ResourceNameSet, ExeSet, ComPlusSet
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Boolean
Parameter Sets: LocalSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the DTC mapping to add.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Service

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

Type: String
Parameter Sets: ServiceSet
Aliases: 

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

DtcClusterTMMapping

NOTES

  • This cmdlet returns a DtcClusterTMMapping object that contains modified mapping information.

RELATED LINKS

Add-DtcClusterTMMapping

Get-DtcClusterTMMapping

Remove-DtcClusterTMMapping