> For the complete documentation index, see [llms.txt](https://docs.faronics.com/deep-freeze-cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.faronics.com/deep-freeze-cloud/using-deep-freeze-cloud-console/utilities/deep-freeze-mac-utilities.md). # Deep Freeze Mac Utilities ## Deep Freeze Mac Command Line (APFS) The Deep Freeze Mac Command Line gives network administrators increased flexibility in managing Deep Freeze Mac computers. These commands can be run with several different third-party enterprise management tools, such as Apple Remote Desktop, and/or central management solutions; this includes executing commands in Terminal while connected to a remote computer via SSH. Deep Freeze Mac has the following command line options. Usage: `deepfreeze argument [option]` {% hint style="info" %} Specify the Deep Freeze Mac Command Line Utility full path `/usr/local/bin/deepfreeze` when executing the command using third-party management tools. {% endhint %} {% hint style="info" %} If Deep Freeze password is enabled, Deep Freeze password can be passed as an environment variable by specifying "--env". Usage: `DFXPSWD=password /usr/local/bin/deepfreeze argument [option] --env` {% endhint %} | Command | Description | | | | | | | | | | | | | | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | --------------------------------------------------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -------------------- | --------------------- | ----------------------------------------------------------- | ---------------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | `deepfreeze version` | Displays the Deep Freeze Mac version. | | | | | | | | | | | | | | | | | `deepfreeze status` | Displays the current status of Deep Freeze Mac. | | | | | | | | | | | | | | | | |

deepfreeze freeze --volume VolumeName | --startup | --computer

deepfreeze thaw --volume VolumeName | --startup | --computer

|

--volume – Freeze or thaw a specific volume

--startup – Freeze or thaw the startup volume

--computer – Change Global state

Volumes will be set to Frozen or Thawed depending on the status of Deep Freeze.

| | | | | | | | | | | | | `deepfreeze license [--info]` |

\[--info] shows detailed information of the license

This command displays the full license key if run with root privilege or if Deep Freeze password is enabled.

| | | | | | | | | | | | | | | | |

deepfreeze password enable

deepfreeze password disable

| Enable or disable Deep Freeze password. | | | | | | | | | | | | | | | | |

deepfreeze password add --description Description

deepfreeze password edit --description Description \[--newdescription newDescription]

deepfreeze password delete --description Description

| Add, edit or delete Deep Freeze password. | | | | | | | | | | | | | | | | |

deepfreeze hideicon frozen \[--on | --off]

deepfreeze hideicon thaw \[--on | --off]

| Show or hide the Deep Freeze Frozen icon in the menu bar. | | | | | | | | | | | | | | | `deepfreeze restartinstead [--on \| --off]` | Restart the computer after user logs out, or the last user logs out if fast user switching is enabled. | | | | | | | | | | | | | | | | | `deepfreeze ardinfo [--set N \| --clear]` | Set or clear ARD info field. | | | | | | | | | | | | | | | | |

deepfreeze schedule add --name "ScheduleName" \[--enable on | off] --day monday\[,tuesday,wednesday,thursday,friday,saturday,sunday] --begin "24-hr-time" --end "24-hr-time" \[--onceonly on | off] \[--installappleupdate on | off] \[--lockuser on | off] \[--warnuser off | "5-999"] \[--message "message string"] \[--shutdownafter on | off] \[--runscript off | "script file name"]

deepfreeze schedule edit --name "ScheduleName" \[--enable on | off] \[--day monday\[,tuesday,wednesday,thursday,friday,saturday,sunday]] \[--begin "24-hr-time"] \[--end "24-hr-time"] \[--onceonly on | off] \[--installappleupdate on | off] \[--lockuser on | off] \[--warnuser off | "5-999"] \[--message "message string"] \[--shutdownafter on | off] \[--runscript off | "script file name"]

deepfreeze schedule delete --all | --name "ScheduleName"

deepfreeze schedule enable --name "ScheduleName"

deepfreeze schedule disable --name "ScheduleName"

| Add, edit, remove, enable or disable Maintenance schedules. | |

deepfreeze schedule scripts --add "ScriptFullpath"

deepfreeze schedule scripts --delete "ScriptName"

deepfreeze schedule scripts --list

|

Add, delete or list scripts.

This command requires root privilege, even when Deep Freeze password is enabled.

| | | | | | | | | | | | | | | | ### Deep Freeze Tasks for ARD Select this utility to install Deep Freeze tasks to manage Deep Freeze remotely via ARD. Complete the following steps after downloading the utility. 1. Double-click *Deep Freeze Tasks for ARD*. 2. Select the tasks to install. 3. Click *Continue*. 4. If *Deep Freeze tasks for APFS* is selected, you have the option to use Deep Freeze password if Deep Freeze password is enabled on the console. Select *Use Deep Freeze Password* and enter the password. If *Deep Freeze tasks for HFS+* is selected, specify Deep Freeze user name and password. 5. Click *Continue*. {% hint style="info" %} If you are using Apple Remote Desktop 3.7 or later, you must restart the computer to finalize installing Deep Freeze Tasks. You will be presented with an option to restart the computer at the end of installation. Click *Restart* to restart the computer and finalize the installation. {% endhint %} In ARD, the Deep Freeze-specific tasks are saved in the *Deep Freeze (APFS)* and *Deep Freeze (HFS+)* folder. The following tasks are available for Deep Freeze (APFS): | Task | Description | | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `DeepFreeze (APFS):addPassword` | Add Deep Freeze password. | | `DeepFreeze (APFS):addSchedule` | Add a Maintenance schedule. | | `DeepFreeze (APFS):addScript` | Add scripts. | | `DeepFreeze (APFS):clearArdInfo` | Clear the ARD Info Field. | | `DeepFreeze (APFS):deleteAllSchedules` | Delete all Maintenance schedules. | | `DeepFreeze (APFS):deletePassword` | Delete Deep Freeze password. | | `DeepFreeze (APFS):deleteSchedule` | Delete a Maintenance schedule. | | `DeepFreeze (APFS):deleteScript` | Delete one scripts at a time. | | `DeepFreeze (APFS):disablePassword` | Disable Deep Freeze password. | | `DeepFreeze (APFS):disableSchedule` | Disable a Maintenance schedule. | | `DeepFreeze (APFS):editPassword` | Edit Deep Freeze password. | | `DeepFreeze (APFS):editSchedule` | Edit a Maintenance schedule. | | `DeepFreeze (APFS):enablePassword` | Enable Deep Freeze password. | | `DeepFreeze (APFS):enableSchedule` | Enable a Maintenance schedule. | | `DeepFreeze (APFS):freezeComputer` | Change Global state to Frozen. | | `DeepFreeze (APFS):freezeStartup` | Freeze the startup volume. | | `DeepFreeze (APFS):freezeVolume` | Freeze a specific volume. | | `DeepFreeze (APFS):hideFrozenIcon` | Show or hide the Deep Freeze Frozen icon in the menu bar. | | `DeepFreeze (APFS):hideThawedIcon` | Show or hide the Deep Freeze Thawed icon in the menu bar. | | `DeepFreeze (APFS):licenseInfo` | Displays the License information. | | `DeepFreeze (APFS):listScripts` | List all the script files. | | `DeepFreeze (APFS):restartInstead` | Restart the computer when the user logs out (if fast user switching is enabled, restart the computer when the last user logs out). | | `DeepFreeze (APFS):setArdInfo` | Set the specific ARD Info Field to show Deep Freeze status. | | `DeepFreeze (APFS):status` | Displays the current status of Deep Freeze Mac. | | `DeepFreeze (APFS):thawComputer` | Change Global state to Thawed. | | `DeepFreeze (APFS):thawStartup` | Thaw the startup volume. | | `DeepFreeze (APFS):thawVolume` | Thaw a specific volume. | | `DeepFreeze (APFS):version` | Displays the Deep Freeze Mac version. | The following commands and arguments are available for Deep Freeze (HFS+) {% hint style="info" %} If Deep Freeze is to be upgraded from the previous installation on the target computer, the existing Deep Freeze Administrator user name and password must be entered during this step. A new Deep Freeze Administrator cannot be created during this step if a Deep Freeze Administrator already exists. {% endhint %} {% hint style="info" %} Each task can be configured in Deep Freeze, except for *requestStatus*. {% endhint %}
CommandArgumentDescription
activateScheduleSchedule nameActivates the scheduled updates on target computer(s); name of the schedule must be included in the command as a parameter.
addScheduleschedule_name [-a "on"|"off"] [-d monday[,tuesday,wednesday,thursday,friday,saturday,sunday]] [-b "24-hr-time"] [-e "24-hr-time"] [-o "on"|"off"] [-i "on"|"off"] [-l "on"|"off"] [-w "off"|5-999] [-m "message string"] [-s "on"|"off"] [-r "off" | "script name"]

Adds a schedule.

24-hr-time is in the form of HH:MM.

Multiple days is only for repeating schedules.

When specifying multiple schedules, there should be no space between the days specified.

addUserNew user nameAdds user to list.
badgeFrozenPartitionson|offShows/Hides Deep Freeze icon on Frozen partitions.
bootFrozen Sets target computer(s) to restart in a Frozen state.
bootThawed Sets target computer(s) to restart in a Thawed state.
bootThawedForTimesSets target computer(s) to restart in a Thawed state for the next x restarts; this number can be customized in the Times argument.
deactivateScheduleSchedule nameDeactivates the scheduled updates on target computer(s); name of the schedule must be included in the command as an argument.
deleteAllScripts Deletes all scripts.
deleteScriptScript NameDeletes a specific script.
deleteUserUser nameDeletes user from list.
editScheduleschedule_name [--newname "new_schedule_name "] [--activate "on"|"off"] [--day monday[,tuesday,wednesday,thursday,friday,saturday,sunday]] [--begin "24-hr-time"] [--end "24-hr-time"] [--onceonly "on"|"off"] [--installappleupdate "on"|"off"] [--lockuser "on"|"off"] [--warnuser "off"|5-999] [--message "message string"] [--shutdownafter "on"|"off"] [--runscript "off"|"script name"]Edits a schedule.
editUserUser nameAllows administrators to edit the name and password of a user.
freezePartitionPartition nameDesignates a partition on target computer(s) to be Frozen.
getARDInfoField Specifies which Apple Remote Desktop’s information field is used to display the computer status.
getLicenseInfo Displays the License information.
help This will print all the options and parameters available in the "deepfreeze" command line tool.
mapAllUsers

(Argument 1)

admin|standard|mobile

(Argument 2)

Partition name|

userthawspace

Maps all users to a specified ThawSpace: name of user type and location of ThawSpace must be included as a parameter; e.g. admin Panther maps all admin users to the partition named Panther.**
rebootInsteadOfLogoffon|offRestarts target computer(s) instead of logging off when the on argument is used. This feature is turned off when the off argument is used.
removeAllSchedules Removes all schedules.
removeAllThawSpace Removes all ThawSpaces present.
removeScheduleschedule_nameRemoves a schedule.
removeThawSpaceuserthawspace_name |globalRemoves a single ThawSpace***
resizeThawSpace"global" | userthawspace_name nnnn

Resizes a ThawSpace.

global is entered as it is, representing global ThawSpace.

nnnn is the new size in MB.

setARDInfoFieldARD Info FieldThis parameter is used to specify which Remote Desktop’s Information Field is used to display the computer status. The parameter value is 0 to 4, 0 is to unset the Information Field.
showFrozenIconon|offConfigures target computer(s) to show/hide the Deep Freeze Frozen icon in the menu bar.
showThawedIconon|offConfigures target computer(s) to show/hide the Deep Freeze Thawed icon in the menu bar.
status[-x]Requests target computer(s) to display the status of various Deep Freeze settings. x specifies that the result is in XML format.
thawPartitionPartition nameDesignates a partition on target computer(s) to be Thawed.
uninstall[keepThawSpace]

Uninstalls Deep Freeze from target computer(s). The target computer(s) must be restarted in the Boot Thawed state before the uninstall task can be run.

[keepThawSpace] uninstalls Deep Freeze from target computer(s) but retains ThawSpace.

version[-x]Displays Deep Freeze version number. x specifies that the result is in XML format.
\* = This only occurs during the first Deep Freeze installation using the settings provided by the custom installer created by Deep Freeze Assistant. \*\*= The mapAllUsers command also includes the parameters: "admin", "standard", "mobile", "userthawspace" and, partition name such as "Macintosh HD" or "Panther". \*\*\*= The single ThawSpace "name" must be specified as well as "global" for a Global ThawSpace. #### Adding a script file via Apple Remote Desktop Complete the following steps to add a script file via Apple Remote Desktop: 1. Select the target computer(s) from the computer list. 2. From the menu, select Manage > Copy Items… 3. Add the script files to the *Items to copy* list. 4. In the *Place items in:*, select *Specify full path…* and enter */Library/Application Support/Faronics/Deep Freeze/Scripts*. Click *OK*. 5. In the *Set ownership to:*, select *Inherit from destination folder*. 6. Other settings can be set as required. 7. Click *Copy*. #### Adding Targeted Computers to the Task List In order to run a task, there must be computers targeted to run the task. To add one or more computers to be targeted to run the task, complete the following steps: 1. In the left column, double-click the task to be targeted to the specified computers. 2. The *Task Edit* window appears. At the bottom of the window is a dialog listing the designated computers assigned to the task. Before a computer is added to the list, it reads *No Computers*. 3. Drag and drop the preferred computer or group of computers into the dialog from the computers in the *All Computers* list. The number of computers assigned to a specific task appears at the bottom of the window. 4. Click *Save*.