Skip to main content

Install BlackPoint SnapAgent

Summary​

Installs the Blackpoint SNAP Agent on Windows and macOS machines.

On Windows, the task uses the agnostic script Install-SnapAgent with the installer download URL from the Win_DownloadUrl parameter or the BP_WIN_URL custom field.

On macOS, the task runs a Bash script that:

  • Exits without making changes if /Library/LaunchDaemons/snap-agent.plist already exists.
  • Resolves the authentication token and customer ID as a pair. The MAC_Authentication_Token and Mac_Customer_ID parameters are used when both are populated; otherwise, the BP_MAC_Authentication_Token and BP_Mac_Customer_ID custom fields are used. If only one of the two parameters is populated, it is ignored and a warning is written to the log.
  • Confirms that the customer ID is a valid UUID.
  • Downloads the Blackpoint deployment installer and removes any license.yaml left behind by a previous incomplete installation, so the supplied credentials are always applied.
  • Runs the Blackpoint installer and verifies the installation by checking for snap-agent.plist and confirming that the service is loaded.

Every macOS failure path exits with a non-zero code and writes an ERROR: line to the script log.

Sample Run​

Windows:
Image1

macOS:
Image2

Dependencies​

User Parameters​

NameExampleAccepted ValuesRequiredDefaultTypeDescription
Win_DownloadUrlhttps://file.something.com/SnapAgent/SnapAgent_Installer.exeDirect download URL of the installerNoText StringDownload URL for the Windows installer. Used on Windows only. When provided, it takes precedence over the BP_WIN_URL custom field.
MAC_Authentication_Tokenabc.xyzBlackpoint authentication tokenNoText StringBlackpoint authentication token for macOS endpoints. Must be provided together with Mac_Customer_ID. When both are populated, they take precedence over the BP_MAC_Authentication_Token and BP_Mac_Customer_ID custom fields.
Mac_Customer_ID00000000-0000-0000-0000-000000000000UUIDNoText StringBlackpoint customer ID that links macOS endpoints to the correct Blackpoint customer. Must be provided together with MAC_Authentication_Token. When both are populated, they take precedence over the BP_MAC_Authentication_Token and BP_Mac_Customer_ID custom fields.

Custom Fields​

NameLevelTypeRequiredDescription
BP_WIN_URLCompanyTextNoDownload URL for the Windows installer. Used when the Win_DownloadUrl parameter is not provided.
BP_MAC_Authentication_TokenCompanyTextNoBlackpoint authentication token for macOS endpoints. Used together with BP_Mac_Customer_ID when the MAC_Authentication_Token and Mac_Customer_ID parameters are not both provided.
BP_Mac_Customer_IDCompanyTextNoBlackpoint customer ID (UUID) for macOS endpoints. Used together with BP_MAC_Authentication_Token when the MAC_Authentication_Token and Mac_Customer_ID parameters are not both provided.

Note: Either the custom fields or the user parameters must be populated for the installation to proceed. On macOS, the authentication token and customer ID are always taken from the same source.

Task Setup Path​

  • Tasks Path: AUTOMATION ➞ Tasks
  • Task Type: Script Editor

Task Creation​

Description​

  • Name: Install BlackPoint SnapAgent
  • Description: Installs the Blackpoint SNAP Agent on Windows and macOS machines.
  • Category: Application
  • Script Isolation Mode: Inactive

Image3

Parameters​

Parameter NameRequired FieldParameter TypeDefault Value
Win_DownloadUrlDisabledText String
MAC_Authentication_TokenDisabledText String
Mac_Customer_IDDisabledText String

Win_DownloadUrl:
Image4

MAC_Authentication_Token:
Image5

Mac_Customer_ID:
Image6

Image7

Script Editor​

Row 1: Set Pre-defined Variable ( @Client_DownloadURL@ = BP_WIN_URL )​

  • Variable Name: Client_DownloadURL
  • Type: Custom Field
  • Custom Field: BP_WIN_URL
  • Continue on Failure: False
  • Operating System: Windows

Image8

Row 2: Set Pre-defined Variable ( @Client_Authentication_Token@ = BP_MAC_Authentication_Token )​

  • Variable Name: Client_Authentication_Token
  • Type: Custom Field
  • Custom Field: BP_MAC_Authentication_Token
  • Continue on Failure: False
  • Operating System: MacOS

Image9

Row 3: Set Pre-defined Variable ( @Client_Customer_ID@ = BP_Mac_Customer_ID )​

  • Variable Name: Client_Customer_ID
  • Type: Custom Field
  • Custom Field: BP_Mac_Customer_ID
  • Continue on Failure: False
  • Operating System: MacOS

Image10

Row 4: PowerShell script​

  • Use Generative AI Assist for script creation: False
  • Expected time of script execution in seconds: 1800
  • Continue on Failure: False
  • Run As: System
  • Operating System: Windows
  • PowerShell Script Editor:

PowerShell Script

Image11

Row 5: Bash script​

  • Use Generative AI Assist for script creation: False
  • Expected time of script execution in seconds: 1800
  • Continue on Failure: False
  • Run As: System
  • Operating System: MacOS
  • Bash Script Editor:

Bash Script

Image12

Row 6: Script Log​

  • Script Log Message: %Output%
  • Continue on Failure: False
  • Operating System: Windows, MacOS

Image13

Completed Script​

Image14

Output​

  • Script Log

Schedule Task​

Task Details​

  • Name: Install BlackPoint SnapAgent
  • Description: Installs the Blackpoint SNAP Agent on Windows and macOS machines.
  • Category: Application

Image15

Schedule​

  • Schedule Type: Schedule
  • Timezone: Local Machine Time
  • Start: <Current Date>
  • Trigger: Time At <Current Time>
  • Recurrence: Every day
  • Execute at next agent check-in: True
  • Stop After: 22
  • Unit: Hour(s)

Image16

Targeted Resource​

Device Group: Deploy BlackPoint SnapAgent

Image17

Completed Scheduled Task​

Image18

Changelog​

2026-09-23​

  • Rewrote the document in the current format.
  • Corrected the documented credential precedence for macOS: the user parameters take precedence over the custom fields when both are populated, and the authentication token and customer ID are always taken from the same source.
  • Updated the macOS script to validate the customer ID format, remove a stale license.yaml before installing, download the installer to a secure temporary file, and confirm that the service is loaded after installation.
  • Corrected Row 5 to the Bash script function and set the Script Log row to run on both Windows and macOS.
  • Fixed potential issues with the PowerShell script.

2026-08-25​

  • Updated the script to include MAC installation as well.

2025-04-10​

  • Initial version of the document