HelpCache/Microsoft.Windows.Diagnosis.TroubleshootingPack.dll-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-TroubleshootingPack</command:name><maml:description><maml:para>Gets a troubleshooting pack or generates an answer file. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>TroubleshootingPack</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-TroubleshootingPack cmdlet gets a DiagPack object that you can pass to the Invoke-TroubleshootingPack cmdlet. </maml:para><maml:para>The Get-TroubleshootingPack can also get information about a troubleshooting pack and generate an answer file.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-TroubleshootingPack</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="P"><maml:name>Path</maml:name><maml:description><maml:para>Specifies a path to the folder that contains the troubleshooting pack. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="AF"><maml:name>AnswerFile</maml:name><maml:description><maml:para>Specifies a path where the cmdlet saves an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. If you specify this parameter, this cmdlet does not provide output.</maml:para><maml:para>You can use the Get-TroubleshootingPack cmdlet to generate an XML file that contains answers to troubleshooting questions. You can use the answers stored in an answer file to automate question responses during package execution using Invoke-TroubleshootingPack.</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="false" pipelineInput="false" position="named" aliases="AF"><maml:name>AnswerFile</maml:name><maml:description><maml:para>Specifies a path where the cmdlet saves an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. If you specify this parameter, this cmdlet does not provide output.</maml:para><maml:para>You can use the Get-TroubleshootingPack cmdlet to generate an XML file that contains answers to troubleshooting questions. You can use the answers stored in an answer file to automate question responses during package execution using Invoke-TroubleshootingPack.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="P"><maml:name>Path</maml:name><maml:description><maml:para>Specifies a path to the folder that contains the troubleshooting pack. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. </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:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Windows.Diagnosis.DiagPack</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The DiagPack object defines the troubleshooting pack.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Get a troubleshooting pack </maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" </dev:code><dev:remarks><maml:para>The command gets the troubleshooting pack for Audio in the specified path. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Get a root cause</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $Audio = Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" PS C:\> $Audio.Rootcauses[2] </dev:code><dev:remarks><maml:para>This example shows how to discover a root cause from a troubleshooting pack. </maml:para><maml:para>The first command gets the troubleshooting pack for Audio in the specified path and saves that object in the $Audio variable.</maml:para><maml:para>The second command displays a root cause. The $Audio object contains an array of root causes. This command uses conventional array notation to access the third member of the array.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Get a resolution</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $Audio = Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" PS C:\> $Audio.RootCauses[2].Resolutions[0] </dev:code><dev:remarks><maml:para>This example shows how to discover a resolution for a root cause.</maml:para><maml:para>The first command gets the troubleshooting pack for Audio in the specified path and saves that object in the $Audio variable.</maml:para><maml:para>The second command displays a resolution for a root cause. The $Audio object contains an array of root causes, each of which contains an array of resolutions. This command uses conventional array notation to access the first resolution for the third root cause.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 4: Generate an answer file</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" -AnswerFile "AudioAnswerFile.xml" </dev:code><dev:remarks><maml:para>This command uses the Get-TroubleshootingPack cmdlet to generate an answer file. The Areo troubleshooting pack provides a series of questions for the user to describe the troubleshooting situation and saves that information in the specified XML file. </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/p/?linkid=287584</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-TroubleshootingPack</maml:linkText><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>Invoke-TroubleshootingPack</command:name><maml:description><maml:para>Runs a troubleshooting pack.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Invoke</command:verb><command:noun>TroubleshootingPack</command:noun><dev:version /></command:details><maml:description><maml:para>The Invoke-TroubleshootingPack cmdlet runs a troubleshooting pack in either interactive or unattended mode. A troubleshooting pack determines the root causes of issues, resolves the issues, and verifies that the issues were resolved. The cmdlet can save reports that detail issues and resolutions.</maml:para><maml:para>In interactive mode, you can select the resolutions to use and provide input to interactions with the troubleshooting pack. In unattended mode, the troubleshooting pack determines which resolutions to use at run time. While in unattended mode, if the troubleshooting pack requires input, you need to provide answers or specify an answer file. To create an answer file, use the Get-TroubleshootingPack cmdlet.</maml:para><maml:para>You can save the result report and the debug report, along with XSL and any linked files. Both reports contain the issues and resolutions. The debug report contains additional information.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Invoke-TroubleshootingPack</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="P"><maml:name>Pack</maml:name><maml:description><maml:para>Specifies a DiagPack object. The DiagPack object defines a troubleshooting pack. To obtain a DiagPack object, use the Get-TroubleshootingPack cmdlet.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DiagPack</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="AF"><maml:name>AnswerFile</maml:name><maml:description><maml:para>Specifies a path for an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. To generate an answer file, use the Get-TroubleshootingPack cmdlet.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="R"><maml:name>Result</maml:name><maml:description><maml:para>Specifies a path for the result report and the debug report. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. </maml:para><maml:para>If you do not use this parameter, the cmdlet does not save reports.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="U"><maml:name>Unattended</maml:name><maml:description><maml:para>Indicates that the troubleshooting pack runs in unattended mode. If you specify this parameter and the troubleshooting pack requires input, specify an answer file in the AnswerFile parameter.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="AF"><maml:name>AnswerFile</maml:name><maml:description><maml:para>Specifies a path for an answer file. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. To generate an answer file, use the Get-TroubleshootingPack cmdlet.</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="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="P"><maml:name>Pack</maml:name><maml:description><maml:para>Specifies a DiagPack object. The DiagPack object defines a troubleshooting pack. To obtain a DiagPack object, use the Get-TroubleshootingPack cmdlet.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DiagPack</command:parameterValue><dev:type><maml:name>DiagPack</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="R"><maml:name>Result</maml:name><maml:description><maml:para>Specifies a path for the result report and the debug report. You can use an absolute path, a relative path, or a Universal Naming Convention (UNC) path. </maml:para><maml:para>If you do not use this parameter, the cmdlet does not save reports.</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="false" pipelineInput="false" position="named" aliases="U"><maml:name>Unattended</maml:name><maml:description><maml:para>Indicates that the troubleshooting pack runs in unattended mode. If you specify this parameter and the troubleshooting pack requires input, specify an answer file in the AnswerFile parameter.</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>Microsoft.Windows.Diagnosis.DiagPack</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para> The troubleshooting pack to run. To obtain a DiagPack object, use the Get-TroubleshootingPack cmdlet. </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:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Run a troubleshooting pack</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" | Invoke-TroubleshootingPack </dev:code><dev:remarks><maml:para>This example runs the Audio pack in interactive mode. This example does not save reports. </maml:para><maml:para>The command uses the Get-TroubleshootingPack cmdlet to get a DiagPack object and pipes it to the Invoke-TroubleshootingPack cmdlet. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Save troubleshooting reports</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $Audio = Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" PS C:\> Invoke-TroubleshootingPack -Pack $Audio -Result "C:\DiagResult" </dev:code><dev:remarks><maml:para>This example runs the Areo pack in interactive mode and saves the results to a folder.</maml:para><maml:para>The first command uses the Get-TroubleshootingPack cmdlet to get a DiagPack object and stores it in the $Audio variable.</maml:para><maml:para>The second command invokes the troubleshooting pack stored in $Audio. The pack saves reports in the specified folder. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 3: Run a troubleshooting pack in unattended mode</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> $Audio = Get-TroubleshootingPack -Path "C:\Windows\Diagnostics\System\Audio" PS C:\> Invoke-TroubleshootingPack -Pack $Audio -AnswerFile "AudioAnswerFile.xml" -Unattended </dev:code><dev:remarks><maml:para>This example runs the Audio pack in unattended mode with a specified answer file.</maml:para><maml:para>The first command uses the Get-TroubleshootingPack cmdlet to get a DiagPack object and stores it in the $Audio variable.</maml:para><maml:para>The second command invokes the troubleshooting pack stored in $Audio in unattended mode. The command specifies an answer file, previously created by using the Get-TroubleshootingPack cmdlet.</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/p/?linkid=287585</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-TroubleshootingPack</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |