< Back
Remove-SVTbackup
Post
NAME Remove-SVTbackup
SYNOPSIS
Delete one or more HPE SimpliVity backups
SYNTAX
Remove-SVTbackup [-BackupId] <String> [<CommonParameters>]
DESCRIPTION
Deletes one or more backups hosted on HPE SimpliVity. Use Get-SVTbackup output to pipe in the backup(s) to delete
or
specify the Backup ID, if known.
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.
PARAMETERS
-BackupId <String>
The UID of the backup(s) to delete
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, 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
NOTES
This cmdlet uses the /api/backups/delete REST API POST call which creates a task to delete the specified
backup. This call can accept
multiple backup IDs, but its used here to delete one backup Id at a time. This also works for backups in
remote clusters.
There is another specific DELETE call (/api/backups/<bkpId>) which works locally (i.e. if you're connected to
an OVC where the backup
resides), but this fails when trying to delete remote backups.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Backup -BackupName 2019-05-09T22:00:01-04:00 | Remove-SVTbackup
Deletes the backups with the specified backup name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-Backup -VMname MyVM -Hour 3 | Remove-SVTbackup
Deletes any backup that's at least 3 hours old for the specified virtual machine
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-Backup | ? VMname -match "test" | Remove-SVTbackup
Deletes all backups for all virtual machines that have "test" in their name
RELATED LINKS
SYNOPSIS
Delete one or more HPE SimpliVity backups
SYNTAX
Remove-SVTbackup [-BackupId] <String> [<CommonParameters>]
DESCRIPTION
Deletes one or more backups hosted on HPE SimpliVity. Use Get-SVTbackup output to pipe in the backup(s) to delete
or
specify the Backup ID, if known.
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.
PARAMETERS
-BackupId <String>
The UID of the backup(s) to delete
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, 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
NOTES
This cmdlet uses the /api/backups/delete REST API POST call which creates a task to delete the specified
backup. This call can accept
multiple backup IDs, but its used here to delete one backup Id at a time. This also works for backups in
remote clusters.
There is another specific DELETE call (/api/backups/<bkpId>) which works locally (i.e. if you're connected to
an OVC where the backup
resides), but this fails when trying to delete remote backups.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Backup -BackupName 2019-05-09T22:00:01-04:00 | Remove-SVTbackup
Deletes the backups with the specified backup name
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-Backup -VMname MyVM -Hour 3 | Remove-SVTbackup
Deletes any backup that's at least 3 hours old for the specified virtual machine
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-Backup | ? VMname -match "test" | Remove-SVTbackup
Deletes all backups for all virtual machines that have "test" in their name
RELATED LINKS