Get-DbaPbmPolicy

Want to see the source code for this command? Check out Get-DbaPbmPolicy on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaPbmPolicy.

Synopsis

Returns policies from Policy-Based Management from an instance.

Description

Returns details of policies with the option to filter on Category and SystemObjects.

Syntax

Get-DbaPbmPolicy
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Policy] <String[]>]
    [[-Category] <String[]>]
    [[-InputObject] <PSObject[]>]
    [-IncludeSystemObject]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016

Returns all policies from sql2016 server

Example: 2

PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016 -SqlCredential $cred

Uses a credential $cred to connect and return all policies from sql2016 instance

Example: 3

PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016 -Category MorningCheck

Returns all policies from sql2016 server that part of the PolicyCategory MorningCheck

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

-Policy

Filters results to only show specific policy

-Category

Filters results to only show policies in the category selected

-InputObject

Allows piping from Get-DbaPbmStore

-IncludeSystemObject

By default system objects are filtered out. Use this parameter to INCLUDE them .

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.