HelpCache/MSFT_DtcTask_v1.0.cdxml-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Dtc</command:name> <maml:description> <maml:para>Get-Dtc can be used to enumerate DTC instances specified by the DtcName parameter, running on the host.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Dtc</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Get-Dtc can be used to enumerate DTC instances specified by the DtcName parameter, running on the host.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Dtc</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC instance to be enumerated on the host. If this parameter is null or set to Local, this will return the Local DTC instance for the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC instance to be enumerated on the host. If this parameter is null or set to Local, this will return the Local DTC instance for the host.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> Get-Dtc DtcName : Local KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b Status : Started UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e VirtualServerName : CSDVM736403-GU XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd</dev:code> <dev:remarks> <maml:para>Using Get-Dtc without any parameters</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> PS C:\ Get-Dtc -DtcName Local DtcName : Local KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b Status : Started UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e VirtualServerName : CSDVM736403-GU XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd</dev:code> <dev:remarks> <maml:para>Using Get-Dtc to obtain a specific DTC instances information.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317153 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Install-Dtc</command:name> <maml:description> <maml:para>Install-Dtc can be used to install the local transactions coordinator.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>Dtc</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Install-Dtc can be used to install the local transactions coordinator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Install-Dtc</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>LogPath</maml:name> <maml:description> <maml:para>Specifies the path of the Log file. If not specified, the default log path is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>StartType</maml:name> <maml:description> <maml:para>Specifies the start type for the local transactions coordinator. Available start types include, BootStart, SystemStart, AutoStart, DemandStart, and Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>LogPath</maml:name> <maml:description> <maml:para>Specifies the path of the Log file. If not specified, the default log path is used.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>StartType</maml:name> <maml:description> <maml:para>Specifies the start type for the local transactions coordinator. Available start types include, BootStart, SystemStart, AutoStart, DemandStart, and Disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317165 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-Dtc</command:name> <maml:description> <maml:para>Start-Dtc starts the DTC service specified by the DtcName parameter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Start</command:verb> <command:noun>Dtc</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Start-Dtc starts the DTC service specified by the DtcName parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-Dtc</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC service to start. If this parameter is null or set to Local, this will start the Local DTC service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC service to start. If this parameter is null or set to Local, this will start the Local DTC service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317182 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-Dtc</command:name> <maml:description> <maml:para>Stop-Dtc stops the DTC instance specified by the DtcName parameter.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Stop</command:verb> <command:noun>Dtc</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Stop-Dtc stops the DTC instance specified by the DtcName parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-Dtc</maml:name> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC instance to stop. If this parameter is null or set to Local, this will stop the Local DTC instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Specifies to stop any services relying on the specified DTC instance, such as SQL Server, etc. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>DtcName</maml:name> <maml:description> <maml:para>Specifies the DTC instance to stop. If this parameter is null or set to Local, this will stop the Local DTC instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases=""> <maml:name>Recursive</maml:name> <maml:description> <maml:para>Specifies to stop any services relying on the specified DTC instance, such as SQL Server, etc. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>1. Get-Dtc -DtcName Local to view the Local DTC instance's Status. PS C:\> Get-Dtc -DtcName Local __GENUS : 2 __CLASS : DtcInstance __SUPERCLASS : __DYNASTY : DtcInstance __RELPATH : __PROPERTY_COUNT : 7 __DERIVATION : {} __SERVER : __NAMESPACE : __PATH : DtcName : Local KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b Status : Started UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e VirtualServerName : CSDVM736403-GU XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd 2. Since the Status shows that the instance is started, it is safe to Stop-Dtc -DtcName Local. PS C:\> Stop-Dtc -DtcName Local 3. Get-Dtc -DtcName Local one last time to confirm that the DTC instance is stopped. PS C:\> Get-Dtc -DtcName Local __GENUS : 2 __CLASS : DtcInstance __SUPERCLASS : __DYNASTY : DtcInstance __RELPATH : __PROPERTY_COUNT : 7 __DERIVATION : {} __SERVER : __NAMESPACE : __PATH : DtcName : Local KtrmEndpointCid : b6628c9f-46ff-404d-a0fa-62657cb828af OleTxEndpointCid : f3027ea1-4ee5-45b5-a01c-06f41221111b Status : Stopped UisEndpointCid : e9385758-8092-4dd7-8b09-587aa427a58e VirtualServerName : CSDVM736403-GU XAEndpointCid : ced49d85-82a9-49d9-a6ee-8c5b4bd7b5bd</dev:code> <dev:remarks> <maml:para>Stopping a DTC instance.</maml:para> <maml:para>For the purpose of this example the Local DTC instance is used, however you can stop any instance by changing the value of the DtcName parameter</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317185 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Uninstall-Dtc</command:name> <maml:description> <maml:para>Uninstall-Dtc can be used to uninstall the local transactions coordinator.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Uninstall</command:verb> <command:noun>Dtc</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Uninstall-Dtc can be used to uninstall the local transactions coordinator.</maml:para> </maml:description> <command:syntax></command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Describes what would happen if you executed the command without actually executing the command.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code>PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title></maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> </dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?linkid=317189 </maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |