description | external help file | Module Name | ms.date | schema | title |
---|---|---|---|---|---|
Creates a user data and profile configuration item. |
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
05/07/2019 |
2.0.0 |
New-CMUserDataAndProfileConfigurationItem |
Creates a user data and profile configuration item.
New-CMUserDataAndProfileConfigurationItem [-AccessPolicy <Boolean>] [-AddAdminGroupToRupEnabled <Boolean>]
[-AllowAllDevice <Boolean>] [-AllowCrossForestUserPolicy <Boolean>] [-AppDataRoaming <FolderRedirectionType>]
[-BackgroundSynchronization <SynchronizationType>] -ConfigureFolderRedirection <Boolean>
-ConfigureOfflineFile <Boolean> -ConfigureRoamingUserProfile <Boolean> [-ConnectionTransferRate <Int32>]
[-Contact <FolderRedirectionType>] [-DeleteProfileOlderDays <Int32>] [-DeleteRoamingCacheEnabled <Boolean>]
[-Description <String>] [-Desktop <FolderRedirectionType>] [-DetectSlowLinkDisabled <Boolean>]
[-DeviceType <DeviceType>] [-DisableMakeOffline <Boolean>] [-DisableWorkOffline <Boolean>]
[-Document <FolderRedirectionType>] [-Download <FolderRedirectionType>] [-EnableOfflineFile <Boolean>]
[-EnableSlowLink <Boolean>] [-ErrorDays <Int32>] [-ExcludeProfile <String[]>]
[-Favorite <FolderRedirectionType>] [-FileSynchronization <SynchronizationType>]
[-ForceUnloadDisabled <Boolean>] [-GrantExclusiveRight <Boolean>] [-LeaveFolderNewLocation <Boolean>]
[-LimitDisk <Int32>] [-Link <FolderRedirectionType>] [-ManageAdvancedSetting <Boolean>]
[-ManageSlowLink <Boolean>] [-MoveCachedFolder <Boolean>] [-MoveContent <Boolean>]
[-Music <FolderRedirectionType>] -Name <String> [-OfflineFile <String[]>] [-OnlyAllowLocalProfile <Boolean>]
[-OwnerCheckDisabled <Boolean>] [-Picture <FolderRedirectionType>] [-ProfileUploadDisabled <Boolean>]
[-SavedGame <FolderRedirectionType>] [-Search <FolderRedirectionType>] [-SlowLink <Int32>]
[-SlowLinkUIEnabled <Boolean>] [-SpecifiedLocation <String>] [-SpecifyTime <String>] [-SpecifyTimeMin <Int32>]
[-StartMenu <FolderRedirectionType>] [-SyncDirectory <String[]>] [-SynchronizationPolicy <Boolean>]
[-SyncMins <Int32>] [-TempProfileLogonBlocked <Boolean>] [-Timeout <Int32>] [-UseCommonAlert <Boolean>]
[-UseSpecifiedLocation <Boolean>] [-Video <FolderRedirectionType>] [-WaitForNetworkSec <Int32>]
[-WarningDays <Int32>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf] [-Confirm]
[<CommonParameters>]
The New-CMUserDataAndProfileConfigurationItem cmdlet creates a user data and profile configuration item that can apply to Windows 8 computers. A configuration item can manage folder redirection, offline folders, and roaming user profiles. You can modify settings for an existing configuration item by using the Set-CMUserDataAndProfileConfigurationItem cmdlet.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
PS XYZ:\> New-CMUserDataAndProfileConfigurationItem -ConfigureFolderRedirection $True -ConfigureOffineFile $True -ConfigureRoamingUserProfile $True -Name "CMUserDataProfileCI07" -FolderRedirectionUserConfigurationForDesktop RedirectToRemote -SpecifiedLocation "\\Server017\Shared" -UseSpecifiedLocation $True
This command creates a configuration item named CMUserDataProfileCI07. This configuration item manages folder redirection, offline folders, and roaming user profiles. The command specifies redirect to remote for the Desktop folder. The command includes a specified location and includes the UseSpecifiedLocation parameter with a value of $True.
PS XYZ:\> New-CMUserDataAndProfileConfigurationItem -ConfigureFolderRedirection $True -ConfigureOffineFile $True -ConfigureRoamingUserProfile $True -Name "CMUserDataProfileCI27" -AccessPolicy $True -AddAdminGroupToRUPEnabled $True -AllowAllDevice $False -AllowCrossForestUserPolicy $True -BackgroundSynchronization NotConfigured -ConnectionTransferRate 300 -DeleteProfileOlderDays 300 -DeleteRoamingCacheEnabled $True -Description "Configuration item for off-site staff." -DetectSlowLinkDisabled $False -DeviceType OnlyOnPrimaryDevices -DisableMakeOffline $True -DisableWorkOffline $True -EnableOfflineFile $True -EnableSlowLink $True -ErrorDays 200 -ExcludeList "MiscFolder" -FileSynchronization Enabled -FolderRedirectionUserConfigurationForAppDataRoaming RedirectToLocal -FolderRedirectionUserConfigurationForContacts RedirectToRemote -FolderRedirectionUserConfigurationForDesktop RedirectToRemote -FolderRedirectionUserConfigurationForDocuments RedirectToRemote -FolderRedirectionUserConfigurationForDownloads RedirectToLocal -FolderRedirectionUserConfigurationForFavorites RedirectToLocal -FolderRedirectionUserConfigurationForLinks RedirectToRemote -FolderRedirectionUserConfigurationForMusic RedirectToLocal -FolderRedirectionUserConfigurationForPictures RedirectToRemote -FolderRedirectionUserConfigurationForSavedGames RedirectToRemote -FolderRedirectionUserConfigurationForSearches RedirectToLocal -FolderRedirectionUserConfigurationForStartMenu RedirectToLocal -FolderRedirectionUserConfigurationForVideos RedirectToRemote -ForceUnloadDisabled $True -GrantExclusiveRight $False -LeaveFolderNewLocation $True -LimitDisk 1024 -ManageAdvancedSetting $True -ManageSlowLink $True -MoveCachedFolder $True -MoveContent $False -OfflineFile "\\Server78\MiscShared" -OnlyAllowLocalProfiles $True -OwnerCheckDisabled $True -ProfileUploadDisabled $True -SlowLink 350 -SlowLinkUIEnabled $True -SpecifiedLocation "\\Server221\Part17" -SpecifyTimeInterval 120 -SynchronizationInterval 1200 -SynchronizationList "\\Server221\Part17" -SynchronizationPolicy $True -TempProfileLogonBlocked $True -TimeOut 130 -UseCommonAlert $True -UseSpecifiedLocation $True -WaitForNetworkInSeconds 300 -WarningDays 100
This command creates a configuration item named CMUserDataProfileCI27. This configuration item manages folder redirection, offline folders, and roaming user profiles. Like the previous example, this command specifies folder redirection settings, this time for several folders. The command includes other settings for folder redirection, offline folders, and roaming user profiles.
Indicates whether this configuration item manages profile access settings for roaming profiles.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to grant the Administrators group access to roaming profile folders.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to allow roaming profiles on all devices. If this value is $False, roaming profiles apply only to the primary device for a user.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to permit user policies to roam across Active Directory forests that have a trust relationship with the current forest.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForAppDataRoaming
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a background synchronization type for a file in offline mode. The acceptable values for this parameter are: Disabled, Enabled, and NotConfigured.
Type: SynchronizationType
Parameter Sets: (All)
Aliases:
Accepted values: Enabled, Disabled, NotConfigured
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the configuration item includes settings for folder redirection.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the configuration item includes settings for offline folders.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the configuration item includes settings for roaming user profiles.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a connection transfer rate.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForContacts, Contacts
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of days to keep a user profile since the last time someone used it. A computer deletes an older profile when it restarts.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to delete cached copies of roaming user profiles. The default for this parameter is $False.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a description for the configuration item.
Type: String
Parameter Sets: (All)
Aliases: LocalizedDescription
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForDesktop
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to disable slow link detection.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the applicability of folder redirection for user devices. The acceptable values for this parameter are:
- FolderRedirectionOnAnyDeviceCachingOnPrimaryDevicesOnly. Folder redirection for any user device, but caching only on the primary device for a user.
- OnAnyDevice. Folder redirection and caching on any device.
- OnlyOnPrimaryDevices. Folder redirection and caching on the primary device for a user.
Type: DeviceType
Parameter Sets: (All)
Aliases:
Accepted values: OnAnyDevice, OnlyOnPrimaryDevices, FolderRedirectionOnAnyDeviceCachingOnPrimaryDevicesOnly
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether users can disable the Make Available Offline command.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether users can disable the Work Offline command.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForDocuments, Documents
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForDownloads, Downloads
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether this configuration item enables use of offline files.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the configuration enables work with offline files over a slow link.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of days to wait before the profile creates an error.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String[]
Parameter Sets: (All)
Aliases: ExcludeList
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForFavorites, Favorites
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a file synchronization type for metered networks for work in offline mode. The acceptable values for this parameter are: Disabled, Enabled, and NotConfigured.
Type: SynchronizationType
Parameter Sets: (All)
Aliases:
Accepted values: Enabled, Disabled, NotConfigured
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to disable forced unload of a user profile at logoff. The default value for this parameter is $False.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to grant the user exclusive permissions to a redirected folder.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to leave the folder in the redirected location in the event you remove this configuration item.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a limit, in megabytes, for the disk space used for offline files.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForLinks, Links
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether this configuration item manages advanced settings for folder redirection. Specify values for any of the following parameters:
- GrantExclusiveRight
- MoveContent
- LeaveFolderNewLocation
- MoveCachedFolder
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether this profile item manages slow links.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to move the cached folder when the path updates on the server.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to move the contents of redirected folders to the new location.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForMusic
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a name for the configuration item.
Type: String
Parameter Sets: (All)
Aliases: LocalizedDisplayName
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies an array of Administrative user assigned offline folders, as UNC paths as follows: \\server\share%UserName%.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Boolean
Parameter Sets: (All)
Aliases: OnlyAllowLocalProfiles
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether the configuration item does not check for ownership of roaming profile folders.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForPictures, Pictures
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to disable uploading of profiles.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForSavedGames, SavedGames
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForSearches, Searches
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a value for a slow link.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to enable user logon prompt to allow profile download when a device detects a slow link.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a specified location.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a time for background upload of the user hive.
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: 12:00 AM, 1:00 PM, 2:00 PM, 3:00 PM, 4:00 PM, 5:00 PM, 6:00 PM, 7:00 PM, 8:00 PM, 9:00 PM, 10:00 PM, 11:00 PM, 12:00 PM
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Int32
Parameter Sets: (All)
Aliases: SpecifyTimeInterval
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForStartMenu
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: String[]
Parameter Sets: (All)
Aliases: SynchronizationList, SyncDirectories
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to use a synchronization policy.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Int32
Parameter Sets: (All)
Aliases: SynchronizationInterval
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to block users from logging on by using a temporary profile.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a timeout value.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to use common alerts.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to use the specified location referred to by the SpecifiedLocation parameter.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: FolderRedirectionType
Parameter Sets: (All)
Aliases: FolderRedirectionUserConfigurationForVideos, Videos
Accepted values: RedirectToRemote, RedirectToLocal, DoNotManage
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: Int32
Parameter Sets: (All)
Aliases: WaitForNetworkInSeconds
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the number of days to wait before the profile creates a warning.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.