Set-SmCloneJob
Suggest changes
PDFs
Modifies an existing clone job.
Syntax
Set-SmCloneJob [-CloneJobName] <String> [-PluginCode] <PluginCode> [-CloneToInstance] <String> [-CloneToHost] <String> [-Description] <String> [-ResourceGroupName] <String> [-Resources] <Hashtable[]> [-EnableAsupOnFailure] <Boolean> [-EnableSysLog] <Boolean> [-EnableEmail] <> [-EmailPreference] <SmEmailNotificationPreference>
Detailed Description
Modifies an existing clone job based on the parameters provided.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
CloneJobName |
true |
true (ByPropertyName) |
||
PluginCode |
true |
true (ByPropertyName) |
||
CloneToInstance |
true |
true (ByPropertyName) |
||
CloneToHost |
true |
true (ByPropertyName) |
||
Description |
false |
true (ByPropertyName) |
||
ResourceGroupName |
false |
true (ByPropertyName) |
||
Resources |
false |
true (ByPropertyName) |
||
EnableAsupOnFailure |
false |
true (ByPropertyName) |
||
EnableSysLog |
false |
true (ByPropertyName) |
||
EnableEmail |
false |
false |
||
EmailPreference |
false |
false |
||
AutoAssignMountPoint |
false |
true (ByPropertyName) |
||
AssignMountPointUnderPath |
false |
true (ByPropertyName) |
||
CloneType |
false |
true (ByPropertyName) |
||
Suffix |
false |
true (ByPropertyName) |
||
ArchivedLocators |
false |
true (ByPropertyName) |
||
CustomSnapShotFomat |
false |
true (ByPropertyName) |
||
CustomText |
false |
true (ByPropertyName) |
||
SchedulerCredentialName |
false |
true (ByPropertyName) |
||
Schedules |
false |
true (ByPropertyName) |
||
SchedulerType |
false |
true (ByPropertyName) |
||
SchedulerInstance |
false |
true (ByPropertyName) |
||
DeleteCloneOnScheduleExpiry |
false |
true (ByPropertyName) |
||
PreScriptCommand |
false |
true (ByPropertyName) |
||
PreScriptArguments |
false |
true (ByPropertyName) |
||
PostScriptCommand |
false |
true (ByPropertyName) |
||
PostScriptArguments |
false |
true (ByPropertyName) |
||
ScriptTimeOut |
false |
true (ByPropertyName) |
||
EmailBody |
false |
true (ByPropertyName) |
||
EmailFrom |
true |
true (ByPropertyName) |
||
EmailTo |
true |
true (ByPropertyName) |
||
EmailSubject |
true |
true (ByPropertyName) |
||
EnableEmailAttachment |
false |
true (ByPropertyName) |
Examples
- Example 1: Modifying a clone job to add a suffix. -
Set-SmCloneJob -ResourceGroupName RG1 -CloneJobName CLMJob -PluginCode SCSQL -CloneToInstance R708202074BV1\SQL2019 -CloneToHost R708202074BV1.hnk2.com -Suffix _clone_001
This example syntax modifies a clone job by adding a new suffix.
Result : SMCoreContracts.SMResult
TotalCount : 0
DisplayCount : 0
Context :
Job : SMCoreContracts.SmJob
Name: Clone life cycle of Resource Group 'CLMJob' with policy 'CLMJob_ClonePolicy'
Id : 151
StartTime : 8/25/2020 6:14:05 AM
EndTime :
IsCancellable : False
IsRestartable : False
IsCompleted : False
IsVisible : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status : Queued
Owner :
Error :
Priority: None
Tasks : {}
ParentJobID : 0
EventId : 0
JobTypeId : 8
ApisJobKey :
ObjectId: 0
PluginCode : NONE
PluginName : NONE
HostId : 0
RoleId :
JobIds : {}
- Example 2: Modifying a clone job -
Set-SmCloneJob -ResourceGroupName RG1 -CloneJobName CLMJob -PluginCode SCSQL -CloneToInstance R708202074BV1\SQL2019 -CloneToHost R708202074BV1.hnk2.com -AssignMountPointUnderPath 'C:\work' -Suffix _clone_001
This example syntax modifies a clone job.
Result : SMCoreContracts.SMResult
TotalCount : 0
DisplayCount : 0
Context :
Job : SMCoreContracts.SmJob
Name: Clone life cycle of Resource Group 'CLMJob' with policy 'CLMJob_ClonePolicy'
Id : 157
StartTime : 8/25/2020 6:17:34 AM
EndTime :
IsCancellable : False
IsRestartable : False
IsCompleted : False
IsVisible : True
IsScheduled : False
PercentageCompleted : 0
Description :
Status : Queued
Owner :
Error :
Priority: None
Tasks : {}
ParentJobID : 0
EventId : 0
JobTypeId : 8
ApisJobKey :
ObjectId: 0
PluginCode : NONE
PluginName : NONE
HostId : 0
RoleId :
JobIds : {}