Introduction

The FilesCom.PowerShell module provides PowerShell cmdlets for the Files.com API. Each API cmdlet works with one kind of Files.com object, such as a user, a folder, or a permission, and writes those objects to the pipeline so you can filter, sort, export, or pass them to the next cmdlet.

The API cmdlets are generated from the same API definition as the Files.com SDKs, and the module adds cmdlets for connections, file transfers, and streams. Every cmdlet the module exports has a reference page in this site's PowerShell command navigation, with its syntax, parameters, and examples, built from the same help source as Get-Help.

The module is a compiled binary module that includes its own runtime dependencies. It is distributed as a NuGet package on NuGet.org, and the installation page describes how to install it with PSResourceGet.

How the Cmdlets Behave

Commands that list objects write every object of every page, loading one page at a time as the pipeline consumes them. -First and -Skip limit what a command writes, and stopping the pipeline early, as Select-Object -First does, loads no further page. -Page and -Continuation let you work with one page at a time instead.

Commands that change Files.com support -WhatIf and -Confirm. -WhatIf describes each change without making it, and -Confirm asks before each change. Without -Confirm, PowerShell asks only for actions whose confirm impact reaches $ConfirmPreference, which is High by default. Among the API commands, deletions, security changes, and other selected high-impact actions are High, so they ask by default; add -Confirm:$false to run them without asking in a script that has already decided. Other API commands that change Files.com are Medium and run without asking. The reference page of each API command gives its confirm impact.

Every API command accepts -Connection to choose the connection it uses, and -WorkspaceScope or -NoWorkspaceScope to run its requests in a particular Workspace. The authentication page describes connections.

Next Steps

  1. Install and import the module.
  2. Connect to your site with Connect-FilesAccount.
  3. Follow Administration and Reporting for inventories and bulk access changes, or Automation and Scheduled Jobs for unattended scripts.
  4. Open any cmdlet's reference page from this site's PowerShell command navigation, or run Get-Help on any cmdlet.