ISESteroids

2.2.0.12

HelpCache/MSFT_DtcLogTask_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-DtcLog</command:name>
      <maml:description>
        <maml:para>Get-DtcLog retrieves the Log File settings for the DTC instance specified by the DtcName parameter.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Get</command:verb>
      <command:noun>DtcLog</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>Get-DtcLog retrieves the Log File settings for the DTC instance specified by the DtcName parameter.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-DtcLog</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 from which the Log File settings are to be displayed. If this parameter is null or set to Local, this will display the Log File settings for the Local DTC instance.</maml:para>
          </maml:description>
          <command:parameterValue required="false" 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 from which the Log File settings are to be displayed. If this parameter is null or set to Local, this will display the Log File settings for the Local DTC instance.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Local</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:\&gt; Get-DtcLog
MaxSizeInMB : 512
Path : C:\Windows\system32\MSDtc
SizeInMB : 4</dev:code>
        <dev:remarks>
          <maml:para>Using Get-DtcLog with no parameters. This will return the Dtc Log File settings for the Local DTC instance.</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:\&gt; Get-DtcLog &lt;instancename&gt;
MaxSizeInMB : 512
Path : G:\MSDTC\beb6d145-405e-47cd-b326-a5505a461229
SizeInMB : 4</dev:code>
        <dev:remarks>
          <maml:para>Using Get-DtcLog with a named DTC instance. &lt;instancename&gt; can be any named DTC instance or Local.</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=317159
</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>Reset-DtcLog</command:name>
      <maml:description>
        <maml:para>Reset-DtcLog resets the Log File of the DTC service specified by the DtcName parameter. Reset-DtcLog will recreate the transactions log with the existing settings and the DTC service will be restarted.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Reset</command:verb>
      <command:noun>DtcLog</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>Reset-DtcLog resets the Log File of the DTC service specified by the DtcName parameter. Reset-DtcLog will recreate the transactions log with the existing settings and the DTC service will be restarted.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Reset-DtcLog</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 for which the Log File is to be reset. If this parameter is null or set to Local, this will reset the Log File for the Local DTC service.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <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: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 for which the Log File is to be reset. If this parameter is null or set to Local, this will reset the Log File for the Local DTC service.</maml:para>
        </maml:description>
        <command:parameterValue required="false" 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="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:\&gt;
</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:\&gt;
</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=317170
</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>Set-DtcLog</command:name>
      <maml:description>
        <maml:para>Set-DtcLog modifies the Log File settings of the DTC instance specified by the DtcName parameter. Set-DtcLog will recreate the transactions log with new settings and the DTC instance will be restarted.</maml:para>
      </maml:description>
      <maml:copyright>
        <maml:para />
      </maml:copyright>
      <command:verb>Set</command:verb>
      <command:noun>DtcLog</command:noun>
      <dev:version />
    </command:details>
    <maml:description>
      <maml:para>Set-DtcLog modifies the Log File settings of the DTC instance specified by the DtcName parameter. Set-DtcLog will recreate the transactions log with new settings and the DTC instance will be restarted.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-DtcLog</maml:name>
        <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="">
          <maml:name>DtcName</maml:name>
          <maml:description>
            <maml:para>Specifies the DTC instance for which the Log File is to be modified. If this parameter is null or set to Local, this will modify the Log File for the Local DTC instance.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="" pipelineInput="false" position="named" aliases="">
          <maml:name>MaxSizeInMB</maml:name>
          <maml:description>
            <maml:para>Specifies the maximum file size of the new Log File in MB.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>Specifies the physical or network path for the new Log File to be stored. If a Log File already exists in the specified path it will be overwritten.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">String</command:parameterValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="">
          <maml:name>SizeInMB</maml:name>
          <maml:description>
            <maml:para>Specifies the initial file allocation size of the new Log File in MB.</maml:para>
          </maml:description>
          <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
        </command:parameter>
        <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:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="false" globbing="" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="">
        <maml:name>DtcName</maml:name>
        <maml:description>
          <maml:para>Specifies the DTC instance for which the Log File is to be modified. If this parameter is null or set to Local, this will modify the Log File for the Local DTC instance.</maml:para>
        </maml:description>
        <command:parameterValue required="false" 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="true (ByValue, ByPropertyName)" position="named" aliases="">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>Specifies the physical or network path for the new Log File to be stored. If a Log File already exists in the specified path it will be overwritten.</maml:para>
        </maml:description>
        <command:parameterValue required="false" 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="true (ByValue, ByPropertyName)" position="named" aliases="">
        <maml:name>SizeInMB</maml:name>
        <maml:description>
          <maml:para>Specifies the initial file allocation size of the new Log File in MB.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
        <dev:type>
          <maml:name>UInt32</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>MaxSizeInMB</maml:name>
        <maml:description>
          <maml:para>Specifies the maximum file size of the new Log File in MB.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">UInt32</command:parameterValue>
        <dev:type>
          <maml:name>UInt32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue></dev:defaultValue>
      </command:parameter>
      <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>Using Set-DtcLog to modify the Log File settings.
PS C:\&gt; Set-DtcLog -Path C:\Windows\system32\MSDtc\NewLog\ -SizeInMB 32 -MaxSizeInMB 1024
 
Verifying that the changes were made using Get-DtcLog.
PS C:\&gt; Get-DtcLog
MaxSizeInMB : 1024
Path : C:\Windows\system32\MSDtc\NewLog
SizeInMB : 32</dev:code>
        <dev:remarks>
          <maml:para>Modifying the DTC Log File settings using Set-DtcLog</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=317177
</maml:uri>
      </maml:navigationLink>
    </maml:relatedLinks>
  </command:command>
</helpItems>