Start-SqlCloneAgent
Published 16 April 2021
Registers and starts a SQL Clone Agent, defaulting to the latest installed one.
Syntax
Start-SqlCloneAgent [[-Version] <version>] [<CommonParameters>]
Description
The Start-SqlCloneAgent cmdlet registers the newest installed SQL Clone Agent (or the one for the provided version) and starts the associated Windows service, setting it to Automatic startup.
This operation is idempotent as already running SQL Clone Agents will not be affected.
Requires administrator privileges.
This cmdlet will return an error if the SQL Clone Agent isn't found or if the associated service can't be started.
Parameters
-Version
<System.Version>
Specifies the version of the SQL Clone Agent to start. Defaults to newest one if not provided.
Aliases | None |
Required? | false |
Position? | 0 |
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.
- None
Examples
---------- EXAMPLE 1 ----------
Start-SqlCloneAgent
This command will start the newest installed SQL Clone Agent.
---------- EXAMPLE 2 ----------
Start-SqlCloneAgent -Version 4.5.12.12345
This command will start the SQL Clone Agent with version 4.5.12.12345.