| external help file | Module Name | online version | schema |
|---|---|---|---|
HPESimpliVity-help.xml |
HPESimpliVity |
2.0.0 |
Display information about HPE SimpliVity backups.
Get-SvtBackup [[-VmName] <String[]>] [-BackupName <String[]>] [-DestinationName <String[]>]
[-BackupState <String[]>] [-BackupType <String[]>] [-MinSizeMB <Int32>] [-MaxSizeMB <Int32>] [-Date <String>]
[-CreatedAfter <String>] [-CreatedBefore <String>] [-ExpiresAfter <String>] [-ExpiresBefore <String>]
[-Hour <String>] [-Sort <String>] [-Ascending] [-All] [-Limit <Int32>] [-Raw] [<CommonParameters>]
Get-SvtBackup [-Clustername <String[]>] [-BackupName <String[]>] [-DestinationName <String[]>]
[-BackupState <String[]>] [-BackupType <String[]>] [-MinSizeMB <Int32>] [-MaxSizeMB <Int32>] [-Date <String>]
[-CreatedAfter <String>] [-CreatedBefore <String>] [-ExpiresAfter <String>] [-ExpiresBefore <String>]
[-Hour <String>] [-Sort <String>] [-Ascending] [-All] [-Limit <Int32>] [-Raw] [<CommonParameters>]
Get-SvtBackup [-DatastoreName <String[]>] [-BackupName <String[]>] [-DestinationName <String[]>]
[-BackupState <String[]>] [-BackupType <String[]>] [-MinSizeMB <Int32>] [-MaxSizeMB <Int32>] [-Date <String>]
[-CreatedAfter <String>] [-CreatedBefore <String>] [-ExpiresAfter <String>] [-ExpiresBefore <String>]
[-Hour <String>] [-Sort <String>] [-Ascending] [-All] [-Limit <Int32>] [-Raw] [<CommonParameters>]
Get-SvtBackup [-BackupId <String[]>] [-Raw] [<CommonParameters>]
Show backup information from the HPE SimpliVity Federation. Without any parameters, SimpliVity backups from the last 24 hours are shown, but this can be overridden by specifying the -Hour parameter.
By default the limit is set to show up to 500 backups, as per the HPE recommended value. This can be set to a maximum of 3000 backups using -Limit.
If -Date is used, it will override -CreatedAfter, -CreatedBefore and -Hour. The other date related parameters all override -Hour, if specified.
-All will display all backups, regardless of limit. Be careful, this command will take a long time to complete because it returns ALL backups. It does this by calling the SimpliVity API multiple times (using an offset value of 3000). It is recommended to use other parameters with the -All parameter to limit the output.
The use of -Verbose is recommended because it shows information about what the command is doing. It also shows the total number of matching backups. If matching backups is higher than -Limit (500 by default), then you are not seeing all the matching backups.
Multiple values can be used for most parameters, but only when connecting to a Managed Virtual Appliance. Multi-value parameters currently fail when connected to a SimpliVity Virtual Appliance. For this reason, using an MVA (centralized configuration) is highly recommended.
Get-SvtBackup
Show the last 24 hours of backups from the SimpliVity Federation, limited to 500 backups.
Get-SvtBackup -Date 23/04/2020
PS C:\>Get-SvtBackup -Date '23/04/2020 10:00:00 AM'
The first command shows all backups from the specified date (24 hour period), up to the default limit of 500 backups. The second command shows the specific backup from the specified date and time (using local date/time format).
Get-SvtBackup -CreatedAfter "04/04/2020 10:00 AM" -CreatedBefore "04/04/2020 02:00 PM"
Show backups created between the specified dates/times. (using local date/time format). Limited to 500 backups by default.
Get-SvtBackup -ExpiresAfter "04/04/2020" -ExpiresBefore "05/04/2020" -Limit 3000
Show backups that will expire between the specified dates/times. (using local date/time format). Limited to display up to the maximum of 3000 backups.
Get-SvtBackup -Hour 48 -Limit 2000 |
Select-Object VmName, DatastoreName, SentMB, UniqueSizeMB | Format-Table -Autosize
Show backups up to 48 hours old and display specific properties. Limited to display up to 2000 backups.
Get-SvtBackup -All -Verbose
Shows all backups with no limit. This command may take a long time to complete because it makes multiple calls to the SimpliVity API until all backups are returned. It is recommended to use other parameters with the -All parameter to restrict the number of backups returned. (such as -DatastoreName or -VmName).
Get-SvtBackup -DatastoreName DS01 -All
Shows all backups for VMs located on the specified Datastore with no upper limit. This command will take a long time to complete.
Get-SvtBackup -DatastoreName DS01,DS02 -Limit 1000
Shows all backups for VMs located on the specified SimpliVity datastores, up to the specified limit
Get-SvtBackup -VmName Vm1,Vm2 -BackupName 2020-03-28T16:00+10:00
PS C:\>Get-SvtBackup -VmName Vm1,Vm2,Vm3 -Hour 2
The first command shows backups for the specified VMs with the specified backup name. The second command shows the backups taken within the last 2 hours for each specified VM. The use of multiple, comma separated values works when connected to a Managed Virtual Appliance only.
Get-SvtBackup -VmName VM1 -BackupName '2019-05-05T00:00:00-04:00' -DestinationName SvtCluster
If you have backup policies with more than one rule, further refine the filter by specifying the destination SimpliVity cluster or an external store.
Get-SvtBackup -ClusterName cluster1 -Limit 1 -Verbose
Shows a quick way to determine the number of backups on a cluster without showing them all. The -Verbose parameter will always display the number of backups that meet the command criteria.
Get-SvtBackup -DestinationName cluster1
Show backups located on the specified cluster or external store.
You can specify multiple destinations, but they must all be of the same type. i.e. SimpliVity clusters or external stores.
Get-SvtBackup -DestinationName StoreOnce-Data02,StoreOnce-Data03 -ExpireAfter 31/12/2020
Shows backups on the specified external stores that will expire after the specified date (using local date/time format)
Get-SvtBackup -BackupState FAILED -Limit 20
Show a list of failed backups, limited to 20 backups.
Get-SvtBackup -DatastoreName DS01 -BackupType MANUAL
Show a list of backups that were manually taken for VMs residing on the specified datastore.
Get-SvtVm -ClusterName cluster1 | Foreach-Object { Get-SvtBackup -VmName $_.VmName -Limit 1 }
PS C:\>Get-SvtVm -Name Vm1,Vm2,Vm3 | Foreach-Object { Get-SvtBackup -VmName $_.VmName -Limit 1 }
Display the latest backup for each specified VM
Get-SvtBackup -Sort BackupSize
PS C:\>Get-SvtBackup -Sort ExpiryDate -Ascending
Display backups sorted by a specified property. By default, the sort order is descending but this can be overridden using the -Ascending switch. Accepted properties are VmName, BackupName, BackupSize, CreateDate, ExpiryDate, ClusterName and DatastoreName. The default sort property is CreateDate.
Get-SvtBackup -Limit 5 -Raw
Display the last 5 backups in raw JSON from the Simplivity API.
Show backups for the specified virtual machine(s). By default a limit of 500 backups are shown, but this can be increased to 3000 using -Limit, or removed using -All.
Type: String[]
Parameter Sets: ByVmName
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups sourced from a specified HPE SimpliVity cluster name or names. By default a limit of 500 backups are shown.
Type: String[]
Parameter Sets: ByClusterName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups sourced from a specified SimpliVity datastore or datastores. By default a limit of 500 backups are shown.
Type: String[]
Parameter Sets: ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow the backup with the specified backup ID only.
Type: String[]
Parameter Sets: ByBackupId
Aliases: Id
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups with the specified backup name only.
Type: String[]
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases: Name
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups located on the specified destination HPE SimpliVity cluster name or external datastore name. Multiple destinations can be specified, but they must all be of one type (i.e. cluster or external store) By default a limit of 500 backups are shown, but this can be increased.
Type: String[]
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups with the specified state. i.e. PROTECTED, FAILED or SAVING
Type: String[]
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups with the specified type. i.e. MANUAL or POLICY
Type: String[]
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShow backups with the specified minimum size
Type: Int32
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseShow backups with the specified maximum size
Type: Int32
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups created on the specified date. This takes precedence over CreatedAfter and CreatedBefore. You can specify a date only (shows 24 hours worth of backups) or a date and time, using the local date/time format.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases: CreationDate
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups created after the specified date. This parameter is ignored if -Date is also specified.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backup created before the specified date. This parameter is ignored if -Date is also specified.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups that expire after the specified date.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backup that expire before the specified date.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups created within the specified last number of hours. By default, backups from the last 24 hours are shown. This parameter is ignored when any other date related parameter is also specified.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups sorted by a specified property. By default, the sort order is descending, based on backup creation date (CreateDate). Other accepted properties are VmName, BackupName, BackupSize, ExpiryDate, ClusterName and DatastoreName.
Type: String
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: CreateDate
Accept pipeline input: False
Accept wildcard characters: FalseDisplay backups sorted by a specified property in ascending order.
Type: SwitchParameter
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseBypass the default 500 record limit (and the upper maximum limit of 3000 records). When this parameter is specified, multiple calls are made to the SimpliVity API using an offset, until all backups are retrieved. This can take a long time to complete, so it is recommended to use other parameters, like -VmName or -DatastoreName to limit the output to those specific parameters.
Type: SwitchParameter
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseBy default, display 500 backups. Limit allows you to specify a value between 1 and 3000. A limit of 1 is useful to use with -Verbose, to quickly show how many backups would be returned with a higher limit. Limit is ignored if -All is specified.
Type: Int32
Parameter Sets: ByVmName, ByClusterName, ByDatastoreName
Aliases:
Required: False
Position: Named
Default value: 500
Accept pipeline input: False
Accept wildcard characters: FalseDisplay output as JSON, rather than a formatted PowerShell object. This parameter might useful in troubleshooting and maintaining the module.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Roy Atkins, HPE Services
Known issues with the REST API Get operations for Backup objects: 1. OMNI-53190 REST API Limit recommendation for REST GET backup object calls. 2. OMNI-46361 REST API GET operations for backup objects and sorting and filtering constraints. 3. Filtering on a cluster destination also displays external store backups. This issue applies when connected to SimpliVity Virtual Appliances only. It works as expected when connected to a Managed Virtual Appliance.
https://github.com/atkinsroy/HPESimpliVity/blob/master/Docs/Get-SvtBackup.md