Deployment script and command reference

What the default script is and how it works

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.

The default detection script then reports these two values to a standard output.

Following is the default detection script:

@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%
)

How to customize the default script

Create a custom script by copying and altering the default script. Then paste your custom script into your deployment policy.

When creating your custom script, be aware of the following:

• 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

• Optionally, you can also specify the the organization for the user. Use the registration key for the organization. If the organization is not defined, the user registers to the organization specified in the deployment policy.

  echo C42_ORG_REG_KEY=<value>

• 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 in

• The values cannot include either single (') or double (") quotation marks.

Explorer.exe with ADSI domain lookup script

Professional Services filename: UserDetect_ADSIDomainLookup.bat

The following script detects users running explorer.exe and performs an Active Directory Service Interfaces (ADSI) search against Active Directory to obtain the mail attribute for the users. The script sets the home directory by adding the username to the \Users directory path in Windows. You can adjust this script to look for any attribute in Active Directory, such as userPrincipalName or custom attributes. This script requires an active connection to a Windows domain and PowerShell v.4.0 or later.

<# : batch script
@echo off
setlocal
cd %~dp0
powershell -executionpolicy bypass -Command "Invoke-Expression $([System.IO.File]::ReadAllText('%~f0'))"
endlocal
goto:eof
#>
$username = (Get-Process -IncludeUserName -Name explorer | Select-Object -ExpandProperty UserName).Split('\')[1]
$searcher = [adsisearcher]"(samaccountname=$username)"
$C42_USERNAME = ($searcher.FindOne().Properties.mail)
$ExcludedUsers = @(
     'user1'
     'user2'
     'user3'
     'admin'
     'Administrator'
)
if ([string]::IsNullOrEmpty($C42_USERNAME) -or $username -in $ExcludedUsers) {
     Write-Output "Excluded or null user detected ($username).  Will retry user detection in 60 minutes, or when reboot occurs."
     exit
}
$C42_USER_HOME = "$env:HOMEDRIVE\Users\$username"
Write-Host C42_USERNAME=$C42_USERNAME
Write-Host C42_USER_HOME=$C42_USER_HOME

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.

<# : batch script
@echo off
setlocal
cd %~dp0
powershell -executionpolicy bypass -Command "Invoke-Expression $([System.IO.File]::ReadAllText('%~f0'))"
endlocal
goto:eof
#>
$username = (Get-Process -IncludeUserName -Name explorer | Select-Object -ExpandProperty UserName).Split('\')[1]
$ExcludedUsers = @(
     'user1'
     'user2'
     'user3'
     'admin'
     'Administrator'
)
if ([string]::IsNullOrEmpty($username) -or $username -in $ExcludedUsers) {
     Write-Output "Excluded or null user detected ($username).  Will retry user detection in 60 minutes, or when reboot occurs."
     exit
}
$C42_USERNAME = $username + '@domain.com'
$C42_USER_HOME = "$env:HOMEDRIVE\Users\$username"
Write-Host C42_USERNAME=$C42_USERNAME
Write-Host C42_USER_HOME=$C42_USER_HOME

Active Directory script

Professional Services filename: UserDetect_FirstLastName_ActiveDirectory.bat

The following script finds the real name of Active Directory users, 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 requires an active connection to a domain.

@echo off
setlocal

REM Gather user and home info.
for /f "TOKENS=1,2,*" %%a in ('tasklist /FI "IMAGENAME eq explorer.exe" /FO LIST /V') do if /i "%%a %%b"=="User Name:" set _currdomain_user=%%c
for /f "TOKENS=1,2 DELIMS=\" %%a in ("%_currdomain_user%") do set _currdomain=%%a & set currentuser=%%b
for /f "tokens=2*" %%a in ('net user "%currentuser%" /domain ^| find /i "Full Name"') do set DisplayName=%%b
set RealName=%DisplayName: =.%
set Domain=@domain.com

REM List of Excluded users that shouldn't be used for Code42 install.
FOR %%G IN ("user1"
            "user2"
            "user3"
            "admin"
            "Administrator") DO (
            IF /I "%currentuser%"=="%%~G" GOTO NOMATCH
)

:MATCH
REM Echo Values for Code42 Installer
echo C42_USERNAME=%RealName%%DOMAIN%
echo C42_USER_HOME=%HOMEDRIVE%\Users\%currentuser%
GOTO :EOF

:NOMATCH
echo Excluded or null user detected (%currentuser%).  Will retry user detection in 60 minutes, or when reboot occurs.
GOTO :EOF

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.

<# : batch script
@echo off
setlocal
cd %~dp0
powershell -executionpolicy bypass -Command "Invoke-Expression $([System.IO.File]::ReadAllText('%~f0'))"
endlocal
goto:eof
#>
$username = (Get-Process -IncludeUserName -Name explorer | Select-Object -ExpandProperty UserName).Split('\')[1]
$fullname = (Get-CimInstance -Class Win32_UserAccount -Filter "LocalAccount='True'" | Where-Object -Property Name -like $username).FullName -replace " ","."
$C42_USERNAME = $FullName + '@domain.com'
$ExcludedUsers = @(
     'user1'
     'user2'
     'user3'
     'admin'
     'Administrator'
)
if ([string]::IsNullOrEmpty($C42_USERNAME) -or $username -in $ExcludedUsers) {
     Write-Output "Excluded or null user detected ($username).  Will retry user detection in 60 minutes, or when reboot occurs."
     exit
}
$C42_USER_HOME = "$env:HOMEDRIVE\Users\$username"
Write-Host C42_USERNAME=$C42_USERNAME
Write-Host C42_USER_HOME=$C42_USER_HOME

Text file script

Professional Services filename: UserDetect_ReadFromFile_User.bat

The following script reads a text file (default location C:\Temp\C42_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 v4.0 or later.

<# : batch script
@echo off
setlocal
cd %~dp0
powershell -executionpolicy bypass -Command "Invoke-Expression $([System.IO.File]::ReadAllText('%~f0'))"
endlocal
goto:eof
#>
$username = Get-Content $env:HOMEDRIVE\temp\C42_User.txt
$ExcludedUsers = @(
     'user1@domain.com'
     'user2@domain.com'
     'user3@domain.com'
     'admin@domain.com'
     'Administrator@domain.com'
)
if ([string]::IsNullOrEmpty($username) -or $username -in $ExcludedUsers) {
     Write-Output "Excluded or null user detected ($username).  Will retry user detection in 60 minutes, or when reboot occurs."
     exit
}
$localuser = (Get-Process -IncludeUserName -Name explorer | Select-Object -ExpandProperty UserName).Split('\')[1]
$C42_USER_HOME = "$env:HOMEDRIVE\Users\$localuser"
Write-Host C42_USERNAME=$username
Write-Host C42_USER_HOME=$C42_USER_HOME

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.

<# : batch script
@echo off
setlocal
cd %~dp0
powershell -executionpolicy bypass -Command "Invoke-Expression $([System.IO.File]::ReadAllText('%~f0'))"
endlocal
goto:eof
#>
$username = (Get-ItemProperty HKLM:\Software\Microsoft\Windows\CurrentVersion\Authentication\LogonUI | Select-Object -ExpandProperty LastLoggedOnUser).Split('\')[1]
$ExcludedUsers = @(
     'user1'
     'user2'
     'user3'
     'admin'
     'Administrator'
)
if ([string]::IsNullOrEmpty($username) -or $username -in $ExcludedUsers) {
     Write-Output "Excluded or null user detected ($username).  Will retry user detection in 60 minutes, or when reboot occurs."
     exit
}
$C42_USERNAME = $username + '@domain.com'
$C42_USER_HOME = "$env:HOMEDRIVE\Users\$username"
Write-Host C42_USERNAME=$C42_USERNAME
Write-Host C42_USER_HOME=$C42_USER_HOME

What the default script is and how it works

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.

The default detection script then reports these two values to a standard output.

Following is the default detection script:

function main() {
local user=$(/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 "C42_USERNAME=${user}"
echo "C42_USER_HOME=/Users/${user}"
}
main "$@"

How to customize the default script

Create a custom script by copying and altering the default script. Then paste your custom script into your deployment policy.

When creating your custom script, be aware of the following:

• 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=${user}@example.com"
  

• Optionally, you can also specify the the organization for the user. Use the registration key for the organization. If the organization is not defined, the user registers to the organization specified in the deployment policy.

  echo C42_ORG_REG_KEY=<value>

• 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 in"
  

• The values cannot include either single (') or double (") quotation marks.

Prompt for email script

Professional Services filename: Email_prompt_for_email.sh

The following script creates a pop-up notification at Code42 app installation time prompting users to input their email address, which automatically registers the users in Code42 and starts backup. This script provides an alternative when no other scripts work and you want the end user to manually input their email address.

function main () {
local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
ask () {
        osascript <<EOF - 2>/dev/null
        tell application "CrashPlan"
        activate
        text returned of (display dialog "$1" default answer "")
        end tell
EOF
}

    name=$(ask 'CODE42 BACKUP - Please fill in your email address to continue: ')
    echo "C42_USERNAME=$name"
    echo "C42_USER_HOME=$(dscl . -read "/users/$user" NFSHomeDirectory | cut -d ' ' -f 2)"
fi
}
main "$@"

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.  

function main() {
local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
    realname="$(dscl . -read /Users/$user RealName | cut -d: -f2 | sed -e 's/^[[:space:]]*//' |  sed 's/^\(.\)[^ ]* /\1./' | grep -v "^$" | tr '[:upper:]' '[:lower:]')"
    echo "C42_USERNAME=$realname@domain.com"
    echo "C42_USER_HOME=$(dscl . -read "/users/$user" NFSHomeDirectory | cut -d ' ' -f 2)"
fi
}
main "$@"

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.  

function main() {
local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
    realname="$(dscl . -read /Users/$user RealName | cut -d: -f2 | sed -e 's/^[[:space:]]*//' |  sed 's/ /./' | grep -v "^$" | tr '[:upper:]' '[:lower:]')"
    echo "C42_USERNAME=$realname@domain.com"
    echo "C42_USER_HOME=$(dscl . -read "/users/$user" NFSHomeDirectory | cut -d ' ' -f 2)"
fi
}
main "$@"

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/Code42test.txt). Use when no other logical way of finding the username can be determined and no user interaction is desired. 

function main() {
   local user_email=$(cat /tmp/Code42test.txt)
   local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
   if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
         echo "C42_USERNAME=${user_email}"
         echo "C42_USER_HOME=$(dscl . -read "/users/$user" NFSHomeDirectory | cut -d ' ' -f 2)"
   fi
}
main "$@"

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. 

function main () {
    local user=$(last | egrep 'console.*still' | egrep -v 'root|admin|reboot|shutdown|local|_mbsetupuser' | awk '{print $1}' | sort -u | head -n1)
    if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
        echo "C42_USERNAME=${user}@domain"
        echo "C42_USER_HOME=/Users/${user}"
    fi
}
main "$@"

Python script

Professional Services filename: UserDetect_python_user_plus_domain.sh

The following script utilizes Python to detect the logged-in user. The client's email domain needs to be appended to the resulting username to get a valid Code42 username. 

function main () {
    local user=$(/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");')
    if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
        echo "C42_USERNAME=${user}@domain.com"
        echo "C42_USER_HOME=/Users/${user}"
    fi
}
main "$@"

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 Code42 username. 

function main () {
    local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
    if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -z "$user" ]]; then
        exit
    else
        echo "C42_USERNAME=${user}@domain.com"
        echo "C42_USER_HOME=/Users/${user}"
    fi
}
main "$@"

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.  

function main() {
    local user=$(echo "show State:/Users/ConsoleUser" | scutil | awk '/Name :/ && ! /loginwindow/ { print $3 }')
    if [[ "$user" =~ ^(admin1|admin2|admin3)$ ]]; then
        exit
    elif [[ -n "$user" ]]; then
       echo "C42_USERNAME=$(dscl . -read  /Users/${user} EMailAddress | cut -d ' ' -f 2)"
       echo "C42_USER_HOME=$(dscl . -read "/users/${user}" NFSHomeDirectory | cut -d ' ' -f 2)"
    else
        echo "Could not identify username, please restart the system."
    fi
}
main "$@"

Mac deploy.properties file location

When the Code42 app installer runs on Mac, it looks for the deploy.properties file in three locations, in the following order:

1. In the disk image, typically in /Volumes/Code42CrashPlan
2. In a Jamf Pro temp directory: /tmp/mountpt/Code42CrashPlan
3. (Recommended location) In the directory /Library/Application Support/CrashPlan
   Installations for a single user use ~/Library rather than /Library.

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

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

Create a custom script

Create a custom script and paste your script into your deployment policy. If you need help, contact your Customer Success Manager (CSM) for enterprise support.

When creating your custom script, be aware of the following:

• 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.
• Optionally, you can also specify the the organization for the user. Use the registration key for the organization. If the organization is not defined, the user registers to the organization specified in the deployment policy.

  echo C42_ORG_REG_KEY=<value>

• 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 in;
  

• The values cannot include either single (') or double (") quotation marks.