< Back
Enable-DbaHideInstance
Post
NAME Enable-DbaHideInstance
SYNOPSIS
Enables the Hide Instance setting of the SQL Server network configuration.
SYNTAX
Enable-DbaHideInstance [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Enables the Hide Instance setting of the SQL Server network configuration.
This setting requires access to the Windows Server and not the SQL Server instance. The setting is found in SQL
Server Configuration Manager under the properties of SQL Server Network Configuration > Protocols for
"InstanceName".
PARAMETERS
-Credential [<Pscredential>]
Allows you to login to the computer (not SQL Server instance) using alternative Windows credentials
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
-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: HideInstance, Security
Author: Gareth Newman (@gazeranco), ifexists.blog
Website: https://dbatools.io
Copyright: (c) 2019 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Enable-DbaHideInstance
Enables Hide Instance of SQL Engine on the default (MSSQLSERVER) instance on localhost. Requires (and checks for)
RunAs admin.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Enable-DbaHideInstance -SqlInstance sql01\\SQL2008R2SP2
Enables Hide Instance of SQL Engine for the SQL2008R2SP2 on sql01. Uses Windows Credentials to both connect and
modify the registry.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Enable-DbaHideInstance -SqlInstance sql01\\SQL2008R2SP2 -WhatIf
Shows what would happen if the command were executed.
RELATED LINKS
SYNOPSIS
Enables the Hide Instance setting of the SQL Server network configuration.
SYNTAX
Enable-DbaHideInstance [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Enables the Hide Instance setting of the SQL Server network configuration.
This setting requires access to the Windows Server and not the SQL Server instance. The setting is found in SQL
Server Configuration Manager under the properties of SQL Server Network Configuration > Protocols for
"InstanceName".
PARAMETERS
-Credential [<Pscredential>]
Allows you to login to the computer (not SQL Server instance) using alternative Windows credentials
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
-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: HideInstance, Security
Author: Gareth Newman (@gazeranco), ifexists.blog
Website: https://dbatools.io
Copyright: (c) 2019 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Enable-DbaHideInstance
Enables Hide Instance of SQL Engine on the default (MSSQLSERVER) instance on localhost. Requires (and checks for)
RunAs admin.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Enable-DbaHideInstance -SqlInstance sql01\\SQL2008R2SP2
Enables Hide Instance of SQL Engine for the SQL2008R2SP2 on sql01. Uses Windows Credentials to both connect and
modify the registry.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Enable-DbaHideInstance -SqlInstance sql01\\SQL2008R2SP2 -WhatIf
Shows what would happen if the command were executed.
RELATED LINKS