< Back

Invoke-BpaModel

Thu Apr 04, 2019 5:41 am

NAME Invoke-BpaModel



SYNOPSIS

Starts a Best Practices Analyzer (BPA) scan for a specific model that is installed on a computer.





SYNTAX

Invoke-BpaModel [-ModelId] <String> [-Mode <ScanMode>] [-RepositoryPath <String>] [<CommonParameters>]



Invoke-BpaModel [-ModelId] <String> [-Authentication <AuthenticationMechanism>] [-CertificateThumbprint <String>] [-ComputerName <String[]>]

[-ConfigurationName <String>] [-Context <String>] [-Credential <PSCredential>] [-Mode <ScanMode>] [-Port <Int32>] [-RepositoryPath <String>]

[-SubModelId <String>] [-ThrottleLimit <Int32>] [-UseSsl] [<CommonParameters>]





DESCRIPTION

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.



This cmdlet cannot be canceled after it has been started.



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 Microsoft Download Center.





PARAMETERS

-Authentication <AuthenticationMechanism>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-CertificateThumbprint <String>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ComputerName <String[]>

Specifies the target computer against which to run the BPA scan.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ConfigurationName <String>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Context <String>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Mode <ScanMode>

Specifies the mode to use when running the BPA scan. The acceptable values for this parameter are:?? All, Analysis, or Discovery.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ModelId <String>

Identities the model to be used for the BPA scan.



Required? true

Position? 2

Default value

Accept pipeline input? True (ByValue, ByPropertyName)

Accept wildcard characters? false



-Port <Int32>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RepositoryPath <String>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SubModelId <String>

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).



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ThrottleLimit <Int32>

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseSsl [<SwitchParameter>]

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String



The input string specified by the ModelId parameter.





OUTPUTS

System.Collections.Generic.List<Microsoft.BestPractices.CoreInterface.InvokeBpaModelOutput>



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.





EXAMPLE 1



PS C:\\>Invoke-BPAModel -ModelId ModelId1



This example starts a BPA scan on the model that is represented by ModelId1.



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

EXAMPLE 2



PS C:\\>Invoke-BPAModel ????????ModelId ModelId1 -ArgumentTable @{context=domain; name=contoso.com;}



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.

EXAMPLE 3



PS C:\\>Get-BPAModel | Invoke-BPAModel



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.

EXAMPLE 4



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 :



This example starts a BPA scan on the model specified by ModelId1, and saves the results of the cmdlet as a variable, BPAObj.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?LinkId=287255

Get-BpaModel

Get-BpaResult

Set-BpaResult