Logo

Documentation home for Transend tools

Move-WINUserDrive

SYNOPSIS

Moves a user drive in a Windows filesystem to a user drive in another tenant or consumer account.

SYNTAX

Action (Default)

Move-WINUserDrive -Target <String> [-TranslationCsv <String>] -SourceId <String> [-SourceFolder <String>]
 [-TargetId <String>] [-TargetFolder <String>] [-IncludePattern <String>] [-DryRun] [-NoCache]
 [-Verbosity <String>] [<CommonParameters>]

Help

Move-WINUserDrive [-ShowPrereqs] [<CommonParameters>]

DESCRIPTION

Use the Move-WINUserDrive cmdlet to move a user drive in a Windows filesystem to a user drive in another tenant or consumer account.

This cmdlet uses an interactive, browser-based authentication flow and is most commonly used when you do not have administrative credentials (e.g., consumer accounts).

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Move Windows filesystem drive to Google consumer drive

Description

This example moves a Windows filesystem drive to a Google consumer drive.

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
  Target = @{}
}

Move-WINUserDrive -Target Google -SourceId 'C:\Drives\user@source.org'

Example 2: Move Windows filesystem drive to Microsoft consumer drive

Description

This example moves a Windows filesystem drive to a Microsoft consumer drive.

Additional parameters change the basic functionality shown in Example 1:

  • Using -SourceFolder and -TargetFolder restricts the operation to the Migration folder.

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
  Target = @{}
}

Move-WINUserDrive -Target M365 -SourceId 'C:\Drives\user@source.org' -SourceFolder 'Migration' -TargetFolder 'Migration'

Example 3: Move Windows filesystem drive to Microsoft 365 tenant drive

Description

This example moves a Windows filesystem drive to a Microsoft 365 tenant drive.

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
  Target = @{
    M365Tenant = 'target.org'
  }
}

Move-WINUserDrive -Target M365 -SourceId 'C:\Drives\user@source.org'

Example 4: Move Windows filesystem drive to Windows filesystem drive

Description

This example moves a Windows filesystem drive to a Windows filesystem drive.

Note that, unlike with other targets, the Windows target takes the full path to a local drive via the -TargetId parameter.

Tenant configuration

No tenant configuration is required.

TMCTools

@{
  Source = @{}
  Target = @{}
}

Move-WINUserDrive -Target Windows -SourceId 'C:\Drives\user@source.org' -TargetId 'C:\Drives\user@target.org'

PARAMETERS

-DryRun

When specified, only log what would happen instead of actually transferring data.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludePattern

A matching pattern to determine which folders and files to include. See https://rclone.org/filtering/ for syntax details.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoCache

Refresh tokens obtained from a prior authentication will be used by default. If you are running different tools that require different permissions or want to log in as a different user, use the -NoCache option to bypass an existing refresh token.

Type: SwitchParameter
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceFolder

Restrict the source-side listing to the specified folder.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceId

The full path to a local drive. For example, C:\Drives\user@source.org.

Type: String
Parameter Sets: Action
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

The target platform. Supported values are Google, M365 and Windows.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Google, M365, Windows

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetFolder

Specifies the name of a top-level folder in the target into which all data will be transferred. The source folder hierarchy is preserved under the specified folder.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TargetId

The full path to a local drive. For example, C:\Drives\user@target.org.

This parameter only applies to the Windows filesystem.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TranslationCsv

The path to a CSV file containing translation mappings. The file must use SourceName;TargetName as the field identifiers.

Note that this parameter has no effect at this time and is reserved for future use.

Type: String
Parameter Sets: Action
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Verbosity

The amount of detail logged during processing.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: None, Normal, Detailed, Diagnostic

Required: False
Position: Named
Default value: Detailed
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Void

NOTES

  • Transend apps are used to generate tokens and are subject to shared throttling. If you can create apps in the source and target tenants, consider using Move-WINUserDrives instead.

TMCTools configuration options