Connect-SqlClone
Published 24 February 2017
Connect-SqlClone
Initiates a connection with a SQL Clone Server.
Syntax
Connect-SqlClone [-ServerUrl] <string> [[-Credential] <pscredential>] [<CommonParameters>]
Description
The Connect-SqlClone cmdlet attempts to initate a connection with a SQL Clone Server. If no credential is specified then the current user's credentials will be used.
Should be called before any other SQL Clone cmdlets.
This cmdlet will return an error if the version of the module being used is out of date.
Parameters
-ServerUrl
<System.String>
The address of the SQL Clone Server to connect to.
Aliases | None |
Required? | true |
Position? | 0 |
Default Value | None |
Accept Pipeline Input | true (ByValue) |
Accept Wildcard Characters | false |
-Credential
<System.Management.Automation.PSCredential>
The credential used to connect to the SQL Clone Server. If no credential is specified then the current user's credentials will be used.
Aliases | None |
Required? | false |
Position? | 1 |
Default Value | None |
Accept Pipeline Input | true (ByValue) |
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.
-
System.String
The address of the SQL Clone Server to connect to.
-
System.Management.Automation.PSCredential
The credential used to connect to the SQL Clone Server. If no credential is specified then the current user's credentials will be used.
Return values
The output type is the type of the objects that the cmdlet emits.
- None
Examples
---------- EXAMPLE 1 ----------
Connect-SqlClone -Server 'http://sql-clone.example.com:14145'
This command attempts to intiate a connection to the SQL Clone Server hosted at http://sql-clone.example.com
Since no credential is specified the current user's credentials will be used.
---------- EXAMPLE 2 ----------
$Credential = Get-Credential Connect-SqlClone -Server 'http://sql-clone.example.com:14145' -Credential $Credential
This example shows a dialog to enter credentials and then uses them to initiate a connection to the SQL Clone Server at http://sql-clone.example.com