Skip to content

Migrate Workspace

workspaces_migrate_workspace R Documentation

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume

Description

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original ⁠D:\\Users%USERNAME%⁠ user profile folder is renamed to ⁠D:\\Users%USERNAME%MMddyyTHHmmss%.NotMigrated⁠. A new ⁠D:\\Users%USERNAME%\⁠ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

Usage

workspaces_migrate_workspace(SourceWorkspaceId, BundleId)

Arguments

SourceWorkspaceId

[required] The identifier of the WorkSpace to migrate from.

BundleId

[required] The identifier of the target bundle type to migrate the WorkSpace to.

Value

A list with the following syntax:

list(
  SourceWorkspaceId = "string",
  TargetWorkspaceId = "string"
)

Request syntax

svc$migrate_workspace(
  SourceWorkspaceId = "string",
  BundleId = "string"
)