< Back

Get-DbaStartupParameter

Mon Jan 13, 2020 11:42 am

NAME Get-DbaStartupParameter



SYNOPSIS

Displays values for a detailed list of SQL Server Startup Parameters.





SYNTAX

Get-DbaStartupParameter [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-Credential]

<Pscredential>] [-Simple <Switch>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Displays values for a detailed list of SQL Server Startup Parameters including Master Data Path, Master Log path,

Error Log, Trace Flags, Parameter String and much more.



This command relies on remote Windows Server (SQL WMI/WinRm) access. You can pass alternative Windows credentials

by using the -Credential parameter.



See https://msdn.microsoft.com/en-us/library/ms190737.aspx for more information.





PARAMETERS

-Credential [<Pscredential>]

Allows you to login to servers using alternate Windows credentials.



$scred = Get-Credential, then pass $scred object to the -Credential parameter.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnableException [<Switch>]

If this switch is enabled, exceptions will be thrown to the caller, which will need to perform its own

exception processing. Otherwise, the function will try to catch the exception, interpret it and provide a

friendly error message.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Simple [<Switch>]

If this switch is enabled, simplified output will be produced including only Server, Master Data Path, Master

Log path, ErrorLog, TraceFlags and ParameterString.



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.



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: WSMan, SQLWMI, Memory

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-DbaStartupParameter -SqlInstance sql2014



Logs into SQL WMI as the current user then displays the values for numerous startup parameters.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$wincred = Get-Credential ad\\sqladmin



PS C:\\> Get-DbaStartupParameter -SqlInstance sql2014 -Credential $wincred -Simple



Logs in to WMI using the ad\\sqladmin credential and gathers simplified information about the SQL Server Startup

Parameters.



RELATED LINKS

https://dbatools.io/Get-DbaStartupParameter