Enterprise Vault™ Setting up File System Archiving (FSA)
- About this guide
- About File System Archiving
- About File System Archiving
- About using FSA with clustered file servers
- About setting up File System Archiving
- About FSA policies
- About target volumes, folders, and archive points
- About client access to FSA-archived items
- About archived file permissions
- About FSA shortcut files
- About the FSA Agent
- About retention folders
- About FSA Reporting
- About FSAUtility
- Steps to configure File System Archiving
- Adding a Windows file server to File System Archiving
- Adding a Windows file server to File System Archiving
- Using FSA with the Windows Encrypting File System (EFS)
- About archiving from Windows Server 2012 or later file servers
- Account requirements for managing FSA with Windows file servers
- Permissions and privileges required by the Vault Service account on Windows file servers
- Configuring a file server's firewall for FSA
- Adding a Windows file server as an archiving target
- Adding a NetApp filer to File System Archiving
- Adding a NetApp C-Mode Vserver to File System Archiving
- Adding a NetApp C-Mode Vserver to File System Archiving
- Permissions and privileges required by the Vault Service account on NetApp C-mode Vservers
- Granting the required permission on each Vserver
- Configuring the FPolicy server details
- Adding a NetApp C-Mode Vserver as an archiving target
- Points to note about File System Archiving on NetApp C-Mode file servers
- Adding a Celerra/VNX device to File System Archiving
- Adding a Dell EMC Unity device to File System Archiving
- Configuring FSA with clustered file servers
- About configuring FSA with clustered file servers
- Steps to configure FSA with clustered file servers
- Preparing to set up FSA services in a cluster
- Adding the Vault Service account to the non-secure VCS cluster for FSA high availability
- Adding the virtual file server as an FSA target
- Configuring or reconfiguring the FSA resource
- Removing the FSA resource from all cluster groups
- Troubleshooting the configuration of FSA with clustered file servers
- Installing the FSA Agent
- Defining volume and folder policies
- About defining FSA volume and folder policies
- Creating FSA volume policies and folder policies
- About FSA volume policy and folder policy properties
- About selecting the shortcut type for an FSA policy
- About FSA policy archiving rules
- About options for archiving files that have explicit permissions, and files under DAC
- Configuring the deletion of archived files on placeholder deletion
- Configuring target volumes, target folders, and archive points
- About adding target volumes, target folders, and archive points for FSA
- Adding a target volume for FSA
- Adding a target folder and archive points for FSA
- About managing archive points
- Archive point properties
- Effects of modifying, moving, or deleting folders
- About deleting target folders, volumes, and file servers
- Configuring pass-through recall for placeholder shortcuts
- Configuring and managing retention folders
- Configuring and running FSA tasks
- About configuring and running FSA tasks
- Adding a File System Archiving task
- Scheduling a File System Archiving task
- Setting the FSA folder permissions synchronization schedule
- Scheduling the deletion of archived files on placeholder deletion for Dell EMC Celerra/VNX
- Configuring FSA version pruning
- Using Run Now to process FSA targets manually
- About File System Archiving task reports
- About scheduling storage expiry for FSA
- Configuring file system filtering
- Managing the file servers
- PowerShell cmdlets for File System Archiving
- Appendix A. Permissions and privileges required for the Vault Service account on Windows file servers
- About the permissions and privileges required for the Vault Service account on Windows file servers
- Group membership requirements for the Vault Service account
- DCOM permissions required by the Vault Service account
- WMI control permissions required by the Vault Service account
- Local security user rights required by the Vault Service account
- Permissions required by the Vault Service account for the FSA Agent
- Permissions required by the Vault Service account to support the FSA resource on clustered file servers
- FSA target share and folder permissions required by the Vault Service account
Preparing a Unity device for FSA
Enterprise Vault supports EMC Unity VSA as a file system archiving target. This section describes how to prepare and add a Unity device for File System Archiving.
To prepare a Unity device for FSA using Dell EMC Unity Unisphere VSA
- Log on to Dell EMC Unity Unisphere VSA.
- Add a Unity account for Enterprise Vault to use for authentication on the Unity device.
Click Update System Settings.
On the left-hand pane, click Users and Groups.
Select User Management. Click the '+' icon to add a new user.
In the Create User or Group dialog box, select Local User, and click Next.
Enter the details of the new Unity account, and click Next.
Select Storage Administrator and click Next.
Click Finish, and then click Close.
Click Close to close the Settings dialog box.
- Enable Distributed Hierarchical Storage Management (DHSM) for the NAS server that will be used as the FSA target.
On the left-hand pane, click Storage > File, and then click the NAS Servers tab.
Select the NAS server and edit the properties.
In the properties window, click the Protection and Events tab.
In the left-hand pane, click DHSM.
Select the Enable DHSM check box.
Enter the details of the Unity Storage Administrator account created in the earlier step.
Clear the Enforce HTTP Secure checkbox. HTTPS is not supported.
Click Apply to complete this step.
Click Close to close the properties dialog box.
- Edit the properties of all the file systems that corresponding to the NAS server that you want to archive from.
Select a File system and edit the properties.
Click the Advanced tab.
Select the Sync Writes Enabled, Oplocks Enabled, Notify On Write Enabled ,and Notify On Access Enabled check boxes.
Click Apply to save the settings.
Click Close to close the properties dialog box.
- In the left-hand pane, click System > Service, and click the Service Tasks tab. Make sure that SSH is enabled.
- Connect to EMC Unity using SSH (use Management IP and username should be service account name)
- Configure a DHSM connection to use for recall requests.
Run the following command:
uemcli -u Local/admin -p Unity_Admin_Account_Password /net/nas/dhsmconn create -fs fs_id -secondaryUrl http://EV_Server_FQDN/EnterpriseVault -mode enabled -readPolicy full -secondaryUsername User@Domain -secondaryPassword Password
For example,
uemcli -u Local/admin -p p4ssw0rd /net/nas/dhsmconn create -fs fs_1 -secondaryUrl http://evserver.example.local/EnterpriseVault -mode enabled -readPolicy full -secondaryUsername vsa@example.local -secondaryPassword p@ssw0rd
Where:
p4ssw0rd is the password of the Unity administrator account.
fs_1 is the ID of file system attached to the NAS server. To get the ID of the file system use the following as the URL in a web browser: https:// Unity_IP_Or_FQDN/api/types/filesystem/instances?fields=id,name. The output will contain the list of file systems along with their name and IDs. Look for the ID for your file system.
http://evserver.example.local/EnterpriseVault is the URL of Enterprise Vault Web Access application.
vsa@example.local is the Vault Service account that will have access to all the archives from which files are restored.
p@ssw0rdd is the password to the Vault Service account.
On the remote certificate prompt, choose Accept and store.
- Verify that the settings are correctly applied using the following command:
uemcli -u Local/admin -p Unity_Admin_Password /net/nas/dhsmconn -fs fs_id show
For example:
uemcli -u Local/admin -p Admin123# /net/nas/dhsmconn -fs fs_1 show
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection 1: ID = DHSMConnection_1 File system = fs_1 Secondary url = http://evserver.example.local/EnterpriseVault Secondary port = 80 Secondary username = vsa@example.local Local port =
- Add the Vault Service account as a member of the Administrators group of the Dell EMC UnityVSA server:
In Windows, start Computer Management.
In the Computer Management console, select Action > Connect to another computer. Enter the name of the NAS server.
Add the Vault Service account to the Administrators group.
To prepare a Unity device for FSA using SSH
- Connect to EMC Unity using SSH.
- Add a Unity account for Enterprise Vault to use for authentication on the Unity device, using this command:
uemcli -u Local/admin -p Unity_Admin_Password /user/account create -name Account_Name -type local -passwdSecure -role storageadmin
Example:
uemcli -u Local/admin -p p4ssw0rd /user/account create -name unityaccount -type local -passwdSecure -role storageadmin
Where:
p4ssw0rd is the password of the Administrator account on Unity.
unityaccount is the name of the local Storage Administrator account.
local is the type of the user account. The new Unity account must be a local user.
-passwdSecure Prompts you to specify the password and confirm the password when the command runs.
storageadmin is the role for the new account. The new Unity account must be assigned to the Storage Administrator role.
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection [Secure] For local users, type the user password. Password: Confirm password: ID = user_unityaccount Operation completed successfully.
- Enable Distributed Hierarchical Storage Management (DHSM) for a NAS server.
Get the ID of the file system by using the following as the URL in a web browser:
https://Unity_IP_Or_FQDN/api/types/filesystem/instances?fields=id,name.
The output will contain the list of file systems along with their name and IDs. Look for the ID for your file system.
Enable DHSM on the NAS server, using following command:
uemcli -u Local/admin -p Unity_Admin_Password /net/nas/dhsm -server <NAS_id> set -state Enabled -username Storage_Admin_User -passwdSecure -enableHTTPS no
For example:
uemcli -u Local/admin -p p4ssw0rd /net/nas/dhsm -server nas_1 set -state Enabled -username unityaccount -passwdSecure -enableHTTPS no
Where:
p4ssw0rd is the password of the Administrator account on Unity.
nas_1 is the ID of the associated NAS server.
unityaccount is the name of the local Storage Administrator account.
-passwdSecure Prompts you to specify the password and confirm the password when the command runs.
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection [Secure] The advanced storage access password. Password: Confirm password: Operation completed successfully.
Verify that DHSM is configured correctly, by using the following command:
uemcli -u Local/admin -p Unity_Admin_Password /net/nas/dhsm -server <NAS_id> show
For example:
uemcli -u Local/admin -p Admin123# /net/nas/dhsm -server nas_1 show
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection 1: NAS server = nas_1 State = Enabled
- Configure a DHSM connection to use for recall requests.
Run the following command:
uemcli -u Local/admin -p Unity_Admin_Account_Password /net/nas/dhsmconn create -fs fs_id -secondaryUrl http://EV_Server_FQDN/EnterpriseVault -mode enabled -readPolicy full -secondaryUsername User@Domain -secondaryPassword Password
For example,
uemcli -u Local/admin -p p4ssw0rd /net/nas/dhsmconn create -fs fs_1 -secondaryUrl http://evserver.example.local/EnterpriseVault -mode enabled -readPolicy full -secondaryUsername vsa@example.local -secondaryPassword p@ssw0rd
Where:
p4ssw0rd is the password of the Unity administrator account.
fs_1 is the ID of file system attached to the NAS server. To get the ID of the file system use the following as the URL in a web browser: https:// Unity_IP_Or_FQDN/api/types/filesystem/instances?fields=id,name. The output will contain the list of file systems along with their name and IDs. Look for the ID for your file system.
http://evserver.example.local/EnterpriseVault is the URL of Enterprise Vault Web Access application.
vsa@example.local is the Vault Service account that will have access to all the archives from which files are restored.
p@ssw0rdd is the password to the Vault Service account.
On the remote certificate prompt, choose Accept and store.
- Verify that the settings are correctly applied using the following command:
uemcli -u Local/admin -p Unity_Admin_Password /net/nas/dhsmconn -fs fs_id show
For example:
uemcli -u Local/admin -p Admin123# /net/nas/dhsmconn -fs fs_1 show
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection 1: ID = DHSMConnection_1 File system = fs_1 Secondary url = http://evserver.example.local/EnterpriseVault Secondary port = 80 Secondary username = vsa@example.local Local port =
- Edit the properties of all the file systems that corresponding to the NAS server that you want to archive from, using the following command:
uemcli -u Local/admin -p Unity_Admin_Password /stor/prov/fs -name File_System_Name set -cifsOpLocks yes -cifsNotifyOnWrite yes -cifsNotifyOnAccess yes -cifsSyncWrites yes
For example:
uemcli -u Local/admin -p Admin123# /stor/prov/fs -name TESTFS set -cifsOpLocks yes -cifsNotifyOnWrite yes -cifsNotifyOnAccess yes -cifsSyncWrites yes
The following is an example output:
Storage system address: 127.0.0.1 Storage system port: 443 HTTPS connection ID = res_1 Operation completed successfully.
You can use the Dell EMC Unity read policy with placeholder recalls, if required. The Unity -readPolicy parameter determines how a read request is handled for a file in secondary storage. For example, you can opt to pass a file directly through to the client without recalling it to the Unity device. Unity then recalls the file only if a write request is received.
For pass-through, Unity uses the same cache on the Enterprise Vault server that you set up for Enterprise Vault to use when retrieving files for the Unity device.
Note:
If you configure Unity pass-through, do not configure the Enterprise Vault option to delete archived files on placeholder deletion, as this combination can lead to data loss.
To configure the Unity pass-through behavior, include the -readPolicy parameter in one of the following commands:
The dhsmconn create command to define the DHSM connection that the Unity device uses for recall requests. This method sets the pass-through behavior for all the placeholders that are created through the connection.
The dhsmconn modify command to configure a Unity device. This method sets the pass-through behavior for all the placeholders on the file system.
The syntax of the -readPolicy parameter is as follows:
-readPolicy [full | passthrough | partial | none]
The effect of the values is as follows:
full. Recall the whole file to Unity on read request before the data is returned.
passthrough. Retrieve the data without recalling the data to Unity.
partial. Retrieve only the blocks that are required to satisfy the client read request.
none (the default value). The setting has no effect.
For example, the following command syntax configures pass-through for a file system:
uemcli -u Local/admin -p Admin@123 /net/nas/dhsmconn -id DHSMConnection_ID modify -readPolicy passthrough
Where DHSMConnection_ID is the DHSM connection identifier of the file system on Unity.