Get-SqlCloneImageLocation
Published 24 February 2017
Get-SqlCloneImageLocation
Gets image location details from a SQL Clone Server.
Syntax
Get-SqlCloneImageLocation [[-Path] <string>] [<CommonParameters>]
Description
The Get-SqlCloneImageLocation cmdlet gets details of image locations from a SQL Clone Server.
Without parameters, this cmdlet gets details of all image locations. You can specify a particular image by path or use a wildcard filter.
This cmdlet returns a ImageLocationResource which can be passed to the New-SqlCloneImage cmdlet for specifying where to store the image.
Connect-SqlClone must be called before this cmdlet.
Parameters
-Path
<System.String>
The path of the image location. Wildcards are permitted. If no path is specified then details of all existing image locations will be returned.
Aliases | None |
Required? | false |
Position? | 0 |
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 path of the image location. Wildcards are permitted. If no path is specified then details of all existing image locations will be returned.
Return values
The output type is the type of the objects that the cmdlet emits.
- RedGate.SqlClone.Client.Api.Objects.ImageLocationResource
Examples
---------- EXAMPLE 1 ----------
Get-SqlCloneImageLocation
This command gets details of all image locations from a SQL Clone Server.
---------- EXAMPLE 2 ----------
Get-SqlCloneImageLocation -Path '\\shared-drive\images'
This command gets details of the image location '\\shared-drive\images' from a SQL Clone Server.
---------- EXAMPLE 3 ----------
Get-SqlCloneImageLocation -Path '\\shared-drive\*'
This command gets details of all image locations on '\\shared-drive\' from a SQL Clone Server.