nf images

The nf images command manages OS images used for iPXE network booting.

You can browse images available in the NodeFoundry registry, download them to the master node, view which images are already downloaded, and set the default image that is served to newly booting nodes.

When a node PXE boots, it pulls the image marked as default. Use nf images default to control which OS is deployed to new machines.

Usage

Terminal

$ nf images available
$ nf images downloaded
$ nf images download --id <image-id>
$ nf images default --id <image-id>

Commands

nf images available

nf images available

List all OS images in the NodeFoundry registry. Shows name, distro, version, architecture, and whether it has already been downloaded to the master node.

Flag	Description
`--json`	Output results as JSON

nf images downloaded

nf images downloaded

List images that have been downloaded to the master node. The current default boot image is marked with a ✓.

Flag	Description
`--json`	Output results as JSON

nf images download

nf images download

Download an image from the registry to the master node. A real-time progress bar is displayed via SSE. You can use a short 8-character ID prefix.

Flag	Description
`--id`	Image ID or short prefix (required)

nf images default

nf images default

Set an already-downloaded image as the default boot image. All newly booting nodes will receive this image.

Flag	Description
`--id`	Image ID to set as default (required)

Examples

Terminal

$ nf images available
ID        NAME                 DISTRO     VERSION    ARCH       STATUS
a1b2c3d4  Ubuntu Server 24.04  ubuntu     v24.04     amd64      downloaded
e5f6a7b8  Rocky Linux 9.4      rocky      v9.4       amd64

Terminal

$ nf images download --id a1b2c3d4 Downloading ██████████████████████████████ 100% | 1.2 GB Download complete!

$ nf images default —id a1b2c3d4 Default image updated.

Terminal

$ nf images downloaded
  ID        NAME                 DISTRO     VERSION    ARCH       FLAGS
✓ a1b2c3d4  Ubuntu Server 24.04  ubuntu     v24.04     amd64      default
  c9d0e1f2  Rocky Linux 9.4      rocky      v9.4       amd64