Robocopy Explained

Robocopy
Other Names:Robust File Copy for Windows
Developer:Microsoft
Operating System:Windows NT 4 and later
Included With:Windows Vista and later
Genre:Command
License:Freeware

Robocopy is a command-line file transfer utility for Microsoft Windows. Robocopy is functionally more comprehensive than the COPY command and XCOPY, but replaces neither. Created by Kevin Allen[1] and first released as part of the Windows NT 4.0 Resource Kit, it has been a standard feature of Windows since Windows Vista and Windows Server 2008.

Features

Robocopy provides features not found in the built-in Windows COPY and XCOPY commands, including the following:

Compression

Since Windows Server 2019 and Windows 10, Robocopy supports SMB compression for transferring files across a network. If the /compress is specified, the destination computer supports SMB compression, and the files being copied are compressible, the operation enjoys significant performance improvements. The SMB compression adds inline whitespace compression to file transfers. Compression is also available with the [[XCOPY]] command and Hyper-V live migration with SMB.[7] [8]

Examples of use

Here are some examples of usage, which is not case-sensitive. If more than one option is specified, they must be separated by spaces.

Example 1
  • Copy directory contents of the source to the destination (including file data, attributes and timestamps), recursively with empty directories (/E):

    Robocopy "C:\Directory A" "C:\Directory B" /E

    If directory names have non-standard characters, such as spaces, they must be enclosed in double quotes, as is usual in the command line.

    Example 2
  • Copy directory recursively (/E), copy all file information (/COPYALL, equivalent to /COPY:DATSOU, D=Data, A=Attributes, T=Timestamps, S=Security=NTFS ACLs, O=Owner info, U=Auditing info), do not retry locked files (/R:0) (the number of retries on failed copies default value is 1 million), preserve original directories' Timestamps (/DCOPY:T - requires version XP026 or later):

    Robocopy C:\A C:\B /COPYALL /E /R:0 /DCOPY:T

    Example 3
  • Mirror A to B, destroying any files in B that are not present in A (/MIR), copy files in resume mode (/Z) in case network connection is lost:

    Robocopy C:\A \\backupserver\B /MIR /Z

    For the full reference, see the Microsoft TechNet Robocopy page.[9]

    Syntactic focus on copying folders

    Robocopy syntax is markedly different from its predecessors (copy and xcopy), in that it accepts only folder names, without trailing backslash, as its source and destination arguments. File names and wildcard characters (such as * and ?) are not valid as source or destination arguments; files may be selected or excluded using the optional "file" filtering argument (which supports wildcards) along with various other options.[10]

    For example, to copy two files from folder c:\bar to c:\baz, the following syntax is used:

    robocopy c:\bar c:\baz file1.txt file2.db

    And to copy all PDF files from c:\bar to c:\baz:

    robocopy c:\bar c:\baz *.pdf

    The files named are copied only from the folder selected for copying; fully qualified path names are not supported.

    CAUTION: A long-standing issue with Robocopy means that if you back up from the root folder of a drive [e.g., {{code|robocopy d:\ b:\d-backup\ ....}}], the destination files will be given attributes including SH. This means that they will be invisible to normal access (including DIR in cmd.exe). To fix this, add to the robocopy command line - or do an ATTRIB command to remove them afterwards.

    Output

    Robocopy outputs to the screen, or optionally to a log file, the names of all the directories it encounters, in alphabetical order. Each name is preceded by the number of files in the directory that fulfill the criteria for being copied. If the directory does not yet exist in the target, it is marked "New Dir"; if the directory is empty and the /E option is not used, or it contains no files meeting the criteria, a new directory will not be created.

    If the /NFL (no file names in log) option is not used, the files being copied will be listed after the name of the directory they are in.

    At the end of the output is a table giving numbers of directories, files, and bytes. For each of these, the table gives the total number found in the source, the number copied (including directories marked "New Dir" even if they are not copied), the number skipped (because they already exist in the target), and the number of mismatches, FAILED, and extras. "Failed" can mean that there was an I/O error that prevented a file being copied, or that access was denied. There is also a row of time taken (in which the time spent on failed files seems to be in the wrong column).

    Bandwidth throttling

    Robocopy's "inter-packet gap" (IPG) option allows some control over the network bandwidth used in a session. In theory, the following formula expresses the delay (in milliseconds) required to simulate a desired bandwidth (in kilobits per second), over a network link with an available bandwidth of kbps:

    D={BA-BD\overBA x BD} x 512 x 1000

    In practice however, some experimentation is usually required to find a suitable delay, due to factors such as the nature and volume of other traffic on the network. The methodology employed by the IPG option may not offer the same level of control provided by some other bandwidth throttling technologies, such as BITS (which is used by Windows Update and BranchCache).

    Limitations

    GUI

    Although Robocopy itself is a command-line tool, Microsoft TechNet provided a GUI front-end called Robocopy GUI. It was developed by Derk Benisch, a systems engineer with the MSN Search group at Microsoft, and required .NET Framework 2.0.[17] It included a copy of Robocopy version XP026. It is no longer available from Microsoft, but may be downloaded from the Internet Archive's Wayback Machine.[18]

    There are non-Microsoft GUIs for Robocopy:

    Ken Tamaru of Microsoft developed a copying program with functionality similar to Robocopy, called RichCopy, this was discontinued in 2010. It is not based on Robocopy, and does not require .NET Framework.[25]

    Versions

    All versions of Robocopy store their version number and release date in their executable file header, viewable with File Explorer or PowerShell. Some of them (not all) report their version numbers in their textual output.

    Product version File version Year Bundled with
    1.541996 Windows NT 4.0 Resource Kit
    1.701997 Windows NT Resource Kit
    1.714.0.1.71 1997 Windows NT Resource Kit
    1.954.0.1.95 1999 Windows 2000 Resource Kit
    1.964.0.1.96 1999 Windows 2000 Resource Kit
    XP0105.1.1.1010 2003 Windows 2003 Resource Kit
    XP0265.1.2600.26 2005 Robocopy GUI v.3.1.2
    XP0275.1.10.1027 2008 Windows Vista, Server 2008, 7, 2008 R2
    6.16.1.7601 2009 KB2639043
    Windows 8 and later, Windows Server 2012 and later

    See also

    External links

    Notes and References

    1. Web site: AMA with Dave Plummer, creator of Task Manager . Reddit.com . 18 December 2020. 19 December 2020.
    2. Web site: Robocopy.exe - Robust File Copy Utility - Version XP010 . . 2003 . Backup mode copies [...] enable you to copy some files as a Backup Operator that you would not be able to copy as a normal user. .
    3. Web site: Default groups . Microsoft . Backup Operators [...] Members of this group can back up and restore all files [...], regardless of their own individual permissions on those files. .
    4. Web site: Robocopy XP010 FAQ. Lewis. Dick. 15 November 2004. Windows IT Pro. Penton Media. 2. https://web.archive.org/web/20121009110523/http://www.windowsitpro.com/content1/topic/robocopy-xp010-faq/catpath/migration/page/2. 9 October 2012. dead.
    5. Web site: Holliday . Grant . Multi-threaded robocopy for faster copies . Grant Holliday's Blog . . https://web.archive.org/web/20180813013804/https://blogs.msdn.microsoft.com/granth/2009/12/07/multi-threaded-robocopy-for-faster-copies/ . 13 August 2018 . 7 December 2009 . dead.
    6. Web site: Return codes that are used by the Robocopy utility in Windows Server 2008 or Windows Server 2008 R2 . Windows Server troubleshooting . . . 23 February 2023 . Han . Liang . Lucy . Zou . Simonx . Xu.
    7. Web site: RoboCopy supports Copying Files over SMB with Compression on Windows Server 2019, and beyond . Sander . Berkouwer . dirteam.com . 7 September 2020. 14 February 2021 .
    8. Web site: SMB Compression Lowers Bandwidth and Improves Copy Times in Windows Server and Azure. Smith . Russell . Petri . 27 November 2020 .
    9. Web site: Robocopy . Microsoft Technet . 7 June 2020.
    10. Web site: Robocopy . Microsoft Docs . . 14 January 2019 . 31 October 2016.
    11. Web site: CreateFile function . Windows App Development . . Microsoft . FILE_SHARE_READ [...] Enables subsequent open operations on a file or device to request read access. Otherwise, other processes cannot open the file or device if they request read access..
    12. Web site: ShadowSpawn . Craig Andera . ShadowSpawn.exe is an open source MIT licensed tool that creates and manages shadow copies. . 2015-07-14.
    13. Web site: Diskshadow . Microsoft TechNet . DiskShadow.exe is a tool that exposes the functionality offered by the Volume Shadow Copy Service (VSS). . 2013-03-06.
    14. Web site: Microsoft's Robocopy compromise. 2008-08-04. ZDNet. https://web.archive.org/web/20100317020028/http://www.zdnet.com.au/blogs/snorage/soa/Microsoft-s-Robocopy-compromise/0,2000064373,339291041,00.htm. March 17, 2010. dead. 2012-11-11.
    15. Web site: Ugly bug in Robocopy - ignoring security on file level - Martin Zugec blog. 2008-03-03. Msmvps.com. 2012-11-11.
    16. Web site: Robocopy's /MT option disables /NP option. 2009-12-13. Microsoft TechNet. 2014-02-26.
    17. News: Joshua Hoffman. Utility Spotlight Robocopy GUI. TechNet Magazine. Microsoft Corporation and CMP Media, LLC. November 2006. 2008-07-17 .
    18. Web site: Is Microsoft's Robocopy GUI still available . Windows TenForums . 2 May 2022.
    19. Web site: Rose . Darren . PC Assist Software - RoboCopy GUI . 2024-03-08 . www.pcassistsoftware.co.uk.
    20. Web site: Cinchoo's ChoEazyCopy . Cinchoo . GitHub . 11 March 2022 .
    21. Web site: Easy RoboCopy . TribbleSoft . 2022-05-02.
    22. Web site: WinRoboCopy - UpWay2Late.com Software . Upway2late.com . 2012-11-11.
    23. Web site: RoboCop RoboCopy . turnssoft . SourceForge . 10 September 2015 .
    24. Web site: SH-RoboCopy GUI . SH-Soft . 2012-11-23.
    25. News: Hoffman . Joshua . November 2006 . Free Utility: RichCopy, an Advanced Alternative to RoboCopy . 2008-07-17 . TechNet Magazine . Microsoft Corporation and CMP Media, LLC.