NetBoot Images

This section provides a basic, best practice workflow for imaging computers using NetBoot images. The workflow involves the following steps:

  1. Determine which NetBoot images you need to create.

  2. Create clean base OS images.

  3. Create the NetBoot images.

  4. Upload the NetBoot images.

  5. (Optional) Create configurations.

  6. Boot the target computers to a NetBoot image.

  7. Image a computer.

Requirements

To image computers by using a NetBoot image, you need:

  • A NetBoot server. The server can be one of the following:

    • A server with macOS Server installed and access to macOS Server's NetInstall service
      As of fall 2018, Apple removed NetInstall from the server app. For more information about changes to the macOS server and alternatives, see the following article from Apple's support website: https://support.apple.com/HT208312.

    • A Linux server with the NetBoot/SUS Appliance (Net/SUS) installed

    It is recommended but not required that the server be a dedicated NetBoot server.

  • A tool for creating NetBoot images. The tool can be one of the following:

  • The target computers

  • A network switch
    A gigabit network switch is recommended but not required.

  • Network cables (one for the server and one for each computer)

  • A Thunderbolt to Ethernet or USB to Ethernet adapter for computers that do not have built-in Ethernet ports

Step 1: Determine Which NetBoot Images to Create

The number and type of NetBoot images you create depends on the macOS models in your environment. Typically, a NetBoot image must be created on hardware that matches the target computer. Additionally, each macOS model supports a different range of macOS versions, so you need to make sure that the version in the NetBoot image is supported on the target hardware.

To start, create an advanced search that lets you view the macOS models in your environment. Then, use the information in the "System Requirements" section to determine which macOS versions are supported on that hardware and then how many NetBoot images you need to create.

Viewing the macOS Models in Your Environment

  1. Log in to Jamf Pro.

  2. Click Computers at the top of the page.

  3. Click Search Inventory.

  4. Click New images/download/thumbnails/82686259/Icon_New_Button.png .

  5. To save the search, select the Save this Search checkbox.

  6. Enter "Device Models and Years" in the Display Name field.

  7. Click the Display tab.

  8. Click Hardware, and then select Model.

  9. Click Save.

  10. Click View to view the search results.

  11. Sort the results by model by clicking the Model column heading.

System Requirements

For a comprehensive list of which macOS versions are supported on the Mac models in your environment, see the following article from Apple's support website: https://support.apple.com/HT201686

Step 2: Create Clean Base OS Images

Now that you know what NetBoot images you need to create, create a clean base OS image for each one. For instructions, see the Creating a Minimal Base OS Image article.

Step 3: Create the NetBoot Images

The procedure for creating a NetBoot image differs depending on the tool. Follow the procedure for the tool you are using.

Using the Casper NetInstall Image Creator

To avoid complications with server-to-client compatibility, create the NetBoot image on the server that will host the image. The NetBoot image must be created with an operating system that is running the same or later version than the operating system used to image client computers.

  1. Download the Casper NetInstall Image Creator from Jamf Nation.

  2. Follow the instructions in the Creating a NetBoot Image and Setting Up a NetBoot Server article.

Using the AutoCasperNBI

The NetBoot image can be created on any macOS computer, regardless of version.

  1. Download AutoCasperNBI from macmule: https://macmule.com/projects/autocaspernbi/

  2. Open AutoCasperNBI.app.
    Note: This requires administrator credentials for the computer or server.

  3. Select a .dmg of an operating system image.

  4. Select Jamf Imaging.app.

  5. Enter the Jamf Pro server URL. For example, “https://jss.instancename.com:8443/” (excluding the quotation marks).

  6. Enter a name for the NetBoot image.
    It is recommended that you include the version number of the operating system in the name.
    Important: (NetBoot/SUS only) Do not use spaces in the name as they can break the imaging process in the NetBoot/SUS Appliance.

Step 4: Upload the NetBoot Images

The procedure for uploading a NetBoot image differs depending on the tool. Follow the procedure for the tool you are using.

For NetInstall

  1. From the NetBoot server, put the NetBoot image in /Library/NetBoot/NetBootSP0/.

  2. Turn on the NetInstall service in Server.app.

  3. Ensure that a green status icon is displayed next to the NetBoot image in the NetInstall pane, indicating that the image is available for deployment.

For NetBoot/SUS Appliance

  1. Log into the Net/SUS server web application.
    The default credentials are:
    Username: webadmin
    Password: webadmin
    Note: It is recommended that you change the default credentials for better security.

  2. Click NetBoot Server.
    On a smartphone or iPod touch, this option is in the pop-up menu.

  3. Click Upload Net Boot Image.
    This connects you to the SMB share where NetBoot images are stored.

  4. Enter credentials to the share and click Connect.
    The default credentials are:
    Username: smbuser
    Password: smbuser
    Note: It is recommended that you change the default credentials for better security.

  5. Copy the NetBoot image to the SMB share.
    Important: The name of the folder cannot contain any spaces.

  6. Return to the NetBoot/SUS server web application and refresh the page.

  7. Choose the NetBoot image from the pop-up menu.

  8. Choose subnets for the NetBoot image by entering a subnet and a netmask. Then click Add Subnet.

  9. Click Enable NetBoot.
    A green status icon is displayed next to the NetBoot image in the NetInstall pane.
    If a red status icon is displayed, do one of the following:

    • Ensure you are using the subnet that includes the NetBoot server. (For more information, see http://www.subnet-calculator.com.)

    • Ensure there are no spaces in the NetBoot image filename.

Step 5: (Optional) Create Configurations

Configurations give you a quick way to specify what should be installed and configured on computers during imaging. Using configurations can speed up the imaging process. For more information, see Configurations in the Jamf Pro Administrator's Guide.

Step 6: Boot the Target Computers to a NetBoot Image

The NetBoot server must be on the same subnet as the target computers. For information about booting computers across subnets, see the following article from Apple's support website: https://support.apple.com/HT202059

This section explains two ways to boot to a NetBoot image: manually and using a policy. The manual method is useful for testing purposes, and testing is recommended before deploying a policy that boots all computers to the NetBoot image.

Note: If you are booting a macOS 10.11 or later computer to a NetBoot image, the computer must first trust the NetBoot server. For more information, see the Booting a macOS 10.11 or Later Computer to a NetBoot Image Using a Policy or Jamf Remote article.

Manually Booting a Computer to a NetBoot Image

  1. From the target computer, navigate to Apple menu > System Preferences.

  2. Click Startup Disk.

  3. Select the NetBoot image.
    Note: Hover over the NetBoot image to view its IP address.

  4. Click Restart.

Using a Policy to Boot Computers to a NetBoot Image

  1. Log in to Jamf Pro.

  2. Add the NetBoot server to Jamf Pro by doing the following:

    1. In the top-right corner of the page, click Settings images/download/thumbnails/82686259/Icon_Settings_Hover.png .

    2. Click Server Infrastructure.

    3. Click Netboot Servers.

    4. Click New images/download/thumbnails/82686259/Icon_New_Button.png .

    5. Configure the settings on the pane, making sure to choose "Use default image" from the NetBoot Image pop-up menu.

    6. Click Save.

  3. Click Computers at the top of the page.

  4. Click Policies.

  5. Click New images/download/thumbnails/82686259/Icon_New_Button.png .

  6. Use the General payload to configure basic settings for the policy, including the trigger and execution frequency.

  7. Select the Restart Options payload , and choose "Restart immediately" from the No Users Logged In Action or User Logged In Action pop-up menu.

  8. Choose the server that is hosting the NetBoot image from the Boot Computers To pop-up menu.

  9. Click the Scope tab and specify the computers you want to boot to the NetBoot image.

  10. Click Save.

Step 7: Image a Computer

  1. From the target computer, open Jamf Imaging.

  2. Modify the basic imaging settings as needed.

  3. Click Image.

Troubleshooting

Target computers not booting to the NetBoot image

If target computers are not booting to the NetBoot image:

  1. Identify where the failure occurred.

  2. Boot the target computer in verbose mode.

    • Hold down Command-V.

    • Additional messaging will display on the computer screen at startup and help to identify the failure.

  3. Ensure the server and client(s) are on the same subnet range.

  4. Isolate your server and client(s) to a private network on a dumb switch.

  5. Recreate the NetBoot image.

Computers failing to block copy

If block copying of the base OS fails, is skipped, or Jamf Imaging begins “Installing Base OS”:

Create a base operating system using a different method. For more information, see the following article from Apple's support website : https://support.apple.com/HT203638

Jamf Imaging Debug Mode

If a computer does not finish imaging, put Jamf Imaging into full debug mode and contact your Jamf account representative. Putting Jamf Imaging into debug mode will help your Jamf account representative identify the issue. To put Jamf Imaging into full debug mode, execute the following command when creating the NetBoot image:

sudo touch /Applications/Casper\ Suite/Casper\ Imaging.app/Contents/Support/debug

When full debug is enabled in this way, a log is created on the target computer. This log can be found in the following location:

/Library/Logs/JAMF/ImagingScripts.log

A debug log is also created on the host computer running Jamf Imaging. This log can be found in the following location:

~/Library/Logs/JAMF/CasperImagingDebug.log

Logs and any screenshots of the issue are also helpful. From the target computer, the logs to provide are:

  • /var/log/system.log

  • /var/log/jamf.log

  • /var/log/install.log

From the Jamf Pro server, the log to provide is:

/path/to/jss/logs/JAMFSoftwareServer.log

Additional Resources

See the following documentation for more information about NetBoot-related concepts and procedures:

Copyright     Privacy Policy     Terms of Use     Security
© copyright 2002-2021 Jamf. All rights reserved.