SnapCenter PowerShell Commands
Set-SmCloneDataSet
Suggest changes
PDFs
Modifies an existing clone dataset.
Syntax
Set-SmCloneDataSet [-DataSetName] <String> [-Description] <String> [-Policies] <String> [-PluginCode] <PluginCode> [-CloneToInstance] <String> [-Resources] <Hashtable[]> [-Suffix] <String> [-SchedulerCredentialName] <String> [-ArchivedLocators] <Hashtable[]> [-EnableEmail] <> [-EmailPreference] <SmEmailNotificationPreference> [-EmailFrom] <String> [-EmailTo] <String> [-EmailSubject] <String> [-EmailBody] <String> [-CustomSnapShotFomat] <String> [-CustomText] <String> [-RemoveCustomSnapShot] <>
Detailed Description
Modifies an existing clone dataset.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
DataSetName |
Specifies the name of the clone dataset you want to modify. |
true |
true (ByPropertyName) |
|
Description |
Modifies the optional description of the clone dataset. |
false |
true (ByPropertyName) |
|
Policies |
Modifies which policies are attached to the clone dataset. |
false |
true (ByPropertyName) |
|
PluginCode |
true |
true (ByPropertyName) |
||
CloneToInstance |
Changes the SQL Server instance that you want to clone to. All databases in the clone dataset are cloned to this instance. |
true |
true (ByPropertyName) |
|
Resources |
Modifies the list of resources you want to add to the clone dataset.You must provide the resource information in a hashtable, and it must contain the resource name and type, and the host on which it is located. For example,@{"Host"="localhost";"Type"="SQL Database";"Names"="Instance\Database"}Valid Type values are: SQL Database, SQL Instance, SQL Availability Group.You can include comma-separated values for Names. |
true |
true (ByPropertyName) |
|
Suffix |
Modifies a clone name suffix. All clones you create with one clone job are appended with the same suffix name. |
false |
true (ByPropertyName) |
|
SchedulerCredentialName |
false |
true (ByPropertyName) |
||
ArchivedLocators |
false |
true (ByPropertyName) |
||
EnableEmail |
Specifies whether to enable or disable e-mail. |
false |
false |
|
EmailPreference |
Specifies when you will receive e-mail notifications.Possible values: Always, Never, OnError, OnErrorOrWarning. |
false |
false |
|
EmailFrom |
Specifies the sender's e-mail address. |
false |
true (ByPropertyName) |
|
EmailTo |
Specifies the recipient's e-mail address. |
false |
true (ByPropertyName) |
|
EmailSubject |
Specifies the subject of the e-mail. |
false |
true (ByPropertyName) |
|
EmailBody |
Specifies the body of the e-mail. |
false |
true (ByPropertyName) |
|
CustomSnapShotFomat |
Specifies the custom Snaphsot copy naming format. |
false |
true (ByPropertyName) |
|
CustomText |
Specifies the custom text in the custom Snapshot copy naming format. |
false |
true (ByPropertyName) |
|
RemoveCustomSnapShot |
Specifies the removal of the custom Snapshot copy naming format associated with the dataset. |
false |
true (ByPropertyName) |
Examples
Example 1: Modifying a clone dataset with a new suffix
Set-SmCloneDataSet -DataSetName payroll_dataset -Resources @{"Host"="vise-f3.sddev.mycompany.com";"Type"="SQLDatabases";"Names"="vise-f3\SQLExpress\payroll"} -CloneToInstance vise-f4\sqlexpress -Suffix __
newSuffix
This example syntax modifies a clone dataset by adding a new suffix.
Description :
CreationTime: 8/6/2015 2:27:08 PM
ModificationTime: 8/6/2015 2:27:08 PM
EnableEmail :
EmailSMTPServer :
EmailFrom :
EmailTo :
EmailSubject:
EnableSysLog: False
ProtectionGroupType : Clone
EnableAsupOnFailure : False
Policies: {}
HostResourceMaping : {}
Configuration : SMCoreContracts.SmCloneConfiguration
LastBackupStatus:
VerificationServer :
EmailBody :
EmailNotificationPreference :
VerificationServerInfo :
SchedulerSQLInstance:
CustomText :
CustomSnapshotFormat:
SearchResources : False
ByPassRunAs : False
IsCustomSnapshot:
MaintenanceStatus : Production
PluginProtectionGroupTypes :
Name: payroll_dataset
Type: Group
Id :
Host:
UserName:
Passphrase :
Deleted : False
Auth: SMCoreContracts.SmAuth
IsClone : False
CloneLevel : 0
Example 2: Modifying a clone dataset
Set-SmCloneDataSet -DataSetName payroll_dataset -Resources @{"Host"="vise-f3.sddev.mycompany.com";"Type"="SQLDatabases";"Names"="vise-f3\SQLExpress\payroll,vise-f3\SQLExpress\edrive"} -CloneToInstance vise-f3\sqlexpress
This example syntax modifies a clone dataset
Description :
CreationTime: 8/6/2015 3:06:25 PM
ModificationTime: 8/6/2015 3:06:25 PM
EnableEmail :
EmailSMTPServer :
EmailFrom :
EmailTo :
EmailSubject:
EnableSysLog: False
ProtectionGroupType : Clone
EnableAsupOnFailure : False
Policies: {}
HostResourceMaping : {}
Configuration : SMCoreContracts.SmCloneConfiguration
LastBackupStatus:
VerificationServer :
EmailBody :
EmailNotificationPreference :
VerificationServerInfo :
SchedulerSQLInstance:
CustomText :
CustomSnapshotFormat:
SearchResources : False
ByPassRunAs : False
IsCustomSnapshot:
MaintenanceStatus : Production
PluginProtectionGroupTypes :
Name: payroll_dataset
Type: Group
Id :
Host:
UserName:
Passphrase :
Deleted : False
Auth: SMCoreContracts.SmAuth
IsClone : False
CloneLevel : 0