Chat now with support
Chat with Support

Client Profile Updating Utility 5.8 - Administrator Guide

CPUU Parameters

CPUU Parameters

Entering or reviewing command-line parameters is usually not necessary. The Client Profile Updating Utility Configuration wizard creates configuration files (CPUU.ini and CPUU_Update.bat) with the appropriate parameters for you.

You need to reference this section only in the following cases:

  • You read about a parameter in the Client Profile Updating Utility Configuration wizard online help and want more information.
  • You want to create the command line by yourself (though this is not recommended) and run the Client Profile Utility from the command line rather than using the configuration files generated by the Client Profile Updating Utility Configuration wizard.

Management Parameters

Management Parameters

The following management parameters are used in CPUU_Update.bat:

Parameter Description
-Profiles <ProfileName1> [ProfileName2] [ProfileName3] [...]

Makes the Client Profile Updating Utility process the specified profiles only.

NOTE: If two versions of Outlook are installed side-by-side on the computer, CPUU processes profile from the newer version of Outlook.

-Undo <ProfileName1> [ProfileName2] [ProfileName3] [...] Rolls back changes made to the specified profiles. Specify the names of the profiles you want to undo the changes in. If the utility is run with this parameter from a logon script, the changes will be rolled back on every workstation.
-UndoAll Rolls back all changes made by the utility to all updated profiles. If the utility is run with this parameter from a logon script, the changes will be rolled back on every workstation.
-DefaultProfile Default profiles can be updated with the -DefaultProfile parameter, without the need to look up the profile name.
-LeaveTemporaryProfile Before updating a profile, CPUU checks that the target mailbox is available and accessible with current CPUU.ini settings by creating the temporary target profile and trying to logon to it. By default, the temporary profile will be deleted after that. If -LeaveTemporaryProfile is specified, temporary profile will remain. Temporary profile name is like the following: CPUU_{<random GUID value>}. -LeaveTemporaryProfile is useful if CPUU cannot access the target mailbox with current CPUU.ini settings. In this case, you can leave the temporary target profile, open it in the Mail Control Panel applet and check which of the profile settings are incorrect and determine what should be changed in CPUU.ini to force CPUU to set the correct settings for a target profile.
-UndoDefaultProfile Default profiles can be rolled back with the -UndoDefaultProfile parameter, without the need to look up the profile name.
-Log <LogFile>

Specifies the name and path to the log file. You can specify either the full path to the log file or only the file name, in which case the log will be written to the folder from which the utility is started. If this parameter is not specified, the log file will be created with the default name, CPUU.log.

You can use the following additional parameters to add the client computer name and the current date and time:

#H – inserts client computer name

#D – inserts the current date

#T – inserts the current time

You can also use the existing environment variable values to form the CPUU log file name. For example, you can add the user name of the account currently logged on to the name of the log file by typing the following expression:

%username%_CPUU.log

The %username% parameter will be replaced with the real user name associated with the security context in which CPUU was started.

NOTE: If CPUU log files reside in a remote location, CPUU first writes all .log, .csv and crash dump files into the CPUULogs folder in the TEMP directory on the local computer and after CPUU completes its operations, the .log and .csv files are moved to the remote folder. Crash dump files are not moved by default. The maximum number of dump files in the CPUULogs folder is limited to 10.

-MoveDumpsToRemote Enables moving of crash dump files to the CPUU log folder if this folder is located on the remote computer.
-MaxLocalDumps Specifies the maximum number of dump files to be stored in the %TEMP%\CPUULogs folder on a local computer. The default value is 10.
-LogWriteDirectly CPUU writes all .log, .csv and crash dump files directly to the CPUU log folder if this folder is remote.
-Cleanup Deletes all backup profiles and cleans up all auxiliary backup information. Please make sure that all profiles have been successfully updated and no rollback is required before running the utility with this parameter.
-INI <FileName> Specifies the path to the INI file. By default, the file resides in the same directory as CPUU_Update.bat.
-ExcludeScpLookupAlways

Disables Autodiscover SCP lookup for Outlook. This parameter is set by default when processing Outlook 2016 profiles.

Autodiscover SCP lookup must always be disabled when processing Outlook 2016 profiles for mailboxes migrated using Migration Manager for Exchange. Note that setting this parameter affects all Outlook profiles for the logged on user account.

-ExcludeScpLookupNever

By default, CPUU disables Autodiscover SCP lookup when processing Outlook 2016 profiles as described in Using CPUU for Outlook 2016/2019. To turn off that behavior specify this parameter. In particular, it should be always specified when processing Outlook 2016 profile for a mailbox migrated using On Demand Migration for Email.

NOTE:This parameter is effective only in case the URLs of the Autodiscover service for source and for target are not specified on the Autodiscover step of the Client Profile Updating Utility Configuration wizard.

-NameTrgStoreAsSrc This parameter configures CPUU to preserve a source store display name after switching profile to a target mailbox. It is useful in migrations from one Office 365 tenant to another using ODME in which target store by default has the .onmicrosoft.com domain suffix and you plan to change it to the source name after all mailboxes from the source tenant are migrated to the target tenant and then switched.
-SkipAutodiscoverChecking By default, CPUU checks that an Autodiscover URL is on a source domain and a target autodiscover URL is on a target domain. To turn off that behavior specify this parameter for Microsoft Outlook 2016/2019 in case RecreateSwitchMsg is set to 1 in SwitchResMB configuration file.
CPUU cannot update the profile in case Outlook Profile and switch message do not contain valid information about source Autodiscover URL and target Autodiscover URL.
-? Displays help information.

Configuration Parameters

The following configuration parameters are used in CPUU.ini:

Parameter Description
Admin <Domain\User> Allows the user to specify the administrative account to be used to work with Exchange mailboxes. This parameter can be used only together with the - Password parameter.
Password <EncryptedPassword> Specifies the password for the Admin account. The password must be encrypted by the Client Profile Updating Utility Configuration wizard.
AdminTrg<Domain\User>; AdminTrg<User@email> - for Microsoft Office 365 Allows the user to specify the administrative account to log on to the target mailboxes. This parameter can be used only together with the PasswordTrg parameter. The parameter is helpful when no trust relationships are established between the source and target domains.
PasswordTrg <EncryptedPassword> Specifies password for the AdminTrg account. The password must be encrypted by the Client Profile Updating Utility Configuration wizard.
AskCredentials Makes the utility prompt for credentials to log on to the source server. If the specified credentials do not allow logon to the target server, the utility prompts for target server credentials also. If the parameter was used in update mode, CPUU will prompt for credentials automatically when the profile is cleaned up or rolled back.
AskSourceCredentialsOnly Specifies that provided by user source credentials will be used for access to target linked mailboxes in case Prompt for credentials mode is selected (AskCredentials is set to 1). Possible values are 0 (default) and 1. For more details see Typical Scenario.
AllowAdditionalServices <Svc1> [Svc2] [Svc3] [...]

Forces the utility to process the non-default service providers whose MAPI names are specified as the parameter values. To process all the existing services, specify the value <All> as the parameter.

The services updated by default are:

  • Microsoft Exchange Server (MSEMS)
  • Personal Address Book (MSPST AB) Personal Folders (.PST) File (MSPST MS; MSUPST MS)
  • Outlook Address Book (CONTAB)
  • Microsoft LDAP Directory (EMABLT)
  • Internet Folders (INTERSTOR)
  • Internet E-mail (IMAIL)
Skip <Value1> [Value2] [Value3] [...] Forces the utility to skip the specified functionalities. For more information, see the Using a Dial-Up Connection while Updating Profiles topic.
Features <Value1> [Value2] [Value3] [...] Forces the utility to process only the specified features. This functionality cannot be used along with the Skip parameter.
Critical <Value1> [<Value2>] [<Value3>] [...] Forces the utility to skip profiles for which the critical functionalities specified as the values of this parameter cannot be updated. As values of this parameter, you can specify such functionalities as Rules and CONTAB. A complete list of functionalities can be found in the Critical Functionalities topic.
Remove Nicks Forces the utility to remove all nicknames from the profile. If the nickname functionality is also specified in the Critical key and errors occur during nickname removal, the update will automatically be rolled back.
RemoveJunkEmailMessages Forces CPUU to remove all junk e-mail settings from the updated profile.
ProcessOfflineProfiles Forces the utility to process offline profiles.
KeepOST Forces CPUU to associate the original source OST file with the target mailbox profile if the corresponding source mailbox was processed within a Remote Users Collection by the Mail Agent. Otherwise, this parameter is ignored.
BackupOST Forces CPUU to create a backup copy of the original source OST file if the corresponding source mailbox was processed within a Remote Users Collection by the Mail Agent. Otherwise, this parameter is ignored.
CreateRegFileForOSTRecovery Prevents the utility from creating the registry (REG) file used for restoring a lost link between OST file and a profile.
UseTargetOST UseTargetOST is used only during rollback. This option tells Client Profile Updating Utility to keep the OST file for the target mailbox after rollback.
Silent Prevents the utility from displaying any dialog boxes while updating profiles.
SkipPing Specifies that the utility should not ping the target Exchange server to verify its availability. Always use this parameter when the target network has no RPC/TCP connectivity and relies only on HTTP.
WatchDog Launches [1] or stops [0] the watchdog process (by default, this process starts together with CPUU). This process watches the CPUU hangs and stops the utility using the OpenStoreWait, FeatureWait, GlobalWait options. Then the watchdog process restarts CPUU.
StopProcesses

Watchdog stops all processes that are specified as the value for the StopProcesses parameter before it starts CPUU. The following processes are stopped by default:

  • Microsoft Communicator (Communicator.exe)
  • Microsoft Outlook (Outlook.exe)
  • Blackberry Desktop Software 6.x (Rim.Desktop.exe)
  • Blackberry Desktop Software (Legacy) (Desktopmanager.exe)
  • Google Calendar Sync (GoogleCalendarSync.exe)
Attempt [N] Sets the maximum number of attempts to restart CPUU (by default, three times).
OpenStoreWait Sets the maximum allowed wait period to open a store (in seconds).
FeatureWait Sets the maximum allowed wait period for a feature to finish its operations (in seconds).
GlobalWait Sets the maximum run time period for CPUU (in seconds).
[Notification] In this section, you can forces the utility to send a notification message about update results to the addresses specified in the file. The format of the section can be found in the Notification Format topic.
ProcessedDomainsFQDNs

Important: All user's and public folders SMTP domain names that are the same at source and at target must be specified.

The following is an explanation of CPUU behavior depending on ProcessedDomainsFQDNs:

Please do not use semicolon {;}, comma {,}. or any other separators except space character when you specify the values for the ProcessedDomainsFQDNs parameter, for example: ProcessedDomainsFQDNs=<domain name 1> <domain name 2> <domain name 3>.

  • If ProcessedDomainsFQDNs is empty, and there is only one Exchange account in a profile, CPUU switches this Exchange account in the profile.
  • If ProcessedDomainsFQDNs is not empty, and there is only one Exchange account in a profile, CPUU checks that the Exchange account is allowed by ProcessedDomainsFQDNs and, if so, then switches this account. Otherwise, the account will be skipped.
  • If ProcessedDomainsFQDNs is empty, and there are a few Exchange accounts in a profile, CPUU logs the following error: "Profile <profile name> contains multiple Exchange accounts". CPUU requires that you specify the ProcessedDomainsFQDNs parameter to determine if the primary account is allowed to switch.
  • If ProcessedDomainsFQDNs is not empty, and there are a few Exchange accounts in a profile, CPUU checks that the primary Exchange account is allowed by ProcessedDomainsFQDNs and, if so, then switches the primary account and ignores the others.
UseLocalAutodiscoverXMLs

Specifies whether local Autodiscover XML files will be used. Possible values are 0 (default) and 1.

  • 1: Use local Autodiscover XML files
  • 0: Do not use local Autodiscover XML files

See Autodiscover step of the Typical Scenario topic for details.

AutodiscoverSourceURL Specifies URL of the Autodiscover service for source. See Advanced Tuning step of the Typical Scenario topic for details.
AutodiscoverTargetURL Specifies URL of the Autodiscover service for target. See Advanced Tuning step of the Typical Scenario topic for details.
MigrationType

Specifies the type of Outlook profile processing. This parameter might take one of the following values:

BypassModernAuthentication

Disables  Modern Authentication while Client Profile Updating Utility process Outlook profiles in Microsoft Office 365 tenants with enabled Modern Authentication. By default is set to 1: Modern Authentication is disabled while Client Profile Updating Utility process Outlook profiles.

Notification Format

The Client Profile Updating Utility Configuration wizard creates a section in the CPUU.ini file that contains the notification settings. You need to reference this section only if you want to create the command-line by yourself and receive notifications about CPUU activities.

Section Format

Here is an example of the CPUU.ini file section that stores notification settings:

[Admin notification]

SMTPAddress=address1@domain.com address2@domain.com

Priority=normal

Attach log=statistics

Notification=fail

Profile=current

Subject=%R: Profile %P on computer %H

Body=The mail client profile %P for user %U on computer %H has been processed by Client Profile Updating Utility (CPUU), and was %R. The profile was processed at %T, %D. See the CPUU log file for details.

Admin notification – The name of the section. Cannot be changed.

SMTPAddress – Specifies one or several SMTP addresses to which the notification will be sent.

Priority – Defines the priority of the notification.

Possible values: low, high, normal.

Attach log – Defines what should be attached to the notification message. Possible values:

  • none – No attachment will be send with the notification.
  • all – The full log will be attached to the notification.
  • statistics – The statistics gathered from the log file will be attached to the notification.

Notification – Defines in what cases notification should be sent. Possible values:

  • success – Notification will be sent if the profile has been successfully updated.
  • fail – Notification will be sent if the profile has not been updated.
  • all – Notification will be sent in any case.

Profile – Defines which profile should be used to send notifications.

  • default – Notification will be sent via the default profile as soon as this profile is updated. This is the default value.
  • current – Notification will be sent via the current profile as soon as this profile is updated.

Subject – Specifies the notification subject.

Body – Specifies the notification body.

Variables

The following variables can be used in the subject and body of the notification message:

%r, %R UPDATED or NOT UPDATED

%u, %U User name (for Windows 9x, the Profile name parameter value is used)

%p, %P Profile name

%h, %H Computer name

%t, %T Time

%d, %D Date

%% %

 

Related Documents