SQL Clone 4

Get-SqlCloneMachine

Gets machine details from a SQL Clone Server.

Syntax

Get-SqlCloneMachine [[-Name] <string>] [<CommonParameters>]

Description

The Get-SqlCloneMachine cmdlet gets details of machines running SQL Clone Agent associated with a SQL Clone Server.

Instances of SQL Server on machines running SQL Clone Agent can be used to create images and receive clones.

This cmdlet gets details of all machines.

This cmdlet returns an AgentResource.

Connect-SqlClone must be called before this cmdlet.

Parameters

-Name <System.String>

The name of the machine. Wildcards are permitted. If no name is specified then details of all machines 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 name of the machine. Wildcards are permitted. If no name is specified then details of all machines will be returned.

Return values

The output type is the type of the objects that the cmdlet emits.

  • RedGate.SqlClone.Client.Api.Objects.AgentResource

Examples

---------- EXAMPLE 1 ----------

Get-SqlCloneMachine

This command gets details of all machines from a SQL Clone Server.

---------- EXAMPLE 2 ----------

Get-SqlCloneMachine -Name 'machine.name'

This command gets details of the machine 'machine.name' from a SQL Clone Server.

---------- EXAMPLE 3 ----------

Get-SqlCloneMachine -Name 'dev-*'

This command gets details of all machine with the prefix 'dev-' from a SQL Clone Server.


Didn't find what you were looking for?