Remove-RubrikHyperVSnapshot

SYNOPSIS

Connects to Rubrik and removes an expired HyperV VM snapshot available for garbage collection.

SYNTAX

Remove-RubrikHyperVSnapshot [-id] <String> [[-location] <String>] [[-Server] <String>] [[-api] <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-RubrikHyperVSnapshot cmdlet will request that the Rubrik API delete an an expired HyperV VM snapshot. The snapshot must a snapshot from a HyperV VM that is not assigned to an SLA Domain.

EXAMPLES

EXAMPLE 1

Remove-RubrikHyperVSnapshot -id '01234567-8910-1abc-d435-0abc1234d567'

This will attempt to remove HyperV VM snapshot (backup) data with the snapshot id `01234567-8910-1abc-d435-0abc1234d567`

EXAMPLE 2

Remove-RubrikHyperVSnapshot -id '01234567-8910-1abc-d435-0abc1234d567' -location local -Confirm:$false

This will attempt to remove the local copy of the HyperV VM snapshot (backup) data with the snapshot id `01234567-8910-1abc-d435-0abc1234d567` without user intevention

EXAMPLE 3

Get-RubrikHyperVVM VM1 | Get-RubrikSnapshot -Date '03/21/2017' | Remove-RubrikHyperVSnapshot

This will attempt to remove any snapshot from `03/21/2017` for the HyperV VM named `VM1`.

PARAMETERS

-id

ID of the snapshot to delete

Type: String
Parameter Sets: (All)
Aliases: SnapshotId

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 Mike Preston for community usage Twitter: @mwpreston GitHub: mwpreston

RELATED LINKS

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/remove-rubrikhypervsnapshot