Copy-ADTFile
SYNOPSIS
Copies files and directories from a source to a destination.
SYNTAX
Copy-ADTFile [-Path] <String[]> [-Destination] <String> [-Recurse] [-Flatten] [-ContinueFileCopyOnError]
[-FileCopyMode <String>] [-RobocopyParams <String>] [-RobocopyAdditionalParams <String>] [<CommonParameters>]
DESCRIPTION
Copies files and directories from a source to a destination. This function supports recursive copying, overwriting existing files, and returning the copied items.
EXAMPLES
EXAMPLE 1
Copy-ADTFile -Path 'C:\Path\file.txt' -Destination 'D:\Destination\file.txt'
Copies the file 'file.txt' from 'C:\Path' to 'D:\Destination'.
EXAMPLE 2
Copy-ADTFile -Path 'C:\Path\Folder' -Destination 'D:\Destination\Folder' -Recurse
Recursively copies the folder 'Folder' from 'C:\Path' to 'D:\Destination'.
EXAMPLE 3
Copy-ADTFile -Path 'C:\Path\file.txt' -Destination 'D:\Destination\file.txt'
Copies the file 'file.txt' from 'C:\Path' to 'D:\Destination', overwriting the destination file if it exists.
EXAMPLE 4
Copy-ADTFile -Path "$($adtSession.DirFiles)\*" -Destination C:\some\random\file\path
Copies all files within the active session's Files folder to 'C:\some\random\file\path', overwriting the destination file if it exists.
PARAMETERS
-Path
Path of the file to copy. Multiple paths can be specified.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Destination
Destination Path of the file to copy.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Recurse
Copy files in subdirectories.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Flatten
Flattens the files into the root destination directory.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ContinueFileCopyOnError
Continue copying files if an error is encountered. This will continue the deployment script and will warn about files that failed to be copied.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-FileCopyMode
Select from 'Native' or 'Robocopy'. Default is configured in config.psd1. Note that Robocopy supports * in file names, but not folders, in source paths.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RobocopyParams
Override the default Robocopy parameters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: /NJH /NJS /NS /NC /NP /NDL /FP /IS /IT /IM /XX /MT:4 /R:1 /W:1
Accept pipeline input: False
Accept wildcard characters: False
-RobocopyAdditionalParams
Append to the default Robocopy parameters.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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
You cannot pipe objects to this function.
OUTPUTS
None
This function does not generate any output.
NOTES
An active ADT session is NOT required to use this function.
Tags: psadt
Website: https://psappdeploytoolkit.com
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
License: https://opensource.org/license/lgpl-3-0
RELATED LINKS
https://psappdeploytoolkit.com/docs/reference/functions/Copy-ADTFile