Share via


Win32_RoamingProfileMachineConfiguration class

Represents the roaming profile configuration for a computer.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class Win32_RoamingProfileMachineConfiguration
{
  boolean                                    IsEffective;
  boolean                                    PrimaryComputerEnabled;
  boolean                                    AddAdminGroupToRUPEnabled;
  Win32_RoamingProfileBackgroundUploadParams BackgroundUploadParams;
  boolean                                    DeleteRoamingCacheEnabled;
  uint16                                     DeleteProfilesOlderDays;
  boolean                                    DetectSlowLinkDisabled;
  boolean                                    ForceUnloadDisabled;
  boolean                                    TempProfileLogonBlocked;
  boolean                                    OnlyAllowLocalProfiles;
  boolean                                    ProfileUploadDisabled;
  boolean                                    SlowLinkUIEnabled;
  uint16                                     WaitForNetworkInSec;
  string                                     MachineProfilePath;
  Win32_RoamingProfileSlowLinkParams         SlowLinkTimeOutParams;
  boolean                                    WaitForRemoteProfile;
  boolean                                    AllowCrossForestUserPolicy;
  boolean                                    OwnerCheckDisabled;
};

Members

The Win32_RoamingProfileMachineConfiguration class has these types of members:

Properties

The Win32_RoamingProfileMachineConfiguration class has these properties.

AddAdminGroupToRUPEnabled

Data type: boolean

Access type: Read/write

If true, add the Administrator group to roaming user profiles.

AllowCrossForestUserPolicy

Data type: boolean

Access type: Read/write

If true, allow cross-forest user policy and roaming user profiles. If false, a roaming profile user receives a local profile when logged on to a cross-forest domain.

BackgroundUploadParams

Data type: Win32_RoamingProfileBackgroundUploadParams

Access type: Read/write

A Win32_RoamingProfileBackgroundUploadParams object containing the parameters for the background upload of a roaming user profile's registry file while the user is logged on.

DeleteProfilesOlderDays

Data type: uint16

Access type: Read/write

Qualifiers: Max (100000)

If the DeleteRoamingCache property is true, this property specifies the number of days after which a user profile should be deleted. User profiles older than this number of days are deleted when the computer is restarted.

DeleteRoamingCacheEnabled

Data type: boolean

Access type: Read/write

If true, cached copies of the roaming profile are deleted when the user logs off.

DetectSlowLinkDisabled

Data type: boolean

Access type: Read/write

If true, do not detect slow network connections. If false, use the SlowLinkTimeOutParams property to determine whether the computer has a slow network connection.

ForceUnloadDisabled

Data type: boolean

Access type: Read/write

If true, do not forcibly unload the user's registry when the user logs off.

IsEffective

Data type: boolean

Access type: Read-only

If true, the configuration settings are in effect.

MachineProfilePath

Data type: string

Access type: Read/write

The roaming profile path to be set for all users that log on to this computer. The path should be in the form of \\\\ComputerName\\ShareName\\%USERNAME% with no trailing backslash.

OnlyAllowLocalProfiles

Data type: boolean

Access type: Read/write

If true, allow only local user profiles.

OwnerCheckDisabled

Data type: boolean

Access type: Read/write

If true, don't check the owners of user profiles.

PrimaryComputerEnabled

Data type: boolean

Access type: Read/write

If true, a configured roaming profile will only be downloaded if the computer is a primary computer for the user.

ProfileUploadDisabled

Data type: boolean

Access type: Read/write

If true, prevent roaming profile changes from being copied to the server.

SlowLinkTimeOutParams

Data type: Win32_RoamingProfileSlowLinkParams

Access type: Read/write

A Win32_RoamingProfileSlowLinkParams object containing slow network connection timeout parameters to be used for user profiles.

If the DetectSlowLinkDisabled property is false, this property is ignored.

SlowLinkUIEnabled

Data type: boolean

Access type: Read/write

If true, the user is prompted to specify whether his or her profile should be downloaded even when the network connection is slow.

TempProfileLogonBlocked

Data type: boolean

Access type: Read/write

If true, do not allow users to log in with temporary profiles.

WaitForNetworkInSec

Data type: uint16

Access type: Read/write

Qualifiers: Max (300)

The maximum time, in seconds, to wait for the network transport to be available if a user has a roaming user profile. If the network is unavailable after this time has elapsed, the user is logged on, but the profile is not synchronized.

WaitForRemoteProfile

Data type: boolean

Access type: Read/write

If true, wait for a remote user profile.

Remarks

This class requires a context object to be passed as the pCtx parameter to the IWbemServices::GetObject method. This context object has the following properties, which should be set to the following values:

Property Name Type Specify This Value
PolicyPlatformContext_PrincipalContext_Type VT_BSTR "PolicyPlatform_MachineContext"
PolicyPlatformContext_PrincipalContext_Id VT_BSTR "SYSTEM"

Requirements

Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]
Namespace
Root\CIMv2
MOF
UserProfileConfigurationWmiProvider.mof