What is a File Share ReACL Profile?  

A File Share ReACL Profile is a collection of ReACL related settings for File Shares which can be defined once and then applied to multiple File Shares.

 

What is the purpose of the default File Share ReACL Profile?  

The default File Share ReACL Profile is used if a different profile is not defined and set on the File Share. The default File Share ReACL Profile can be edited.

 

How are File Share ReACL Profiles created?  

To add a File Share ReACL profile:

1. On the File Share ReACL section of the Profiles page, click the Add button. The Add Your File Share ReACL Profile window appears.
2. In the Profile Name field, enter a name to identify this File Share ReACL Profile.
3. Select a Logging Level, either Informational (default) or Debugging.
4. Enter the network errors that will trigger a retry in the Retry If the Following Error Codes Are Encountered box. By default, errors 53 and 64 will trigger a retry.
5. Enter the number of retries to attempt on a network error in the Retry Count field. The default retry count is 10 times.
6. Enter the number of seconds to wait between retries on a network error in the Retry Interval field. The default interval is 1 second.
7. Click Next.

8. Select the components to process.

   By default the System ACLs and Roaming Profiles will be processed. If the Preserve the "Archive" Bit box is left unchecked, the archive bit will be reset. If checked, the archive bit will not be reset.

9. In the Exclude These Paths From Processing box, enter folder paths that will not be included in the ReACL process. Wild card characters (‘*’ matches zero or more characters and ‘?’ matches any single character) can be used when specifying excluded folders. Separate the paths by pressing Enter. By default, the following folders are excluded:

   • \Windows
   • \WINNT
   • \I386
   • \Windows\I386
   • \Program Files
   • \PROGRAM FILES (x86)
   • \MSOCACHE
   • \System Volume Information
   • \Recycler
   • \$RECYCLE.BIN
   • \CONFIG.MSI
   • \RECOVERY
   • \OEM
   • \Quarantine
   • \BOOT
   • \ProgramData\Microsoft\Windows Defender

10. In the Exclude These Files From Processing box, enter files that will not be included in the ReACL process. A leading '\' is not necessary. Wild card characters (‘*’ matches zero or more characters and ‘?’ matches any single character) can be used when specifying excluded files. Separate the files by pressing Enter. The following wild card characters are permitted when specifying files:

    • * matches zero or more characters in a file name, but not the '\' path delimiter.
    • ? matches any single character.
    • ** matches zero or more parent directories.

    Examples:

    • FileToSkip.dat – a single file in the root directory
    • \FolderToProcess\ExcludedFIle.sys – a single file in the FolderToProcess directory
    • \FolderToProcess\**\*.dat – all .dat files anywhere under the FolderToProcess directory

11. In the Exclude These Registry Keys From Processing box, enter registry keys that will not be included in the ReACL process. A leading '\' is not necessary. Separate the keys by pressing Enter. The following wild card characters are permitted when specifying registry keys:

    • * matches zero or more characters in a key name, but not the '\' path delimiter.
    • ? matches any single character.
    • ** matches zero or more parent keys.

    Examples:

    • HKEY_LOCAL_MACHINE\SOFTWARE\XYZ – a single key
    • HKEY_LOCAL_MACHINE\SOFTWARE\XY* – all keys starting with "XY" in HKEY_LOCAL_MACHINE\SOFTWARE
    • HKEY_LOCAL_MACHINE\SOFTWARE\?YZ – all 3-character keys ending with "YZ" in HKEY_LOCAL_MACHINE\SOFTWARE
    • HKEY_LOCAL_MACHINE\**\XYZ – all keys named "XYZ" anywhere under HKEY_LOCAL_MACHINE
    • **\XYZ – all keys named "XYZ" in any registry hive

12. In the Exclude These Security Identifiers From Processing box, enter SIDs that will not be included in the ReACL process. Separate the SIDs by pressing Enter.

13. Click Next.

14. The Reparse Point Processing Rules page appears. Reparse Points like Symbolic Links, Mount Points, and OneDrive folders will be processed by ReACL. Additional Reparse Tags can be added to the rules list in the Advanced view to change how ReACL will process those items. Click the Show Advanced button to edit the rules list.

    When Show Advanced is clicked the rules list is displayed. Additional Reparse Points can added to the list in the "ReparseTag:Action" format. Skip, Recurse, Update, and Full are the available actions. Separate rules by pressing Enter.

15. Click Next.

16. Select an option from the Elevated Permissions Failure Action drop-down list to choose the action that should be taken if the ReACL process encounters permissions elevation errors.

    In order to successfully adjust permissions, Active Directory must create a process with a security token that has been assigned additional permissions. The token is said to have elevated rights/permissions. If this process fails, it is likely that the ReACL will be largely unsuccessful in updating the operating system for use by target user accounts.

    • The default is Terminate processing with fatal error, this means the ReACL job for a File Share is stopped if a permissions elevation error occurs. This is a time-saving option. The ReACL Status will be Failed in the File Shares + Network Storage table. This is the recommended setting.
    • If you choose Log informational entry, an info entry will be logged if a permissions elevation error occurs. If no other errors are encountered the ReACL job will complete as successful and the ReACL Status will be Completed in the File Shares + Network Storage table. This choice allows experienced migration architects to analyze the logs and choose to proceed with Cutover based on their analysis of the results. We suggest choosing “Log warning entry” rather than “Log informational entry” as that will make the entries easier to locate in the log.
    • If you choose Log warning entry, a warning entry will be logged if a permissions elevation error occurs. If no other errors are encountered the ReACL job will complete as successful and the ReACL Status will be Completed in the File Shares + Network Storage table. This choice allows experienced migration architects to analyze the logs and choose to proceed with Cutover based on their analysis of the results.
    • If you choose Log error entry, an error entry will be logged if a permissions elevation error occurs. The ReACL job will continue, but the ReACL Status will be Failed in the File Shares + Network Storage table. This selection may take significantly more time than "Terminate processing with fatal error" because the entire process will attempt to finish before reporting as Failed.

17. Select an option from the Preserve Rollback Metadata in ACLs drop-down list.

    Active Directory can leave behind metadata during the ReACL process to allow seamless rollback of the process if needed. This setting controls the creation of this metadata which is later removed during the Cleanup process.

    • The default is Always - Keep source security principles which does not affect performance. We recommend this setting. This is the only setting where the changes performed by the ReACL process can be rolled back, or undone, in all scenarios.

    • If you choose Only If Ambiguous - Keep source security principles when necessary, metadata will only be included when the rollback settings would be ambiguous. Only If Ambiguous results in the inclusion of less metadata, preserving usage for times when it may be impossible to determine the original file or folder permissions. For example, when users have accounts in multiple domains that will be consolidated into a single domain.

      Note that Only If Ambiguous guarantees a ReACL can be rolled back to the original state only when the file system permissions remained unchanged. Modification of ACLs on the file system could create a state where a rollback cannot complete with 100% success. To ensure the ability to perform a ReACL Rollback in all scenarios, Always should be selected.

    • If you are an experienced migration architect, you may choose Never - Replace source security principles to never include metadata.

      Note: If Never is selected, a complete rollback may not be possible.

18. Select Yes under Run Processing in Simulation Mode) to simulate the results of the ReACL process without actually making any changes to the ACLs. Visit the logs/reports to determine if there are any potential issues and correct them before changing this setting to No and running an actual ReACL process. Alternatively, you might use this setting to create a separate File Share ReACL Profile specifically for testing purposes.

19. Click Save Profile. The new File Share ReACL Profile is added to the list.