Deployment script and command reference

Overview

When you create a deployment policy in the CrashPlan console, the process generates user-detection scripts and arguments for CrashPlan app install commands. This article provides details about the scripts for Windows, Mac, and Linux devices.

msiexec /i CrashPlan_n.n.n_Win64.msi 
 CP_ARGS="DEPLOYMENT_URL=https://.host
 &DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02
 &PROXY_URL=http://.host/fname.pac"
 CP_SILENT=true DEVICE_CLOAKED=false /norestart /qn

Domain-joined username detection

Professional Services filename: Win_Azure_ADSI_Combined_Userdetect.bat

This script detects users running explorer.exe and determines their email addresses from the directory. This script is the default Windows user detection script used by the CrashPlan Professional Services team. For Entra, the script looks at one of two registry keys. This script requires an active connection to a Windows domain and requires Powershell v.4.0 or later. 

Explorer.exe script

Professional Services filename: UserDetect_Explorer_AppendDomain.bat

The following script detects users running explorer.exe and appends the domain of the email address. The script sets the home directory by adding the username to the \Users directory path in Windows. This script requires PowerShell v.4.0 or later.

First name and last name script

Professional Services filename: UserDetect_FirstLastname_LastLoggedOnDisplayName.bat

The following script detects the locally logged-in users' first and last names and edits the string to create a username of firstname.lastname.  

Local account script

Professional Services filename: UserDetect_FirstLastName_NoActiveDirectory.bat

The following script retrieves names from a local account, joins the first name to the last name to create a username of firstname.lastname, and appends the domain of the email address. This script needs the Full Name field for a local account to be populated with a user's first name and last name separated by a space. This script requires PowerShell v4.0 or later.

Text file script

Professional Services filename: UserDetect_ReadFromFile_User.bat

The following script reads a text file (default location C:\Temp\CrashPlan_User.txt) for the user email addresses, and sets the home directory by adding the username to the \Users directory path in Windows. This script requires PowerShell v.4.0 or later.

Last logged on user script

Professional Services filename: UserDetect_Registry_AppendDomain.bat

The following script detects which user last logged in using the LastLoggedOnUser registry value in HKLM, and appends the domain of the email address. The script sets the home directory by adding the username to the \Users directory path in Windows.

Mac

For CrashPlan apps on Mac devices, a deployment policy provides:

• A detection script to provide the CrashPlan app with a username and home directory for the device. The script can also optionally specify the user's organization.
• A deploy.properties file to distribute along with the CrashPlan app installer package.

 /usr/bin/python -c 'from SystemConfiguration import SCDynamicStoreCopyConsoleUser; import sys; username = (SCDynamicStoreCopyConsoleUser(None, None, None) or [None])[0]; username = [username,""][username in [u"loginwindow", None, u""]]; sys.stdout.write(username + "\n");'

echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }'

hdiutil attach CrashPlan_n.n.n_Mac.dmg
installer -package "/Volumes/CrashPlan/Install CrashPlan.pkg"  
-target LocalSystem
hdiutil detach /Volumes/CrashPlan

• To install for one user only, sign in as that user and use targetCurrentUserHomeDirectory. 

Individual parts of the commands are as follows:

Mac deploy.properties file

The typical deploy.properties file reads like this:

DEPLOYMENT_URL=https://.host
DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02
CP_SILENT=true
DEVICE_CLOAKED=false
PROXY_URL=http://.host/fname.pac

Individual parts of that file are as follows:

#!/bin/bash
mkdir -p /Library/Application\ Support/CrashPlan
echo "<deploy.properties>" > /Library/Application\ Support/CrashPlan/deploy.properties

Location 2, the disk image

Adding deploy.properties to the installer disk image is best for users starting an install manually, by clicking on the .dmg file.

Add deploy.properties to the disk image as follows:

1. Make a writable copy of the disk image.
2. Mount the writable copy.
3. Copy deploy.properties to the new image's root directory.
4. Unmount the image.
5. Return the image to the read-only state.

The following example shows the commands needed to add the deploy.properties file to the disk image.

hdiutil convert -format UDRW CrashPlan_n.n.n_Mac.dmg -o AGENT_n.n.n_w.dmg
hdiutil attach AGENT_n.n.n_w.dmg
cp deploy.properties /Volumes/CrashPlan/deploy.properties
hdiutil detach /Volumes/CrashPlan
hdiutil convert -format UDRO AGENT_n.n.n_w.dmg -o AGENT_n.n.n_ro.dmg

: /tmp/mountpt/CrashPlan

This location is unique to the Jamf Pro device management tool.

Example Mac user detection scripts

Following are example user detection scripts for the Mac platform. For help with these scripts, contact your Account Executive to engage the Professional Services team.

General usage:

• Replace domain.com with your domain name.
• Add users you want to exclude from processing to the denylist in each script (look for admin1|admin2|admin3). This helps IT teams ensure that the CrashPlan installation is set up for the correct users, and not the support staff setting up the Mac computers for the first time.

First initial and last name script

Professional Services filename: UserDetect_and_modify_firstinitial_dot_lastname.sh

The following script detects the locally logged-in users' first and last names and edits the string to create a username of firstinitial.lastname.

First name and last name script

Professional Services filename: UserDetect_and_modify_firstname_dot_lastname.sh

The following script detects the locally logged-in users' first and last names and edits the string to create a username of firstname.lastname.

Text file script

Professional Services filename: UserDetect_from_text.sh

The following script reads the username from a text file (located by default at /tmp/CrashPlantest.txt). Use when no other logical way of finding the username can be determined and no user interaction is desired.

Last logged on user script

Professional Services filename: UserDetect_last_plus_domain.sh

The following script checks the last known logged in users and narrows down the list to the currently logged-in user.

Scutil script

Professional Services filename: UserDetect_scutil_user_plus_domain.sh

The following script uses the system configuration utility (scutil) to detect the logged-in user. The client's email domain needs to be appended to the resulting username to get a valid CrashPlan username.

DSCL script

Professional Services filename: UserDetect_using_DSCL.sh

The following script obtains the user's email address from the domain records stored on the client using the Directory Service command line utility (DSCL). The Mac must be domain-bound.

Jamf plist script

Professional Services filename: macuserdetection-plist.sh

The following script is helpful if you use Jamf for device management. The script places a plist on the local machine that is populated with the username associated with the device from Jamf. This script is a good option if you have a username associated with a specific device in JAMF, but you do not have assurance that the usernames on the local device match the username part of the email address. This script requires additional setup in Jamf. 

To use this script:

• Place the script into your deployment policy.
  You may need to update the script depending on your Jamf version and configuration. Earlier versions of Jamf put the plist in ~/Library/Preferences/, but later versions put it in /Library/Managed Preferences/.
• In Jamf, create a new configuration profile or edit an existing one.
• Go to Custom Settings (or Application & Custom Settings, depending on your Jamf version), and upload the following com.crashplan.email file.
  This is a sample plist file. If you prefer, you can create your own, as long as the EMAIL variable is present as a key that matches what the deployment policy is set up to read.

​​​​<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <key>crashplanActivationEmail</key>
    <string>$EMAIL</string>
</dict>
</plist>

Linux

For CrashPlan apps on Linux devices, a deployment policy provides:

• A custom-written detection script to provide the CrashPlan app with a username and home directory for the device. The script can also optionally specify the user's organization.
• Installation properties to serve as the arguments string to a CrashPlan app install command.

tar -xvf CrashPlan_n.n.n_Linux.tgz
sudo crashplan-install/install.sh -q -d "DEPLOYMENT_URL=https://host
  &DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02
  &PROXY_URL=http://host/filename.pac"

#!/bin/bash
mkdir -p /Library/Application\ Support/CrashPlan
echo "<deploy.properties>" > /usr/local/crashplan/deploy.properties