Logo

Documentation home for Transend tools

Copy-GOUserDrive

SYNOPSIS

Copies a user drive in a Google Workspace tenant or Google consumer account to a user drive in another tenant or consumer account.

SYNTAX

Action (Default)

Copy-GOUserDrive -Target <String> [-TranslationCsv <String>] [-SourceFolder <String>] [-TargetId <String>]
 [-TargetFolder <String>] [-IncludePattern <String>] [-DryRun] [-SharedWithMe] [-SkipUnowned] [-NoCache]
 [-Verbosity <String>] [<CommonParameters>]

Help

Copy-GOUserDrive [-ShowPrereqs] [<CommonParameters>]

DESCRIPTION

Use the Copy-GOUserDrive cmdlet to copy a user drive in a Google Workspace tenant or Google consumer account 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).

Note that you will need to log into both the source and target accounts using two separate browser authentication flows.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Copy Google consumer drive to Google consumer drive

Description

This example copies a Google consumer drive to a Google consumer drive.

Tenant configuration

No tenant configuration is required.

TMCTools

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

Copy-GOUserDrive -Target Google

Example 2: Copy Google consumer drive to Microsoft consumer drive with permissions

Description

This example copies a Google consumer 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.

  • Using Rclone.IncludeMetadata and -TranslationCsv propagates permissions.

Tenant configuration

No tenant configuration is required.

Translation CSV format

SourceName TargetName
user1@source.org user1@target.org
user2@source.org user2@target.org
source.org target.org

TMCTools

@{
  Source = @{}
  Target = @{}
  Rclone = @{
    IncludeMetadata = $true
  }
}

Copy-GOUserDrive -Target M365 -SourceFolder 'Migration' -TargetFolder 'Migration' -TranslationCsv 'translations.csv'

Example 3: Copy Google Workspace tenant drive to Microsoft 365 tenant drive

Description

This example copies a Google Workspace tenant drive to a Microsoft 365 tenant drive.

Tenant configuration

No tenant configuration is required.

TMCTools

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

Copy-GOUserDrive -Target M365

Example 4: Copy Google consumer drive to Windows filesystem drive

Description

This example copies a Google consumer 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 = @{}
}

Copy-GOUserDrive -Target Windows -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

-SharedWithMe

Shared with me files are omitted by default. Use -SharedWithMe to include them. Note that this option means that only Shared with me files are considered.

This option only applies to Google Workspace.

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

-SkipUnowned

Files the user does not own are included by default. Use -SkipUnowned to exclude them.

This option only applies to Google Workspace.

Type: SwitchParameter
Parameter Sets: Action
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

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

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 Copy-GOUserDrives instead.

TMCTools configuration options