Edit

New-CMUserDataAndProfileConfigurationItem

  • Reference
Module:
ConfigurationManager

Creates a user data and profile configuration item.

Syntax

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>]

Description

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.

Examples

Example 1: Specify folder redirection

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.

Example 2: Specify settings for a configuration item

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.

Parameters

-AccessPolicy

Indicates whether this configuration item manages profile access settings for roaming profiles.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AddAdminGroupToRupEnabled

Indicates whether to grant the Administrators group access to roaming profile folders.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowAllDevice

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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowCrossForestUserPolicy

Indicates whether to permit user policies to roam across Active Directory forests that have a trust relationship with the current forest.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AppDataRoaming

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForAppDataRoaming
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BackgroundSynchronization

Specifies a background synchronization type for a file in offline mode. The acceptable values for this parameter are: Disabled, Enabled, and NotConfigured.

Type:SynchronizationType
Accepted values:Enabled, Disabled, NotConfigured
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigureFolderRedirection

Indicates whether the configuration item includes settings for folder redirection.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ConfigureOfflineFile

Indicates whether the configuration item includes settings for offline folders.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ConfigureRoamingUserProfile

Indicates whether the configuration item includes settings for roaming user profiles.

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionTransferRate

Specifies a connection transfer rate.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Contact

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForContacts, Contacts
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeleteProfileOlderDays

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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeleteRoamingCacheEnabled

Indicates whether to delete cached copies of roaming user profiles. The default for this parameter is $False.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the configuration item.

Type:String
Aliases:LocalizedDescription
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Desktop

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForDesktop
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DetectSlowLinkDisabled

Indicates whether to disable slow link detection.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeviceType

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
Accepted values:OnAnyDevice, OnlyOnPrimaryDevices, FolderRedirectionOnAnyDeviceCachingOnPrimaryDevicesOnly
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableMakeOffline

Indicates whether users can disable the Make Available Offline command.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWorkOffline

Indicates whether users can disable the Work Offline command.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Document

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForDocuments, Documents
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Download

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForDownloads, Downloads
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableOfflineFile

Indicates whether this configuration item enables use of offline files.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EnableSlowLink

Indicates whether the configuration enables work with offline files over a slow link.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ErrorDays

Specifies the number of days to wait before the profile creates an error.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExcludeProfile

Type:String[]
Aliases:ExcludeList
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Favorite

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForFavorites, Favorites
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FileSynchronization

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
Accepted values:Enabled, Disabled, NotConfigured
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceUnloadDisabled

Indicates whether to disable forced unload of a user profile at logoff. The default value for this parameter is $False.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GrantExclusiveRight

Indicates whether to grant the user exclusive permissions to a redirected folder.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LeaveFolderNewLocation

Indicates whether to leave the folder in the redirected location in the event you remove this configuration item.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LimitDisk

Specifies a limit, in megabytes, for the disk space used for offline files.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Link

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForLinks, Links
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManageAdvancedSetting

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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ManageSlowLink

Indicates whether this profile item manages slow links.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MoveCachedFolder

Indicates whether to move the cached folder when the path updates on the server.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MoveContent

Indicates whether to move the contents of redirected folders to the new location.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Music

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForMusic
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a name for the configuration item.

Type:String
Aliases:LocalizedDisplayName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OfflineFile

Specifies an array of Administrative user assigned offline folders, as UNC paths as follows: \\server\share%UserName%.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OnlyAllowLocalProfile

Type:Boolean
Aliases:OnlyAllowLocalProfiles
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OwnerCheckDisabled

Indicates whether the configuration item does not check for ownership of roaming profile folders.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Picture

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForPictures, Pictures
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProfileUploadDisabled

Indicates whether to disable uploading of profiles.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SavedGame

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForSavedGames, SavedGames
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Search

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForSearches, Searches
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SlowLink

Specifies a value for a slow link.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SlowLinkUIEnabled

Indicates whether to enable user logon prompt to allow profile download when a device detects a slow link.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SpecifiedLocation

Specifies a specified location.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SpecifyTime

Specifies a time for background upload of the user hive.

Type:String
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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SpecifyTimeMin

Type:Int32
Aliases:SpecifyTimeInterval
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StartMenu

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForStartMenu
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SyncDirectory

Type:String[]
Aliases:SynchronizationList, SyncDirectories
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SynchronizationPolicy

Indicates whether to use a synchronization policy.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SyncMins

Type:Int32
Aliases:SynchronizationInterval
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TempProfileLogonBlocked

Indicates whether to block users from logging on by using a temporary profile.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Timeout

Specifies a timeout value.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseCommonAlert

Indicates whether to use common alerts.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseSpecifiedLocation

Indicates whether to use the specified location referred to by the SpecifiedLocation parameter.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Video

Type:FolderRedirectionType
Aliases:FolderRedirectionUserConfigurationForVideos, Videos
Accepted values:RedirectToRemote, RedirectToLocal, DoNotManage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WaitForNetworkSec

Type:Int32
Aliases:WaitForNetworkInSeconds
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WarningDays

Specifies the number of days to wait before the profile creates a warning.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

IResultObject