Deployment script and command reference
- Last updated
- Save as PDF
Available in:
Overview
When you create a deployment policy in the administration console, Code42 generates two essential pieces of code:
- User-detection scripts
- Arguments for Code42 app install commands
This article provides details about both, for Windows, Mac, and Linux devices.
Considerations
This article assumes you understand the introduction to deployment provided by the article Prepare to deploy Code42 client apps.
These instructions apply to the Code42 cloud. If you work in an on-premises Code42 environment, see Manage app installations in your Code42 environment
To use these deployment tools, you need to sign in to your administration console as a user with the role:
Windows
For Code42 apps on Windows devices, a deployment policy provides:
- A detection script to provide the Code42 app with a username and home directory for its device.
- Installation properties to serve as the arguments string to a Code42 app install command.
Windows user detection script
A user detection script examines the host device and provides the Code42 app with a username and home directory. The script resides on the Code42 cloud. The Code42 app retrieves it during the install process.
You need to customize the default script because Code42 usernames must be email addresses. You may have other reasons to customize the script as well, depending on your environment. If you need help, contact your Customer Success Manager (CSM) for enterprise support at csmsupport@code42.com
Default script
The default detection script for Windows:
- Uses the device's operating system to determine the most recent logged-on username.
- Calculates the typical home directory for that username.
- Reports those two values to standard output.
@echo off
rem Use sysnative when running 32-bit on a 64-bit processor
if "%PROCESSOR_ARCHITEW6432%"=="" goto native
%SystemRoot%\Sysnative\cmd.exe /c %0 %*
exit
:native
rem Change code page to UTF-8
CHCP 65001
for /f "TOKENS=2*" %%a in ('reg query "HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Authentication\LogonUI" /v LastLoggedOnUser') do set current_domain_user=%%b
echo current_domain_user = %current_domain_user%
for /f "TOKENS=1,2 DELIMS=\" %%a in ("%current_domain_user%") do set current_domain=%%a& set current_user=%%b
echo current_domain = %current_domain%
echo current_user = %current_user%
if "%current_user%" == "" (
set current_user=%current_domain%
echo current_user = %current_user%
)
if NOT "%current_user%" == "" (
echo C42_USERNAME=%current_user%
echo C42_USER_HOME=C:\Users\%current_user%
)
Custom scripts
Create a custom script by copying and altering the default script. Then paste your custom script into your deployment policy. The rules for custom user detection scripts are as follows:
- Every script must end as the default script does, by echoing values for two variables:
echo C42_USERNAME=<value> echo C42_USER_HOME=<value>
- In the Code42 cloud, usernames must be email addresses.
echo C42_USERNAME=%current_user%@example.com - You must provide values. Null values and empty strings will not work.
- If you cannot write a script to provide a workable value, write a message for the username field of the Code42 app sign in dialog, for example:
echo C42_USERNAME=Enter name and click Sign up
- The values cannot include quote marks, 'single' or "double".
Windows command and arguments
Command arguments provided by a deployment policy are for import to your software management tool. Commands and arguments are detailed here in case you need to modify them for some reason, or to help you deploy without a software management tool.
To install a Code42 app for all users of a device, sign in to an account with administrative rights and issue a command like the following:
msiexec /i Code42CrashPlan_n.n.n_Win64.msi CP_ARGS="DEPLOYMENT_URL=https://.host:port &DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02 &PROXY_URL=http://.host:port/fname.pac" CP_SILENT=true /norestart /qn
To install for one user only, sign in as that user, and append to the command the three parameters in the final row of the table below.
Individual parts of a command are as follows:
| Element | Description |
| msiexec /i | Windows command to install a product. |
| Code42CrashPlan_n.n.n_Win64.msi | Name of Code42 app installer file, version n.n.n. |
| CP_ARGS=" | Start of the installation properties copied from the deployment policy. |
| DEPLOYMENT_URL= https://.host:port |
The address of your administration console. The Code42 app requests its deployment policy from this address. |
| DEPLOYMENT_POLICY_TOKEN= | A unique ID string identifies each deployment policy. |
|
PROXY_URL= http://.host:port/fname.pac |
The address of a proxy auto-config file. The file tells a Code42 app how to communicate with Code42 through a proxy server. This argument is only present when your policy configuration says Use Org Proxy URL: Yes. If the argument is present, but has no value, the policy says use proxy: yes, but the organization has no proxy addressed defined. |
| " | The value of CP_ARGS begins and ends with quote marks. |
| CP_SILENT=true or false |
|
| /norestart | The Windows operating system does not restart after the Code42 app installs. |
| /qn | Quiet: The Windows installer does not open a console and does not prompt the user. |
| /l* filename | Code42 app writes installation logs to filename. |
| ALLUSERS=2 MSIINSTALLPERUSER=1 INSTALL_PER_USER=1 |
Add these three parameters if you wish to install the Code42 app for only the currently signed-in user, not all users of the device. |
| ARPNOREMOVE= |
(Optional) Add this parameter to prevent users from uninstalling the Code42 app from the Start menu and Add/Remove programs in the Control Panel.
The |
Mac
For Code42 apps on Mac devices, a deployment policy provides:
- A detection script to provide the Code42 app with a username and home directory for its device.
- A deploy.properties file to distribute along with the Code42 app installer package.
Mac user detection script
A user detection script examines the host device and provides the Code42 app with a username and home directory. The script resides on the Code42 cloud. The Code42 app retrieves it during the install process.
You need to customize the default script because Code42 usernames must be email addresses. You may have other reasons to customize the script as well, depending on your environment. If you need help, contact your Customer Success Manager (CSM) for enterprise support at csmsupport@code42.com
Default script
The default detection script for Mac:
- Uses the device's operating system to determine the most recent logged-on username.
- Calculates the typical home directory for that username.
- Reports those two values to standard output.
function main() {
local user=$(last | egrep 'console.*still' | egrep -v 'root|admin|reboot|shutdown|local|_mbsetupuser' | awk '{print $1}' | sort -u | head -n1)
echo "C42_USERNAME=${user}"
echo "C42_USER_HOME=$(dscl . -read "/users/${user}" NFSHomeDirectory | cut -d ' ' -f 2)"
}
main "$@"
Custom scripts
Create a custom script by copying and altering the default script. Then paste your custom script into your deployment policy. The rules for custom user detection scripts are as follows:
- Every script must end as the default script does, by echoing values for two variables:
echo "C42_USERNAME=<value>" echo "C42_USER_HOME=<value>"
- In the Code42 cloud, usernames must be email addresses.
echo "C42_USERNAME=%current_user%@example.com" - You must provide values. Null values and empty strings will not work.
- If you cannot write a script to provide a workable value, write a message for the username field of the Code42 app sign in dialog, for example:
echo "C42_USERNAME=Enter name and click Sign up"
- The values cannot include quote marks, 'single' or "double".
Mac commands
Command arguments provided by a deployment policy are for import to your device management tool. Commands and arguments are detailed here in case you need to modify them for some reason, or to help you deploy without a device management tool.
To install a Code42 app for all users of a device, sign in to an account with administrative rights and issue a command like the following:
hdiutil attach Code42CrashPlan_n.n.n_Mac.dmg installer -package "/Volumes/Code42CrashPlan/Install Code42 CrashPlan.pkg" -target LocalSystem hdiutil detach /Volumes/Code42CrashPlan
To install for one user only, sign in as that user and use
target CurrentUserHomeDirectory
Individual parts of the commands are as follows:
| Element | Description |
| hdiutil attach Code42CrashPlan_n.n.n_Mac.dmg | Mount the Code42 app disk image. |
| installer -package "/Volumes/Code42CrashPlan/Install Code42 CrashPlan.pkg" |
Run the install program. |
|
-target LocalSystem -target CurrentUserHomeDirectory |
Install the Code42 app for all users of the device. Or install for only the current user. |
| hdiutil detach /Volumes/Code42CrashPlan | Unmount the Code42 app disk image. |
Mac deploy.properties location
When the Code42 app installer runs on Mac, it looks for the deploy.properties file in three locations, in this order:
- In the disk image: /Volumes/Code42CrashPlan
- In a temp directory for Jamf Pro (formerly Casper Suite): /tmp/mountpt/Code42CrashPlan
- One of two Library directories:
Installations for all users: /Library/Application Support/CrashPlan
Installations for a single user: ~/Library/Application Support/CrashPlan
Location 1, the disk image
Adding deploy.properties to the installer disk image is chiefly recommended for users starting an install manually, by clicking on the *.dmg file.
Add deploy.properties to the disk image as follows:
- Make a writable copy of the disk image.
- Mount the writable copy.
- Copy deploy.properties to the new image's root directory.
- Unmount the image.
- Return the image to the read-only state.
Following is an example of the commands to add the deploy.properties file to the disk image:
hdiutil convert -format UDRW Code42CrashPlan_n.n.n_Mac.dmg -o C42_n.n.n_w.dmg hdiutil attach C42_n.n.n_w.dmg cp deploy.properties /Volumes/Code42CrashPlan/deploy.properties hdiutil detach /Volumes/Code42CrashPlan hdiutil convert -format UDRO C42_n.n.n_w.dmg -o C42_n.n.n_ro.dmg
Location 2, Jamf Pro tmp
The /tmp/mountpt/Code42CrashPlan is unique to the Jamf Pro device management tool. See the vendor's documentation.
Location 3, Application Support
Before running Code42 app instalers, place deploy.properties files into one of two directories:
- Installations for all users: /Library/Application Support/CrashPlan
- Installations for a single user: ~/Library/Application Support/CrashPlan
This option has two advantages:
- Not all deployment software mounts the disk image in the same location, making deploy.properties in the disk image hard to find.
- You can create a deploy.properties file once, then distribute for any number of deployments, current and future.
Mac deploy.properties
The typical deploy.properties file reads like this:
DEPLOYMENT_URL=https://.host:port DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02 CP_SILENT=true PROXY_URL=http://.host:port/fname.pac
Individual parts of that file are as follows:
| Element | Description |
| DEPLOYMENT_URL= https://.host:port |
The address of your administration console. The Code42 app requests its deployment policy from this address. |
| DEPLOYMENT_POLICY_TOKEN= | A unique ID string identifies each deployment policy. |
| CP_SILENT=true or false |
|
|
PROXY_URL= http://.host:port/fname.pac |
The address of a proxy auto-config file. The file tells a Code42 app how to communicate with Code42 through a proxy server. This argument is only present when your policy configuration says Use Org Proxy URL: Yes. If the argument is present, but has no value, the policy says use proxy: yes, but the organization has no proxy addressed defined. |
Linux
For Code42 apps on Linux devices, a deployment policy provides:
- A custom-written detection script to provide the Code42 app with a username and home directory for its device.
- Installation properties to serve as the arguments string to a Code42 app install command.
Linux user detection script
A user detection script examines the host device and provides the Code42 app with a username and home directory. The script resides on the Code42 cloud. The Code42 app retrieves it during the install process.
Code42 does not provide a default script for Linux devices. Create a custom script according to the rules below. Then paste your script into your deployment policy.
If you need help, contact your Customer Success Manager (CSM) for enterprise support at csmsupport@code42.com
- Every script must end as the default script does, by echoing values for two variables:
echo C42_USERNAME=<value>; echo C42_USER_HOME=<value>;
- In the Code42 cloud, usernames must be email addresses.
echo C42_USERNAME=%current_user%@example.com; - You must provide values. Null values and empty strings will not work.
- If you cannot write a script to provide a workable value, write a message for the username field of the Code42 app sign in dialog, for example:
echo C42_USERNAME=Enter name and click Sign up;
- The values cannot include quote marks, 'single' or "double".
Linux commands and arguments
Command arguments provided by a deployment policy are for import to your device management tool. Commands and arguments are detailed here in case you need to modify them for some reason, or to help you deploy without a device management tool.
To install a Code42 app for all users of a device, sign in to an account with root access and issue a command like the following:
tar -xvf Code42CrashPlan_n.n.n_Linux.tgz sudo crashplan-install/install.sh -qd "DEPLOYMENT_URL=https://host:port &DEPLOYMENT_POLICY_TOKEN=0fb12341-246b-448d-b07f-c6573ad5ad02 &SSL_WHITELIST=7746278a457e64737094c44eeb2bbc32357ece44 &PROXY_URL=http://host:port/filename.pac"
To install for one user only, sign in as that user and specify-qdu
| Element | Description |
| tar -xvf Code42CrashPlan_n.n.n_Linux.tgz | Unpack the installer file. |
| crashplan-install/install.sh |
Run the Code42 app install script. |
|
-qd -qdu |
q: Quiet. Do not open a console. Do not prompt the user. d: Deployment. Apply the following properties. u: Install for the currently signed-in user only. |
| " | Start and end the following properties with a quote. |
| DEPLOYMENT_URL= https://.host:port |
The address of your administration console. The Code42 app requests its deployment policy from that address. |
| DEPLOYMENT_POLICY_TOKEN= | A unique ID string identifies each deployment policy. |
|
PROXY_URL= http://.host:port/fname.pac |
The address of a proxy auto-config file. The file tells a Code42 app how to communicate with Code42 through a proxy server. This argument is only present when your policy configuration says Use Org Proxy URL: Yes. If the argument is present, but has no value, the policy says use proxy: yes, but the organization has no proxy addressed defined. |
| " | Start and end the above properties with a quote. |