RobocopyPS

Description

RobocopyPS is a PowerShell module with the intention to be a wrapper for Robocopy.exe and output Robocopys information to PowerShell streams (Verbose, Error etc).

RobocopyPS only works if the language is set to en-US. This is because we look at each line of output from Robocopy and make a decision on what stream to use. If the language is not english we are not sure what to do.

If we do not know what stream to output to we use the Information stream, so if you are missing output try and run with -InformationAction Continue

You can use all Robocopys native parameters like -e, -mir etc but we try and translate them to easier parameter names as -Recurse and -Mirror instead.

Getting started

The easiest way to get RobocopyPS is using the PowerShell Gallery!

Installing the module

PS> Install-Module -Name RobocopyPS

Example: Copy with Recurse

PS > Invoke-RoboCopy -Source "E:\Google Drive\Script Library" -Destination G:\Temp\ -Recurse  -Unit Bytes

Source              : E:\Google Drive\Script Library
Destination         : G:\Temp\
Command             : Robocopy.exe "E:\Google Drive\Script Library" "G:\Temp" *.* /r:3 /w:3 /e /bytes /TEE /np /njh /fp /v /ndl /ts
DirCount            : 589
FileCount           : 1220
DirCopied           : 588
FileCopied          : 1220
DirIgnored          : 1
FileIgnored         : 0
DirMismatched       : 0
FileMismatched      : 0
DirFailed           : 0
FileFailed          : 0
DirExtra            : 0
FileExtra           : 1
TotalTime           : 00:00:02
StartedTime         : 7/16/2019 10:03:28 PM
EndedTime           : 7/16/2019 10:03:30 PM
TotalSize           : 18839977 B
TotalSizeCopied     : 18839977 B
TotalSizeIgnored    : 0 B
TotalSizeMismatched : 0 B
TotalSizeFailed     : 0 B
TotalSizeExtra      : 557048280 B
Speed               : 12957343 B/s
ExitCode            : 3
Success             : True
LastExitCodeMessage : [SUCCESS]Some files were copied. Additional files were present. No failure was encountered.

How RobocopyPS handle native Robocopy errors

In this example we try to use the -Backup parameter (/B) without having permission to do so. Invoke-Robocopy, at the moment, do not know if it should be a terminating or a non terminating error in PowerShell, so it will throw all errors it can find as non terminating and continue.

PS$ > Invoke-RoboCopy -Source "C:\Users\Simon\Downloads\" -Destination NULL -List -Recurse -Verbose -BackupMode                                                                                                                                                    VERBOSE: Performing the operation "List" on target "NULL from C:\Users\Simon\Downloads\".
Invoke-RoboCopy : ERROR : You do not have the Backup and Restore Files user rights.. *****  You need these to perform Backup copies (/B or /ZB).
At line:1 char:1
+ Invoke-RoboCopy -Source "C:\Users\Simon\Downloads\" -Destination NULL ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Invoke-RoboCopy], Exception
    + FullyQualifiedErrorId : Invoke-RoboCopy

Invoke-RoboCopy : ERROR : Robocopy ran out of memory, exiting.. ERROR : Invalid Parameter #%d : "%s"
At line:1 char:1
+ Invoke-RoboCopy -Source "C:\Users\Simon\Downloads\" -Destination NULL ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Invoke-RoboCopy], Exception
    + FullyQualifiedErrorId : Invoke-RoboCopy

Invoke-RoboCopy : ERROR : Invalid Job File, Line #%d :"%s". Started : %s %s
At line:1 char:1
+ Invoke-RoboCopy -Source "C:\Users\Simon\Downloads\" -Destination NULL ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : NotSpecified: (:) [Invoke-RoboCopy], Exception
    + FullyQualifiedErrorId : Invoke-RoboCopy


Source              : C:\Users\Simon\Downloads\
Destination         : NULL
Command             : Robocopy.exe "C:\Users\Simon\Downloads" "NULL" *.* /r:3 /w:3 /e /b /l /bytes /TEE /np /njh /fp /v /ndl /ts
DirCount            : 0
FileCount           : 0
DirCopied           : 0
FileCopied          : 0
DirIgnored          : 0
FileIgnored         : 0
DirMismatched       : 0
FileMismatched      : 0
DirFailed           : 0
FileFailed          : 0
DirExtra            : 0
FileExtra           : 0
TotalTime           : 00:00:00
StartedTime         : 7/16/2019 10:21:53 PM
EndedTime           : 7/16/2019 10:21:53 PM
TotalSize           : 0 B
TotalSizeCopied     : 0 B
TotalSizeIgnored    : 0 B
TotalSizeMismatched : 0 B
TotalSizeFailed     : 0 B
TotalSizeExtra      : 0 B
Speed               : 0 B/s
ExitCode            : 16
Success             : False
LastExitCodeMessage : [ERROR]Robocopy did not copy any files. Either a usage error or an error due to insufficient access privileges on the source or destination directories.

Release History

A detailed release history is contained in the Change Log.

License

RobocopyPS is provided under the MIT license.