6
Client Tool
The Client Tool is a shell command that runs on a Mac endpoint. It is used to activate the client from a remote location or to run a script through a remote management utility. As administrator, you can activate a client and do the following:
• Activate as administrator
• Activate temporarily
• Retrieve information from the Mac client
To use the Client Tool manually, open a ssh session and enter the desired command on the command line.
Example:
/Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/ client -at domainAccount domainPassword
Enter client alone to display the usage instructions.
/Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/client
Table 1. Client Tool Commands
Command Purpose Syntax Results
Activate Activates a Mac client with the Dell
Server but without going through the user interface. To activate, a valid domain user name and password must be entered.
With the client tool you can activate a different local user than the one logged in and associate the domain credentials with that user.
-a domainAccount domainPassword
-a localAccount* domainAccount domainPassword domainAccount is the account used to activate via the client tool.
localAccount is optional and is the current user if none is specified.
The activation command has this format: client -a <user to activate*> <domainUser>
<domainPassword>
If you use the No Auth User List policy to create classes of users that do not get activated to the
Dell Server, optionally, you can use the client tool to specify a different local account than the one logged in. See
No Auth User List policy in step 3
.
0 = Success
2 = Activation failed, and reason for failure
6 = User not found
Activate temporarily Activates a Mac client without leaving a footprint.
-at domainAccount domainPassword
-at localAccount* domainAccount domainPassword
Disk
FileVault Change
Recovery
Request the status of the disk
-d
Cycle recovery keys for FileVault volumes
-fc deviceId recoveryPassphrase
-fc deviceId personalRecoveryKey
-fc deviceId pathToKeychain keychainPassword
-fc deviceId recoveryFile
Disk status displays, including the disk's ID, encryption status, and policies
If empty braces are returned, it means no disks are encrypted.
0 = Success
7= LVUUID not found
10 = Credential failure
11 = Escrow failed
30 Client Tool
Table 1. Client Tool Commands (continued)
Command Purpose Syntax
NOTE: deviceId must be a Logical Volume UUID or resolved to exactly one LVUUID.
Often, a mount point or devnode works.
Policy
Results
Policies display
Server
Test
Request the policies of the Mac client
-p
Polls the Dell Server for updated policies on behalf of the Mac client
NOTE:
The poll can take several minutes to complete.
-s
Test the Mac client's activation status
-t localAccount*
0 = Success
Any other value indicates that either the Dell Server or Mac client software was busy or not responding.
User
Version
Request user information
Request the Mac client's version
-u localAccount*
-v
0 (domainAccount) =
Success
1 = Not activated
6 = User not found
The user's account information displays:
0 (account information) =
Success
6 = User not found
The version of the Mac client displays: Example: 8.x.x.xxxx
* The account running the Client Tool is used for the localAccount unless another is specified.
The Plist Option
The -plist option prints the results of the command with which it is combined. It follows the command and must appear prior to its arguments to make the results print as a plist.
Examples
Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/ client -p -plist
To retrieve the policies from the client and print them.
Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/ client -at -plist localAccount domainAccount domainPassword
To temporarily activate the client and print the result.
Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/ client -s ; echo$?
To poll the Dell Server for updated policies on behalf of the client and display them on-screen.
Library/PreferencePanes/Dell\ Encryption\Enterprise.prefPane/Contents/Helpers/ client -d -plist
To retrieve the client's disk status and prints it.
Global Return Codes
No error 0
Client Tool 31
Parameter error 4
Unrecognized command 5
Socket timed out 8
Internal error 9
32 Client Tool
