Update-FilesRemoteServerAgent

Push update to Files Agent.

Syntax

Id (Default)

Update-FilesRemoteServerAgent [-Id] <System.Int64> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

InputObject

Update-FilesRemoteServerAgent -InputObject <FilesCom.PowerShell.Models.RemoteServer> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Push update to Files Agent.

The command accepts remote servers 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. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.

Examples

Example 1: Push update to Files Agent

Update-FilesRemoteServerAgent -Id 1

Writes the agent push update returned.

Example 2: Act on remote servers from the pipeline

Get-FilesRemoteServer -Id 1 | Update-FilesRemoteServerAgent

Takes the remote server from the pipeline and uses its Id and connection.

Example 3: Preview the change

Update-FilesRemoteServerAgent -Id 1 -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Id

Remote Server ID.

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

-InputObject

The remote server 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.RemoteServer
  • 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: High. At the default $ConfirmPreference of High, the command asks before each change; -Confirm:$false runs it without asking.

-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.RemoteServer: a remote server from another command of the module, as -InputObject.

Outputs

  • FilesCom.PowerShell.Models.AgentPushUpdate: the agent push update 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.