Citrix Virtual Apps and Desktops SDK

Get-UserProfileDefinition

August 9, 2024

Contributed by:

Gets the high level description of a configuration for profile management, based on a byte array (blob).

Syntax

Get-UserProfileDefinition
   [-ByteArray] <Byte[]>
   [-ExcludeUnconfigured]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to convert a configuration byte array into a set of named property settings. The byte array will either have been retrieved from the Broker, or from the New-UserProfileConfiguration cmdlet.

Examples

EXAMPLE 1

The first command creates a fresh configuration set in its default state, and stores it in a Windows PowerShell variable. The second command interprets the new blob, and would output the individual properties of the default configuration.

$blob = New-UserProfileConfiguration

Get-UserProfileDefinition -ByteArray $blob
<!--NeedCopy-->

EXAMPLE 2

This command creates a fresh configuration set in its default state, and pipes the resulting byte array through to Get-UserProfileDefinition, which will interpret it and output its individual properties.

New-UserProfileConfiguration | Get-UserProfileDefinition
<!--NeedCopy-->

Parameters

-ByteArray

Specifies the low-level byte array (blob) to be interpreted.

Type:	Byte[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-ExcludeUnconfigured

When this switch is supplied, the returned object will only carry the properties whose values have been explicitly set. Properties whose values are unconfigured will be omitted. When this switch is not supplied, the full set of configuration properties will be returned, and any unconfigured settings will just appear to be set to their default value.

Type:	SwitchParameter
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

Byte[]

The cmdlet accepts the ByteArray parameter as pipeline input.

Outputs

PSObject

This cmdlet outputs a single PSObject with multiple properties. Each property denotes one setting within the configuration set. The following is a summary of the properties and their data types:

ServiceActive (bool?)

ProcessedGroups (string[])

ExcludedGroups (string[])

ProcessAdmins (bool?)

UserStorePath (string)

PSMidSessionWriteBack (bool?)

OfflineSupport (bool?)

DeleteCachedProfilesOnLogoff (bool?)

ProfileDeleteDelay (int?)

MigrateWindowsProfilesToUserStore (MigrateWindowsProfilesToUserStoreEnum?)

LocalProfileConflictHandling (LocalProfileConflictHandlingEnum?)

TemplateProfilePath (string)

TemplateProfileOverridesLocalProfile (bool?)

TemplateProfileOverridesRoamingProfile (bool?)

TemplateProfileIsMandatory (bool?)

LoadRetries (int?)

ProcessCookieFiles (bool?)

DisableDynamicConfig (bool?)

LogoffRatherThanTempProfile (bool?)

DebugMode (bool?)

LogLevel_Warnings (bool?)

LogLevel_Information (bool?)

LogLevel_FileSystemNotification (bool?)

LogLevel_FileSystemActions (bool?)

LogLevel_RegistryActions (bool?)

LogLevel_RegistryDifference (bool?)

LogLevel_ActiveDirectoryActions (bool?)

LogLevel_PolicyUserLogon (bool?)

LogLevel_Logon (bool?)

LogLevel_Logoff (bool?)

LogLevel_UserName (bool?)

MaxLogSize (int?)

DebugFilePath (string)

ExclusionList (string[])

IncludeListRegistry (string[])

ExclusionListSyncFiles (string[])

ExclusionListSyncDir (string[])

SyncDirList (string[])

SyncFileList (string[])

MirrorFoldersList (string[])

PSEnabled (bool?)

PSAlwaysCache_Enabled (bool?)

PSAlwaysCache (int?)

PSPendingLockTimeout (int?)

PSUserGroups (string[])

CPEnable (bool?)

CPUserGroups (string[])

CPSchemaPathData (string)

CPPathData (string)

CPMigrationFromBaseProfileToCPStore (bool?)

FRAdminAccess (bool?)

FRIncDomainName (bool?)

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)

about_UpmSnapInUserProfileManagerSnapin

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Get-UserProfileDefinition

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Get-UserProfileDefinition

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ByteArray

-ExcludeUnconfigured

CommonParameters

Inputs

Byte[]

Outputs

PSObject

Related Links

In this article