none
Using Redirections.xml to configure what to copy to a profile with FSLogix RRS feed

  • General discussion

  • Using Redirections.xml to configure what to copy to a profile with FSLogix

    The redirections.xml file is used to tell FSLogix services what to copy in/out of a profile when a login/logoff occurs.

     

     

    1. Location

    Location of redirections.xml:

    <profile>\AppData\Local\FSLogix   (inside the VHD)

    What's included/excluded is only taken into account at login. If changes are made then a logoff/logon sequence must be done to sync to files.

     

     

    2. Distribution

    The redirections.xml can be centrally managed and distributed. The RedirXMLSourceFolder registry key specifies a location where the client checks at logon to see if there is a redirections.xml file. If one is found and it is different than the existing one, it is downloaded to the client and used.

    • The storage location of course must have read access for the user, but does not need write access so the location can be protected so that only admins may change the file.

    Typically this location might be in the root or a sub-directory of the location where profiles are stored: example - \\<server>\Profiles\Redirection (the redirections.xml would be placed in the Redirection folder).

     

     

    3. Structure of the file

    The basic structure of the redirections.xml document is as follows:

    <?xml version="1.0"  encoding="UTF-8"?>

    <FrxProfileFolderRedirection ExcludeCommonFolders="###VALUE###">

        <Includes>

           <Include>AppData\Low\MyCompanyFolder\Volatile Data 1\Except me</Include>

           <Include>… another include folders… </Include>

       </Includes>

       <Excludes>

            <Exclude Copy="###VALUE###">AppData\Low\MyCompanyFolder\Volatile Data 1</Exclude>

           <Exclude>… another exclude folders… </Exclude>

       </Excludes>

    </FrxProfileFolderRedirection>

     

    You can specify any numbers of items inside the Includes and Excludes tags. Folders are relative to the user profile only (That’s why AppData is shown in this example).

    Exclude folders are redirected to base (meaning the \Users\local_<username> folder FSLogix creates) and include folders are used when certain folders should remain on virtual profile. Include are usually used when redirecting a branch to base EXCEPT some sub-folders.

     

    Note: Contents of folders redirected to base (\Users\local_<username>) are lost on user logout UNLESS the optional Copy attribute is specified with an or’ed bitmask value:

     

    = No files copied in or out. (Note: the copy tag may be left out entirely and the action will be the same as setting to 0.

    Only the folder(s) are created on the local_<user_name> directory.

    1 = Copy files to base 

    Any existing file in an excluded folder will be copied to base.

     2 = Copy files back to virtual profile

    Any modified file in base will be copied back to profile on user logout.

     3 = Files are copied from/to base.

    Combinations options 1 and 2.

     

     

    4. Optional attributes

    NOTE: The optional attribute ExcludeCommonFolders is not working properly as of 15 April 2020.

    ExcludeCommonFolders must be set to 0.

    Folders which could be handled through ExcludeCommonFolders can also be handled by manually entering each folder on an as needed basis as any other folder exclusion can be done as per this example:

    <Exclude Copy="0">Music</Exclude>

    INote: Optional attributes are very rarely used in a redirections.xml file. A set list of default redirections (specific for each OS) are implemented automatically by the FSLogix client at each users logon. These default redirections were put together to handle the standard environment presented by a default install of the OSs.

    If the ExcludeCommonFolders attribute is specified, folders specified by the or’ed bitmask value are excluded, so redirected to base.

    1 = Contacts folder

    2 = Desktop folder

    4 = Documents folder

    8 = Downloads folder

    16 = Links folder

    32 = Music and Podcasts folders

    64 = Pictures and Videos folders

    128 = Folders involved in Low Integrity Level processes like AppData\LocalLow

     

     

    5. Other Notes

    a)      Starting from official 2.1 release, files in the default excluded folders are copied to/from base. For versions 2.7 and later: See NOTE: on b) below.

    b)      On Windows 8 and later, folders involved in Low Integrity Level processes are ALWAYS redirected to base. NOTE: From release 2.7 and after, the number of folders redirected is greatly reduced due to our new features.

    c)       If you want to avoid copy to/from base in some common folder, you can add an “Exclude” item to override. “Exclude” items have priority over common folders exclusions.

    d)      If the same folder is specified as Exclude and as Include item, the exclude will have priority.







    Tuesday, June 25, 2019 9:07 PM
    Owner

All replies

  • Hi

    We are trying to implement FSLogix in our VMWare Horizon environment. Setup is simple, FSLogix agent, Instant Clone pool and a share for the VHDX files. When implementing the redirections.xml configuration with a GPO, the user profile is unable to get reattached (Status 0x00000017 Reason: 0x00000000 Error Code: 0x0000000D). If we do not implement the redirection.xml, we do not have that issue. I've tried with an empty XML only containing the following: 


    <?xml version=”1.0″ encoding=”UTF-8″?>

        <FrxProfileFolderRedirection ExcludeCommonFolders=”0”>

        <Excludes>

        </Excludes>

        </FrxProfileFolderRedirection>

    But we are still getting the error. So here are the scenarios:

    1. New VHDX, no redirections.xml, it works. Sign-out and sign-in, still works.

    2. New VHDX, redirections.xml, first sign in works, sign-out and sign-in, User profile failed to attach. After that, even when I remove the redirections.xml GPO, the VHDX is unusable.

    Thank you

    Para

    Wednesday, September 23, 2020 7:44 PM
  • Hi

    I've had the same issue, after inspecting the logging I saw that the redirection.xml was failing. 

    In my case it was a syntax typo in my XML...probably caused by saving it with notepad, without the unicode language... this will wreck your xml. 

    Hope this helps!

    Friday, October 30, 2020 2:46 PM