HelpCache/Microsoft.BestPractices.Cmdlets.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-BpaModel</command:name><maml:description><maml:para>Retrieves and displays the list of BPA models installed on the system.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>BpaModel</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-BpaModel cmdlet retrieves and displays the list of models that are supported by Best Practices Analyzer (BPA) and installed on the computer.</maml:para><maml:para>If no parameter is specified, then this cmdlet returns all models that are installed on the computer. If a model is specified by using the ModelId parameter, then the specified model is returned.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-BpaModel</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by the ReportsRoot registry key or in the custom location supplied as input to the Invoke-BpaModel cmdlet through this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-BpaModel</maml:name><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Specifies the model ID of the Best Practices Analyzer model for displaying details. The short form of this parameter can also be used, Id. This is the identity of the model whose details need to be obtained. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel to get for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services). </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=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by the ReportsRoot registry key or in the custom location supplied as input to the Invoke-BpaModel cmdlet through this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Specifies the model ID of the Best Practices Analyzer model for displaying details. The short form of this parameter can also be used, Id. This is the identity of the model whose details need to be obtained. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">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=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by the ReportsRoot registry key or in the custom location supplied as input to the Invoke-BpaModel cmdlet through this parameter. </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="3" aliases=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel to get for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services). </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>System.String</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.BestPractices.CoreInterface.Model</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</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-BPAModel Id : Microsoft/Windows/ADRMS Company : Microsoft Corporation Name : RightsManagementServices Version : 1.0 LastScanTime : Never LastScanTimeUtcOffset : SubModels : Parameters : ModelType : SingleMachine SupportedConfiguration : </dev:code><dev:remarks><maml:para>This example can be used to return details about the BPA model that is specified in the ModelId parameter, represented by ModelID1. The short form of the ModelId parameter can also be used, Id.</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:\>Get-BPAModel Id Last Scan Time --- -------------- ModelID1 01/05/2012 10:12 ModelID2 Never ModelID3 05/20/2010 12:46 </dev:code><dev:remarks><maml:para>This example can be used to return details about BPA scans for all models that are installed on the computer.</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=287253</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaResult</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-BpaModel</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-BpaResult</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>Get-BpaResult</command:name><maml:description><maml:para>Retrieves and displays the results of the most recent Best Practices Analyzer (BPA) scan for a specific model.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>BpaResult</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-BpaResult cmdlet retrieves and displays the results of the latest Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer. To use this cmdlet, add the ModelId parameter, and specify the model identifier (ID) for which to view the most recent BPA scan results. The All parameter can be used to retrieve all of the scanned results for a particular model. If the All parameter is not specified, then the most recent results of the particular model are returned.</maml:para><maml:para>This cmdlet can be used to view the results of a BPA scan for a specific model. An administrator specifies a model ID as a parameter and the latest results for that model are displayed.</maml:para><maml:para>Note: This cmdlet does not start a new BPA scan.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-BpaResult</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identifies the model from which results need to be obtained.</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="3" aliases=""><maml:name>CollectedConfiguration</maml:name><maml:description><maml:para>Returns only discovery information that was collected during a BPA scan, not the results of evaluating rules in the model.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns the output type Reports. This parameter can be used to retrieve all of the scanned results for a particular model. If this parameter is not specified, then the most recent results of the particular model are returned.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Filter</maml:name><maml:description><maml:para>Filters the type of result to return. The acceptable values for this parameter are: All, Compliant, or Noncompliant.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FilterOptions</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location contained in the ReportsRoot registry key or in the custom location supplied as the value of this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-BpaResult</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identifies the model from which results need to be obtained.</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="3" aliases=""><maml:name>CollectedConfiguration</maml:name><maml:description><maml:para>Returns only discovery information that was collected during a BPA scan, not the results of evaluating rules in the model.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns the output type Reports. This parameter can be used to retrieve all of the scanned results for a particular model. If this parameter is not specified, then the most recent results of the particular model are returned.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the target computer from which to retrieve BPA results.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server.</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=""><maml:name>Filter</maml:name><maml:description><maml:para>Filters the type of result to return. The acceptable values for this parameter are: All, Compliant, or Noncompliant.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FilterOptions</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location contained in the ReportsRoot registry key or in the custom location supplied as the value of this parameter. </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=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services). </maml:para><maml:para></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=""><maml:name>All</maml:name><maml:description><maml:para>Returns the output type Reports. This parameter can be used to retrieve all of the scanned results for a particular model. If this parameter is not specified, then the most recent results of the particular model are returned.</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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>CollectedConfiguration</maml:name><maml:description><maml:para>Returns only discovery information that was collected during a BPA scan, not the results of evaluating rules in the model.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the target computer from which to retrieve BPA results.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">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=""><maml:name>Context</maml:name><maml:description><maml:para>Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server.</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=""><maml:name>Filter</maml:name><maml:description><maml:para>Filters the type of result to return. The acceptable values for this parameter are: All, Compliant, or Noncompliant.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">FilterOptions</command:parameterValue><dev:type><maml:name>FilterOptions</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identifies the model from which results need to be obtained.</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=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location contained in the ReportsRoot registry key or in the custom location supplied as the value of this parameter. </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=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services). </maml:para><maml:para></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>System.String</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.BestPractices.CoreInterface.Report</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue><command:returnValue><dev:type><maml:name>Microsoft.BestPractices.CoreInterface.Result</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</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-BPAResult -ModelId ModelId1 </dev:code><dev:remarks><maml:para>This example returns the most recent Best Practices Analyzer scan results for the model that is represented by ModelId1. The short form of the ModelId parameter can also be used, Id.</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:\> Get-BPAModel | Get-BPAResult </dev:code><dev:remarks><maml:para>This example, the Get-BpaModel cmdlet is used to return a list of all BPA models that are installed on the computer. The results of the Get-BpaModel cmdlet are piped to this cmdlet to retrieve the most recent Best Practices Analyzer scan results for all models that are supported by BPA.</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=287254</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaModel</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-BpaModel</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-BpaResult</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-BpaModel</command:name><maml:description><maml:para>Starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Invoke</command:verb><command:noun>BpaModel</command:noun><dev:version /></command:details><maml:description><maml:para>The Invoke-BpaModel cmdlet starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a Windows-based computer. The model is specified either by using the ModelId parameter, or by piping the results of the Get-BpaModel cmdlet into this cmdlet. If a model is specified in the cmdlet after the BPA scan has been performed, then the results of the scan are available as an XML file.</maml:para><maml:para>This cmdlet cannot be canceled after it has been started.</maml:para><maml:para>Single-node XML is not supported by the BPA model schema. For more information about what is supported by the BPA model schema, see the Microsoft Baseline Configuration Analyzer Model Authoring Guide on the <maml:navigationLink><maml:linkText>Microsoft Download Center</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Invoke-BpaModel</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identities the model to be used for the BPA scan.</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=""><maml:name>Mode</maml:name><maml:description><maml:para>Specifies the mode to use when running the BPA scan. The acceptable values for this parameter are: All, Analysis, or Discovery.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ScanMode</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies that the default location for reports specified by the ReportsRoot registry key should be overridden. This parameter specifies the path where the results should be stored.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Invoke-BpaModel</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identities the model to be used for the BPA scan.</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=""><maml:name>Authentication</maml:name><maml:description><maml:para>Specifies the authentication mode to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">AuthenticationMechanism</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CertificateThumbprint</maml:name><maml:description><maml:para>Specifies the certificate thumbprint to use when creating a remote connection via SSL for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the target computer against which to run the BPA scan.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the session configuration, such as the name of the endpoint, to use when creating a session for a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</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=""><maml:name>Context</maml:name><maml:description><maml:para>Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server.</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=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Mode</maml:name><maml:description><maml:para>Specifies the mode to use when running the BPA scan. The acceptable values for this parameter are: All, Analysis, or Discovery.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ScanMode</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Port</maml:name><maml:description><maml:para>Specifies the port to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies that the default location for reports specified by the ReportsRoot registry key should be overridden. This parameter specifies the path where the results should be stored.</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=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel to run for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services).</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=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the throttle limit to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>UseSsl</maml:name><maml:description><maml:para>Specifies whether or not to use SSL when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</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=""><maml:name>Authentication</maml:name><maml:description><maml:para>Specifies the authentication mode to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">AuthenticationMechanism</command:parameterValue><dev:type><maml:name>AuthenticationMechanism</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=""><maml:name>CertificateThumbprint</maml:name><maml:description><maml:para>Specifies the certificate thumbprint to use when creating a remote connection via SSL for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</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="true" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the target computer against which to run the BPA scan.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">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=""><maml:name>ConfigurationName</maml:name><maml:description><maml:para>Specifies the session configuration, such as the name of the endpoint, to use when creating a session for a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</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=""><maml:name>Context</maml:name><maml:description><maml:para>Scans a submodel in the context of a specific model (one that is different from the parent model of the submodel). Example: an administrator wants to run a scan on the Backend submodel of the SQL model, but only those in the context of a third model, a technology that relies upon SQL Server.</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=""><maml:name>Credential</maml:name><maml:description><maml:para>Specifies the credentials to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue><dev:type><maml:name>PSCredential</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=""><maml:name>Mode</maml:name><maml:description><maml:para>Specifies the mode to use when running the BPA scan. The acceptable values for this parameter are: All, Analysis, or Discovery.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">ScanMode</command:parameterValue><dev:type><maml:name>ScanMode</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="2" aliases="Id,BestPracticesModelId"><maml:name>ModelId</maml:name><maml:description><maml:para>Identities the model to be used for the BPA scan.</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=""><maml:name>Port</maml:name><maml:description><maml:para>Specifies the port to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</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=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies that the default location for reports specified by the ReportsRoot registry key should be overridden. This parameter specifies the path where the results should be stored.</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=""><maml:name>SubModelId</maml:name><maml:description><maml:para>Identifies the submodel to run for the model specified by the ModelId parameter. Example: The Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services).</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=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>Specifies the throttle limit to use when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-Command</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</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=""><maml:name>UseSsl</maml:name><maml:description><maml:para>Specifies whether or not to use SSL when creating a remote connection for running a remote BPA scan. For more information, run the following cmdlet. - Get-Help Invoke-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><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>System.String</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The input string specified by the ModelId parameter.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>System.Collections.Generic.List<Microsoft.BestPractices.CoreInterface.InvokeBpaModelOutput></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The output object encapsulates the results of the cmdlet that is entered. The output object contains information such as the BPA model ID, the success or failure of the cmdlet, and other details.</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:\>Invoke-BPAModel -ModelId ModelId1 </dev:code><dev:remarks><maml:para>This example starts a BPA scan on the model that is represented by ModelId1.</maml:para><maml:para>The same task can be completed by running any of the following cmdlets. Invoke-BPAModel -ModelId ModelId1 - OR - Invoke-BPAModel -Id ModelId1 - OR - Invoke-BPAModel ModelId1</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:\>Invoke-BPAModel –ModelId ModelId1 -ArgumentTable @{context=domain; name=contoso.com;} </dev:code><dev:remarks><maml:para>This example starts a BPA scan on the specified model ID. The ArgumentTable parameter helps the administrator start a BPA scan with additional model-specific instructions. In this example, the values of additional and required model parameters are specified by using the ArgumentTable parameter. The scan is focused only on those parts of the model that occur in the contoso.com domain.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-BPAModel | Invoke-BPAModel </dev:code><dev:remarks><maml:para>This example gets all BPA models that are installed on the computer, and then pipes the results of the Get-BPAModel cmdlet to this cmdlet to start a BPA scan on all models.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 4</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code> PS C:\>$BPAObj = Invoke-BPAModel ModelId1 This cmdlet displays the results of any specific object in the previous cmdlet by calling the variable into which the results of the previous cmdlet were saved, and then specifying the object in the results that the administrator wants. The object is identified by its numerical order in the collection of results (the 0, or first, object). The cmdlet then identifies which field of the results in that object (for this example, the Detail field) the administrator wants to view. The cmdlet shown returns the properties of the Detail field from the first object in the results of the preceding line. PS C:\>$BPAObj[0].Detail ModelId : ModelId1 Success : True ScanTime : 10/21/2008 3:08:47 PM InformationMessages : 5 WarningMessages : 4 ErrorMessages : 0 Description : </dev:code><dev:remarks><maml:para>This example starts a BPA scan on the model specified by ModelId1, and saves the results of the cmdlet as a variable, BPAObj.</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=287255</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaModel</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaResult</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-BpaResult</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>Set-BpaResult</command:name><maml:description><maml:para>Excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>BpaResult</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-BPAResult cmdlet excludes or includes existing results of a Best Practices Analyzer (BPA) scan to display only the specified scan results. The action specified in this cmdlet (such as Exclude) determines how the existing results of a BPA scan are updated. This cmdlet is typically applied after using the Get-BpaResult cmdlet to return a collection of scan results. Filters can be applied to results returned by the Get-BpaResult cmdlet, and then pipe the filtered collection of results to this cmdlet, specifying either to include or exclude filtered scan results.</maml:para><maml:para>This will update the results in the result file with the specified result collection with the action specified. The administrator would generally need to call the Get-BpaResult cmdlet prior to this to get the result collection, apply some filters and pipe the collection to this cmdlet specifying the action (exclusion or inclusion).</maml:para><maml:para>If this cmdlet is canceled before the results are written to a file, then the operation is canceled and the results file is not modified. If cancellation occurs after the results file has been modified, then the actions of the cmdlet are carried out, and the cmdlet cannot be canceled.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-BpaResult</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>Exclude</maml:name><maml:description><maml:para>Removes any BPA scan results that are specified by a filter added to this cmdlet. The Exclude action applies to all results returned by this cmdlet. To exclude results by using this parameter, add the value $true following the parameter, as shown: - -Exclude $true</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="3" aliases=""><maml:name>Results</maml:name><maml:description><maml:para>Specifies the result collection to be updated in the result file returned by this cmdlet. This parameter is typically used to specify a filtered subset of scan results that has already been stored in a variable; the variable name is provided as the valid value for this parameter. This is the result collection which needs to be updated in the result file. Example: if a variable named $allPerformance is created to store all the Performance category results for a BPA scan of all roles on a computer, and to exclude those Performance results from the complete collection of scan results, add the following parameter to this cmdlet. - -Results $allPerformance</maml:para></maml:description><command:parameterValue required="true" variableLength="false">List<Result></command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location where the report should be stored. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by ReportsRoot registry key or in a custom location supplied as input to this parameter.</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="2" aliases=""><maml:name>Exclude</maml:name><maml:description><maml:para>Removes any BPA scan results that are specified by a filter added to this cmdlet. The Exclude action applies to all results returned by this cmdlet. To exclude results by using this parameter, add the value $true following the parameter, as shown: - -Exclude $true</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue><dev:type><maml:name>Boolean</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""><maml:name>RepositoryPath</maml:name><maml:description><maml:para>Specifies the location where the report should be stored. The Invoke-BpaModel cmdlet provides an option to store the results either in the default reports repository location referred by ReportsRoot registry key or in a custom location supplied as input to this parameter.</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="3" aliases=""><maml:name>Results</maml:name><maml:description><maml:para>Specifies the result collection to be updated in the result file returned by this cmdlet. This parameter is typically used to specify a filtered subset of scan results that has already been stored in a variable; the variable name is provided as the valid value for this parameter. This is the result collection which needs to be updated in the result file. Example: if a variable named $allPerformance is created to store all the Performance category results for a BPA scan of all roles on a computer, and to exclude those Performance results from the complete collection of scan results, add the following parameter to this cmdlet. - -Results $allPerformance</maml:para></maml:description><command:parameterValue required="true" variableLength="false">List<Result></command:parameterValue><dev:type><maml:name>List<Result></maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>System.Collections.Generic.List<Microsoft.BestPractices.CoreInterface.Result></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The input object specified by the Results parameter.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</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-BPAResult -ModelId ModelId1 | Where-Object -FilterScript { $_.Category -Eq "Performance" } | Set-BPAResult -ModelId ModelId1 -Exclude $true </dev:code><dev:remarks><maml:para>This example, to the left of the first pipe character (|), uses the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for the model ID represented by ModelId1. The second section of the cmdlet filters the results of the Get-BpaResult cmdlet to get only those scan results for which the category name is equal to Performance. The final section of the example, following the second pipe character, excludes the Performance results filtered by the previous section of the example.</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>The variable $rcPolicy is created to store the filtered results of the Get-BpaResult cmdlet; this variable can be used in subsequent cmdlets to represent those results. PS C:\>$rcPolicy = Get-BPAResult -ModelId ModelId1 | Where-Object –FilterScript { $_.Category -Eq "Policy" } The second line of the example uses this cmdlet to exclude the set of results stored in the $rcPolicy variable, for the specified model ID. In this cmdlet, the Results parameter is added because the administrator wants to exclude a specific subset of scan results for that model, and has created the variable $rcPolicy to represent that subset of results. PS C:\>Set-BPAResult -ModelId ModelId1 -Exclude $true -Results $rcPolicy </dev:code><dev:remarks><maml:para>This example, to the left of the pipe character (|), instructs the Get-BpaResult cmdlet to retrieve Best Practices Analyzer scan results for the model represented by ModelId1 The second section of the example, after the pipe character, filters the results of the Get-BpaResult cmdlet to return only those scan results for which the category name is equal to (note the Eq option) Policy.</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=287253</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Where-Object</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaModel</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-BpaResult</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Invoke-BpaModel</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |