< Back
Get-DbaInstanceProperty
Post
NAME Get-DbaInstanceProperty
SYNOPSIS
Gets SQL Server instance properties of one or more instance(s) of SQL Server.
SYNTAX
Get-DbaInstanceProperty [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-InstanceProperty] <System.Object[]>] [[-ExcludeInstanceProperty]
<System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaInstanceProperty command gets SQL Server instance properties from the SMO object sqlserver.
PARAMETERS
-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
-ExcludeInstanceProperty [<System.Object[]>]
SQL Server instance property(ies) to exclude.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InstanceProperty [<System.Object[]>]
SQL Server instance property(ies) to include.
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: Instance, Configure, Configuration
Author: Klaas Vandenberghe (@powerdbaklaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance localhost
Returns SQL Server instance properties on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2, sql4\\sqlexpress
Returns SQL Server instance properties on default instance on sql2 and sqlexpress instance on sql4
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>'sql2','sql4' | Get-DbaInstanceProperty
Returns SQL Server instance properties on sql2 and sql4
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2,sql4 -InstanceProperty DefaultFile
Returns SQL Server instance property DefaultFile on instance sql2 and sql4
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2,sql4 -ExcludeInstanceProperty DefaultFile
Returns all SQL Server instance properties except DefaultFile on instance sql2 and sql4
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>$cred = Get-Credential sqladmin
PS C:\\> Get-DbaInstanceProperty -SqlInstance sql2 -SqlCredential $cred
Connects using sqladmin credential and returns SQL Server instance properties from sql2
RELATED LINKS
https://dbatools.io/Get-DbaInstanceProperty
SYNOPSIS
Gets SQL Server instance properties of one or more instance(s) of SQL Server.
SYNTAX
Get-DbaInstanceProperty [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [[-InstanceProperty] <System.Object[]>] [[-ExcludeInstanceProperty]
<System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Get-DbaInstanceProperty command gets SQL Server instance properties from the SMO object sqlserver.
PARAMETERS
-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
-ExcludeInstanceProperty [<System.Object[]>]
SQL Server instance property(ies) to exclude.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InstanceProperty [<System.Object[]>]
SQL Server instance property(ies) to include.
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: Instance, Configure, Configuration
Author: Klaas Vandenberghe (@powerdbaklaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance localhost
Returns SQL Server instance properties on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2, sql4\\sqlexpress
Returns SQL Server instance properties on default instance on sql2 and sqlexpress instance on sql4
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>'sql2','sql4' | Get-DbaInstanceProperty
Returns SQL Server instance properties on sql2 and sql4
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2,sql4 -InstanceProperty DefaultFile
Returns SQL Server instance property DefaultFile on instance sql2 and sql4
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaInstanceProperty -SqlInstance sql2,sql4 -ExcludeInstanceProperty DefaultFile
Returns all SQL Server instance properties except DefaultFile on instance sql2 and sql4
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>$cred = Get-Credential sqladmin
PS C:\\> Get-DbaInstanceProperty -SqlInstance sql2 -SqlCredential $cred
Connects using sqladmin credential and returns SQL Server instance properties from sql2
RELATED LINKS
https://dbatools.io/Get-DbaInstanceProperty