Start-FilesAutomation

Manually Run Automation.

Syntax

Id (Default)

Start-FilesAutomation [-Id] <System.Int64> [-Items <System.Collections.IDictionary[]>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Start-FilesAutomation [-Items <System.Collections.IDictionary[]>] -InputObject <FilesCom.PowerShell.Models.Automation> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Manually Run Automation.

The command accepts automations from the pipeline as -InputObject, and uses each one's Id 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: Manually Run Automation

Start-FilesAutomation -Id 1 -Items @(@{ })

Sends the request and writes nothing when it succeeds.

Example 2: Act on automations from the pipeline

Get-FilesAutomation -Id 1 | Start-FilesAutomation -Items @(@{ })

Takes the automation from the pipeline and uses its Id and connection.

Example 3: Preview the change

Start-FilesAutomation -Id 1 -Items @(@{ }) -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Automation ID.

  • Type: System.Int64
  • Parameter sets: Id (required, position 0)

-Items

Initial items for a v2 manual trigger. Each item contains exactly one file path or data object.

  • Type: System.Collections.IDictionary[]
  • Parameter sets: Id, InputObject

-InputObject

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

  • Type: FilesCom.PowerShell.Models.Automation
  • Parameter sets: InputObject (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.Automation: a automation from another command of the module, as -InputObject.

Outputs

None. The command writes nothing when it succeeds.

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.