Get-SqlCloneSqlServerInstance
Published 24 February 2017
Gets SQL Server instance details from a SQL Clone Server.
Syntax
Get-SqlCloneSqlServerInstance [[-MachineName] <string>] [[-InstanceName] <string>] [<CommonParameters>]
Description
The Get-SqlCloneSqlServerInstance cmdlet gets details of SQL Server instances from a SQL Clone Server.
Without parameters, this cmdlet gets details of all SQL Server instances. You can specify a particular instance by machine or instance name or use a wildcard filter.
This cmdlet returns a SqlServerInstanceResource which can be passed to the New-SqlClone and New-SqlCloneImage cmdlets.
Connect-SqlClone must be called before this cmdlet.
Parameters
-MachineName
<System.String>
Specifies the machine name of the SQL Server instance. Wildcards are permitted.
| Aliases | None |
| Required? | false |
| Position? | 0 |
| Default Value | None |
| Accept Pipeline Input | false |
| Accept Wildcard Characters | false |
-InstanceName
<System.String>
Specifies the instance name of the SQL Server instance. Wildcards are permitted.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | false |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Return values
The output type is the type of the objects that the cmdlet emits.
- RedGate.SqlClone.Client.Api.Objects.SqlServerInstanceResource
Examples
---------- EXAMPLE 1 ----------
Get-SqlCloneSqlServerInstance
This command gets details of all SQL Server instances from a SQL Clone Server.
---------- EXAMPLE 2 ----------
Get-SqlCloneSqlServerInstance -MachineName TESTMACHINE -InstanceName SQL2014
This command gets details of the SQL Server instance TESTMACHINE\SQL2014.
---------- EXAMPLE 3 ----------
Get-SqlCloneSqlServerInstance -MachineName TESTMACHINE -InstanceName ''
This command gets details of the default SQL Server instance on TESTMACHINE.
---------- EXAMPLE 4 ----------
Get-SqlCloneSqlServerInstance -InstanceName 'SQL2014'
This command gets details of all SQL Server instances named 'SQL2014' on any machine.
