Migrating Content and Users with the XM to XM Cloud Migration Tool CLI


In my previous blog, I discussed how we can migrate content, media, and users using the XM to XM Cloud Migration Tool – GUI option.

In today’s blog, I’ll walk you through the CLI (Command Line Interface) option, which provides the same functionality but is also ideal for scripting and automation.

Step 1: Configuration Setup

It is very important to use the same configuration settings as in the GUI version, stored in the appsettings.json file.
If needed, you can adjust some values manually. You can also refer to a sample appsettings.json file here.

Key Configurations

RAIFs Configuration

The XM to XM Cloud Migration Tool transfers content and media via RAIFs (batches).

  • The default values in appsettings.json are balanced for most customers.

  • ItemsPerRaif defines the number of items per transfer.

    • Too low → creates too many RAIF files.

    • Too high → may impact transfer speed.

  • MediaSizeLimit defines the maximum media size per RAIF.

    • Must be a long value.


Content Migration Configuration

Ensure proper settings for source and target configuration before executing migration.


Step 2: Explore CLI Options

Navigate to the folder containing the console app and run:

.\XMMigration.exe --help

This will display a list of all available commands.


Step 3: Migrate Content

Run the following command to migrate content:

.\XMMigration.exe content



Step 4: Migrate Users

You have multiple options for migrating users:

  • Retrieve domains from the source instance

    .\XMMigration.exe users --retrieve-domains

  • Migrate users by passing domains (comma separated)

    .\XMMigration.exe users --migrate-userdomains sitecore


This may ask to login to XM Cloud-


Key Points to Remember

  1. This tool can only be used for “as-is” migration.

    • Content cannot be transformed.

    • Content templates cannot be updated.

  2. Templates must be migrated first, followed by content.

  3. Only media items stored in the database can be migrated.

  4. Best suited for migrating a large volume of legacy content to XM Cloud.

Conclusion

The XM to XM Cloud Migration Tool’s CLI option is powerful for automation and large-scale migrations. With proper configuration and sequence, it ensures a smooth transfer of content, media, and users to XM Cloud.

Location: Kolkata, West Bengal, India

Comments

Post a Comment

Popular posts from this blog

Setup New Project in Sitecore XMCloud – Part 1

Image
In my previous blog , I discussed about the XMCloud Introduction and features of XMCloud. In this blog I will show, how to create a new Project and environments in the Sitecore XM cloud. In the next blog, I will show how easily you can set up your local app development for XM Cloud and run the Sitecore XM Cloud project on your development machine. Prerequisites: • You must have one Organization account in Sitecore portal ( https://portal.sitecorecloud.io/ ) which has access to XMCloud.  And your account should be associated with that Organization account with admin access.  • Organization must have proper Sitecore licensing to run the XMCloud site in local docker environments. • Create your own Github account to link with XMCloud project. Steps to setup your project 1. Click on “Manage My projects” menu to open https://deploy.sitecorecloud.io/projects.io/projects site to Create a new project or manage existing one. 2. Then click on “Create New Project” button to cr...
Read more

Step by Step installation of Sitecore 10.3 on Azure PaaS

Image
  In this document we will learn how to setup Sitecore 10.3 XP on Azure PaaS. We shall briefly cover the step by step process and overview of Sitecore 10.3 XP setup. While doing the installation, I follow Deploying a new Sitecore environment to the Microsoft Azure App service . Thanks, Sitecore Team! Prerequisites: To setup Sitecore 10.3 on Azure PaaS, we shall need the following: Check PowerShellGet Module. If not found please install PowerShell Gallery Install the Azure Az PowerShell module. Download Sitecore Azure Toolkit 2.8.0 . This will provide a zip file that can be extracted and used for setup.  Deployment Topologies We will do the setup for Sitecore 10.3 XP. Sitecore XP product edition is the full Sitecore Experience Platform, which includes all Sitecore roles and services, including xConnect. This is a Sitecore Experience Platform configuration that runs: Three Sitecore roles: Content Delivery, Content Management, and Processing, as a single WebA...
Read more

Step by Step installation of Sitecore 10.3 on Docker

Image
  In this document, we will learn how to setup Sitecore 10.3 on docker desktop in Windows 11. We shall briefly cover the step-by-step process and overview of Sitecore 10.3 setup. While doing the installation in my windows, I followed Installation Guide for Developer Workstation with Containers . Thanks, Sitecore Team! Prerequisites - To setup Sitecore 10.3 on docker, we shall need the following - Docker Desktop Installed on Windows Desktop Docker Desktop support for windows containers 16 GB of RAM Approximately 50GB of free disk space for Sitecore container images. SSD storage is highly recommended. The default Sitecore container configuration uses specific ports. To avoid any conflicts, we should ensure the following ports are not being used by another process: 443, 8079, 8081, 8984, and 14330 To check the prerequisites for Sitecore 10.3 installation, please check the below link - Support Information - Sitecore compatibility table for Sitecore XP 9.0 and later Setup Files - Docker...
Read more