Get-BpaModel

Retrieves and displays the list of BPA models installed on the system.

Syntax

Get-BpaModel
   [-ModelId] <String[]>
   [[-SubModelId] <String>]
   [-RepositoryPath <String>]
   [<CommonParameters>]

Description

The Get-BpaModel cmdlet retrieves and displays the list of models that are supported by Best Practices Analyzer (BPA) and installed on the computer.

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.

Examples

Example 1: Get BPA models by ID

PS C:\> Get-BPAModel -ModelId "ADRMS"

Id                     : Microsoft/Windows/ADRMS 
Company                : Microsoft Corporation 
Name                   : RightsManagementServices 
Version                : 1.0 
LastScanTime           : Never 
LastScanTimeUtcOffset  : 
SubModels              : 
Parameters             : 
ModelType              : SingleMachine 
SupportedConfiguration :

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.

Example 2: Get all BPA models

PS C:\> Get-BPAModel

Id                       Last Scan Time 
---                      -------------- 
ModelID1                 01/05/2012 10:12 
ModelID2                 Never 
ModelID3                 05/20/2010 12:46

This example can be used to return details about BPA scans for all models that are installed on the computer.

Required Parameters

-ModelId

Specifies the model ID of the BPA 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.

Type:String[]
Aliases:Id, BestPracticesModelId
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-RepositoryPath

Specifies the location of the repository from which to get the results generated by the Invoke-BpaModel cmdlet. Invoke-BpaModel 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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SubModelId

Identifies the submodel to get for the model specified by the ModelId parameter. For example, the Update Services model (Microsoft/Windows/UpdateServices) has two submodels (UpdateServices-DB, UpdateServices-Services).

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String

Outputs

Microsoft.BestPractices.CoreInterface.Model