Get-SqlInstance

Gets a SQL Instance object for each instance of SQL Server that is present on the target computer.

Syntax

Get-SqlInstance
   [-Path <String[]>]
   [-Script]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlInstance
   [-ServerInstance <String[]>]
   [[-Credential] <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [-Script]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlInstance
   -InputObject <Server[]>
   [-Script]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SqlInstance cmdlet gets a SQL Instance object for each instance of SQL Server that is present on the target computer. If the name of the instance of SQL Server is provided, the cmdlet will only get this specific instance of SQL Server.

Examples

Example 1: Get a SQL Server instance on a computer

PS C:\> Get-SqlInstance -Credential -ServerInstance "Computer002\InstanceName"

This command gets the SQL Server instance named InstanceName on the computer named Computer002.

Example 2: Get instances of SQL Server on multiple computers

PS C:\Users\matteot> @('Server1', 'Server2', 'Server3') | % { Get-SqlInstance -ServerInstance $_}

Instance Name                   Version    ProductLevel UpdateLevel
-------------                   -------    ------------ -----------
Server1                         11.0.6607  SP3          CU10
Server2                         12.0.5600  SP2          CU14
Server3                         13.0.1742  RTM          n/a

This command gets all instances of SQL Server running on 3 diffent computers. Note that the output is formatted to display the Version, the ProductLevel, and the ProductUpdateLevel (aliased and abbreviated to "UpdateLevel"), when available.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-ConnectionTimeout

Specifies the number of seconds to wait for a server connection before a time-out failure. The time-out value must be an integer between 0 and 65534. If 0 is specified, connection attempts do not time out.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a PSCredential object for the connection to the SQL Server. To obtain a credential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.

Type:PSCredential
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject

Specifies a SQL Server Management Objects (SMO) object that represent the SQL Server on which this cmdlet operates.

Type:Server[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Path

Specifies the path of the SQL Server on which this cmdlet runs the operation. The default value is the current working directory.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Script

Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ServerInstance

Specifies the name of an instance of SQL Server. For the default instance, specify the computer name. For named instances, use the format ComputerName\InstanceName.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.String[]