Already a NinjaOne customer? Log in to view more guides and the latest updates.

File Transfer Automation

Topic

This article describes how to transfer files to endpoints that have the NinjaOne Agent deployed.

Environment

  • NinjaOne Endpoint Management
  • macOS
  • Windows
  • Linux

Description

The File Transfer automation tool enables you to host various files for your automations and script workflows. Transfer compressed archives, configurations, certificates, and many other small file types to multiple endpoints simultaneously, whether the file is from a source outside of NinjaOne or hosted within the application. 

Select a category to learn more: 

Requirements

  • File Transfer Automations are limited to 200 MB.
  • Destination path length can hold no more than 250 characters.

How it Works

  • Our File Transfer Automation tool runs the same way as any other automation in NinjaOne.
  • The agent creates a target directory on the endpoint if one does not already exist. If a duplicate file already exists in the destination, the file will be overwritten with the newly transferred data.
  • If you are transferring a file with a .zip file extension, the file transfer configuration modal will display an option to decompress the file in the target folder. The folder structure within the .zip file will be retained.

Create a File Transfer Automation

  1. Access the

    Figure 1: Add a file transfer automation in NinjaOne

    1. Refer to the following table as a guide to complete all applicable fields in the File Transfer configuration modal. 

      FieldDescriptionRequired? (Y/N)
      NameEnter a unique identifier for the automation. Yes
      DescriptionEnter a description of the file being transferred. No
      Operating SystemSelect the destination endpoint's operating system from the drop-down. Yes
      Destination folderEnter a single path to which the file will be transferred. Destination folders support paths with environment variables, and paths with and without trailing slashes. 
      This field accepts a maximum of 250 characters. 
      Yes
      FileFrom the drop-down menu, select the file type (URL or upload). The corresponding field will change depending on the type, allowing you to type in any valid URL or upload the file from your local computer. Yes
      CategoriesOptionally, select one or more categories to associate with the file. No
    2. Click Submit

    A notification will display on the screen to confirm processing. Click the View status button to navigate to the Automation Library's Under review tab, where you can check the scan status or delete the automation. 

    To delete, move your cursor over the row, click the ellipsis button, and then click Delete. 

    delete file transfer automation_fta.png

    Figure 2: Delete a file transfer automation that is under review in NinjaOne

    File Transfer Failures

    If your file transfer fails, an event will be logged under Activities on the system dashboard. This event will provide the time the failure occurred and a reason so you can troubleshoot the issue. 

    Use File Transfers in NinjaOne

    After a file is successfully configured, it shows up under the Automations tab in NinjaOne's Automation Library. You can quickly find these automation types by selecting "File Transfer" in the Type filter. 

    fta_automation tab_filter for file transfer.png

    Figure 3: Filter automations to find file transfers in NinjaOne

    You can use these file transfers in the following places in NinjaOne: 

    Add to a Policy Scheduled Automation

    When

    Add to Windows Patching Jobs

    1. Navigate to a Windows policy configuration page and open Windows Patches.
    2. In the Pre/Post Automation Execution section, click Add Automation before or after the update. 
    fta_add to windows patching.png
    1. In the Automation Library selection modal, click the file transfer you want to run. 

    Add to a Policy Condition

    When

    Add to a Scheduled Task

    When

    Run on a Device

    1. Find a device that can run automations and navigate to its device dashboard in NinjaOne.
    2. Click the action button next to the device name and select Run Automation.
    3. Click File Transfer
    run file transfer automation on device.png

    Figure 4: Run a file transfer automation for a device in NinjaOne

    1. In the Automation Library selection modal, click the file transfer you want to run and then click Yes in the confirmation window. 

    Additional Resources

    Scripting, Automation, CLI: Resource Catalog

FAQ

Next Steps