サポートと今すぐチャット
サポートとのチャット

On Demand Migration Current - Desktop Update Agent User Guide

Deploying Agents

To complete a migration project and reconfigure a user's applications, agents must be configured and deployed by administrators, then run on users' workstations.

To deploy Desktop Update Agent to users' workstations, you need to:

  • Download the agent. (On Demand Migration Desktop Update Agent Installer MSI)

    NOTE: Desktop Update Agent can be downloaded either during the configuration of the Switch Application task or prior to the configuration.

  • Generate an access token to be used by the agent.
  • Share the installation through a Group Policy Object or using Microsoft Endpoint Configuration Manager (MECM).

NOTE: While a managed deployment solution is likely best for broad deployment of DUA, you can also install the agent directly using a command line script. This may be useful for initial testing. See Deploy the agent using the command line.

Download the agent and generate the required token

  1. On the On Demand Migration Project page, under Accounts, choose Desktop Agents.

  2. Under More, choose the Download Agent menu option.

  3. Under New Agent Authentication Token, specify a passphrase. Ensure that you keep this passphrase safe, as it is required when you deploy the agent.

    Caution: You will not be able to retrieve this passphrase from On Demand Migration later.
  4. If required, enter one or more email addresses to send notifications for DUA tokens that are set to expire in 14 days or have been manually revoked.

  5. Click Generate Token. A new task will be created to generate the token.

  6. Click Download Agent and save a copy of the new token for use during the agent deployment.

Deploy the agent using the command line

This method is recommended primarily for initial testing on a small set of computers. A managed deployment approach such as Deploying the agent with a GPO or Deploying the agent using Microsoft Endpoint Configuration Manager (MECM) is recommended for wide scale deployment to user computers.

To install DUA from Windows PowerShell, use the following procedure: 

  1. Download the agent and generate the required token

  2. Create a PowerShell script with the required Token (Token Value) and Passphrase (Passphrase Value) values. For example: 

    msiexec.exe /I 'C:\DUA\ODM_DesktopUpdateAgent.msi' TOKEN=######## PASSPHRASE=##### /qn

    NOTE: It is necessary to run PowerShell as Administrator so that the installer can write the token to the registry. If not, an error similar to "Failed to save access token to registry.' may be displayed.
  3. Run the script on the desired computer(s).

Deploying the agent with a GPO

NOTE: To install the agent using a GPO you need to convert the Desktop Update Agent MSI package and the parameters into an MST file. The following procedure uses Microsoft Orca to create the MST file. Orca installation is available in Windows SDK Components for Windows Installer Developers.

  1. Download the On Demand Migration Desktop Update Agent Installer MSI file. (See Download the agent and generate the required token.)

  2. Right-click the On Demand Migration Desktop Update Agent Installer MSI file and select Edit with Orca.

  3. From within Orca, select Transform | New Transform.

  4. Navigate to the Property table and add the following:

    1. Add a Row with property of TOKEN and the token value. The token value previously created in the Agent Download page.

    2. Add a Row with property of PASSPHRASE and the passphrase value. The passphrase value previously created in the Agent Download page.

  5. Select Transform | Generate Transform to complete the MST file creation.

  6. Right-click the share that contains the ODM Desktop Update Agent MSI, and choose Properties.
  7. Select the Sharing tab, and select Share.
  8. Select the required users.

    NOTE:

    • Ensure the users have Read access.
  9. Choose Share.
  10. Choose Done.
  11. Select the Security tab and ensure Authenticated Users security group has the Read and NTFS permissions.
  12. From the Start menu, go to Administrative Tools and choose Group Policy Management.
  13. Right-click the domain or OU you are migrating and choose Create a GPO in this domain, and link it here.
  14. In the New GPO dialog, enter a name for the GPO and choose OK.
  15. Select the new GPO and choose OK.
  16. Right-click the GPO and select Edit.
  17. Open Computer Configuration | Policies | Software Settings, right-click Software Installation, go to New, and choose Package.
  18. In the File Name field, enter the UNC path to the On Demand Migration Desktop Update Agent Installer MSI file and choose Open.
  19. Select the On Demand Migration Desktop Setup Agent and choose Open.
  20. In the Deploy Software dialog, select Advanced as the deployment method, and select OK.
  21. Under the Modifications tab, add the previously created MST file, and click OK.

  22. Restart the computer for the applied group policy to complete the agent installation.

To configure Desktop Update Agent to run at User Logon using a Group Policy Object:

  1. From the Start menu, go to Administrative Tools and choose Group Policy Management.
  2. Right-click the domain or OU you are migrating and choose Create a GPO in this domain, and link it here.
  3. In the New GPO dialog, enter a name for the GPO and choose OK.
  4. Select the new GPO and choose OK.
  5. Right-click the GPO and select Edit.
  6. Open Computer Configuration | Policies | Administrative Template | System | Logon ,and right select Run these programs at user logon, and select Edit.

  7. Select Enabled | Show and enter the applications you want to run when a user logs in, select OK, then OK again. You must use the full path to the application.

  8. Restart the computer for the applied group policy to complete the installation.

    On Demand Migration Desktop Update Agent will now open automatically when the user logs in.

Deploying the agent using Microsoft Endpoint Configuration Manager (MECM)

For more details on MECM see Microsoft's documentation.

NOTE: Before continuing, ensure that:

  • MECM / Configuration Manager is pre-configured for the environment and is functioning properly.

  • Distribution points are configured.

  1. Open the pre-configured Microsoft Configuration Manager.

  2. From the left navigation menu, select Software Library.

  3. Expand Application Management, right-click and select Create Application.

  4. In the Create Application Wizard, under Location specify the shared location of the ODM_DesktopUpdateAgent.msi, and click Next.

  5. Review the imported application information, and click Next.

  6. Specify the Installation program by entering: 
    msiexec /qb /i "ODM_DesktopUpdateAgent.msi" PASSPHRASE="MyPassphrase" TOKEN="MY_Valid_Token" /q
    (replace “MyPassphrase” and “My_Valid_Token” with the values from On Demand Migration), and click Next.

  7. Review the Summary and confirm the settings by selecting Next.

  8. Review the Completion details and click Close.

  9. The On Demand Migration Desktop Update Agent will now be displayed in the application library.

  10. Right-click the application and select Properties. Select how you want the application to display in the Software Center, and click OK.

  11. Right-click the new application registration and select Deploy. Specify the pre-created workstation collection to which to assign the deployment, and click OK.

  12. In the Deployment Wizard, under General | Content specify the distribution point. and click Next.

  13. Under General | Deployment Settings, specify the settings to control the deployment.

    Setting the Action to Install and the Purpose to Required forces the application to push to the workstation for the required collection.

  14. Under General | Scheduling , specify the schedule for the deployment. and click Next.

  15. Under General | User Experience, optionally specify additional installation settings including how the application will display in the Software Center on the workstation, and click Next.

  16. Under General | Alerts, specify the Configuration Manager and Operation Manager alerting options, and click Next.

  17. Confirm the settings on the Summary page, and click Next.

  18. Click Close to complete the application deployment.

  19. On Demand Migration Desktop Update Agent should now be visible through the Control Panel | Programs and Features, through the Start menu, or an icon in the System Tray.

Deploying the agent using Quest KACE

For more details on KACE see Quest's KACE product information and the KACE Systems Management Appliance Technical Documentation.

NOTE: Before continuing, ensure that:

  • KACE is configured for the environment and is functioning properly.

Within the KACE appliance:

  1. On the side navigation bar, expand Scripting, and choose Scripts.

  2. Under Choose Action, choose New.

  3. Under Script Detail:

    1. Under Configure, provide a friendly Name for the script, e.g., On Demand Migration Desktop Update Agent. Select a Type and a Category. Optionally provide a Description and Notes.

    2. Under Deploy,

      1. Specify the pre-created, desired Labels which will dictate which devices are in scope.

      2. Specify Local System for the Windows Run As option.

      3. Under Operating Systems, select Edit (pencil icon) to specify the OS versions to receive the agent. Uncheck the All check box, and select only those device OSes you wish to target.


        NOTE: This is a good time to review the latest information on OS versions supported by the Desktop Update Agent.

    3. Under User Notify, notification options are available, and optional for the individual project. Often customers prefer to install the agent without end user awareness.

    4. Under Schedule, scheduling options are available, may can be configured for the individual project.

    5. Under Dependencies, indicate the location of the Desktop Update Agent installer.
      The msi can be located on a central share in the network accessible to all machines, or as most prefer, upload the installation .msi to the KACE appliance, from where it will be pushed out. This is easier than using a network share that will require to have access maintained through ACL’s, group memberships etc. Deploying from the KACE appliance directly allows for devices outside the Domain who communicate with KACE itself to also receive the deployment.

    6. Under Tasks, choose Add New Task.

      1. Under Verify,

        1. Choose Launch a Program.Optionally, adjust the attempts and what should happen upon failure.

        2. Specify the Directory where the .msi has been uploaded to on the appliance.

        3. Specify the File location to point to msiexec.exe (by default c:\windows\sytem32\)

        4. Provide the Parameters to install DUA including the required “PassPhrase” and “Token”
          For example: /qb /I “ODM_DesktupUpdateAgent.msi” Passphrase:”MypassPhrase” Token=”MyToken”

    7. Under On Success choose Log message. For Type, chooseStatus, and provide an installation message to log for the KACE administrator's awareness. Choose Save Changes.

  4. Review the completed configuration.

Configuring the Switch Application Task

Which applications are reconfigured by Desktop Update Agent is managed through On Demand Migration's Switch Application tasks.

NOTE:

  • Each application and/or set of users can have its own separate switch application task.
  • Each application reconfiguration status is tracked separately for reporting purposes.

NOTE: If required, you can create custom PowerShell scripts that can run before and/or after the desktop application reconfiguration steps. See Extending DUA with PowerShell scripts.

To configure the switch application task to start the reconfiguration job:

  1. Log in to On Demand.
  2. Navigate to Migration and select the required project.
  3. Under Accounts, select the Desktop Agents tab.
  4. Select one or more users with a successful mail and OneDrive migration.
  5. Choose Switch Applications.
    1. Under Start, select an existing task template if desired. If no changes to the chosen template are needed, select Go to Summary step.

      NOTE: To use templates in DUA, the On Demand Migration administrator for DUA must have at least these two roles assigned:

      • Manage Desktop Update Agent

      • Run provision and migration tasks

    2. Under App Update Scope, select the applications to update and select Next.
      • Ensure your choice of Microsoft 365 Office Activation, Outlook Application, OneDrive Application, and Teams Application are selected.

        Caution: Migrate Signature is a legacy setting that will not work with Microsoft 365 roaming signatures.
    3. You can optionally configure custom scripts to run before and/or after the desktop application reconfiguration. See Extending DUA with PowerShell scripts for script deployment details. To use PowerShell scripts, under PowerShell, select:
      • Whether to run the script at the start or end of the reconfiguration process or both. Once selected, further specify:

      • For pre configuration scripts, select whether to proceed with the reconfiguration if the script fails;

      • For post configuration scripts, select whether to proceed with running the script if the reconfiguration fails.

      • For both types of scripts, specify:

        • Whether to run the script for every reconfiguration.

        • Whether to run the script as the local system account or as the logged in user. (If run as the logged in user, they must be permitted to run scripts, and the PowerShell script execution policy must be set to allow scripts as well.)

    4. Under Refresh, you can choose to select to refresh account before running the switch task. This is important when Switching Applications in a Domain Move Scenario.
    5. Under Custom Domain, you have the option to specify a domain to use for switch application tasks. This is necessary when the DNS domain is moving at the same time as the users but is not being set as the primary SMTP address in the target tenant. When a custom domain is specified, the Desktop Update Agent checks for Switch Tasks matching the user’s current source domain, the user’s current target domain, and the custom domain. This is recommended for domain move scenarios that do not update the target identity.
    6. Under Validation, you can choose to Skip mailbox state validation and Skip OneDrive state validation if needed. (This is not normally recommended, except in the case of a Domain Move. However, it may be required if mailbox or OneDrive migration takes place outside of On Demand Migration.)
    7. Under Notifications, select to send the email notification (with the required authentication steps for users) to the source or the new target, and select Next. See Managing User Notifications for details on customizing the user notifications.
    8. Administrators have the flexibility to decide when they want users to reconfigure their desktop applications. Under Schedule, select when you want the switch application to run, and select Next.
    9. Caution: Migration administrators should schedule Switch Applications tasks so that they are not run until prerequisite migration project steps have been completed and their help desk is ready to support users, if necessary.
    10. Under Summary, review the Switch Applications Task settings and select Finish.

Once the Switch Applications task is completed, On Demand Migration reports each application reconfiguration status as “Waiting”. This means that the task is pending the user running the Desktop Update Agent. For a complete list of possible states, see Monitoring the Switch Application Status.

 

Switching Applications in a Domain Move Scenario

When performing a tenant-to-tenant migration that includes a domain move, On Demand Migration needs to refresh the source and target usernames and email addresses after the domain move to ensure that the Desktop Update Agent works as expected.

To use the Desktop Update Agent after moving a domain from one tenant to another:

  1. Complete the Domain Move

  2. Confirm that the updated usernames and email addresses are shown in the source and target tenants

  3. Run Refresh All Discovered Accounts task to refresh source and target usernames and email addresses

  4. Run the New Switch Applications Task wizard. Select the options to Skip mailbox state validation and Skip OneDrive state validation if the account migration states were reset to Matched.

NOTE: When configuring the Switch Application Task, you have the option to specify a custom domain. This is necessary when the DNS domain is moving at the same time as the users but is not being set as the primary SMTP address in the target tenant.

When a custom domain is specified, the Desktop Update Agent checks for Switch Tasks matching the user’s current source domain, the user’s current target domain, and the custom domain. This is recommended for domain move scenarios that do not update the target identity.

Managing User Notifications

Notification emails with detailed instructions for the application switch process can be sent to users at either their original (source) mailboxes or their new (target) mailboxes.

To customize the default notification messages, choose User Notifications. The Message body can be customized using a limited set of markup tags. Like HTML tags, these tags are used in pairs, as an open and close marker, and transform the text between those markers. The tags are converted to the corresponding formatting when the notification is sent. Users will not see the markup tags in their email. Available tags are:

  • [b]This is bold text[/b] which produces This is bold text in the notification. This is useful for paragraph headings.

  • [i]This is italicized text[/i] which produces This is italicized text in the notification. This is useful for emphasis.

  • [u]This is underlined text[/u] which produces This is underlined text in the notification.

  • [a(url)custom link][/a] is an 'anchor tag' set used to include hyperlinks in the notification. [a] and [/a] are used to delimit the link element, like the other tag pairs above. Unlike the other tags, though, the open anchor tag element has sub-elements inside it (before the closing ] character) that specify the hyperlink elements:

    • (url) contains the Universal Resource Locator, also known as the hyperlink address, or simply 'link'. The parentheses that surround the url are required. For example, (https://www.quest.com) links to the Quest Software web site.

      NOTE: If your URL contains parentheses or certain other special characters, you will have to encode those characters using web encoding, a.k.a. character or percent encoding. For example, use %28 and %29 in place of open and close parenthesis characters if these occur within your chosen URL.

      NOTE: For security and compliance reasons, query string parameters (the ? character and any following characters) are not permitted in URLs for user notification messages.

    • custom link is the human readable text to display to the user in the notification.
    • All elements are required in the given order. A complete example of a formatted hyperlink is [a(https://www.quest.com)Quest Software][/a] which produces Quest Software in the notification email. Broken down it looks like this:
      Open anchor tag and
      open parenthesis
      URL Closing parenthesis
      after URL
      Display text End of open anchor tag
      and close anchor tag
      [a( https://www.quest.com ) Quest Software ][/a]
      Caution: Pay close attention to the placement of the closing ] character from the open anchor tag. It occurs after the end of the display text string.
関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択