Remove-UnifiBackup
SYNOPSIS
Remove specified backup file
SYNTAX
Remove-UnifiBackup [-Url] <String> [-WebSession] <WebRequestSession> [[-SiteName] <String>]
[-FileName] <String> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Remove specified backup file
EXAMPLES
EXAMPLE 1
$Credential = $(Get-SecureCredential -Name 'Unifi' -VaultName 'MyVault')
PS>$Url = "https://unifi.domain.com:8443"
PS>$session = Get-UnifiSession -Url $Url -Credential $Credential
PS>$MySite = Get-UnifiSite -Url $Url -WebSession $session -SiteName 'MySite'
PS>$backup = Get-UnifiBckup -Url $Url -WebSession $session | Where-Object {$( Get-Date -Date $_.datetime).tostring('yyyy-MM-dd') -ieq $(Get-Date -Format 'yyyy-MM-dd')}
PS>Remove-UnifiBackup -Url $Url -WebSession $session -FileName $backup.filename
PS>Remove-UnifiSession -Url $Url -WebSession $session -Confirm:$false
PARAMETERS
-Url
Target UniFi Url
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WebSession
UniFi web session
Type: WebRequestSession
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SiteName
Use the 'name' property of the target site
Type: String
Parameter Sets: (All)
Aliases: name
Required: False
Position: 3
Default value: Default
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FileName
Target device mac address
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
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
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.