Logo

Documentation home for Transend tools

Copy-WINUserDrives

SYNOPSIS

Copies user drives in a Windows filesystem to user drives in another tenant.

SYNTAX

Help (Default)

Copy-WINUserDrives -Target <String> [-ShowPrereqs] [<CommonParameters>]

Action

Copy-WINUserDrives -Target <String> -Csv <String> [-TranslationCsv <String>] [-SourceFolder <String>]
 [-TargetFolder <String>] [-IncludePattern <String>] [-DryRun] [-Verbosity <String>]
 [<CommonParameters>]

DESCRIPTION

Use the Copy-WINUserDrives cmdlet to copy user drives in a Windows filesystem to user drives in another tenant.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Copy Windows filesystem drives to Google Workspace tenant drives

Description

This example copies pairs of Windows filesystem and Google Workspace tenant drives listed in user_drives.csv.

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A
Google Workspace Target Google Drive https://www.googleapis.com/auth/drive

CSV format

SourceId TargetId
C:\Drives\user@source.org user@target.org

TMCTools

@{
  Source = @{}
  Target = @{
    GOAdmin             = 'admin@target.org'
    GOServiceAccountKey = 'C:\ProgramData\Transend\tools\target.org.json'
  }
}

Copy-WINUserDrives -Csv 'user_drives.csv' -Target Google

Example 2: Copy Windows filesystem drives to Microsoft 365 tenant drives

Description

This example copies pairs of Windows filesystem and Microsoft 365 tenant drives listed in user_drives.csv.

Additional parameters change the basic functionality shown in Example 1:

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

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A
Microsoft 365 Target Microsoft Graph Files.ReadWrite.All

CSV format

SourceId TargetId
C:\Drives\user@source.org user@target.org

TMCTools

@{
  Source = @{}
  Target = @{
    M365ClientId     = '66666666-7777-8888-9999-000000000000'
    M365ClientSecret = 'mnoPqRstuv1wXy23ZaBcDeFGhi4JkLmNO5PqrsTUvWX='
    M365Tenant       = 'target.org'
  }
}

Copy-WINUserDrives -Csv 'user_drives.csv' -Target M365 -SourceFolder 'Migration' -TargetFolder 'Migration'

Example 3: Copy Windows filesystem drives to Windows filesystem drives

Description

This example copies pairs of Windows filesystem and Windows filesystem drives listed in user_drives.csv.

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A
Windows filesystem Target N/A N/A

CSV format

SourceId TargetId
C:\Drives\user@source.org C:\Drives\user@target.org

TMCTools

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

Copy-WINUserDrives -Csv 'user_drives.csv' -Target Windows

Example 4: Copy Windows filesystem drives to Google Workspace tenant drives with merging

Description

This example uses the TargetFolder CSV field to merge multiple Windows filesystem drives into a single Google Workspace tenant drive.

Tenant configuration

Tenant Direction APIs Scopes
Windows filesystem Source N/A N/A
Google Workspace Target Google Drive https://www.googleapis.com/auth/drive

CSV format

SourceId TargetId TargetFolder
C:\Drives\user1@source.org merged@target.org User1
C:\Drives\user2@source.org merged@target.org User2

TMCTools

@{
  Source = @{}
  Target = @{
    GOAdmin             = 'admin@target.org'
    GOServiceAccountKey = 'C:\ProgramData\Transend\tools\target.org.json'
  }
}

Copy-WINUserDrives -Csv 'user_drives.csv' -Target Google

PARAMETERS

-Csv

The path to a CSV file containing drives to process. See the examples for the required CSV format.

Type: String
Parameter Sets: Action
Aliases:

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

-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

-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.

Note that this parameter is a global option that applies to all drives listed in the CSV file.

This parameter has no effect if the SourceFolder CSV field is set.

Type: String
Parameter Sets: Action
Aliases:

Required: False
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: (All)
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.

Note that this parameter is a global option that applies to all drives listed in the CSV file.

This parameter has no effect if the TargetFolder CSV field is set.

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

TMCTools configuration options