Blast Image Config Workflow Preference Settings

Below are the workflow settings for Blast Image Config version 3.0 and newer. The documentation for previous versions are still available.

Blast Image Config has the ability to read in workflow settings which can greatly automate and speed up the restoration and config process.

Default workflow settings are useful for the system admins who want to force the person doing the restore to use certain defaults, ie, Firmware security settings can't be changed and will be set to "command", using a specific master system disk image, post install script, etc.

Workflow files can also be used to force a (mostly) autorun mode, which is useful for quick and simple installs - ie, when there's only one image to restore and there's no need to make a lot of choices. Note that in order for autorun to work the default settings MUST be configured as well as the autorun settings, like "AUTO_RUN", detailed below.

In order to use a workflow file it must be specified in the 'WorkFlows.xml' file. See the WorkFlows Manager documentation for how to add entries for these workflow files to the WorkFlows.xml file. These workflow files can be created with any text editor and can have any filename that you want, but it's recommended to stick with no spaces in the filename.

Check out the download disk image of PSU Blast Image Config to get familiar with the new layout and to look over the sample workflow which you may find useful for reference.

The format of the keys and values in the file is as follows:

KEY_NAME=KEY_VALUE

Lines starting with a '#' are treated as comments:

# This is a comment line.

Here are the possible keys and values:

Key Name Possible Values Key Description
ENABLE_DEBUG_LOGGING YES
NO
Introduced in BIC version 2.9.3b2. No code currently uses this new debug mode, but will be used in future versions of BIC. Note that you can also enable debug mode by holding the 'Command' key when launching BIC.
NUMBER_OF_LOGS_TO_KEEP (Any Integer Value.) How many run logs should be kept in the 'Logs' folder?
AUTO_RUN YES
NO
Should PSU BIC auto run with these defaults?
PROMPT_TO_AUTORUN YES
NO
If we're autorunning, do you want to be prompted to autorun or not?
(This is provided for a way to cancel an autorun.)
DEFAULT_AUTORUN_BUTTON YES
NO
CANCEL
Which button should be the default button? If you pressed return on this dialog, it would be the button selected.
LOCK_FW_SETTINGS YES
NO
Do you want to allow (YES) or not (NO) the user to make changes to the Firmware security defaults?
FW_MODE DONOTMODIFY
OFF
COMMAND
FULL
Which mode do you want to set the Firmware security to? Most lab environments will probably use the command mode.
FW_PASSWD_MODE USEADMIN
SPECIFY_PASSWORD
What should the EFI Firmware security password be? Use the Admin password at login, or prompt the user for a password.
PRE_RESTORE_SCRIPT ScriptName.pl This is the filename of the script in the Pre-Restore-Scripts folder that should be selected as a default and executed when autorunning.
LOG_PRE_RESTORE_SCRIPT_OUTPUT YES
NO
Added in version 2.7.0b1. The output of the pre and post restore scripts can now be logged to the run log file.
PRE_RESTORE_SCRIPT_TIMEOUT_MINUTES (Any Integer Value.) Set this value to the number of minutes that you want BIC to wait for the pre restore script to finish running before reporting an error.
SKIP_DATE_TIME_SET YES
NO
Do you want to skip over setting the date and time? Note that as of version 2.9.1rc2 setting this to 'YES' will be honored regardless if auto-running or not.
DEFAULT_NETWORK_LOCATION_NAME Ethernet DHCP
Ethernet Static IP
As of BIC version 2.9.2b2, you can now specify the network location name to use, ie, if you need to specify something other than 'Automatic'. If this setting is not specified then the network location name will be set to 'Automatic' on the restored disk volume.
NETWORK_INTERFACE_NAME (Do Not Configure for default of "Ethernet")
Display Ethernet
Broadcom NetXtreme Gigabit Ethernet Controller
Added in BIC v3.1.8b5. If you want to override the default network interface name of "Ethernet" configure this key value with the name of the network interface you want to be configured. This workflow key is useful for when you need to configure a different network interface name, like a USB or Thunderbolt dock ethernet port ("Broadcom NetXtreme Gigabit Ethernet Controller"). To get a listing of the valid network interface names open the terminal.app and enter in this command (after the $):
$ networksetup -listallnetworkservices
NETWORK_CONFIG DO_NOT_CHANGE
DHCP
SET_IP
How should the network settings be configured on the restored disk?
DEFAULT_IP 123
123.123
123.123.123
123.123.123.123
Added in version 2.9.1rc2. Add at least 1, 2, 3 or all 4 octets.
DEFAULT_SUBNET 123.123.123
123.123.123.123
Added in version 2.9.0rc1. A good default value to use for this is '255.255.255' and don't specify the last octet. Note that if DEFAULT_IP is specified this value needs to have the same number of octets specified.
DEFAULT_ROUTER MATCH_IP
123.123.123.123
Added in version 2.9.0rc1. Set the value to 'MATCH_IP' and as you enter in the IP address the router IP will automatically fill in each respective octet to match the IP octet. Saves a little time when entering IP configurations. As of 2.9.1rc2 you can specify the full IP address if desired. Be aware that specifying the router IP requires that the DEFAULT_IP is also specified and that it has the same number of octets specified.
CREATE_NEW_NETWORK_PREFS_FILE YES
NO
Added in version 2.7.0b1. The network preferences file on the restored disk can now be erased before a new one is created, if desired.
DNS_SERVER1 123.123.123.123 IP address of the primary DNS Server. Only used when the NETWORK_CONFIG is set to SET_IP
DNS_SERVER2 123.123.123.123 IP address of the second DNS Server. Only used when the NETWORK_CONFIG is set to SET_IP
DNS_SERVER3 123.123.123.123 IP address of the third DNS Server. Only used when the NETWORK_CONFIG is set to SET_IP
SKIP_NETWORK_NAMES YES
NO
If this is set to 'YES' then BIC will not configure the network names and skip the stage.
COMPUTER_NAME Mac.{$IP}

Mac.{$IP1}.{$IP2}.{$IP3}.{$IP4}

Mac.{$SN}
Set the computer name on the restored disk. The max length is 63 characters, and should not contain these characters: "@", "=", ":". Use {$IP} to insert the Mac's IP address when using a static IP configuration. As of BIC version 2.9.0rc1 each IP octet is now available via the new dynamic variables: {$IP1}, {$IP2}, {$IP3}, {$IP4}
As of BIC version 2.9.0rc7 use the new {$SN} dynamic variable when you want the Mac's hardware serial number inserted into the name.
LOCAL_NAME Mac-{$IP}

Mac-{$IP1}-{$IP2}-{$IP3}-{$IP4}

Mac-{$SN}
Set the local (rendezvous) name on the restored disk. The max length is 63 characters, and should not contain these characters: " ", "'", "!", ".". Use {$IP} to insert the Mac's IP address when using a static IP configuration. As of BIC version 2.9.0rc1 each IP octet is now available via the new dynamic variables: {$IP1}, {$IP2}, {$IP3}, {$IP4}
As of BIC version 2.9.0rc7 use the new {$SN} dynamic variable when you want the Mac's hardware serial number inserted into the name.
IGNORE_NETWORK_NAME_ERRORS YES
NO
New as of BIC version 2.9.0rc7. Set this to 'YES' when you don't want to see error dialogs if the network names are too long and need to be truncated (which can be up to 63 characters long as of 10.6.) This setting isn't critical but useful to limit interruptions during a quick install process.
ENABLE_AIRPORT YES
NO
Added to PSU BIC version 2.6.4. If an AirPort (802.11 Wireless Network Card) is detected, should it be enabled on the restored disk? Please note that this will ONLY work reliably when PSU BIC is running under Mac OS X 10.4.7, with ncutil version 3.1.1 installed, and the restored volume is ALSO at Mac OS X 10.4.7 or higher. All that this does is enable the card - whatever wireless networks were selected and known about on the master Mac that was imaged should continue to be recognized on the restored Mac.
SKIP_SYSTEM_IMAGE YES
NO
Added to BIC v3.1.8b5. Skip restoring the system disk image. This would be useful in a "surplus or retire the Mac" workflow that just needs to securely erase the Mac's disk and leave the disk empty.
SKIP_SYSTEM_IMAGE_AND_DISK_OPTIONS YES
NO
Added to BIC v3.1.8b5. Do you want to skip restoring the system disk image and all disk options? This is most useful when you are testing your workflow and want to save time testing the post restore tasks. Note that enabling this feature may result in unexpected behavior with the selected volume since it can be modified again and again without doing a fresh restore of your system image. Once you are done testing the post restore events be sure to do a full run of your workflow to check that everything functions as you've intended with everything enabled.
DEFAULT_DISK_IMAGE MasterSystem.dmg

/Volumes/ServerVolName/MasterSystem.dmg

http://myserver.edu/MasterSystem.dmg

asr://my.asr.multicast.server.org
This is the name of the disk image that should be selected in the Disk Image popup menu. Images found in the RestoreImages folder or as specified in the NetworkImagesList file are FIRST added to the Disk Images popup menu, and THEN the matching disk image is automatically selected.

As of version 2.5b2: If the path begins with "/" then the path is assumed to be a full absolute path and NOT an image in the RestoreImages folder. The easiest way to get this path is to drag and drop the image file from the Finder into the a terminal.app window and then copy the path that was generated there and paste it into the DEFAULT_DISK_IMAGE key value field.
STOP_IMAGE_RESTORE_IF_NOT_ASR_SCANNED YES
NO
Introduced in BIC version 2.9.3b2. Setting this to 'YES' will force BIC to stop and warn the user if the system disk image to restore has not been properly scanned for restore.
BIC_IGNORE_DISK_FLAG_FILE (Any Filename)

.NameOfTheFileYouWantExample
Introduced in BIC version 2.9.3b2. To help prevent accidentally erasing disk volumes that you NEVER want BIC to touch, BIC will now check this setting for a value, and if it's not set, it will use the default setting and always check for the .BlastImageConfigIgnoreThisVolume file at the root of each mounted disk. Notice that filenames that start with a 'dot' character prevents the Finder from displaying it.
EXCLUDE_BOOT_DISK_VOLUMES YES
NO
Added in version 2.7.0b1. Set this to 'YES' if you do NOT want the other partitions that are on the same physical disk as the booted volume. If you are booting with a disk that has 2 or more partitions on it and you don't want them accidentally deleted by BIC, enable this setting. Read the Revision History for more details on this setting.
RESTORE_TO_INTERNAL_VOLUMES_ONLY YES
NO
New as of BIC version 2.9.1rc1. When set to 'YES' BIC will only restore to internal disk volumes of the Mac it's running on. This helps to prevent accidental erasure of external student scratch disks, USB flash drives, etc.
STOP_RESTORE_IF_MULTIPLE_DISKS_FOUND YES
NO
New as of BIC version 2.9.0rc7. If this key is set to 'YES' stopping the restore if more than 1 writable disk was found. This was created to help encourage the person doing the restore to unmount other volumes before allowing the restore to happen. Otherwise the risk is (unintentionally) erasing the wrong volume (ie, an external scratch disk for student files, etc.)
RESTORE_FIRST_DISK YES
NO
Should the first available disk in the Disk To Restore popup menu be used for the autorun restore?
ENABLE_VERIFICATION YES
NO
Should the restore be verified? If YES, the restore disk IMAGE must be read-only/compressed and have been scanned (checksums added).
PAUSE_ON_RESTORE YES
NO
Added with BIC version 2.0b17. If autorunning, do you still want to pause at the main restore dialog? Useful for when you want all other tasks to be automated but you might need to select a different restore image or disk to restore to.
ZERO_ERASE_RESTORE_DISK YES
NO
Added in BIC version 2.9.0rc2. Set this to 'YES' if you want BIC to zero out (secure erase) the selected disk before the master disk image is restored.
DEBUG_SKIP_RESTORE_BUTTON YES
NO
Added with BIC version 2.9.0rc1. Deprecated as of BIC v3.1.8b5, use the "SKIP_SYSTEM_IMAGE_AND_DISK_OPTIONS" key instead.
CREATE_SINGLE_PARTITION YES
NO
Should BIC create a single partition of the parent disk of the selected volume? This would be useful to configure to 'YES' if you were going to run a post restore script to restore the 'Recovery HD' volume. Note that if any of the other MOUNTED volumes on the same disk have the 'BIC_IGNORE_DISK_FLAG_FILE' then the disk will not be touched, for safety.
CREATED_SINGLE_PARTITION_VOLUME_NAME Disk Volume Name Here Added in BIC v3.1.8b5. Configure this setting value if you want to override the default volume name used when BIC is configured to create a single volume on the selected disk. Note that if you restore a system disk image this setting will be overridden.
ASR_TIMEOUT_MINUTES (Any Integer Value.) Added with BIC version 2.9.0rc1. Set this value to the number of minutes that you want to wait for the asr command line tool to respond. Take note that on older Macs restoring very large system images asr could go a few minutes before sending back a progress update. I'd recommend generally setting this number pretty high, like 60 for 1 hour, if you set this value at all. If not specified or set to 0, defaults to NO time out.
PAUSE_AFTER_RESTORE YES
NO
Added with BIC version 2.9.1rc2. Regardless if auto-running or not, BIC will only pause after the restore if this is set to 'YES'.
BLESS_RESTORED_DISK YES
NO
Should the restored disk be bootable? In most cases, this should be set to 'YES'.
SET_FW_BOOT YES
NO
Should the Firmware boot device be set to the restored disk? In most cases, you want this to be YES. If the Firmware security is enabled, and this is set to NO, it's possible that the Mac will not allow the booting from the restored disk.
POST_RESTORE_SCRIPT

PerlScriptName.pl

ShellScriptName.sh

PythonScriptName.py

RubyScriptName.rb

This is the filename of the script (anything that can run at the command line) in the Post-Restore-Scripts folder that should be selected as a default and executed when autorunning. This script receives the shell path of the restored disk.
LOG_POST_RESTORE_SCRIPT_OUTPUT YES
NO
Added in version 2.7.0b1. The output of the pre and post restore scripts can now be logged to the run log file.
POST_RESTORE_SCRIPT_TIMEOUT_MINUTES (Any Integer Value.) Set this value to the number of minutes that you want BIC to wait for the post restore script to finish running before reporting an error.
ENDING_TASK_SHELL_COMMAND /path/to/command -arguments
/sbin/shutdown -r now
Added in BIC v3.1.9b3. Configure this key with the command that you want to run instead of the 'ENDING_TASK' command. Useful for when you want to shutdown the Mac differently and/or run a script right before quitting/restarting/powering down.
ENDING_TASK QUIT
RESTART
SHUTDOWN
What should be done when the restore and configure process is complete? NOTE: If the above 'ENDING_TASK_SHELL_COMMAND' key is configured then this key will be ignored and have no effect.
Return to main BIC Documentation

Last Updated May 26, 2015