< Back
Get-DbaPbmPolicy
Post
NAME Get-DbaPbmPolicy
SYNOPSIS
Returns policies from Policy-Based Management from an instance.
SYNTAX
Get-DbaPbmPolicy [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Policy] <System.String[]>] [[-Category] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Dmf.PolicyStore[]>] [-IncludeSystemObject <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Returns details of policies with the option to filter on Category and SystemObjects.
PARAMETERS
-Category [<System.String[]>]
Filters results to only show policies in the category selected
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSystemObject [<Switch>]
By default system objects are filtered out. Use this parameter to INCLUDE them .
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Dmf.PolicyStore[]>]
Allows piping from Get-DbaPbmStore
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Policy [<System.String[]>]
Filters results to only show specific policy
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Policy, PolicyBasedManagement, PBM
Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Get-DbaPbmPolicy
SYNOPSIS
Returns policies from Policy-Based Management from an instance.
SYNTAX
Get-DbaPbmPolicy [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Policy] <System.String[]>] [[-Category] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Dmf.PolicyStore[]>] [-IncludeSystemObject <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Returns details of policies with the option to filter on Category and SystemObjects.
PARAMETERS
-Category [<System.String[]>]
Filters results to only show policies in the category selected
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSystemObject [<Switch>]
By default system objects are filtered out. Use this parameter to INCLUDE them .
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Dmf.PolicyStore[]>]
Allows piping from Get-DbaPbmStore
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Policy [<System.String[]>]
Filters results to only show specific policy
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
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.
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Policy, PolicyBasedManagement, PBM
Author: Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/Get-DbaPbmPolicy