Get-FilesRemoteServerAgentNode

List Files.com Agent nodes.

Syntax

Id (Default)

Get-FilesRemoteServerAgentNode [-Id] <System.Int64> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [<CommonParameters>]

InputObject

Get-FilesRemoteServerAgentNode -InputObject <FilesCom.PowerShell.Models.RemoteServer> [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [<CommonParameters>]

Description

List Files.com Agent nodes.

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

Examples

Example 1: List Files.com Agent nodes

Get-FilesRemoteServerAgentNode -Id 1

Writes the agent node returned.

Example 2: Act on remote servers from the pipeline

Get-FilesRemoteServer -Id 1 | Get-FilesRemoteServerAgentNode

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

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)

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.AgentNode: the agent node 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.