Faronics Deploy Docs
Deploy HomeDeploy Sign inSubmit a ticket
  • About Faronics Deploy
  • Highlights
    • Top 10 Trending Topics
    • What's New?
  • Getting Started
    • Quick Start Guide
      • System Requirements
      • Initial Setup and Configuration
        • Sign Up - Create a Faronics Deploy Account
        • Download and Install Deploy Agents
          • Windows Install Guide
            • Download MSI Installer to Deploy via Active Directory
          • Mac Install Guide
        • Login to Deploy for the First Time
        • Configure User Profile and Organization Settings
          • How to Configure your User Profile
          • How to Configure your Organization Settings
        • Add Administrators - Invite your Team and Assign Roles
        • Manage Tags
          • Apply a Tag
    • Navigating the User Interface
      • Deploy User Interface Views
        • Control Grid
          • Dashboard View
          • Applications View
          • Windows Updates View
          • OS Deployment View
          • Anti-Virus View
          • Inventory View
          • Policies View
        • Analytics
          • Applications View
          • Usage Reports View
          • Windows Updates Status View
          • Anti-Virus Reports View
          • Deploy Diagnostics View
        • Tickets View
        • Tasks View
      • Using the Control/Smart Grids
      • Using the Action Toolbar
      • Computer States and Actions
        • Handling Offline Computers
        • Wake-On-LAN
          • Designate Last Man Standing (LMS) computers
      • Light Mode/Dark Mode View
  • Feature Definitions and Glossary
  • Action Toolbar
  • App Preset
  • Custom App
  • Policies (Windows)
  • Policies (macOS)
  • Policy Update Mode
  • Application Management
    • Applications Overview
    • Navigating the Applications Control Grid
    • Cache Server: Save Bandwidth
    • Groups Configuration
      • Create a Group
      • Delete a Group
      • Add Computer(s) to a Group
        • Assign a Computer to a Group via the Deploy Agent Download and Install
        • Assign Computers to a Group After they Appear in the Dashboard
        • Group Computers Using a Naming Convention
        • Group Computers Based on Criteria in Inventory
      • Perform Actions on a Group of Computers
        • Perform Actions via the Action Toolbar on a Group of Computers
    • Install, Uninstall & Update Applications
      • Install Application(s)
        • Install Built-In Application(s)
        • Install an Application on All Computers in Deploy
        • Install an Application Using Winget
          • Enable and Install Winget
          • Install an Application Using the Winget Tool
        • Install an External Application (Custom App)
          • Create and Install a Custom App
            • Hosting a Custom App - URL or Network Path
          • Edit a Custom App
          • Copy a Custom App
          • Request Assistance From a Deployment Specialist
          • Example: Installing MS Office 365 as a Custom App
        • Install a Pre-Defined Group of Applications (App Presets)
          • Create an App Preset
          • Install an App Preset
          • Manage App Presets
        • Install an Application on a Group of Computers
        • Schedule an Install of Application(s)
          • Schedule an Install of an Application
          • Schedule an Install of Multiple Applications
      • Uninstall Application(s)
        • Uninstall an Application From a Group of Computers
        • Uninstall an Application From all Computers
        • Schedule an Uninstall
      • Update Application(s)
        • Performing Updates On-Demand
        • Update via Apps with Recent Updates Grid
        • Update Applications Using Policy Modes
    • Application Management for macOS
      • Install Application on macOS
        • Install Built-In Application(s) on macOS
        • Install a Custom App (External) on macOS
          • Create and Install a Custom App on macOS
      • Update an Application on macOS
      • Uninstall Application on macOS
      • Shell Scripts on macOS
  • WINDOWS UPDATES
    • Navigating the Windows Updates Control Grid
  • Manual Windows Updates Approval
    • Manually Approve All Windows Updates for All Computers (Install All Updates)
    • Manually Install Windows Updates on a Group of Computers
    • Manually Approve a Windows Update Category (in a Policy) for all Computers
    • Manually Approve an Individual Windows Update in a Policy for All Computers
    • Manually Approve or Deny Individual Windows Updates via Pending Windows Updates
    • Patch Scan (On-Demand)
  • Automated Windows Updates Approval
    • Automated Windows Updates Using Policies
    • Automated Windows Updates Use Case: Testing Patches
    • Patch Scan (Using a Policy)
  • OS DEPLOYMENT
    • Navigating the OS Deployment Control Grid
    • Imaging Utility Requirements
    • Getting Images Ready for Deployment
      • Loading Images from ISO Files
        • Download and Install the Faronics Deploy Imaging Server Tool
        • Loading ISO Image Files via the Faronics Deploy Imaging Tool
      • Building Images for Deployment - Template Machine
    • Capturing Images
    • Deployment Packages
      • Deployment Package Install Settings
    • Post Imaging Actions
    • USB Media Creator
      • Generate a Portable USB Creator (Used to Create a Recovery USB Drive)
      • Create a Recovery USB Flash Drive from a Portable USB Creator
    • Inject Drivers into the boot.wim File
    • Abort the Sysprep Task
  • OS MANAGEMENT
  • OS Management Overview
  • Create a Configuration
    • System and Security
    • Network and Internet
    • Hardware
    • User Accounts
    • Appearance and Personalization
    • Clock and Region
    • Ease of Access
    • Others
  • Apply a Configuration to a Group of Computers
  • Custom Scripts - PowerShell, VB, Batch, Executable [.exe]
    • Custom Scripts Library
      • Quick Guide to Self-Hosting Custom Scripts
      • Send Message
      • Rename Multiple Computers
      • Show All Notification Icons
      • Hide Task View
      • Hide Recent Apps
      • Hide People Taskbar
      • Disable Cortana
      • Google Chrome Ad Blocker Extension
        • Create a Custom Script to Install any Google Chrome Extension
      • Uninstall Windows Updates
      • Auto Logon
      • Disable the UltraVNC System Tray Icon
      • Install Printer Driver Silently
  • Policies - Scheduling and Automation
    • Update modes - Automatic, Scheduled, Adhoc
    • Create a Policy
      • Create a Windows Policy
      • Create a macOS Policy
      • Create a New Policy (MDM)
        • Global Settings (MDM)
    • Maintenance Mode
    • End-User Experience: Defer Updates and Reboots
    • Protecting the Deploy Agent
  • ANTI-VIRUS & FIREWALL
    • Faronics Anti Virus & Firewall Protection Configuration
      • Anti-Virus Settings
      • Firewall Settings
      • Computer Settings
  • Upgrade Anti-Virus Software
  • Restore or Delete Quarantined Files
  • INVENTORY
    • Inventory
      • View Details
    • Organize Computers Using Inventory Data
    • Retrieve MSInfo Reports Using the Deploy Console
    • Inventory Data Update - Heartbeat + On-Demand
    • Quickly View Installed Applications
    • Organize Inventory by Active Directory Group Membership / Organization User Membership
  • ANALYTICS
    • Usage Statistics Reports
      • Application Usage Report
      • Application Update Status Report
      • Installed Applications Report
      • Computer Usage Report
      • Login Summary Report
      • Windows Update Status Report
  • REMOTE ACCESS - RDP / VNC
    • Remote Access Requirements - Ports and Networking
    • Remote Pro
    • VNC - Initial Setup
    • Using VNC - Virtual Network Computing
    • Using RDP - Remote Desktop Protocol
    • Remote View the Screen of a Computer (Configure Refresh Rate & Monitor Selection)
  • TASKS
    • Task History
    • Scheduled Tasks
      • Assign a Scheduled Task
      • Delete a Recurring Scheduled Task
      • Cancel a One Time or Recurring Scheduled Task
    • Schedule a One Time Task
    • Schedule a Recurring Task
    • Schedule a Custom Script to Run on Every Reboot
  • Help Desk Tickets
    • Enabling Ticketing
      • Enable Ticketing for Your Organization
        • Enable Email Alerts for Incoming Tickets
      • Enable Ticketing for a User
      • Ticketing Emails
    • Ticket Actions
      • Create a Ticket
      • Edit a Ticket
      • Add a Note to a Ticket
      • Assign Ticket (To a User)
      • Assign Owner (To a Ticket)
      • Change Status of a Ticket (Open, In Progress, Closed)
      • Download a File Attached to a Ticket
      • View a Ticket
      • View History
      • Export a Report of All Tickets to a CSV File
      • Remote Access a Computer via a Ticket
    • Ticketing - Mapping Email IDs
    • Fair Use Policy - Ticketing
  • User Management
    • User Roles
    • Add Users
      • Add a User via Email
      • Add a User/Group via Active Directory
    • Configure SAML (Verify Users for External Applications)
  • Organization Settings
    • 2FA - Two Factor Authentication
    • Accessibility
  • Mobile Device Management
    • Overview
    • Device Configuration
      • MDM Set up
      • Enroll Standard Device
        • Mobile Browser
        • iOS App
        • Apple Configurator
        • Email
      • Enroll Lite Device
    • Apple Devices
    • Apple Lite Devices
    • Apps & Docs
      • Applications
      • Shared Documents
    • Settings
      • Networks
      • Personalization
      • Accounts
    • Device Actions
    • Action Toolbar
Powered by GitBook
On this page
  • Creating the Script
  • Adding Scripts to Deploy
  • Pushing the Script
  • Copy a Script (Duplicate)
  • Copy to a Site
  • Edit a Custom Script

Custom Scripts - PowerShell, VB, Batch, Executable [.exe]

PreviousApply a Configuration to a Group of ComputersNextCustom Scripts Library

Last updated 2 years ago

Creating the Script

To push a custom script using Faronics Deploy, the script will need to be hosted on a web server (see for further information). The supported scripts are PowerShell, VB Script, Batch Script and Executable [.exe]. See the for some example scripts.

Adding Scripts to Deploy

Once the script is hosted, it can be added to the Faronics Deploy grid. To do this, go to the Custom Script button on the top right corner of the Applications Control Grid and select the drop-down arrow to Create Custom Script.

1. Select the Control Grid tab on the top menu bar.

2. Navigate to the Applications tab.

3. Click CUSTOM SCRIPT.

4. Select Create Custom Script.

5. Enter a Name for the script.

6. Enter the URL or UNC path (e.g., \\FTS\Share\DFEscript.ps1 ) that points to the location where the script is being hosted.

7. Select a script type, Powershell, VB Script, Batch Script, or Executable [.exe] (PowerShell in this example).

8. Select the account to Run As, either System Account or Specified User Account.

9. Click SAVE TO GRID.

Once saved, the script can be pushed to an individual computer or groups of computers. It can also be scheduled using a Policy.

Pushing the Script

If a custom script has been saved to the grid, it can be pushed out to computers immediately or at a scheduled time. Custom scripts will appear in the Applications Control Grid.

1. Select the Control Grid tab on the top menu bar.

2. Navigate to the Applications tab.

3. Select the Custom Scripts column header.

4. Select the grid for the Computer that you want to run the Custom Script on (DESKTOP1 in this example).

5. Click the RUN button.

6. Confirm the action by clicking RUN on the confirmation dialog.

The Custom Script has successfully been run on the individual computer.

Copy a Script (Duplicate)

A script can be duplicated or copied to another site.

1. Select the Control Grid tab on the top menu bar.

2. Navigate to the Applications tab.

3. Click CUSTOM SCRIPT.

4. Select View Custom Scripts.

5. Select a Script to copy, then select the COPY drop-down menu.

6. Select Duplicate.

7. The script will be named "copy of - xxxxxxx"; it's a direct copy with just the name change. Make any changes you require to the name, URL, Type, Run As, or Command-Line, then click SAVE TO GRID.

The copied script will now appear in the list of Custom Scripts. It will also be available to select from the Applications Control Grid View.

Search for the script in the grid using the search option. If your applications are grouped, you will see a column named Custom Scripts. Selecting the Custom Script header will display all the scripts that have been added to the grid.

Copy to a Site

1. Select the Control Grid tab on the top menu bar.

2. Navigate to the Applications tab.

3. Click CUSTOM SCRIPT.

4. Select View Custom Scripts.

5. Select a Script to copy, then select the COPY drop-down menu.

6. Check the box(es) next to the site(s) to copy the script.

7. Click COPY TO SITES.

The copied script will now appear in the specified sites in their list of Custom Scripts. It will also be available to select from the Applications Control Grid View.

Search for the script in the grid using the search option. If your applications are grouped, you will see a column named Custom Scripts. Selecting the Custom Script header will display all the scripts added to the grid.

Edit a Custom Script

Once a script has been created, it can be edited. The name, URL, Type, Command Line and User can all be changed.

1. Select the Control Grid tab on the top menu bar.

2. Navigate to the Applications tab.

3. Click on the name of the script to be edited in the header of the Applications Grid view (Disable Power Management in this example).

4. The ACTION TOOLBAR will now appear; click the blue EDIT DETAILS button.

5. If changing the URL, enter the new URL.

6. Select a new type from the drop-down list if changing the type.

7. If changing/adding command line syntax, enter the new command line syntax in the box provided.

8. If changing the User account running this script, select one from the drop-down list.

9. Click the SAVE TO GRID button.

The Custom Script has successfully been updated.

Quick Guide to Self-Hosting Custom Scripts
Custom Scripts Library
Create a Custom Script
Configure the Custom Script
Locate Custom Scripts in Application View
Run the Custom Script
View Custom Scripts
Select Duplicate
Save Duplicate Script
View Custom Scripts