Remove-RubrikVMSnapshot
SYNOPSIS
Connects to Rubrik and removes an expired VMware VM snapshot available for garbage collection.
SYNTAX
Remove-RubrikVMSnapshot [-id] <String> [[-location] <String>] [[-Server] <String>] [[-api] <String>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
The Remove-RubrikVMSnapshot cmdlet will request that the Rubrik API delete an an expired VMware VM snapshot. The snapshot must be an on-demand snapshot or a snapshot from a virtual machine that is not assigned to an SLA Domain.
EXAMPLES
EXAMPLE 1
Remove-RubrikVMSnapshot -id '01234567-8910-1abc-d435-0abc1234d567'
This will attempt to remove VM snapshot (backup) data with the snapshot id `01234567-8910-1abc-d435-0abc1234d567`
EXAMPLE 2
Remove-RubrikVMSnapshot -id '01234567-8910-1abc-d435-0abc1234d567' -location local -Confirm:$false
This will attempt to remove the local copy of the VM snapshot (backup) data with the snapshot id `01234567-8910-1abc-d435-0abc1234d567` without user intevention
EXAMPLE 3
Get-RubrikVM OldVM1 | Get-RubrikSnapshot -Date '03/21/2017' | Remove-RubrikVMSnapshot
This will attempt to remove any snapshot from `03/21/2017` for VM `OldVM1`.
PARAMETERS
-id
ID of the snapshot to delete
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-location
Snapshot location to delete, either "local" or "all". Defaults to "all"
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: All
Accept pipeline input: False
Accept wildcard characters: False
-Server
Rubrik server IP or FQDN
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: $global:RubrikConnection.server
Accept pipeline input: False
Accept wildcard characters: False
-api
API version
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: $global:RubrikConnection.api
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
Written by Matt Elliott for community usage Twitter: @NetworkBrouhaha GitHub: shamsway
RELATED LINKS
Last updated
Was this helpful?