RM Unify Network Provisioning - How to change the home folder location for new users
Published Date : 18 Mar 2022
Last Updated : 26 Jun 2023
Content Ref: TEC8382417
Operating System
MS Windows 2016 Server, MS Windows 2019 Server
Part No
(none)
Summary
Describes the process of changing where the Network Agent creates and sets home folders for new users.
Symptoms
You want to change the default home folder settings that the RM Unify Network Agent applies to new users it creates in Active Directory (AD). The changes made as a result of this article will apply only to new users created after the changes were made; existing users will be unaffected.
This article applies to RM Unify Network Provisioning on a vanilla Windows network; it is not suitable for Community Connect® 4 (CC4) networks.
If you are using RM Unify Network Provisioning on a CC4 network, the new users' home folders are created on the User Server where the Network Agent is installed (CC4 First server) even if the CC4 user template is set to a different server. This default setting cannot be changed but, once provisioned, you can use the CC4 Management Console to move users to the desired User Server as you normally would. Please contact your usual support provider for further assistance.
Procedure
Create the new home folder location
In File Explorer, on the desired home server, create a new home folder under which user home folders will be created by the Network Agent.
Create a hidden share on the new home folder, e.g. 'StudentsHome$' and set share permissions as desired. Note: If the <InheritPermissions> tag in the 'BaseConfiguration.xml' file is set to true, please be aware that the Network Agent will then copy all permissions from the parent folder when creating a user's home folder, including parent folder permissions set as 'This folder only'. You can prevent this by setting the <InheritPermissions> tag to false, then setting <PropogatePermissions> to true and using the <Permissions> section to explicitly set required permissions on the home folder.
On the server with the RM Unify Network Agent installed, click Start, Run and enter the UNC path to your new share to confirm you can successfully access it, e.g. \\HomeServer\StudentHome$.
Edit the 'BaseConfiguration.xml' file
On the server with the RM Unify Network Agent installed, run regedit to open Registry Editor.
Browse to the registry key [HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\RM\RM Unify Network Agent].
Right-click UPTBlockUserProvisioning and select Modify.
Type true, click OK and close the Registry Editor window.
Stop the RM Unify Network Agent service.
In File Explorer, click View and tick 'Hidden items'.
Browse to C:\ProgramData\RM\RM Unify Network Agent\RMUPROOT-config\[AD]\Configuration.
Make a backup copy of the 'BaseConfiguration.xml file' and name it 'BaseConfigurationBACKUP.xml'.
Right-click the 'BaseConfigurationxml' file and select 'Open with Notepad'.
The file has a configuration section for each role type: Students, Teachers and NonTeachers. For multi-site configurations, there is a configuration section for each role type per school.
Find the role-based section you want to amend, e.g. <Name>STUDENTS</Name> or <Name>SUPPORT_SCHOOL STUDENTS</Name>, in the case of multi-site.
Under the role-based section, use the table below to find the settings relevant to the changes you want to make and amend as required.
Section
Tag
Action
Example
<PrimarySystemSettings>
<HomeServer>
Change if the new home folder is on a different server, otherwise keep unchanged.
<HomeServer>NewHomeServer</HomeServer>
<UserFolder> <FolderType>HOME</FolderType
<Physical location>
Enter the user home folder path you want the Network Agent to create for each new user on the home server.
This value is placed in the user's AD attribute 'homeDrive'. Usually unchanged.
<MappedDrive>N:</MappedDrive>
<Sharename>
Specifies the sharename to create on the user's home folder. Usually unchanged as you are retaining the existing user sharename format.
<ShareName>[Username]$</ShareName>
<Path>
This value is placed in the user's AD attribute 'homeDirectory'. Usually unchanged if you are keeping the same home server, otherwise update with the new UNC path.
<Path>\\NewHomeServer\[Username]$</Path>
Restart the RM Unify Network Agent service.
Test your new settings by running the Network Provisioning Test Tool to check if new users are created successfully with the desired home folder and permissions. Please refer to TEC7323785 in the Other Useful Articles section below.
Resolve any issues identified by the Test Tool.
Repeat Steps 1-3 above and change the UPTBlockUserProvisioning value from 'true' to 'false'.
If I change the home folder settings, what happens to an existing AD user's home folder settings?
The Network Agent only applies the new home folder settings to new AD user accounts it creates. It will not change or apply the new home folder settings to any existing AD user account, regardless of whether the AD account is linked to an RM Unify user or not and regardless of whether home folder AD attributes have been set on the existing AD user account. Essentially, the Network Agent ignores the home folder settings in the 'BaseConfiguration.xml' file for any action on an existing AD account.
After I update the home folder settings, what happens if I change an existing user's RM Unify username?
The Network Agent does not use the home folder settings configured in the 'BaseConfiguration.xml' file when it updates a username. Instead, it reads the user's 'homeDirectory' AD attribute value, confirms if the UNC uses the username as a sharename and determines the physical server path of the UNC. It then creates a new home folder with the new username in the same location and copies the home folder contents over. Once the contents are successfully copied, it deletes the user's original home folder.
If this article has not helped provide a solution then it is also possible to
log a call...
Document Keywords: RM Unify network provisioning - how to change home folder settings, ad, new user, solution, rmuvnp, umunp, vanilla, non-cc4, cc4, TEC8382417, home folder