ShareFile

ShareFile PowerShell

The ShareFile PowerShell tool is a snap-in for Microsoft PowerShell that provides users with access to the ShareFile API. This is an open source tool that can be mapped to a specific ShareFile account.

This tool is recommended for IT Administrators with programming knowledge. Click here to learn more about the ShareFile REST API.

System Requirements

Installation

  • The ShareFile PowerShell tool may be downloaded from Github. Click here to view the latest release of the ShareFile PowerShell SDK.
  • Locate the most recent release of the ShareFile PowerShell tool and download the appropriate ShareFileSnapIn-Installer.msi. Installers are available for both 32-bit and 64-bit machines.
  • Once you have downloaded the MSI installer, double-click the file to run the installation wizard.
  • You must accept the License Agreement before continuing the installation. You may change the installation destination if you wish. Once the installation wizard is complete, click Finish.
  • You may now run Windows PowerShell or Windows PowerShell ISE and take the necessary steps to begin using the ShareFile PowerShell Snap-in.

Getting Started

The ShareFile PowerShell GitHub site contains a number of commands to get you started. For additional information on how to get started using the ShareFile PowerShell tool, see the link below.

Script Execution Policy

It may be necessary to alter the Execution Policy before you may run scripts downloaded online.

Click here for more information (including a list of Policy types) on managing Execution Policies in Windows PowerShell.To set an execution policy, use the command Set-ExecutionPolicy <Execution Policy>. For example:

Set-ExecutionPolicy RemoteSigned

SFCLI Commands in PowerShell

The latest version of the ShareFile PowerShell tool includes ShareFile Command Line Interface parameters for those users transitioning from the older tool.

Click here for a detailed guide on transitioning from SFCLI to ShareFile PowerShell.

Features

Multi-threaded Sync - The ShareFile PowerShell tool utilizes multi-thread uploads and downloads. By default, this count is set to 4. The number of threads used is configurable only by recompiling source code, which can be found here.

Bulk Sync Resume - In the event that a bulk file transfer is interrupted, already-transferred files will not be transferred again upon resuming.

Schedule jobs using Windows Task Scheduler - The ShareFile PowerShell tool supports running jobs using Windows Task Scheduler. For more information on using Windows Task Scheduler to run a Windows PowerShell script, please click here.

Creating Basic Scripts

Once you have familiarized yourself with basic calls to the ShareFile API, you can begin creating useful scripts for automating various tasks.

Github ShareFile PowerShell Wiki

Click here to view the ShareFile PowerShell Github Wiki, which contains various examples of usage to help you get started.

Disclaimer

Citrix is not responsible for and does not endorse or accept any responsibility for the contents or your use of these third party Web sites. Citrix is providing these links to you only as a convenience, and the inclusion of any link does not imply endorsement by Citrix of the linked Web site. It is your responsibility to take precautions to ensure that whatever Web site you use is free of viruses or other harmful items.

ShareFile PowerShell