< Back
Set-SVTbackupRetention
Post
NAME Set-SVTbackupRetention
SYNOPSIS
Set the retention of existing HPE SimpliVity backups
SYNTAX
Set-SVTbackupRetention [-RetentionDay] <Int32> [-BackupId] <String> [<CommonParameters>]
DESCRIPTION
Change the retention on existing SimpliVity backup.
BackupId is the only unique identifier for backup objects (e.g. multiple backups can have the same name). This
makes
using this command a little cumbersome by itself. However, you can use Get-SVTBackup to identify the backups you
want to target
and then pipe the output to this command.
Note: There is currently a known issue with the REST API that prevents you from setting retention times that will
cause backups to immediately expire. As a consequence, this cmdlet will only allow you to increase backup
retentions.
if you try to decrease the retention for a backup policy where backups will be expired, you'll receive an error in
the task.
OMNI-53536: Setting the retention time to a time that causes backups to be deleted fails
PARAMETERS
-RetentionDay <Int32>
The new retention you would like to set, in days.
Required? true
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-BackupId <String>
The UID of the backup you'd like to set the retention for
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
HPE.SimpliVity.Backup
OUTPUTS
HPE.SimpliVity.Task
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Backup -BackupName 2019-05-09T22:00:01-04:00 | Set-SVTbackupRetention -RetentionDay 21
Gets the backups with the specified name and sets the retention to 21 days.
RELATED LINKS
SYNOPSIS
Set the retention of existing HPE SimpliVity backups
SYNTAX
Set-SVTbackupRetention [-RetentionDay] <Int32> [-BackupId] <String> [<CommonParameters>]
DESCRIPTION
Change the retention on existing SimpliVity backup.
BackupId is the only unique identifier for backup objects (e.g. multiple backups can have the same name). This
makes
using this command a little cumbersome by itself. However, you can use Get-SVTBackup to identify the backups you
want to target
and then pipe the output to this command.
Note: There is currently a known issue with the REST API that prevents you from setting retention times that will
cause backups to immediately expire. As a consequence, this cmdlet will only allow you to increase backup
retentions.
if you try to decrease the retention for a backup policy where backups will be expired, you'll receive an error in
the task.
OMNI-53536: Setting the retention time to a time that causes backups to be deleted fails
PARAMETERS
-RetentionDay <Int32>
The new retention you would like to set, in days.
Required? true
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-BackupId <String>
The UID of the backup you'd like to set the retention for
Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
HPE.SimpliVity.Backup
OUTPUTS
HPE.SimpliVity.Task
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Backup -BackupName 2019-05-09T22:00:01-04:00 | Set-SVTbackupRetention -RetentionDay 21
Gets the backups with the specified name and sets the retention to 21 days.
RELATED LINKS