Set-SmResourceGroup
Modifies a resource group.
Syntax
Set-SmResourceGroup [-ArchivedLocators] <Hashtable[]> [-ResourceGroupName] <String> [-PluginCode] <PluginCode> [-EnableEmail] <> [-EmailPreference] <SmEmailNotificationPreference> [-RemoveCustomSnapShot] <> [-BackupServers] <SmBackupServer>
Detailed Description
Modifies a resource group. You can modify policies, schedules, verification schedules, and resources associated with the resource group.
Parameters
Name | Description | Required? | Pipeline Input | Default Value |
---|---|---|---|---|
ArchivedLocators |
Specifies in a hashtable the secondary storage system details for each unique primary storage system resource in the resource group. For example:-ArchivedLocators @{Primary="my_vs1:my_vol_iscsi";Secondary="my_vs1:my_vol_iscsi_SECONDARY"} |
false |
true (ByPropertyName) |
|
ResourceGroupName |
Specifies the name of the resource group that you want to modify. |
true |
true (ByPropertyName) |
|
PluginCode |
Specifies the plug-in code of the host for which you are modifying a backup resource group. Valid values are SCSQL, SCW, and SCO. |
true |
true (ByPropertyName) |
|
EnableEmail |
Specifies whether to enable or disable email. |
false |
false |
|
EmailPreference |
Specifies when you will receive e-mail notifications.Possible values: Always, Never, OnError, OnErrorOrWarning. |
false |
false |
|
RemoveCustomSnapShot |
false |
true (ByPropertyName) |
||
BackupArchiveLogsAfterRecentMissingOne |
This option is only valid for SCO plugin code. Specifies that you want to backup archive log files, which are created after the most recent missing archive log files and ignore the files created prior to it. If this option is not specified, then all archive log files except the missing archive log files are be backed up. |
false |
true (ByPropertyName) |
|
ExcludeArchiveLogPathsFromBackup |
This option is only valid for SCO plugin code. Specifies the archive log destinations to be excluded from backup. Archive log files present in the specified destinations will be excluded during log backup. Multiple entries can be specified using comma separated list. For example: -ExcludeArchiveLogPathsFromBackup '/arch/logs/on/local/disk1, /arch/logs/on/local/disk2'. |
false |
true (ByPropertyName) |
|
BackupServers |
false |
true (ByPropertyName) |
||
Resources |
Specifies the list of resources to be associated with the resource group.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"}For instance-level backup @{"Host"="localhost";"Type"="SQL Instance";"Names"="Instance"}For availability group backup @{"Host"="localhost";"Type"="SQL Availability Group";"Names"="AG1"}Valid Type values are: SQL Database, SQL Instance, SQL Availability Group.You can include comma-separated values for Names. For Oracle Database, the format is @{"Host"="host.example.com";"Oracle Database"="db1,db2,.."}. For Oracle Application Volume, the format is @{"Host"="host.example.com";"Application Volume"="appVol1,appVol2,.."}. |
true |
true (ByPropertyName) |
|
Description |
Specifies an optional description for the new resource group. |
false |
true (ByPropertyName) |
|
Tag |
Enables you to apply a unique tag to help identify the resource group. |
false |
true (ByPropertyName) |
|
Policies |
Specifies the list of policies associated with the resource group. Multiple policies can be added as a comma-separated list. |
false |
true (ByPropertyName) |
|
SchedulerCredentialName |
false |
true (ByPropertyName) |
||
SchedulerInstance |
Specifies the SQL Server Instance where the schedule is created and managed. This is mandatory if the policy has SQL scheduler enabled. |
false |
true (ByPropertyName) |
|
VerificationServers |
Specifies the list of verification servers to be associated with the resource group. Multiple verification servers can be added as a comma-separated list. This parameter is only required when you want to verify backups for SnapCenter Plug-in for Microsoft SQL Server resource groups. |
false |
true (ByPropertyName) |
|
CustomSnapshotFormat |
Specifies that you want to use a custom Snapshot copy naming format. By default, a timestamp is appended to the Snapshot copy name. Valid values for CustomSnapshotFormat are : $ResourceGroup, $Policy, $HostName, $ScheduleType, $CustomText |
false |
true (ByPropertyName) |
|
CustomText |
Specifies the custom text in the custom Snapshot copy naming format. |
false |
true (ByPropertyName) |
|
DeleteBackupForDetachPolicies |
Deletes backups for the detached policies. |
false |
true (ByPropertyName) |
|
Schedules |
Specifies the schedule parameters to be used in the resource group. Schedule parameters can include the policy name, schedule type, schedule start and end times. You can specify multiple schedules in a comma-separated list, for example:-Schedules @{"PolicyName"="BackupPolicy";"ScheduleType"="OneTime"}, @{"PolicyName"="BackupPolicy";"ScheduleType"="Hourly";"StartTime"=" 05/27/2016 6:13 PM";"EndTime"="'05/27/2016 6:30 PM'"} |
false |
true (ByPropertyName) |
|
SchedulerType |
Specifies the scheduler type. Possible values are Windows, SQL, None. |
false |
true (ByPropertyName) |
|
VerificationSchedules |
Specifies the verification schedules you want to add to the resource. The verification schedule includes the following parameters:"VerificationType" which defines if and when verification is performed. The following values are available:VERIFY_SCHEDULEDVERIFY_AFTER_BACKUPNONE"ScheduleType" represents the schedule type for the verification."BackupScheduleType" represents the schedule type for the backup-VerificationServers "WIN-DVGQDI73QR6" needs to be provided in the above command if we are creating verification enabled resource group for SCSQL plugin.Example:-VerificationSchedules @{"BackupScheduleType"="Hourly";"DeferredBackupCount"="1";"VerificationType"="VERIFY_SCHEDULED";"VerifyOnSecondary"="true";"BackupPolicyName"="sco_20july";"ScheduleType"="Weekly";"DaysOfTheWeek"="Monday";"StartTime"="20-Jul-16 6:42:12 PM";"EndTime"="25-Jul-16 6:42:12 PM"} |
false |
true (ByPropertyName) |
|
ConsistencyGroupSnapshot |
false |
true (ByPropertyName) |
||
ConsistencyGroupWaflSync |
false |
true (ByPropertyName) |
||
ConsistencyGroupTimeOut |
false |
true (ByPropertyName) |
||
SnapShotCreateCommand |
false |
true (ByPropertyName) |
||
UseFileSystemConsistentSnapshot |
false |
true (ByPropertyName) |
||
UseSnapcenterWithoutFileSystemConsistency |
false |
true (ByPropertyName) |
||
PreAppQuiesceCmd |
false |
true (ByPropertyName) |
||
PostAppQuiesceCmd |
false |
true (ByPropertyName) |
||
AppQuiesceCmd |
false |
true (ByPropertyName) |
||
AppUnQuiesceCmd |
false |
true (ByPropertyName) |
||
PreAppUnQuiesceCmd |
false |
true (ByPropertyName) |
||
PostAppUnQuiesceCmd |
false |
true (ByPropertyName) |
||
PreExitCmd |
false |
true (ByPropertyName) |
||
PreSnapshotCmd |
false |
true (ByPropertyName) |
||
PostSnapshotCmd |
false |
true (ByPropertyName) |
||
AppIgnoreError |
false |
true (ByPropertyName) |
||
UseExternalSnapShot |
false |
true (ByPropertyName) |
||
ExternalSnapshotRegex |
false |
true (ByPropertyName) |
||
ConfigParams |
false |
true (ByPropertyName) |
Examples
Example 1: Modifying a custom Snapshot copy format
Set-SmResourceGroup -ResourceGroupName PayrollDataset -CustomSnapShotFomat '$CustomText $Dataset$Policy$HostName' -CustomText NetApp
This example syntax modifies a custom Snapshot copy format.
Example 2: Modifying a HANA custom Snapshot copy format
Set-SmResourceGroup -ResourceGroupName "RG1" -PluginCode HANA -Resources @{"Host"="hanahost01.testlab.netapp.com";"Uid"="MDC\R71"} -CustomSnapShotFomat '$CustomText $Dataset$Policy$HostName' -CustomText NetApp
This example syntax modifies a HANA custom Snapshot copy format.
Example 3: Deleting associated backups when detaching a policy from a resource group
Set-SmResourceGroup -ResourceGroupName "RG1" -PluginCode SCSQL -Resources @{"Host"="WIN-DVGQDI73QR6";"Type"="SQL Database";"Names"="WIN-DVGQDI73QR6\INST_SQL12\DB123} -Policy poly_full -DeleteBackupForDetachPolicies 1
This example syntax modifies a resource group to delete the backups associated with the policy when detaching the policy.
Example 4: Modifying an Oracle Plug-in resource group
Set-SmResourceGroup -ResourceGroupName 'mixedRG' -Resources @(@{"Host"="R809278EA03V1.HNK2.com";"Oracle Database"="DB11,DB12"},@{"Host"="R8092776CF4V1.HNK2.com";"Application Volume"="appVol1,appVol3"}) -plugincode 'SCO' -Policies 'appVolPolicyModified'
This example syntax modifies the policy and resources of an Oracle Plug-in resource group.