See the help documentation for individual TMCTools cmdlets for usage examples. You can see a list of available cmdlets by running Get-Command -Module TMCTools.

CONFIG

To use TMCTools, you’ll need a TMCTools license key. The key must be added to TMCTools.psd in the General.LicenseKey variable.

You may need to add configuration information to C:\ProgramData\Transend\tools\config.psd1. A cmdlet’s doc page contains examples that show required configurations specific to that cmdlet. However, some options are general and apply to any cmdlet. Those options are defined in this section.

Note that options are tied to a configuration node, which are the top-level keys in the PowerShell data file. For example:

@{
  General = @{}
  Rclone  = @{}
  Source  = @{}
  Target  = @{}
}

In this example, the top-level keys are General, Rclone, Source and Target. Options belong to one or more of these keys and should be set as sub-keys within their top-level key. For a hypothetical option General.Foo, the config.psd1 file would look like this:

@{
  General = @{
    Foo = $true
  }
  Rclone  = @{}
  Source  = @{}
  Target  = @{}
}

It is not necessary to include a top-level key that does not contain any options, though doing so is harmless.

General options

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

LicenseKey: The TMCTools license key.
PageSize: The maximum number of records to fetch per API request.

Default: 100
PruneAfterDays: The number of days after which logs will be deleted.

Default: 0 (never delete)
StageIntermissionSeconds: The number of seconds to pause between stages for staged tools.

Default: 600
UseLocalCache: Use local cache files from a previous run instead of dynamically building the cache at runtime.

Default: $false

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

ApiRetries: The number of times Rclone should attempt a low-level API operation before failing.

Default: 2
ChunkedUploadThreshold: The size above which transfers will switch to chunked operations. Note that this needs to be set in SizeSuffix notation. For example, to use chunked operations above 100 KiB, set the value to 100Ki.

Default: Rclone default
IncludeDanglingShortcuts: Determines whether or not Rclone will consider dangling shortcuts, which are shortcuts that point to items that no longer exist. Only applies to Google Workspace.

Default: $false
IncludeLabels: Determines whether or not Rclone will fetch labels. Note that this requires an additional API call per file and can increase processing time significantly. Only applies to Google Workspace.

Default: $false
IncludeShared: Determines whether or not Rclone will consider shared folders. Only applies to Dropbox.

Default: $false
IncludeShortcuts: Determines whether or not Rclone will consider shortcuts. Before enabling this, be sure you understand the implications. Only applies to Google Workspace.

Default: $false
IncludeUnowned: Determines how to handle unowned folders, files and permissions. Set to $false to exclude them or $true to include them.

Default: $false
LogFormat: Determines the type of logging Rclone uses. Options are text for human-friendly logging and json for machine-friendly logging. Note that in-flight reporting requires JSON logs.

Default: 'json'
PollingSeconds: Determines how often (in seconds) in-flight reporting will be printed. Note that this option requires running jobs in the background.

Default: 5
Retries: The number of times Rclone should attempt a high-level operation before failing. Field testing has shown that increasing this value only delays how long it takes to produce a failure because Rclone will cycle through the drive multiple times to attempt to pick up failures from the previous retry. In most cases, those failures will simply fail again, so the default option allows reaching the final stage faster.

Default: 1
RunInForeground: Determines whether or not Rclone jobs will run in the foreground instead of running in the background. Note that running jobs in the foreground precludes in-flight reporting.

Default: $false
SkipChecksumValidation: Determines whether or not Rclone will skip checksum comparisons after transfers.

Default: $false
SkipGoogleDocs: Determines whether or not Rclone will consider Google Workspace’s proprietary document types like Docs and Sheets. Only applies to Google Workspace.

Default: $false
SkipMapperLogging: Determines whether or not mapper logs will be generated. Troubleshooting mapping issues requires mapper logging, but it introduces a performance penalty.

Default: $false
SkipSizeValidation: Determines whether or not Rclone will skip size comparisons when evaluating files.

Default: $false
StopOnThrottling: Determines whether or not a job will be stopped if source or target throttling is detected.

Default: $false
Threads: The number of Rclone threads to use for parallel processing. Note that increasing this also increases the likelihood of throttling.

Default: 8
TransactionsPerSecondLimit: The number of transactions Rclone is allowed to perform per second. By default, Rclone is not capped and will attempt as many transactions as the underlying hardware and network will allow. This option can be used to limit the number of transactions to avoid throttling.

Default: Rclone default
UseChecksumEquality: Determines whether or not Rclone will compare files using checksums and sizes ($true) or just sizes.

Default: $false
UseFastList: Determines whether or not Rclone will use a recursive directory listing for supported platforms. This can potentially increase read performance at the cost of more memory.

Default: $true
UseQuotaSize: Determines whether or not Rclone will report files with their quota size, which includes the file and additional versions. Only applies to Google Workspace.

Default: $false

PROXY SUPPORT

To use TMCTools with a proxy server, set the following environment variables:

$env:TRANSEND_PROXY_URI
$env:TRANSEND_PROXY_USERNAME
$env:TRANSEND_PROXY_PASSWORD