Start-Robocopy.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
<#
.Synopsis
   PowerShell wrapper function for robocopy.
.DESCRIPTION
   PowerShell wrapper function for robocopy.
.NOTES
    Created by: Jason Wasser @wasserja
    Modified: 4/7/2016 11:16:12 AM
 
    Version 1.0
 
.PARAMETER Source
    The source folder you wish to copy.
.PARAMETER Destination
    The destination folder to which you are copying.
.PARAMETER RobocopyPath
    The path to the robocopy binary (exe)
.PARAMETER RobocopyParameters
    Specify the robocopy parameters you wish to you.
 
    robocopy /?
     
-------------------------------------------------------------------------------
   ROBOCOPY :: Robust File Copy for Windows
-------------------------------------------------------------------------------
 
  Started : Thursday, April 7, 2016 11:18:11 AM
              Usage :: ROBOCOPY source destination [file [file]...] [options]
 
             source :: Source Directory (drive:\path or \\server\share\path).
        destination :: Destination Dir (drive:\path or \\server\share\path).
               file :: File(s) to copy (names/wildcards: default is "*.*").
 
::
:: Copy options :
::
                 /S :: copy Subdirectories, but not empty ones.
                 /E :: copy subdirectories, including Empty ones.
             /LEV:n :: only copy the top n LEVels of the source directory tree.
 
                 /Z :: copy files in restartable mode.
                 /B :: copy files in Backup mode.
                /ZB :: use restartable mode; if access denied use Backup mode.
                 /J :: copy using unbuffered I/O (recommended for large files).
            /EFSRAW :: copy all encrypted files in EFS RAW mode.
 
  /COPY:copyflag[s] :: what to COPY for files (default is /COPY:DAT).
                       (copyflags : D=Data, A=Attributes, T=Timestamps).
                       (S=Security=NTFS ACLs, O=Owner info, U=aUditing info).
 
 
               /SEC :: copy files with SECurity (equivalent to /COPY:DATS).
           /COPYALL :: COPY ALL file info (equivalent to /COPY:DATSOU).
            /NOCOPY :: COPY NO file info (useful with /PURGE).
            /SECFIX :: FIX file SECurity on all files, even skipped files.
            /TIMFIX :: FIX file TIMes on all files, even skipped files.
 
             /PURGE :: delete dest files/dirs that no longer exist in source.
               /MIR :: MIRror a directory tree (equivalent to /E plus /PURGE).
 
               /MOV :: MOVe files (delete from source after copying).
              /MOVE :: MOVE files AND dirs (delete from source after copying).
 
     /A+:[RASHCNET] :: add the given Attributes to copied files.
     /A-:[RASHCNET] :: remove the given Attributes from copied files.
 
            /CREATE :: CREATE directory tree and zero-length files only.
               /FAT :: create destination files using 8.3 FAT file names only.
               /256 :: turn off very long path (> 256 characters) support.
 
             /MON:n :: MONitor source; run again when more than n changes seen.
             /MOT:m :: MOnitor source; run again in m minutes Time, if changed.
 
      /RH:hhmm-hhmm :: Run Hours - times when new copies may be started.
                /PF :: check run hours on a Per File (not per pass) basis.
 
             /IPG:n :: Inter-Packet Gap (ms), to free bandwidth on slow lines.
 
                /SL :: copy symbolic links versus the target.
 
            /MT[:n] :: Do multi-threaded copies with n threads (default 8).
                       n must be at least 1 and not greater than 128.
                       This option is incompatible with the /IPG and /EFSRAW options.
                       Redirect output using /LOG option for better performance.
 
 /DCOPY:copyflag[s] :: what to COPY for directories (default is /DCOPY:DA).
                       (copyflags : D=Data, A=Attributes, T=Timestamps).
 
           /NODCOPY :: COPY NO directory info (by default /DCOPY:DA is done).
 
         /NOOFFLOAD :: copy files without using the Windows Copy Offload mechanism.
 
::
:: File Selection Options :
::
                 /A :: copy only files with the Archive attribute set.
                 /M :: copy only files with the Archive attribute and reset it.
    /IA:[RASHCNETO] :: Include only files with any of the given Attributes set.
    /XA:[RASHCNETO] :: eXclude files with any of the given Attributes set.
 
 /XF file [file]... :: eXclude Files matching given names/paths/wildcards.
 /XD dirs [dirs]... :: eXclude Directories matching given names/paths.
 
                /XC :: eXclude Changed files.
                /XN :: eXclude Newer files.
                /XO :: eXclude Older files.
                /XX :: eXclude eXtra files and directories.
                /XL :: eXclude Lonely files and directories.
                /IS :: Include Same files.
                /IT :: Include Tweaked files.
 
             /MAX:n :: MAXimum file size - exclude files bigger than n bytes.
             /MIN:n :: MINimum file size - exclude files smaller than n bytes.
 
          /MAXAGE:n :: MAXimum file AGE - exclude files older than n days/date.
          /MINAGE:n :: MINimum file AGE - exclude files newer than n days/date.
          /MAXLAD:n :: MAXimum Last Access Date - exclude files unused since n.
          /MINLAD:n :: MINimum Last Access Date - exclude files used since n.
                       (If n < 1900 then n = n days, else n = YYYYMMDD date).
 
                /XJ :: eXclude Junction points. (normally included by default).
 
               /FFT :: assume FAT File Times (2-second granularity).
               /DST :: compensate for one-hour DST time differences.
 
               /XJD :: eXclude Junction points for Directories.
               /XJF :: eXclude Junction points for Files.
 
::
:: Retry Options :
::
               /R:n :: number of Retries on failed copies: default 1 million.
               /W:n :: Wait time between retries: default is 30 seconds.
 
               /REG :: Save /R:n and /W:n in the Registry as default settings.
 
               /TBD :: wait for sharenames To Be Defined (retry error 67).
 
::
:: Logging Options :
::
                 /L :: List only - don't copy, timestamp or delete any files.
                 /X :: report all eXtra files, not just those selected.
                 /V :: produce Verbose output, showing skipped files.
                /TS :: include source file Time Stamps in the output.
                /FP :: include Full Pathname of files in the output.
             /BYTES :: Print sizes as bytes.
 
                /NS :: No Size - don't log file sizes.
                /NC :: No Class - don't log file classes.
               /NFL :: No File List - don't log file names.
               /NDL :: No Directory List - don't log directory names.
 
                /NP :: No Progress - don't display percentage copied.
               /ETA :: show Estimated Time of Arrival of copied files.
 
          /LOG:file :: output status to LOG file (overwrite existing log).
         /LOG+:file :: output status to LOG file (append to existing log).
 
       /UNILOG:file :: output status to LOG file as UNICODE (overwrite existing log).
      /UNILOG+:file :: output status to LOG file as UNICODE (append to existing log).
 
               /TEE :: output to console window, as well as the log file.
 
               /NJH :: No Job Header.
               /NJS :: No Job Summary.
 
           /UNICODE :: output status as UNICODE.
 
::
:: Job Options :
::
       /JOB:jobname :: take parameters from the named JOB file.
      /SAVE:jobname :: SAVE parameters to the named job file
              /QUIT :: QUIT after processing command line (to view parameters).
              /NOSD :: NO Source Directory is specified.
              /NODD :: NO Destination Directory is specified.
                /IF :: Include the following Files.
 
::
:: Remarks :
::
       Using /PURGE or /MIR on the root directory of the volume will
       cause robocopy to apply the requested operation on files inside
       the System Volume Information directory as well. If this is not
       intended then the /XD switch may be used to instruct robocopy
       to skip that directory.
 
 
.PARAMETER LogFileName
    The path to the log file for the robocopy results.
.PARAMETER Tee
    Use this parameter if you wish to see tee the output from robocopy
    to the screen as well as the log file.
 
.EXAMPLE
   Start-Robocopy -Source C:\Temp -Destination D:\Temp2
   Starts robocopy from c:\temp to D:\Temp2.
.EXAMPLE
   Start-Robocopy -Source C:\Temp -Destination D:\Temp2 -RobocopyParameters '/E /Z /MIR /COPYALL'
#>

function Start-Robocopy
{
    [CmdletBinding()]
    Param
    (
        [Parameter(Mandatory,
                    Position=0)]
        [string]$Source,

        [Parameter(Mandatory,
                    Position=1)]
        [string]$Destination,

        [string]$IncludeFile = '*.*',
        
        [string]$RobocopyPath = 'c:\Windows\system32\robocopy.exe',
        
        [string]$RobocopyParameter = '/E /Z /MIR /V /NP /R:3 /W:5 /MT',
        
        [string]$LogFileName = "C:\Logs\Start-Robocopy-$(Get-Date -Format 'yyyyMMddhhmmss').log",

        [switch]$Tee = $false
    )

    Begin
    {
        # Turn on verbose
        $VerbosePreference = 'Continue'

        # Start Log
        # Begin Logging
        Add-Content -Value "Beginning $($MyInvocation.InvocationName) on $($env:COMPUTERNAME) by $env:USERDOMAIN\$env:USERNAME" -Path $LogFileName

        $RobocopyParameter = "$RobocopyParameter /LOG+:$LogFileName"
        if ($Tee) {
            $RobocopyParameter = "$RobocopyParameter /TEE"
            }
        
        Write-Verbose "Robocopy Parameters: $RobocopyParameter"

    }
    Process
    {
        
        # Build robocopy command line
        $RobocopyExecute = "$RobocopyPath $Source $Destination $IncludeFile $RobocopyParameter"       
        Write-Verbose "Executing Robocopy Command Line: $RobocopyExecute"
        Add-Content "Executing Robocopy Command Line: $RobocopyExecute" -Path $LogFileName
        Invoke-Expression $RobocopyExecute
        
    }
    End
    {

    }
}