For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set-RASFSLogix

SYNOPSIS

Modifies the FSLogix settings.

SYNTAX

Set-RASFSLogix
 -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings}
 -GeneralSettings <SwitchParameter> [-CacheDirectory <string>]
 [-CleanupInvalidSessions {Disable | Enable}] [-LogDirectory <string>]
 [-LogEnabled {Disable | Specific | All}] [-LogFileKeepingPeriod <uint>]
 [-LogLevel {Debug | Information | Warning | Error}]
 [-LogSpecificComponents {ProfileConfigTool | IEPlugin | RuleEditor | JavaRuleEditor | FSLogixAgentService | Profile | JavaLauncher | OfficeContainer | RuleCompilation | FontVisibility | Network | PrinterVisibility | ADSComputerGroup | DriverInterface | WindowsSearchRoaming | WindowsSearchPlugin | ProcessStartMonitor}]
 [-ProxyDirectory <string>] [-RoamRecycleBin {Disable | Enable}] [-RobocopyLogPath <string>]
 [-SilenceACLWarning {Disable | Enable}] [-SiteId <uint>] [-UseCacheDirectory <bool>]
 [-UseCleanupInvalidSessions <bool>] [-UseProxyDirectory <bool>] [-UseRoamRecycleBin <bool>]
 [-UseSilenceACLWarning <bool>] [-UseVHDCompactDisk <bool>] [-UseWriteCacheDirectory <bool>]
 [-VHDCompactDisk {Disable | Enable}] [-WriteCacheDirectory <string>] [<CommonParameters>]
Set-RASFSLogix
 -DefObjType {RDSDef | VDIDef | AVDSingleSessionDefaultSettings | AVDMultiSessionDefaultSettings}
 -OfficeContainer <SwitchParameter> [-AccessNetworkAsComputerObject {Disable | Enable}]
 [-AllocationType {Dynamic | Full}] [-AttachVHDSDDL <string>] [-CCDLocations <string[]>]
 [-ClearCacheOnForcedUnregister {Disable | Enable}] [-ClearCacheOnLogoff {Disable | Enable}]
 [-DefaultSize <uint>] [-DiffDiskParentFolderPath <string>]
 [-FlipFlopProfileDirectoryName {Disable | Enable}] [-HealthyProvidersRequiredForRegister <uint>]
 [-HealthyProvidersRequiredForUnregister <uint>] [-IgnoreNonAVD {AnySession | AVDSessions}]
 [-IncludeOfficeActivation {Disable | Enable}] [-IncludeOneDrive {Disable | Enable}]
 [-IncludeOneNote {Disable | Enable}] [-IncludeOneNoteUWP {Disable | Enable}]
 [-IncludeOutlook {Disable | Enable}] [-IncludeOutlookPersonalization {Disable | Enable}]
 [-IncludeSharepoint {Disable | Enable}] [-IncludeTeams {Disable | Enable}]
 [-LocationType {SMBLocation | CloudCache}] [-LockedRetryCount <uint>] [-LockedRetryInterval <uint>]
 [-MaxCacheSizeInMBs <uint>] [-MirrorLocalOSTToVHD {DoNothing | Copy | Move}]
 [-NoProfileContainingFolder {Disable | Enable}] [-NumSessionVHDsToKeep <uint>]
 [-OfficeContainerEnabled <bool>] [-OutlookCachedMode {Disable | Enable}]
 [-OutlookFolderPath <string>] [-PreventLoginWithFailure {Disable | Enable}]
 [-PreventLoginWithTempProfile {Disable | Enable}] [-ProfileDiskFormat {VHD | VHDX}]
 [-ReAttachIntervalSeconds <uint>] [-ReAttachRetryCount <uint>] [-RedirectType {Legacy | Advanced}]
 [-RefreshUserPolicy {Disable | Enable}] [-RemoveOrphanedOSTFilesOnLogoff {Disable | Enable}]
 [-RoamSearch {Disable | SingleUser | MultiUser}] [-SIDDirNameMatch <string>]
 [-SIDDirNamePattern <string>] [-SIDDirSDDL <string>] [-SiteId <uint>] [-UnregisterTimeout <uint>]
 [-UseAccessNetworkAsComputerObject <bool>] [-UseAttachVHDSDDL <bool>]
 [-UseClearCacheOnForcedUnregister <bool>] [-UseClearCacheOnLogoff <bool>]
 [-UseDiffDiskParentFolderPath <bool>] [-UseFlipFlopProfileDirectoryName <bool>]
 [-UseHealthyProvidersRequiredForRegister <bool>] [-UseHealthyProvidersRequiredForUnregister <bool>]
 [-UseIgnoreNonAVD <bool>] [-UseIncludeOfficeActivation <bool>] [-UseIncludeOneDrive <bool>]
 [-UseIncludeOneNote <bool>] [-UseIncludeOneNoteUWP <bool>] [-UseIncludeOutlook <bool>]
 [-UseIncludeOutlookPersonalization <bool>] [-UseIncludeSharepoint <bool>] [-UseIncludeTeams <bool>]
 [-UseLockedRetryCount <bool>] [-UseLockedRetryInterval <bool>] [-UseMaxCacheSizeInMBs <bool>]
 [-UseMirrorLocalOSTToVHD <bool>] [-UseNoProfileContainingFolder <bool>]
 [-UseNumSessionVHDsToKeep <bool>] [-UseOutlookCachedMode <bool>] [-UseOutlookFolderPath <bool>]
 [-UsePreventLoginWithFailure <bool>] [-UsePreventLoginWithTempProfile <bool>]
 [-UseReAttachIntervalSeconds <bool>] [-UseReAttachRetryCount <bool>] [-UseRedirectType <bool>]
 [-UseRefreshUserPolicy <bool>] [-UseRemoveOrphanedOSTFilesOnLogoff <bool>] [-UseRoamSearch <bool>]
 [-UseSIDDirNameMatch <bool>] [-UseSIDDirNamePattern <bool>] [-UseSIDDirSDDL <bool>]
 [-UseUnregisterTimeout <bool>] [-UseVHDAccessMode <bool>] [-UseVHDNameMatch <bool>]
 [-UseVHDNamePattern <bool>] [-UseVHDXSectorSize <bool>] [-UseVolumeWaitTimeMS <bool>]
 [-VHDAccessMode {NormalDirectAccess | DiffDiskNetwork | DiffDiskLocal | UniqueVHDPerSession}]
 [-VHDLocations <string[]>] [-VHDNameMatch <string>] [-VHDNamePattern <string>]
 [-VHDXSectorSize {SystemDefault | Size_512 | Size_4096}] [-VolumeWaitTimeMS <uint>]
 [<CommonParameters>]

DESCRIPTION

Modifies the FSLogix settings of RDSH, RDSHostPool, RDSDefaults, VDIDesktop, VDITemplate or VDIDesktopDefaults.

EXAMPLES

Example 1

Modifies the Profile Container within the FSLogix Settings of the RDS Default Settings.

Example 2

Modifies the Profile Container within the FSLogix Settings of the specified RDSHostPool by Name.

PARAMETERS

-ProfileContainerEnabled

Specifies if the Profile Container is enabled or disabled..

-OfficeContainerEnabled

Specifies if the Office Container is enabled or disabled.

-LocationType

Specifies the 'Location type'.

Possible values: SMBLocation, CloudCache

Type reference: LocationType

-VHDLocations

Specifies the 'VHD Locations'.

-CCDLocations

Specifies the 'CDD Locations'.

-ProfileDiskFormat

Specifies the 'Profile disk format'.

Possible values: VHD, VHDX

Type reference: ProfileDiskFormat

-AllocationType

Specifies the 'Allocation type'.

Possible values: Dynamic, Full

Type reference: AllocationType

-DefaultSize

Specifies the 'Default size'.

-CustomizeProfileFolders

Enable or disable the 'Customize Profile Folders' option.

-ExcludeCommonFolders

Specifies the 'Exclude Common Folders'.

Possible values: Contacts, Desktop, Documents, Links, MusicPodcasts, PicturesVideos, FoldersLowIntegProcesses, Downloads

Type reference: ExcludeCommonFolders

-UseLockedRetryCount

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

-LockedRetryCount

Specifies the 'Number of locked VHD(X) retries'.

-UseLockedRetryInterval

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

-LockedRetryInterval

Specifies the 'Delay between locked VHD(X) retries'.

-UseAccessNetworkAsComputerObject

Specifies if the 'Access network as computer object' option is enabled or disabled.

-AccessNetworkAsComputerObject

Specifies the 'Access network as computer object'.

Possible values: Disable, Enable

Type reference: EnableState

-UseAttachVHDSDDL

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

-AttachVHDSDDL

Specifies the 'SDDL used when attaching the VHD'.

-UseDiffDiskParentFolderPath

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

-DiffDiskParentFolderPath

Specifies the 'Diff disk parent folder path'.

-UseFlipFlopProfileDirectoryName

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

-FlipFlopProfileDirectoryName

Specifies the 'Swap SID and username in profile directory names'.

Possible values: Disable, Enable

Type reference: EnableState

-UseNoProfileContainingFolder

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

-NoProfileContainingFolder

Specifies the 'Do not create a folder for new profiles'.

Possible values: Disable, Enable

Type reference: EnableState

-UseOutlookCachedMode

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

-OutlookCachedMode

Specifies the 'Enable Cached mode for Outlook'.

Possible values: Disable, Enable

Type reference: EnableState

-UsePreventLoginWithFailure

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

-PreventLoginWithFailure

Specifies the 'Prevent logons with failures'.

Possible values: Disable, Enable

Type reference: EnableState

-UsePreventLoginWithTempProfile

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

-PreventLoginWithTempProfile

Specifies the 'Prevent logons with temp profiles'.

Possible values: Disable, Enable

Type reference: EnableState

-UseReAttachRetryCount

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

-ReAttachRetryCount

Specifies the 'Re-attach retry limit'.

-UseReAttachIntervalSeconds

Specifies if the 'Re-attach interval' option is enabled or disabled.

-ReAttachIntervalSeconds

Specifies the 'Re-attach interval'.

-UseRemoveOrphanedOSTFilesOnLogoff

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

-RemoveOrphanedOSTFilesOnLogoff

Specifies the 'Remove duplicate OST files on logoff'.

Possible values: Disable, Enable

Type reference: EnableState

-UseRoamSearch

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

-RoamSearch

Specifies the 'Search roaming feature mode'.

Possible values: Disable, SingleUser, MultiUser

Type reference: RoamSearch

-UseSIDDirNameMatch

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

-SIDDirNameMatch

Specifies the 'User-to-Profile matching pattern'.

-UseSIDDirNamePattern

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

-SIDDirNamePattern

Specifies the 'Profile folder naming pattern'.

-UseSIDDirSDDL

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

-SIDDirSDDL

Specifies the 'Use SSDL on creation of SID container folder'.

-UseVHDNameMatch

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

-VHDNameMatch

Specifies the 'Profile VHD(X) file matching pattern'.

-UseVHDNamePattern

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

-VHDNamePattern

Specifies the 'Naming pattern for new VHD(X) files'.

-UseVHDXSectorSize

Specifies if the 'VHDX sector size' option is enabled or disabled.

-VHDXSectorSize

Specifies the 'VHDX sector size'.

Possible values: SystemDefault, Size_512, Size_4096

Type reference: VHDXSectorSize

-UseVolumeWaitTimeMS

Specifies if the 'Volume wait time' option is enabled or disabled.

-VolumeWaitTimeMS

Specifies the 'Volume wait time'.

-UseIgnoreNonAVD

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.

-IgnoreNonAVD

Specifies the 'Ignore non-AVD sessions'.

Possible values: AnySession, AVDSessions

Type reference: IgnoreNonAVD

-UseRedirectType

Specifies if the 'Redirect type' option is enabled or disabled.

-RedirectType

Specifies the 'Redirect type'.

Possible values: Legacy, Advanced

Type reference: RedirectType

-UseKeepLocalDir

Specifies if the 'Keep local profiles' option is enabled or disabled.

-KeepLocalDir

Specifies the 'Keep local profiles'.

Possible values: Disable, Enable

Type reference: EnableState

-UseDeleteLocalProfileWhenVHDShouldApply

Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.

-DeleteLocalProfileWhenVHDShouldApply

Specifies the 'Delete local profile when loading from VHD'.

Possible values: Disable, Enable

Type reference: EnableState

-UseProfileDirSDDL

Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.

-ProfileDirSDDL

Specifies the 'Custom SDDL for profile directory'.

-UseProfileType

Specifies if the 'Profile type' option is enabled or disabled.

-ProfileType

Specifies the 'Profile type'.

Possible values: NormalProfile, OnlyRWProfile, OnlyROProfile, RWROProfile

Type reference: ProfileType

-UseSetTempToLocalPath

Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.

-SetTempToLocalPath

Specifies the 'Temporary folders redirection mode'.

Possible values: TakeNoAction, RedirectTempAndTmp, RedirectINetCache, RedirectTempTmpAndINetCache

Type reference: TempFolderRedirectionMode

-UseCleanOutNotifications

Specifies if the 'Clean out notifications' option is enabled or disabled.

-CleanOutNotifications

Specifies the 'Clean out notifications'.

Possible values: Disable, Enable

Type reference: EnableState

-UseInstallAppxPackages

Specifies if the Install Appx packages' option is enabled or disabled.

-InstallAppxPackages

Specifies the 'Install Appx packages'.

Possible values: Disable, Enable

Type reference: EnableState

-UseRebootOnUserLogoff

Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.

-RebootOnUserLogoff

Specifies the 'Reboot computer when user logs off'.

Possible values: Disable, Enable

Type reference: EnableState

-UseRoamIdentity

Specifies if the 'Roam identity' option is enabled or disabled.

-RoamIdentity

Specifies the 'Roam identity'.

Possible values: Disable, Enable

Type reference: EnableState

-UseShutdownOnUserLogoff

Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.

-ShutdownOnUserLogoff

Specifies the 'Shutdown computer when user logs off'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOfficeActivation

Specifies if the 'Include Office Activation' option is enabled or disabled.

-IncludeOfficeActivation

Specifies the 'Include Office Activation'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOneDrive

Specifies if the 'Include OneDrive' option is enabled or disabled.

-IncludeOneDrive

Specifies the 'Include OneDrive'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOneNote

Specifies if the 'Include OneNote' option is enabled or disabled.

-IncludeOneNote

Specifies the 'Include OneNote'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOneNoteUWP

Specifies if the 'Include OneNote UWP' option is enabled or disabled.

-IncludeOneNoteUWP

Specifies the 'Include OneNote UWP'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOutlook

Specifies if the 'Include Outlook' option is enabled or disabled.

-IncludeOutlook

Specifies the 'Include Outlook'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeOutlookPersonalization

Specifies if the 'Include Outlook Personalization' option is enabled or disabled.

-IncludeOutlookPersonalization

Specifies the 'Include Outlook Personalization'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeSharepoint

Specifies if the 'Include Sharepoint' option is enabled or disabled.

-IncludeSharepoint

Specifies the 'Include Sharepoint'.

Possible values: Disable, Enable

Type reference: EnableState

-UseIncludeTeams

Specifies if the 'Include Teams' option is enabled or disabled.

-IncludeTeams

Specifies the 'Include Teams'.

Possible values: Disable, Enable

Type reference: EnableState

-UseMirrorLocalOSTToVHD

Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.

-MirrorLocalOSTToVHD

Specifies the 'Mirror Local OST-VHD'.

Possible values: DoNothing, Copy, Move

Type reference: MirrorLocalOSTToVHD

-UseNumSessionVHDsToKeep

Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.

-NumSessionVHDsToKeep

Specifies the 'Number of Session VHDs to Keep'.

-UseOutlookFolderPath

Specifies if the 'Outlook Folder Path' option is enabled or disabled.

-OutlookFolderPath

Specifies the 'Outlook Folder Path'.

-UseRefreshUserPolicy

Specifies if the 'Refresh User Policy' option is enabled or disabled.

-RefreshUserPolicy

Specifies the 'Refresh User Policy'.

Possible values: Disable, Enable

Type reference: EnableState

-UseVHDAccessMode

Specifies if the 'VHD Access Mode' option is enabled or disabled.

-VHDAccessMode

Specifies the 'VHD Access Mode'.

Possible values: NormalDirectAccess, DiffDiskNetwork, DiffDiskLocal, UniqueVHDPerSession

Type reference: VHDAccessMode

-UseCleanupInvalidSessions

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

-CleanupInvalidSessions

Specifies the 'Cleanup invalid sessions'.

Possible values: Disable, Enable

Type reference: EnableState

-UseRoamRecycleBin

Specifies if the 'Roam recycle bin' option is enabled or disabled.

-RoamRecycleBin

Specifies the 'Roam recycle bin'.

Possible values: Disable, Enable

Type reference: EnableState

-UseVHDCompactDisk

Specifies if the 'VHD compact disk' option is enabled or disabled.

-VHDCompactDisk

Specifies the 'VHD compact disk'.

Possible values: Disable, Enable

Type reference: EnableState

-UseCacheDirectory

Specifies if the 'Cache directory' option is enabled or disabled.

-CacheDirectory

Specifies the 'Cache directory'.

-UseWriteCacheDirectory

Specifies if the 'Write cache directory' option is enabled or disabled.

-WriteCacheDirectory

Specifies the 'Write cache directory'.

-UseProxyDirectory

Specifies if the 'Proxy directory' option is enabled or disabled.

-ProxyDirectory

Specifies the 'Proxy directory'.

-UseSilenceACLWarning

Specifies if the 'Silence ACL warning' option is enabled or disabled.

-SilenceACLWarning

Specifies the 'Silence ACL warning'.

Possible values: Disable, Enable

Type reference: EnableState

-LogEnabled

Specifies the 'Log enabled'.

Possible values: Disable, Specific, All

Type reference: FSLogixLogEnabled

-LogLevel

Specifies the 'Log level'.

Possible values: Debug, Information, Warning, Error

Type reference: FSLogixLogLevel

-LogFileKeepingPeriod

Specifies the 'Log keeping period in days'. Default: '2'.

-LogDirectory

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

-RobocopyLogPath

Specifies the 'Robocopy log path'.

-LogSpecificComponents

Specifies the 'FSLogix components to enable logging for'.

Possible values: ProfileConfigTool, IEPlugin, RuleEditor, JavaRuleEditor, FSLogixAgentService, Profile, JavaLauncher, OfficeContainer, RuleCompilation, FontVisibility, Network, PrinterVisibility, ADSComputerGroup, DriverInterface, WindowsSearchRoaming, WindowsSearchPlugin, ProcessStartMonitor

Type reference: LogSpecificComponents

-UseMaxCacheSizeInMBs

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

-MaxCacheSizeInMBs

Specifies the 'Max cache size in MBs'.

-UseClearCacheOnLogoff

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

-ClearCacheOnLogoff

Specifies the 'Clear cache on logoff'.

Possible values: Disable, Enable

Type reference: EnableState

-UseHealthyProvidersRequiredForRegister

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

-HealthyProvidersRequiredForRegister

Specifies the 'Healthy providers required for register'.

-UseHealthyProvidersRequiredForUnregister

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

-HealthyProvidersRequiredForUnregister

Specifies the 'Healthy providers required for unregister'.

-UseUnregisterTimeout

Specifies if the 'Unregister timeout' option is enabled or disabled.

-UnregisterTimeout

Specifies the 'Unregister timeout'.

-UseClearCacheOnForcedUnregister

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

-ClearCacheOnForcedUnregister

Specifies the 'Clear cache on forced unregister'.

Possible values: Disable, Enable

Type reference: EnableState

-Name

The name or server for which to modify the FSLogix settings.

-SiteId

Site ID from which to modify the FSLogix settings.

If the parameter is omitted, the Licensing Server site ID will be used.

-Id

The ID of a server for which to modify the FSLogix settings.

-InputObject

An object of type RDS, RDSHostPool, VDITemplate or VDIDesktop for which to modify the FSLogix settings.

Type reference: RASSerilazableObj

-ObjType

The Object Type for which to modify the FSLogix settings.

Possible values: RDSHost, RDS, RDSHostPool, RDSGroup, VDIHostPool, VDIPool, AVDHostPool

Type reference: FSLogixServerObjType

-DefObjType

The Default Object Type for which to modify the FSLogix settings.

Possible values: RDSDef, VDIDef, AVDSingleSessionDefaultSettings, AVDMultiSessionDefaultSettings

Type reference: ServerDefObjType

-ProfileContainer

Set the Profile Container settings.

-OfficeContainer

Sets the Office Container settings.

-GeneralSettings

Sets the General settings.

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

OUTPUTS

None

Last updated