Set-UserProfileDefinition
Applies one or more modifications to a profile management configuration set.
Syntax
Set-UserProfileDefinition
[-ByteArray] <Byte[]>
[-ServiceActive <Boolean>]
[-ProcessedGroups <String[]>]
[-ExcludedGroups <String[]>]
[-ProcessAdmins <Boolean>]
[-UserStorePath <String>]
[-PSMidSessionWriteBack <Boolean>]
[-OfflineSupport <Boolean>]
[-DeleteCachedProfilesOnLogoff <Boolean>]
[-ProfileDeleteDelay <Int32>]
[-MigrateWindowsProfilesToUserStore <MigrateWindowsProfilesToUserStoreEnum>]
[-LocalProfileConflictHandling <LocalProfileConflictHandlingEnum>]
[-TemplateProfilePath <String>]
[-TemplateProfileOverridesLocalProfile <Boolean>]
[-TemplateProfileOverridesRoamingProfile <Boolean>]
[-TemplateProfileIsMandatory <Boolean>]
[-LoadRetries <Int32>]
[-ProcessCookieFiles <Boolean>]
[-DisableDynamicConfig <Boolean>]
[-LogoffRatherThanTempProfile <Boolean>]
[-DebugMode <Boolean>]
[-LogLevel_Warnings <Boolean>]
[-LogLevel_Information <Boolean>]
[-LogLevel_FileSystemNotification <Boolean>]
[-LogLevel_FileSystemActions <Boolean>]
[-LogLevel_RegistryActions <Boolean>]
[-LogLevel_RegistryDifference <Boolean>]
[-LogLevel_ActiveDirectoryActions <Boolean>]
[-LogLevel_PolicyUserLogon <Boolean>]
[-LogLevel_Logon <Boolean>]
[-LogLevel_Logoff <Boolean>]
[-LogLevel_UserName <Boolean>]
[-MaxLogSize <Int32>]
[-DebugFilePath <String>]
[-ExclusionList <String[]>]
[-IncludeListRegistry <String[]>]
[-ExclusionListSyncFiles <String[]>]
[-ExclusionListSyncDir <String[]>]
[-SyncDirList <String[]>]
[-SyncFileList <String[]>]
[-MirrorFoldersList <String[]>]
[-PSEnabled <Boolean>]
[-PSAlwaysCache_Enabled <Boolean>]
[-PSAlwaysCache <Int32>]
[-PSPendingLockTimeout <Int32>]
[-PSUserGroups <String[]>]
[-CPEnable <Boolean>]
[-CPUserGroups <String[]>]
[-CPSchemaPathData <String>]
[-CPPathData <String>]
[-CPMigrationFromBaseProfileToCPStore <Boolean>]
[-FRAdminAccess <Boolean>]
[-FRIncDomainName <Boolean>]
[-FRAppDataEnabled <FRAppDataEnum>]
[-FRAppDataPath <String>]
[-FRDesktopEnabled <FRDesktopEnum>]
[-FRDesktopPath <String>]
[-FRStartMenuEnabled <FRStartMenuEnum>]
[-FRStartMenuPath <String>]
[-FRDocumentsEnabled <FRDocumentsEnum>]
[-FRDocumentsPath <String>]
[-FRPicturesEnabled <FRPicturesEnum>]
[-FRPicturesPath <String>]
[-FRMusicEnabled <FRMusicEnum>]
[-FRMusicPath <String>]
[-FRVideosEnabled <FRVideosEnum>]
[-FRVideosPath <String>]
[-FRFavoritesEnabled <FRFavoritesEnum>]
[-FRFavoritesPath <String>]
[-FRContactsEnabled <FRContactsEnum>]
[-FRContactsPath <String>]
[-FRDownloadsEnabled <FRDownloadsEnum>]
[-FRDownloadsPath <String>]
[-FRLinksEnabled <FRLinksEnum>]
[-FRLinksPath <String>]
[-FRSearchesEnabled <FRSearchesEnum>]
[-FRSearchesPath <String>]
[-FRSavedGamesEnabled <FRSavedGamesEnum>]
[-FRSavedGamesPath <String>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Use this cmdlet to edit the configurations for profile management. The cmdlet defines one input parameter for each settable property. Any number of these settings can be modified in a single call to the cmdlet. The cmdlet also requires the low-level byte array blob containing the original configuration set to be modified. It will return an updated byte array with the settings applied. The resulting byte array can then be stored back at the Broker.
Examples
EXAMPLE 1
The first command creates a new user profile configuration in its default state, and stores the byte array in a Windows PowerShell variable. The second command then edits this configuration by setting the ServiceActive property to TRUE (which has the effect of enabling the profile management service), and by setting the path to the profile store. All other settings remain unaffected, and hence in their default state.
C:PS> $blob = New-UserProfileConfiguration
C:PS> $updatedBlob = Set-UserProfileDefinition -ByteArray $blob -ServiceActive $true -UserStorePath \\ProfileServer\Profiles$\%USERNAME%.%USERDOMAIN
<!--NeedCopy-->
Parameters
-ByteArray
Specifies the original configuration set that is being modified by this invocation of the command.
| Type: | Byte[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByValue) |
| Accept wildcard characters: | False |
-ServiceActive
Applies to: both file-based and container-based profile solutions
By default, to facilitate deployment, Profile management does not process logons or logoffs.
Turn on processing by enabling this setting.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, Profile management does not process Windows user profiles in any way.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProcessedGroups
Applies to: both file-based and container-based profile solutions
Both computer local groups and domain groups (local, global and universal) can be used. Domain groups should be specified in the format: <DOMAIN NAME>\<GROUP NAME>.
If this setting is configured here, Profile management processes only members of these user groups.
If this setting is disabled, Profile management processes all users.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, members of all user groups are processed.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludedGroups
Applies to: both file-based and container-based profile solutions
You can use computer local groups and domain groups (local, global, and universal) to prevent particular user profiles from being processed. Specify domain groups in the form <DOMAIN NAME>\<GROUP NAME>.
If this setting is configured here, Profile management excludes members of these user groups.
If this setting is disabled, Profile management does not exclude any users.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no members of any groups are excluded.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProcessAdmins
Applies to: both file-based and container-based profile solutions
Specifies whether logons of members of the local group “Administrators” are processed by Profile management.
If this setting is disabled, logons by local administrators are not processed by Profile management.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, administrators will not be processed.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UserStorePath
Applies to: both file-based and container-based profile solutions
Sets the path to the directory in which the user settings (registry changes and synchronized files) are saved (user store).
The path can be an absolute UNC path or a path relative to the home directory.
In both cases, the following types of variables can be used: system environment variables enclosed in percent signs and attributes of the Active Directory user object enclosed in hashes.
Examples: The folder Windows\%ProfileVer% stores the user settings in the subfolder called Windows\W2k3 of the user store (if %ProfileVer% is a system environment variable resolving to W2k3).
\\server\share#SAMAccountName# stores the user settings to the UNC path \\server\share\JohnSmith (if #SAMAccountName# resolves to JohnSmith for the current user).
User environment variables cannot be used, except for %username% and %userdomain%.
If this setting is disabled, the user settings are saved in the Windows subdirectory of the home directory.
If this setting is not configured here, the setting from the .ini file is used.
If this setting is not configured here or in the .ini file, the Windows directory on the home drive is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSMidSessionWriteBack
Applies to: file-based profile solution only
With this setting, files and folders (but not Registry entries) that are modified can be synchronized to the user store in the middle of a session, before logoff.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, active write back is disabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OfflineSupport
Applies to: file-based profile solution only
Enables the offline profiles feature. This is intended for computers that are commonly removed from networks, typically laptops or mobile devices not servers or desktops.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, offline profile support is disabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeleteCachedProfilesOnLogoff
Applies to: file-based profile solution only
Specifies whether locally cached profiles are deleted after logoff.
If this setting is enabled, a user’s local profile cache is deleted after they have logged off. This is recommended for terminal servers.
If this setting is disabled cached profiles are not deleted.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, cached profiles are not deleted.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProfileDeleteDelay
Applies to: file-based profile solution only
Works only if ‘Delete locally cached profiles on logoff’ is enabled. Sets an optional extension to the delay before locally cached profiles are deleted at logoff. A value of 0 deletes the profiles immediately during logoff processing. Checks take place every minute, so a value of 60 ensures that profiles are deleted between one and two minutes after users have logged off (depending on when the last check took place). Extending the delay is useful if you know that a process keeps files or the user registry hive open during logoff. With large profiles, this can also speed up logoff.
If this policy is not configured here, the value from the .ini file is used.
If this policy is not configured here or in the .ini file, profiles are deleted immediately.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MigrateWindowsProfilesToUserStore
Applies to: file-based profile solution only
Profile management can migrate existing profiles “on the fly” during logon if the user has no profile in the user store.
The following event takes place during logon: if an existing Windows profile is found and the user does not yet have a Citrix user profile in the user store, the Windows profile is migrated (copied) to the user store on the fly. After this process, the user store profile is used by Profile management in the current and any other session configured with the path to the same user store.
If this setting is enabled, profile migration can be activated for roaming and local profiles (the default), roaming profiles only, local profiles only, or profile migration can be disabled altogether.
If profile migration is disabled and no Citrix user profile exists in the user store, the existing Windows mechanism for creating new profiles is used as in a setup without Profile management.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, all types of existing profiles are migrated.
| Type: | MigrateWindowsProfilesToUserStoreEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LocalProfileConflictHandling
Applies to: file-based profile solution only
This setting configures what Profile management does if both a profile in the user store and a local Windows user profile (not a Citrix user profile) exist.
If this setting is disabled or set to the default value of “Use local profile”, Profile management uses the local profile, but does not change it in any way.
If this setting is set to “Delete local profile”, Profile management deletes the local Windows user profile, and then imports the Citrix user profile from the user store.
If this setting is set to “Rename local profile”, Profile management renames the local Windows user profile (in order to back it up) and then imports the profile from the user store.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, existing local profiles are used.
| Type: | LocalProfileConflictHandlingEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateProfilePath
Applies to: both file-based and container-based profile solutions
By default, new user profiles are created from the default user profile on the computer where a user first logs on. Profile management can alternatively use a centrally stored template when creating new user profiles. Template profiles are identical to normal profiles in that they reside in any file share on the network. Use UNC notation to specifying paths to templates. Users need read access to a template profile.
If this setting is disabled, templates are not used.
If this setting is enabled, Profile management uses the template instead of the local default profile when creating new user profiles.
If a user has no Citrix user profile, but a local Windows user profile exists, by default the local profile is used (and migrated to the user store, if this is not disabled). This can be changed by enabling the setting “Template profile overrides local profile”.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no template is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateProfileOverridesLocalProfile
Applies to: both file-based and container-based profile solutions
By default, new user profiles are created from the default user profile on the computer where a user first logs on. Profile management can alternatively use a centrally stored template when creating new user profiles. Template profiles are identical to normal profiles in that they reside in any file share on the network. Use UNC notation to specifying paths to templates. Users need read access to a template profile.
If this setting is disabled, templates are not used.
If this setting is enabled, Profile management uses the template instead of the local default profile when creating new user profiles.
If a user has no Citrix user profile, but a local Windows user profile exists, by default the local profile is used (and migrated to the user store, if this is not disabled). This can be changed by enabling the setting “Template profile overrides local profile”.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no template is used.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateProfileOverridesRoamingProfile
Applies to: both file-based and container-based profile solutions
By default, new user profiles are created from the default user profile on the computer where a user first logs on. Profile management can alternatively use a centrally stored template when creating new user profiles. Template profiles are identical to normal profiles in that they reside in any file share on the network. Use UNC notation to specifying paths to templates. Users need read access to a template profile.
If this setting is disabled, templates are not used.
If this setting is enabled, Profile management uses the template instead of the local default profile when creating new user profiles.
If a user has no Citrix user profile, but a local Windows user profile exists, by default the local profile is used (and migrated to the user store, if this is not disabled). This can be changed by enabling the setting “Template profile overrides local profile”.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no template is used.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemplateProfileIsMandatory
Applies to: both file-based and container-based profile solutions
By default, new user profiles are created from the default user profile on the computer where a user first logs on. Profile management can alternatively use a centrally stored template when creating new user profiles. Template profiles are identical to normal profiles in that they reside in any file share on the network. Use UNC notation to specifying paths to templates. Users need read access to a template profile.
If this setting is disabled, templates are not used.
If this setting is enabled, Profile management uses the template instead of the local default profile when creating new user profiles.
If a user has no Citrix user profile, but a local Windows user profile exists, by default the local profile is used (and migrated to the user store, if this is not disabled). This can be changed by enabling the setting “Template profile overrides local profile”.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no template is used.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoadRetries
Applies to: both file-based and container-based profile solutions
Sets the number of retries when accessing locked files.
If this setting is disabled the default value of five retries is used.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, the default value of five retries is used.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProcessCookieFiles
Applies to: file-based profile solution only
Some deployments leave extra Internet cookies that are not referenced by the file index.dat. The extra cookies left in the file system after sustained browsing can lead to profile bloat. Enable this setting to force processing of index.dat and remove the extra cookies. The setting might slightly increase logoff time. Enable this setting only when you experience the issue.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no processing of index.dat takes place.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableDynamicConfig
Applies to: both file-based and container-based profile solutions
Profile management 5.x examines its environment and configures itself accordingly. To disable this for troubleshooting or to retain the settings you used in an earlier version, enable this setting.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, automatic configuration is turned on so Profile management settings might change if the environment changes.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogoffRatherThanTempProfile
Applies to: both file-based and container-based profile solutions
If a problem is encountered when the user logs on (for example, if the user store is unavailable) a temporary profile is provided.
Alternatively, enabling this setting displays an error message and logs the user off.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, a temporary profile is provided.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DebugMode
Applies to: both file-based and container-based profile solutions
Activation of this setting enables debug mode (verbose logging). In debug mode, extensive status information is logged in the log files in “%SystemRoot%\System32\Logfiles\UserProfileManager” or in the location specified by the “Path to log file” policy setting.
If this setting is disabled only errors are logged.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, only errors are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_Warnings
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_Information
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_FileSystemNotification
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_FileSystemActions
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_RegistryActions
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_RegistryDifference
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_ActiveDirectoryActions
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_PolicyUserLogon
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_Logon
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_Logoff
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LogLevel_UserName
Applies to: both file-based and container-based profile solutions
Detailed log settings.
Define events or actions that Profile management logs in depth.
If this setting is not configured here, Profile management uses the settings from the .ini file.
If this setting is not configured here or in the .ini file, errors and general information are logged.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxLogSize
Applies to: both file-based and container-based profile solutions
Sets the maximum size of the log file in bytes. If the log file grows beyond this size an existing backup of the file (.bak) is deleted, the log file is renamed to .bak, and a new log file is created.
The log file is created in “%SystemRoot%\System32\Logfiles\UserProfileManager” or in the location specified by the “Path to log file” policy setting.
If this setting is disabled, the default value of 10 MB is used.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, the default of 10 MB is used.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DebugFilePath
Applies to: both file-based and container-based profile solutions
Sets an alternative path to which the log files are saved.
The path can point to a local drive or a remote, network-based one (a UNC path). Remote paths can be useful in large, distributed environments but they can create significant network traffic, which may be inappropriate for log files. For provisioned, virtual machines with a persistent hard drive, set a local path to that drive. This ensures log files are preserved when the machine restarts. For virtual machines without a persistent hard drive, setting a UNC path allows you to retain the log files but the system account for the machines must have write access to the UNC share. Use a local path for any laptops managed by the offline profiles feature.
Examples: D:\LogFiles\ProfileManagement. \\servername\LogFiles\ProfileManagement
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, the default location “%SystemRoot%\System32\Logfiles\UserProfileManager” is used.
If a UNC path is used for log files then Citrix recommends that an appropriate access control list is applied to the log file folder to ensure that only authorized user or computer accounts can access the stored files.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExclusionList
Applies to: file-based profile solution only
List of registry keys in the HKCU hive that are ignored during logoff.
Example: Software\Policies.
If this setting is disabled, no registry keys are excluded.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no registry keys are excluded.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IncludeListRegistry
Applies to: file-based profile solution only
List of registry keys in the HKCU hive that are processed during logoff. Example: Software\Adobe.
If this setting is enabled, only keys on this list are processed.
If this setting is disabled, the complete HKCU hive is processed.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, all of HKCU is processed.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExclusionListSyncFiles
Applies to: file-based profile solution only
List of files that are ignored during synchronization.
File names should be specified as paths relative to the user profile. Wildcards are allowed. Wildcards in file names are applied recursively while wildcards in folder names are not.
Note: As of Profile Management 7.15, you can use the vertical bar ‘|’ for applying a policy to only the current folder without propagating it to the subfolders.
Examples: Desktop\Desktop.ini ignores the Desktop.ini file in the Desktop folder.
AppData\*.tmp ignores all files with the .tmp extension in the AppData folder and its subfolders.
AppData\*.tmp| ignores all files with the .tmp extension in the AppData folder.
Downloads\*\a.txt ignores a.txt in any immediate subfolder of the Downloads folder. Note that wildcards in folder names are not applied recursively.
If this setting is disabled, no files are excluded.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no files are excluded.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExclusionListSyncDir
Applies to: file-based profile solution only
List of directories that are ignored during synchronization.
Folder names should be specified as paths relative to the user profile.
Wildcards are supported but they are not applied recursively.
Examples: Desktop ignores the Desktop folder in the user profile.
Downloads\* ignores all immediate subfolders of the Downloads folder.
If this setting is disabled, no folders are excluded.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no folders are excluded.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SyncDirList
Applies to: file-based profile solution only
Profile management synchronizes each user’s entire profile between the system it is installed on and the user store.
It allows you to include subfolders of excluded folders.
Paths on this list should be relative to the user profile.
Wildcards are supported but they are not applied recursively.
Examples: Desktop\exclude\include specifies the include subfolder of the Desktop\exclude folder.
Desktop\exclude\* specifies all immediate subfolders of the Desktop\exclude folder.
Disabling this setting has the same effect as enabling it and configuring an empty list.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, only non-excluded folders in the user profile are synchronized.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SyncFileList
Applies to: file-based profile solution only
Profile management synchronizes each user’s entire profile between the system it is installed on and the user store.
This setting allows for the inclusion of files below excluded folders.
Paths on this list should be relative to the user profile. Wildcards are allowed. Wildcards in file names are applied recursively while wildcards in folder names are not.
Note: As of Profile Management 7.15, you can use the vertical bar ‘|’ for applying a policy to only the current folder without propagating it to the subfolders.
Examples: AppData\Local\Microsoft\Office\Access.qat specifies a file below a folder excluded in the default configuration.
AppData\Local\MyApp\*.cfg specifies all files with the extension .cfg in the profile folder AppData\Local\MyApp and its subfolders.
AppData\Local\MyApp\*.cfg| specifies all files with the extension .cfg in the profile folder AppData\Local\MyApp.
Downloads\*\b.txt specifies b.txt in any immediate subfolder of the Downloads folder. Note that wildcards in folder names are not applied recursively.
Disabling this setting has the same effect as enabling it and configuring an empty list.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, only non-excluded files in the user profile are synchronized.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MirrorFoldersList
Applies to: file-based profile solution only
Profile management can mirror a folder relative to the profile’s root folder. Use this setting for files whose contents index data and where separate instances of the data are likely to exist. For example, you can mirror the Internet Explorer cookies folder so that index.dat is synchronized with the cookies that it indexes. Be aware that, in these situations the “last write wins” so files in mirrored folders that have been modified in more than one session are overwritten by the last update, resulting in loss of profile changes.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSEnabled
Applies to: file-based profile solution only
With profile streaming, users’ profiles are synchronized on the local computer only when they are needed. Registry entries are cached immediately, but files and folders are only cached when accessed by users.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSAlwaysCache_Enabled
Applies to: file-based profile solution only
Optionally, to enhance the user experience, use this setting with the Profile streaming setting, which imposes a lower limit on the size of files that are streamed. Any files this size or larger are cached as soon as possible after logon. To use the cache entire profile feature, set this limit to zero (which caches all of the profile contents).
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSAlwaysCache
Applies to: file-based profile solution only
Optionally, to enhance the user experience, use this setting with the Profile streaming setting, which imposes a lower limit on the size of files that are streamed. Any files this size or larger are cached as soon as possible after logon. To use the cache entire profile feature, set this limit to zero (which caches all of the profile contents).
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSPendingLockTimeout
Applies to: file-based profile solution only
You can set a timeout period that frees up users’ files so they are written back to the user store from the pending area in the event that the user store remains locked when a server becomes unresponsive (for example, when it goes down). Use this setting to prevent bloat in the pending area and to ensure the user store always contains the most up-to-date files.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PSUserGroups
Applies to: file-based profile solution only
Enter one or more Windows user groups.
If this setting is enabled, only the profiles of those groups’ members are streamed. If this setting is disabled, all user groups are processed.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, all users are processed.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPEnable
Applies to: both file-based and container-based profile solutions
By default, to facilitate deployment, cross-platform settings is disabled.
Turn on processing by enabling this setting.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no cross-platform settings will be applied.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPUserGroups
Applies to: both file-based and container-based profile solutions
Enter one or more Windows user groups.
If this setting is configured, the cross-platform settings feature of Profile management processes only members of these user groups. If this setting is disabled, all user groups are processed.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, all user groups are processed.
Note: Use Enter to separate multiple entries.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPSchemaPathData
Applies to: both file-based and container-based profile solutions
Specify a folder where the definition files are located.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, no cross-platform settings will be applied.
Note:
- The folder can be local or it can reside on an SMB file share.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPPathData
Applies to: both file-based and container-based profile solutions
Sets the path to the directory in which users’ cross-platform settings are saved (cross-platform settings store).
The path can be an absolute UNC path or a path relative to the home directory.
In both cases, the following types of variables can be used: system environment variables enclosed in percent signs and attributes of the Active Directory user object enclosed in hashes.
User environment variables cannot be used, except for %username% and %userdomain%.
If this setting is disabled, the path Windows\PM_CP is used.
If this setting is not configured here, the value from the .ini file is used.
If this setting is not configured here or in the .ini file, the default value Windows\PM_CP is used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CPMigrationFromBaseProfileToCPStore
Applies to: both file-based and container-based profile solutions
Default: Disabled
Definition files contain a set of definitions that configure an application. If the cross-platform settings store contains a definition with no data, or the cached data in the single-platform profile is newer than the definition’s data in the store, Profile management only migrates the data from the single-platform profile to the store if you enable this setting.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRAdminAccess
Applies to: file-based profile solution only
By default, users are granted exclusive access to the contents of their redirected folders.
Enabling this option allows administrator access to the contents of the users redirected folders.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRIncDomainName
Applies to: file-based profile solution only
Enabling this option will include the %userdomain% environment variable as part of the UNC path.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRAppDataEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the AppData(Roaming) folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRAppDataEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRAppDataPath
Applies to: file-based profile solution only
Lets you specify how to redirect the AppData(Roaming) folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDesktopEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Desktop folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRDesktopEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDesktopPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Desktop folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRStartMenuEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Start Menu folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRStartMenuEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRStartMenuPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Start Menu folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDocumentsEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Documents folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRDocumentsEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDocumentsPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Documents folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRPicturesEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Pictures folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRPicturesEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRPicturesPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Pictures folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRMusicEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Music folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRMusicEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRMusicPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Music folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRVideosEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Videos folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRVideosEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRVideosPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Videos folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRFavoritesEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Favorites folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRFavoritesEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRFavoritesPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Favorites folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRContactsEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Contacts folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRContactsEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRContactsPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Contacts folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDownloadsEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Downloads folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRDownloadsEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRDownloadsPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Downloads folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRLinksEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Links folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRLinksEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRLinksPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Links folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRSearchesEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Searches folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRSearchesEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRSearchesPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Searches folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRSavedGamesEnabled
Applies to: file-based profile solution only
Lets you specify how to redirect the Saved Games folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | FRSavedGamesEnum |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FRSavedGamesPath
Applies to: file-based profile solution only
Lets you specify how to redirect the Saved Games folder. To do so, select Enabled and then type the redirected path. Caution: Potential data loss might occur. See below for details. You might want to modify the path after the policy takes effect. However, consider potential data loss before you do so. The data contained in the redirected folder might be deleted if the modified path points to the same location as the previous path. For example, suppose you specify the Contacts path as path1. Later, you change path1 to path2. If path1 and path2 point to the same location, all data contained in the redirected folder is deleted after the policy takes effect. To avoid potential data loss, complete the following steps:
- Apply Microsoft policy to machines where Profile Management is running through Active Directory Group Policy Objects. To do so, open the Group Policy Management Console, navigate to Computer Configuration > Administrative Templates > Windows Components > File Explorer, and then enable Verify old and new Folder Redirection targets point to the same share before redirecting.
- If applicable, apply hotfixes to machines where Profile Management is running. For details, see https://support.microsoft.com/en-us/help/977229 and https://support.microsoft.com/en-us/help/2799904.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can’t pipe objects to this cmdlet.
Outputs
Byte[]
The new configuration set, with all of the given modifications applied.