Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Remove-NaSnaplockFile


NAME
Remove-NaSnaplockFile

SYNOPSIS
Execute a privileged delete on a SnapLock file.

SYNTAX
Remove-NaSnaplockFile [-Path] <String> [-Controller <NaController>] [-WhatIf
] [-Confirm] [<CommonParameters>]


DESCRIPTION
Execute a privileged delete on a SnapLock file. The file must reside on a S
napLock Enterprise volume and the user performing the privileged delete must
be a member of the "Compliance Administrators" group.


PARAMETERS
-Path <String>
Absolute path of the file to delete. The value must be prefixed with "/v
ol/<volume-name>".

Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS



NOTES


Category: snaplock
API: snaplock-privileged-delete-file

-------------- Example 1 --------------

C:\PS>Remove-NaSnaplockFile /vol/snaplock_entvol0/file1.txt


Remove the SnapLock file, file1.txt, from the SnapLock Enterprise volume sna
plock_entvol0.






RELATED LINKS







 Data ONTAP® PowerShell Toolkit