Copy-FilesFile

Copy File/Folder.

Syntax

Path (Default)

Copy-FilesFile [-Path] <System.String> -Destination <System.String> [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Copy-FilesFile -Destination <System.String> [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -InputObject <FilesCom.PowerShell.Models.RemoteFile> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoteServer

Copy-FilesFile [-Path] <System.String> [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -RemoteServerId <System.Int64> [-DestinationPath <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

RemoteServerInputObject

Copy-FilesFile [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -RemoteServerId <System.Int64> [-DestinationPath <System.String>] -InputObject <FilesCom.PowerShell.Models.RemoteFile> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Snapshot

Copy-FilesFile [-Path] <System.String> [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -SnapshotId <System.Int64> [-DestinationPath <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

SnapshotInputObject

Copy-FilesFile [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -SnapshotId <System.Int64> [-DestinationPath <System.String>] -InputObject <FilesCom.PowerShell.Models.RemoteFile> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

ChildSite

Copy-FilesFile [-Path] <System.String> [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -ChildSiteId <System.Int64> [-DestinationPath <System.String>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

ChildSiteInputObject

Copy-FilesFile [-CopyBehaviors <System.Boolean>] [-Structure <System.Boolean>] [-Overwrite <System.Boolean>] -ChildSiteId <System.Int64> [-DestinationPath <System.String>] -InputObject <FilesCom.PowerShell.Models.RemoteFile> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Copy File/Folder.

The command accepts files from the pipeline as -InputObject, and uses each one's Path and the connection that fetched it.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Copy File/Folder

Copy-FilesFile -Path 'path' -Destination 'destination'

Writes the file action returned.

Example 2: Act on files from the pipeline

Get-FilesFile -Path 'path' | Copy-FilesFile -Destination 'destination'

Takes the file from the pipeline and uses its Path and connection.

Example 3: Preview the change

Copy-FilesFile -Path 'path' -Destination 'destination' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Path

Path to operate on.

  • Type: System.String
  • Parameter sets: Path (required, position 0), RemoteServer (required, position 0), Snapshot (required, position 0), ChildSite (required, position 0)

-Destination

Copy destination path.

  • Type: System.String
  • Parameter sets: Path (required), InputObject (required)

-CopyBehaviors

If copying a folder, also copy supported behaviors, email notification subscriptions, and per-folder branding to the destination folder tree?

  • Type: System.Boolean
  • Parameter sets: Path, InputObject, RemoteServer, RemoteServerInputObject, Snapshot, SnapshotInputObject, ChildSite, ChildSiteInputObject

-Structure

Copy structure only?

  • Type: System.Boolean
  • Parameter sets: Path, InputObject, RemoteServer, RemoteServerInputObject, Snapshot, SnapshotInputObject, ChildSite, ChildSiteInputObject

-Overwrite

Overwrite existing file(s) in the destination?

  • Type: System.Boolean
  • Parameter sets: Path, InputObject, RemoteServer, RemoteServerInputObject, Snapshot, SnapshotInputObject, ChildSite, ChildSiteInputObject

-RemoteServerId

Sends the result to the remote server with this ID instead of a folder of this site.

  • Type: System.Int64
  • Parameter sets: RemoteServer (required), RemoteServerInputObject (required)

-SnapshotId

Sends the result to the snapshot with this ID instead of a folder of this site.

  • Type: System.Int64
  • Parameter sets: Snapshot (required), SnapshotInputObject (required)

-ChildSiteId

Sends the result to the child site with this ID instead of a folder of this site.

  • Type: System.Int64
  • Parameter sets: ChildSite (required), ChildSiteInputObject (required)

-DestinationPath

The path within the remote server, snapshot or child site to send to. Defaults to its root folder.

  • Type: System.String
  • Parameter sets: RemoteServer, RemoteServerInputObject, Snapshot, SnapshotInputObject, ChildSite, ChildSiteInputObject

-InputObject

The file to act on, such as one written by another command of the module, from the pipeline. The command uses its Path and the connection that fetched it.

  • Type: FilesCom.PowerShell.Models.RemoteFile
  • Parameter sets: InputObject (required), RemoteServerInputObject (required), SnapshotInputObject (required), ChildSiteInputObject (required)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

  • FilesCom.PowerShell.Models.RemoteFile: a file from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.FileAction: the file action as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.