Search <book_title>...

Enterprise Vault™ Setting up File System Archiving (FSA)

Last Published: 2024-09-02

Product(s): Enterprise Vault (15.1)

About this guide
1. Introducing this guide
2. Where to get more information about Enterprise Vault
  1. Enterprise Vault training modules
About File System Archiving
1. About File System Archiving
2. About using FSA with clustered file servers
3. About setting up File System Archiving
4. About FSA policies
5. About target volumes, folders, and archive points
6. About client access to FSA-archived items
7. About archived file permissions
8. About FSA shortcut files
9. About the FSA Agent
10. About retention folders
11. About FSA Reporting
12. About FSAUtility
Steps to configure File System Archiving
1. Steps to configure File System Archiving
Adding a Windows file server to File System Archiving
1. Adding a Windows file server to File System Archiving
2. Using FSA with the Windows Encrypting File System (EFS)
3. About archiving from Windows Server 2012 or later file servers
4. Account requirements for managing FSA with Windows file servers
5. Permissions and privileges required by the Vault Service account on Windows file servers
  1. Granting permissions to the Vault Service account if you do not install the FSA Agent
6. Configuring a file server's firewall for FSA
7. Adding a Windows file server as an archiving target
Adding a NetApp filer to File System Archiving
1. Adding a NetApp filer to File System Archiving
2. Setting the permissions for FSA on a NetApp filer
3. Adding a NetApp filer as an archiving target
Adding a NetApp C-Mode Vserver to File System Archiving
1. Adding a NetApp C-Mode Vserver to File System Archiving
2. Permissions and privileges required by the Vault Service account on NetApp C-mode Vservers
3. Granting the required permission on each Vserver
4. Configuring the FPolicy server details
5. Adding a NetApp C-Mode Vserver as an archiving target
6. Points to note about File System Archiving on NetApp C-Mode file servers
Adding a Celerra/VNX device to File System Archiving
1. Adding a Celerra/VNX device to File System Archiving
2. Preparing a Celerra/VNX device for FSA
3. Adding a Celerra/VNX device as an archiving target
4. Specifying a cache location for retrieved Celerra/VNX files
Adding a Dell EMC Unity device to File System Archiving
1. Adding a Dell EMC Unity device to File System Archiving
2. Preparing a Unity device for FSA
3. Adding the Unity device as an archiving target
Configuring FSA with clustered file servers
1. About configuring FSA with clustered file servers
2. Steps to configure FSA with clustered file servers
3. Preparing to set up FSA services in a cluster
4. Adding the Vault Service account to the non-secure VCS cluster for FSA high availability
5. Adding the virtual file server as an FSA target
6. Configuring or reconfiguring the FSA resource
7. Removing the FSA resource from all cluster groups
8. Troubleshooting the configuration of FSA with clustered file servers
  1. 'Failed to collect clustering data' error on starting FSA Cluster Configuration wizard
Installing the FSA Agent
1. About installing the FSA Agent on a Windows file server
  1. Installing the FSA Agent using the Install FSA Agent wizard
  2. Installing the FSA Agent manually
2. About FSA Agent uninstallation
3. Updating the logon credentials of the FSA Agent services
Defining volume and folder policies
1. About defining FSA volume and folder policies
2. Creating FSA volume policies and folder policies
3. About FSA volume policy and folder policy properties
4. About selecting the shortcut type for an FSA policy
  1. About choosing not to display the file size in NetApp placeholder shortcuts
5. About FSA policy archiving rules
6. About options for archiving files that have explicit permissions, and files under DAC
Configuring the deletion of archived files on placeholder deletion
1. About configuring the deletion of archived files on placeholder deletion
2. Configuring the deletion of archived files on placeholder deletion for Windows file servers and NetApp filers
3. Configuring the deletion of files on placeholder deletion for Dell EMC Celerra/VNX devices
  1. Troubleshooting the deletion of files on placeholder deletion for Dell EMC Celerra/VNX devices
Configuring target volumes, target folders, and archive points
1. About adding target volumes, target folders, and archive points for FSA
  1. About the checks for existing archives for an FSA folder path
2. Adding a target volume for FSA
3. Adding a target folder and archive points for FSA
4. About managing archive points
  1. Viewing, editing, or deleting archive points in the Administration Console
5. Archive point properties
  1. Archive point properties: General tab
  2. Archive point properties: Indexing tab
6. Effects of modifying, moving, or deleting folders
  1. Effects of modifying folders with folder policies
  2. Effects of modifying folders with archive points
7. About deleting target folders, volumes, and file servers
Configuring pass-through recall for placeholder shortcuts
1. About configuring pass-through recall for placeholder shortcuts
2. Configuring pass-through recall for a Windows file server
  1. About configuring pass-through recall for a file server cluster
  2. Registry values for pass-through recall on Windows file servers
3. Configuring pass-through recall for a NetApp filer
Configuring and managing retention folders
1. Configuring retention folders
2. About assigning a retention folder policy using the Command Line Interface (CLI)
  1. The format of the RtnFolder.exe settings file
  2. Example RtnFolder.exe commands
3. Managing retention folders
  1. Disabling the archiving of retention folders for an FSA target
  2. Assigning a different retention folder policy to a target folder
Configuring and running FSA tasks
1. About configuring and running FSA tasks
2. Adding a File System Archiving task
3. Scheduling a File System Archiving task
4. Setting the FSA folder permissions synchronization schedule
5. Scheduling the deletion of archived files on placeholder deletion for Dell EMC Celerra/VNX
6. Configuring FSA version pruning
7. Using Run Now to process FSA targets manually
  1. Processing an FSA target volume manually
  2. Running a File System Archiving task manually
8. About File System Archiving task reports
9. About scheduling storage expiry for FSA
Configuring file system filtering
1. About custom filters for File System Archiving
2. Configuring file system filters
3. About file system filter reports
Managing the file servers
1. About managing the target file servers
2. About backing up the target file servers
3. About virus-checking the target file servers
4. About changing the placeholder recall rate settings
  1. Changing the placeholder recall rate settings for a Windows file server
  2. Changing the placeholder recall rate settings for a NetApp file server
5. About preventing unwanted file recalls from placeholder shortcuts
PowerShell cmdlets for File System Archiving
1. About the PowerShell cmdlets for File System Archiving
2. Running the File System Archiving cmdlets
3. Creating PowerShell scripts using File System Archiving cmdlets
4. File System Archiving cmdlets error handling
Appendix A. Permissions and privileges required for the Vault Service account on Windows file servers
1. About the permissions and privileges required for the Vault Service account on Windows file servers
2. Group membership requirements for the Vault Service account
3. DCOM permissions required by the Vault Service account
4. WMI control permissions required by the Vault Service account
5. Local security user rights required by the Vault Service account
6. Permissions required by the Vault Service account for the FSA Agent
7. Permissions required by the Vault Service account to support the FSA resource on clustered file servers
8. FSA target share and folder permissions required by the Vault Service account

File System Archiving cmdlets error handling

The File System Archiving cmdlets write the error information directly on the PowerShell host.

Table: File System Archiving cmdlet errors describes the standard set of errors that the cmdlets return.

Table: File System Archiving cmdlet errors

ErrorID	Reason for failure	Action
CannotDetermineFreeDiskSpaceOnFileServer	The cmdlet is unable to determine the available free disk space on file server.	Ensure that the pass-through recall cache location specified in the command is valid and accessible.
CannotUpdateNetAppPHRecallSettings	The cmdlet cannot update the placeholder recall settings for the specified NetApp file server because either placeholder recall is not enabled or you have chosen to disable placeholder recalls in the command.	Enable placeholder recalls on the NetApp file server for which you want to update placeholder recall settings.
CannotUseFolderPolicyWithPlaceholders	The associated file server does not support placeholder shortcuts. The associated folder does not have placeholder shortcuts configured.	Ensure that the file server supports placeholder shortcuts or that placeholder shortcuts are enabled on the file server. Specify a folder policy that has Internet shortcuts as the shortcut type.
CannotUsePassthroughSettings	The associated file server does not support pass-through recall operations. The associated file server in the Administration Console does not have pass-through recall configured. Pass-through recall is supported on Windows file server that has the Enterprise Vault File Placeholder Service installed and the placeholder driver version is 8.0 or later. For NetApp 7-mode, Enterprise Vault supports pass-through recall for accessing files from the snapshots. There is no support for pass-through recall for server types such as NetApp C-Mode, Celerra/VNX, and others. The file server is not a Windows file server. The Windows file server does not have FSA agent installed.	Ensure that pass-through recall is enabled on the file server. Ensure that the file server is a Windows file server and the FSA agent is installed on it.
CannotUseVolumePolicyWithPlaceholders	The share you want to configure may be on a file server running NetApp 7.0 or earlier versions. The share you want to configure is on a Celerra/VNX file server. The share you want to configure is on Windows file server and the file system type for the share is other than NTFS. The share you want to configure is on a Windows file server and the Enterprise Vault File Placeholder Service is not installed on the file server.	Use a different volume policy or modify the volume policy settings for the placeholder.
CannotUseVolumePolicyWithQuotas	You can configure quota settings only when the volume target is an NTFS file system and the path is the drive path. For example, C:\, E:\, and so on.	Use a different volume policy or modify the volume policy.
CannotValidatePassThroughCacheLocation	The cmdlet cannot validate the pass-through cache location that is specified in the command.	Ensure that the pass-through recall cache location that is specified in the command is valid and accessible.
EnterpriseVaultDirectoryServiceNotAvailable	The Enterprise Vault Directory service is not running on the Enterprise Vault computer.	Start the Enterprise Vault Directory service if it is not running. Check the event logs for any other errors.
ErrorCheckingFSALicense	The cmdlet cannot connect to the Enterprise Vault server to get the File System Archiving license information.	Check whether the Enterprise Vault server is reachable. Also check that the DCOM communication works.
ErrorDeletingFSAFolder	An unknown error has occurred.	Check the DTrace logs for more information.
ErrorGettingFileSystemName	The cmdlet cannot get volume information of the share folder.	Check whether the share is reachable and the user running the cmdlet has appropriate permissions on the share.
FailedToDetectFileServerType	The file server that you want to add is not a Windows file server, a NetApp filer, or a Celerra/VNX device. You do not have the required permissions on the file server that you want to add.	Ensure that the file server that you want to add is either a Windows file server, a NetApp filer, or a Celerra/VNX device. Ensure that you have the required permissions on the file server that you want to add.
FailedToRemoveFileServer	The specified file server cannot be removed due to unknown errors.	Enable DTrace logs and re-run the cmdlet. Check event logs and DTrace logs for more information.
FileServerContainsVolumes	The specified file server has associated volumes that are configured for File System Archiving.	Remove all the associated volumes of the specified file server.
FolderDoesNotExist	The specified folder does not exist or is not accessible on the network.	Check whether the folder is reachable, and the Vault Service account and the user running the cmdlet have appropriate permissions on the server.
FolderPolicyNotConfiguredInEVSite	The specified folder policy is not configured in the given Enterprise Vault site.	Specify a folder policy that is configured in the given Enterprise Vault site.
FSAErrorGettingServiceStatus	The cmdlet cannot connect to the Enterprise Vault server. The file server is not reachable from the Enterprise Vault server.	Check whether the Enterprise Vault server is reachable and the DCOM communication works between the Enterprise Vault server and the computer where cmdlet is running. Check whether the file server is reachable from Enterprise Vault server. Also check that the DCOM communication works between the Enterprise Vault server and the file server.
FSAErrorGettingVolumeInformation	The cmdlet cannot connect to the Enterprise Vault server. The share is not reachable from the Enterprise Vault server.	Check whether the Enterprise Vault server is reachable and the user running the cmdlet has appropriate permissions on the server. Check whether the share is reachable from Enterprise Vault server and the Vault Service account has appropriate permissions on the share.
FSAFileServerAlreadyConfigured	You have already added the file server to the Enterprise Vault site as a File System Archiving target. If you see this error when you try to add a NetApp C-Mode Vserver, then you may have already configured an associated data LIF with a different name.
FSAFileServerDataMoverAccountDetailsRequired	You have not specified Data Mover account credentials for the Celerra/VNX file server that you want to update.	Specify the Data Mover account credentials for the Celerra/VNX file server when you enable placeholder shortcuts for the first time.
FSAFileServerDataMoverAccountValidationFailed	The cmdlet cannot validate the DHSM settings that you provided for the Celerra/VNX file server.	Make sure that you specify valid DHSM settings.
FSAFileServerDataMoverPasswordLengthIncorrect	The password that is provided for the Celerra/VNX Data Mover user account is invalid.	Ensure that the Data Mover account password contains between 1 to 15 characters.
FSAFileServerDataMoverUserNameLengthIncorrect	The user name that is provided for the Celerra/VNX Data Mover user account is invalid.	Ensure that the Data Mover account user name contains between 1 to 1024 characters.
FSAFileServerDHSMCommunicationError	The cmdlet failed to communicate with the Celerra/VNX file server because of one of the following reasons: The Celerra/VNX Data Mover user account is not authorized. Access to Celerra/VNX file server is denied. The Celerra/VNX file server is unavailable. Request to connect Celerra/VNX file server has timed out. The SSL certificate on the Celerra/VNX server is not valid. The Data Mover service (DHSM) is not configured on the provided port number.	Make sure that you specify valid DHSM settings.
FSAFileServerDHSMConfigurationNotAllowed	The cmdlet cannot update the DHSM settings for the specified Celerra/VNX file server because either placeholder shortcuts are disabled or you have chosen to disable placeholder shortcuts in the command.	Enable placeholder shortcuts on the Celerra/VNX file server for which you want to update DHSM settings.
FSAFileServerFailedToConfigure	An unknown error has occurred.	Check Event logs and DTrace logs for more information.
FSAFileServerIPAddressNotAllowed	You have specified the IP address of the file server.	Specify the fully qualified domain name or UNC name or Alias name of the file server.
FSAFileServerNotConfiguredInEVSite	The specified file server is not configured in the Administration Console for the given Enterprise Vault site.	Add the file server using the New File Server wizard. Specify a file server that is configured in the given Enterprise Vault site.
FSAFileServerNotFoundInNetwork	The specified file server is not accessible on the network.	Ensure that the file server is accessible on the network.
FSAFileServerUnsupportedOS	The version of the operating system on the specified file server is not supported.	Specify a file server that is running a supported operating system. Refer to the Enterprise Vault Compatibility Charts for the list of supported operating system versions for Windows file servers.
FSAFolderAlreadyConfigured	You have already added the folder to the Enterprise Vault site as a File System Archiving target.
FSAFolderFailedToConfigure	The cmdlet failed to configure the specified folder.	Ensure that you have the required permissions on the folder that you want to configure.
FSAFolderInvalidPolicyParameter	You have specified a folder policy along with the parameter UseVolumePolicy set to true.	If you want the cmdlet to use the folder policy, set UseVolumePolicy to false. If you want the cmdlet to use the volume policy, do not specify a folder policy.
FSAFolderNotConfiguredInEVSite	The specified folder is not set up for archiving on the file server. Therefore you cannot update, delete, or retrieve properties of the folder.	Use New-EVFSAFolder cmdlet to configure the folder.
FSAInvalidLIFConfiguration	The cmdlet failed to add the NetApp C-Mode file server because of one of the following reasons: The NetApp C-Mode Vserver has no CIFS data LIF associated with it. The value specified in -Identifier is not a valid data LIF for the NetApp C-Mode Vserver associated with the LIF specified in -ManagementLIF.	Ensure that the specified data LIFs are CIFS-enabled and are associated with the management LIF of NetApp C-Mode Vserver that you want to configure.
FSAInvalidParameterSpecified	You have specified a value for -ManagementLIF. However, this parameter is not valid for the type of file server you want to add.	Do not specify -ManagementLIF for non-NetApp C-Mode file servers.
FSAFolderPolicyNotSpecified	You have set the parameter UseVolumePolicy set to false, but have not specified a folder policy.	Specify a folder policy that is configured in the given Enterprise Vault site.
FSALicenseNotFound	The File System Archiving license is not installed on the Enterprise Vault server.	The File System Archiving license is required for adding new volumes. See Installing and Configuring for information about licenses.
FSAParameterNotSpecified	You have not specified a value for -ManagementLIF.	You must specify a value for -ManagementLIF to add a NetApp C-Mode file server.
FSALoggingDetectionFailedOnCelerra	The cmdlet failed to check if logging is enabled on the Celerra/VNX file server because of one of the following reasons: The cmdlet cannot connect to the Enterprise Vault server. The Celerra/VNX file server is not reachable from the Enterprise Vault server.	Check whether the file server is reachable from Enterprise Vault server.
FSAPlaceholderDetectionFailedOnCelerra	The cmdlet failed to check if placeholder creation is enabled on the Celerra/VNX file server because of one of the following reasons: The cmdlet cannot connect to the Enterprise Vault server. The Celerra file server is not reachable from the Enterprise Vault server.	Check whether the Enterprise Vault server is reachable and the DCOM communication works between the Enterprise Vault server and the computer where cmdlet is running. Check whether the file server is reachable from Enterprise Vault server. Also check that DHSM configuration is performed on the Celerra/VNX for the file server.
FSATaskNotConfiguredOnEVServer	The specified File System Archiving task does not exist on the same computer as the Enterprise Vault server that manages the vault store.	Add the File System Archiving task on the Enterprise Vault server which manages the associated vault store.
FSATaskRunning	You cannot delete the specified volume or folder because the associated File System Archiving task is running. You cannot change or update the File System Archiving task for this volume because the associated File System Archiving task is running.	In the Administration Console, expand the Enterprise Vault site, and then expand the Enterprise Vault Servers container. Expand the container for the Enterprise Vault server whose File System Archiving task processes the associated target volume, and select Tasks. Right-click the File System Archiving task that processes the volume you want to delete or update, and on the shortcut menu click Stop.
FSAUpdateFailedInvalidParameter	The specified parameters are invalid to update the specified type of file server.	Specify valid parameters and run Set-EVFSAFileServer.
FSAUpdateParameterNotSpecified	You have not specified any parameters to execute Set-EVFSAFileServer.	Specify at least one parameter along with -Identifier to execute Set-EVFSAFileServer.
FSAVolumeNotConfiguredInEVSite	The specified File System Archiving volume is not set up for archiving on the file server. Therefore you cannot update, delete, or retrieve properties of the volume.	Use New-EVFSAVolume cmdlet to configure the volume.
FSAVolumePolicyNotCreatedForEVSite	The specified FSA volume policy is not configured in the Administration Console for the given Enterprise Vault site.	Add the FSA volume policy in using the New Policy Wizard.
FSAVolumeValidationUnknownError	An unknown error occurred.	Check Event logs and DTrace logs for more information.
FailedToCheckPassthroughSettings	The cmdlet cannot connect to the Enterprise Vault server. The file server is not reachable from the Enterprise Vault server.	Check whether the Enterprise Vault server is reachable and the DCOM communication works between the Enterprise Vault server and the computer where the cmdlet is running. Check whether the file server is reachable from Enterprise Vault server. Also check that the DCOM communication works between the Enterprise Vault server and the file server.
FailedToGetFSATaskStatus	The cmdlet cannot connect to the Enterprise Vault server on which the File System Archiving task is configured.	Check whether the Enterprise Vault server is reachable and the user running the cmdlet has appropriate permissions on the server.
FileSystemNotSupportedForArchiving	The volume has Resilient File System (ReFS) or Cluster Shared Volume File System (CSVFS) installed.	Use a volume that has NTFS file system installed.
IgnoreVolumeRulesCanOnlyBeUsedWithFolderPolicy	You have specified -IgnoreVolumeRules without specifying a folder policy.	Specify -IgnoreVolumeRules along with -Policy.
InvalidPassThroughCacheLocation	The specified pass-through recall cache location is incorrect.	Ensure that the pass-through recall cache location that is specified in the command is valid and is accessible.
NotificationToFSAAgentFailed	The cmdlet cannot connect to the Enterprise Vault server. The Windows file server is not reachable from the Enterprise Vault server.	Check whether the Enterprise Vault server is reachable and the DCOM communication works between the Enterprise Vault server and the computer where cmdlet is running. Check whether the file server is reachable from Enterprise Vault server. Also check that the DCOM communication works between the Enterprise Vault server and the file server.
ParameterNotSpecified	You have not specified any parameters to run the Set-EVFSAVolume cmdlet.	Specify at least one parameter to update. For example, TaskName or TaskId, PolicyName or PolicyId, DisableArchiving or PassthroughRecall.
PassThroughCacheLocationNotSpecified	You have not specified the pass-through recall cache location in this command.	Specify the pass-through recall cache location.
PassThroughInsufficientFreeDiskSpace	You cannot specified a cache size that is greater than the available disk space.	Ensure that there is sufficient free space or specify a smaller cache size.
PassThroughRecallSettingNotEnabled	Pass-through recall is not enabled or you have chosen to disable pass-through recall in this command.	Enable pass-through recalls on the Windows file server to update pass-through recall settings.
PHRecallSettingsNotApplicable	The file server for which you want to update placeholder recall settings is not a NetApp file server.	Ensure that the file server you want to update placeholder recall settings for is a NetApp file server.
PipelineStopped	One of the cmdlet operations from the pipeline failed and threw a terminating exception.	Check the errors that are displayed on the Enterprise Vault Management Shell and take appropriate action.
ShareAlreadyConfiguredForArchiving	The specified share has already been configured for the specified file server. Therefore you cannot use the New-EVFSAVolume cmdlet to add the share.	Specify a different share name.
ShareNotFoundOnFileServer	The specified share is not found on the network.	Ensure that the share path exists and is correct.
UnauthorizedAccess	You are not authorized to perform this operation.	Ensure that you have the appropriate permissions required for File System Archiving. Ensure that you have the appropriate permissions on the specified file server target.
VaultStoreMarkedForDeletion	The specified vault store is marked for deletion.	Use a different vault store.
VaultStoreNotConfiguredInSite	The specified Vault Store is not configured for the given Enterprise Vault site.	Add the vault store using the New Vault Store wizard.