| Author | Stephen Bennett, sqlnotesfromtheunderground.wordpress.com |
| Availability | Windows, Linux, macOS |
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.
Returns policies from Policy-Based Management from an instance.
Returns details of policies with the option to filter on Category and SystemObjects.
Get-DbaPbmPolicy
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-Policy] <String[]>]
[[-Category] <String[]>]
[[-InputObject] <PSObject[]>]
[-IncludeSystemObject]
[-EnableException]
[<CommonParameters>]
PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016
Returns all policies from sql2016 server
PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016 -SqlCredential $cred
Uses a credential $cred to connect and return all policies from sql2016 instance
PS C:\> Get-DbaPbmPolicy -SqlInstance sql2016 -Category MorningCheck
Returns all policies from sql2016 server that part of the PolicyCategory MorningCheck
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to only show specific policy
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to only show policies in the category selected
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Allows piping from Get-DbaPbmStore
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
By default system objects are filtered out. Use this parameter to INCLUDE them .
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |