Sync-DBXUserDrive

SYNOPSIS

Use the Sync-DBXUserDrive cmdlet to sync the contents of a single Dropbox user drive.

SYNTAX

Help

Sync-DBXUserDrive
  -Target <String>
  [-ShowPrereqs]
  [<CommonParameters>]

Action

Sync-DBXUserDrive
  -Target <String>
  [-TargetId <String>]
  [-TranslationCsv <String>]
  [-SourceFolder <String>]
  [-TargetFolder <String>]
  [-IncludePattern <String>]
  [-ExcludePattern <String>]
  [-MaxAge <String>]
  [-MinAge <String>]
  [-DryRun]
  [-NoCache]
  [-Verbosity <String>]
  [<CommonParameters>]

DESCRIPTION

Use this cmdlet to sync the contents of a single user drive pair.

See the Examples section for cmdlet requirements.

EXAMPLES

Example 1: Sync contents to Google Workspace user drive

Description

This example syncs the contents of a user drive to a paired user drive in Google Workspace.

Provider configuration

No provider configuration is required.

TMCTools

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

Sync-DBXUserDrive -Target Google

Example 2: Sync contents to Microsoft 365 user drive

Description

This example syncs the contents of a user drive to a paired user drive in Microsoft 365.

Provider configuration

No provider configuration is required.

TMCTools

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

Sync-DBXUserDrive -Target M365

Example 3: Sync contents to filesystem user drive

Description

This example syncs the contents of a user drive to a paired user drive in the local filesystem.

Provider configuration

No provider configuration is required.

TMCTools

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

Sync-DBXUserDrive -Target Windows -TargetId '<DRIVE_PATH>'

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

-ExcludePattern

A matching pattern to determine which folders and files to exclude. Syntax details can be found here.

Type: String
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. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-MaxAge

The maximum age (modified time) of files to include. Syntax details can be found here.

Type: String
Parameter Sets: Action
Aliases:

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

-MinAge

The minimum age (modified time) of files to include. Syntax details can be found here.

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

-Target

The target provider.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Dropbox, 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 when -Target is Windows.

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

Optional config.psd1 keys

These configuration keys are scoped to the Source node in config.psd1.

• DBXClientId: The client ID of your tenant’s app.

• DBXClientSecret: The client secret of your tenant’s app.

These configuration keys are scoped to the Target node in config.psd1.

• DBXClientId: The client ID of your tenant’s app. Only applies to a Dropbox target.

• DBXClientSecret: The client secret of your tenant’s app. Only applies to a Dropbox target.

• GOClientId: The client ID of your tenant’s app. Only applies to a Google Workspace target.

• GOClientSecret: The client secret of your tenant’s app. Only applies to a Google Workspace target.

• M365ClientId: The client ID of your tenant’s app. Only applies to a Microsoft 365 target.

• M365ClientSecret: The client secret of your tenant’s app. Only applies to a Microsoft 365 target.

• M365CloudEnvironment: The cloud environment for your tenant. Allowed values are Global, China (.cn), Germany (.de) and USGovernment (.us). Only applies to a Microsoft 365 target.

  Default: Global

• M365Tenant: The ID of your tenant. For example, target.org. Only applies to a Microsoft 365 target.

Required APIs

See the Examples section for details.

Required scopes

See the Examples section for details.

RELATED LINKS

General configuration options