< Back
Get-DbaDbCertificate
Post
NAME Get-DbaDbCertificate
SYNOPSIS
Gets database certificates
SYNTAX
Get-DbaDbCertificate [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>]
[[-Certificate] <System.Object[]>] [[-Subject] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets database certificates
PARAMETERS
-Certificate [<System.Object[]>]
Get specific certificate by name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Get certificate from specific database
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
-ExcludeDatabase [<System.String[]>]
Database(s) to ignore when retrieving certificates
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piping from Get-DbaDatabase
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
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Subject [<System.String[]>]
sometimes it's text, other times cert
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: Certificate
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance sql2016
Gets all certificates
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1
Gets the certificate for the db1 database
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1 -Certificate cert1
Gets the cert1 certificate within the db1 database
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1 -Subject 'Availability Group Cert'
Gets the certificate within the db1 database that has the subject 'Availability Group Cert'
RELATED LINKS
SYNOPSIS
Gets database certificates
SYNTAX
Get-DbaDbCertificate [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>]
[[-Certificate] <System.Object[]>] [[-Subject] <System.String[]>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets database certificates
PARAMETERS
-Certificate [<System.Object[]>]
Get specific certificate by name
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
Get certificate from specific database
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
-ExcludeDatabase [<System.String[]>]
Database(s) to ignore when retrieving certificates
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Database[]>]
Enables piping from Get-DbaDatabase
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
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Subject [<System.String[]>]
sometimes it's text, other times cert
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: Certificate
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance sql2016
Gets all certificates
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1
Gets the certificate for the db1 database
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1 -Certificate cert1
Gets the cert1 certificate within the db1 database
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaDbCertificate -SqlInstance Server1 -Database db1 -Subject 'Availability Group Cert'
Gets the certificate within the db1 database that has the subject 'Availability Group Cert'
RELATED LINKS