此页面尚未翻译。显示英文版本。

en → zh-CN

docs / Client Management

Client Management

MAC ACLs, auto-discovery, next boot, WoL.

在 GitHub 上编辑 ↗

Client Management Guide#

Complete guide for managing network boot clients with MAC-based access control.

Table of Contents#

Overview
Adding Clients
Client Permissions
Public vs Private Images
Client Statistics
Bulk Operations
Troubleshooting

Overview#

Bootimus uses MAC address-based access control to manage which clients can boot and which ISOs they can access. This provides granular control over your network boot environment.

Key Concepts#

Client: A network boot device identified by MAC address
Static client: Manually created or promoted from discovered - a permanent registration
Discovered client: Automatically created when an unknown device PXE boots (like a DHCP lease)
Enabled: Client is allowed to boot (shows in boot menu)
Disabled: Client cannot boot (blocked from accessing boot menu)
Assigned Images: When a client has images assigned, it sees only those images (not the full public list)
Show Public Images: When enabled alongside assigned images, client sees both assigned and public images
Next Boot Action: A one-time boot image override that auto-clears after use

Client Auto-Discovery#

When an unknown device PXE boots, Bootimus automatically creates a discovered client record with:

MAC address from the PXE request
Hardware inventory (CPU, memory, manufacturer, serial number, NIC)
Enabled with public images visible by default

Discovered clients appear in the clients table with a “Discovered” badge. You can promote them to static clients using the “Make Static” button, which registers them as permanent entries. If a previously deleted client PXE boots again, it is automatically restored.

Database Modes#

SQLite Mode:

Clients stored in SQLite database
Image assignments stored in allowed_images JSON field
Perfect for single-server deployments

PostgreSQL Mode:

Clients stored in PostgreSQL database
Image assignments use many-to-many relationship table
Better performance for large deployments

Adding Clients#

Via Web Interface#

Navigate to admin panel: http://your-server:8081
Click “Clients” tab
Click “Add Client” button
Fill in details:
- MAC Address: 00:11:22:33:44:55 (required)
- Name: Friendly name (e.g., “Lab Server 1”)
- Description: Additional details (optional)
- Enabled: Check to allow booting
Click “Create Client”

Via API#

curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients \
  -H "Content-Type: application/json" \
  -d '{
    "mac_address": "00:11:22:33:44:55",
    "name": "Lab Server 1",
    "description": "Dell PowerEdge R720",
    "enabled": true
  }'

MAC Address Format#

Bootimus accepts MAC addresses in these formats:

00:11:22:33:44:55 (colon-separated, preferred)
00-11-22-33-44-55 (dash-separated, auto-converted)
001122334455 (no separators, auto-converted)

All formats are normalized to colon-separated lowercase.

Client Permissions#

Assign Images to Client#

Via Web Interface:

Click “Edit” on client row
Select images from multi-select dropdown
Click “Update Client”

Via API:

curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients/assign \
  -H "Content-Type: application/json" \
  -d '{
    "mac_address": "00:11:22:33:44:55",
    "image_filenames": [
      "ubuntu-24.04-live-server-amd64.iso",
      "debian-13.2.0-amd64-netinst.iso",
      "archlinux-2025.12.01-x86_64.iso"
    ]
  }'

View Client Permissions#

Via Web Interface:

Client’s assigned images shown in edit modal

Via API:

# Get client details including assigned images
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" | jq

Response:

{
  "success": true,
  "data": {
    "id": 1,
    "mac_address": "00:11:22:33:44:55",
    "name": "Lab Server 1",
    "description": "Dell PowerEdge R720",
    "enabled": true,
    "boot_count": 15,
    "last_boot": "2025-01-02T10:30:00Z",
    "allowed_images": [
      "ubuntu-24.04-live-server-amd64.iso",
      "debian-13.2.0-amd64-netinst.iso"
    ]
  }
}

Public vs Private Images#

Public Images#

Public images are available to all clients, even unregistered ones.

Use cases:

Rescue/recovery ISOs
Network diagnostic tools
Common deployment images
Open lab environments

Make image public:

curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/images?filename=ubuntu.iso" \
  -H "Content-Type: application/json" \
  -d '{"public": true}'

Private Images#

Private images are only available to assigned clients.

Use cases:

Sensitive or licensed images
Client-specific deployments
Restricted environments
Beta/test images

Make image private:

curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/images?filename=windows.iso" \
  -H "Content-Type: application/json" \
  -d '{"public": false}'

Access Control Matrix#

Client State	What They See
Enabled + Assigned	Only their assigned images
Enabled + No Assignments	All public images
Disabled	All public images
Not Registered	All public images

Client Statistics#

Bootimus tracks boot statistics for each client:

Boot Count: Total number of boot attempts
Last Boot: Timestamp of most recent boot
Success Rate: Percentage of successful boots

View Statistics#

Via Web Interface:

Statistics shown in clients table

Via API:

# Get all clients with statistics
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/clients | jq '.data[] | {name, boot_count, last_boot}'

# Get top clients by boot count
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/clients | \
  jq '.data | sort_by(.boot_count) | reverse | .[0:10] | .[] | {name, boot_count}'

Boot Logs#

View detailed boot logs per client:

# Filter boot logs by MAC address
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/logs | \
  jq '.data[] | select(.mac_address=="00:11:22:33:44:55")'

Bulk Operations#

Bulk Add Clients#

#!/bin/bash
# bulk-add-clients.sh

ADMIN_PASSWORD="${ADMIN_PASSWORD:-your-password}"

# Format: MAC:NAME:DESCRIPTION
CLIENTS=(
  "00:11:22:33:44:01:Server-01:Production Web Server"
  "00:11:22:33:44:02:Server-02:Production Database Server"
  "00:11:22:33:44:03:Server-03:Production Cache Server"
  "00:11:22:33:44:10:Workstation-01:Developer Laptop"
  "00:11:22:33:44:11:Workstation-02:QA Testing Machine"
)

for entry in "${CLIENTS[@]}"; do
  IFS=':' read -r mac name description <<< "$entry"

  curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients \
    -H "Content-Type: application/json" \
    -d "{
      \"mac_address\":\"$mac\",
      \"name\":\"$name\",
      \"description\":\"$description\",
      \"enabled\":true
    }"

  echo "Added $name ($mac)"
  sleep 0.5
done

Bulk Assign Images#

#!/bin/bash
# bulk-assign-images.sh

ADMIN_PASSWORD="${ADMIN_PASSWORD:-your-password}"

# Assign Ubuntu and Debian to all servers
SERVER_MACS=(
  "00:11:22:33:44:01"
  "00:11:22:33:44:02"
  "00:11:22:33:44:03"
)

IMAGES='["ubuntu-24.04-live-server-amd64.iso","debian-13.2.0-amd64-netinst.iso"]'

for mac in "${SERVER_MACS[@]}"; do
  curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients/assign \
    -H "Content-Type: application/json" \
    -d "{\"mac_address\":\"$mac\",\"image_filenames\":$IMAGES}"

  echo "Assigned images to $mac"
done

Bulk Enable/Disable#

#!/bin/bash
# bulk-enable.sh

ADMIN_PASSWORD="${ADMIN_PASSWORD:-your-password}"

# Get all clients and enable them
macs=$(curl -H "Authorization: Bearer $TOKEN" -s http://localhost:8081/api/clients | \
  jq -r '.data[].mac_address')

for mac in $macs; do
  curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/clients?mac=$mac" \
    -H "Content-Type: application/json" \
    -d '{"enabled":true}'
  echo "Enabled $mac"
done

Export Client List#

#!/bin/bash
# export-clients.sh

ADMIN_PASSWORD="${ADMIN_PASSWORD:-your-password}"

echo "MAC Address,Name,Description,Enabled,Boot Count,Last Boot"

curl -H "Authorization: Bearer $TOKEN" -s http://localhost:8081/api/clients | \
  jq -r '.data[] | [.mac_address, .name, .description, .enabled, .boot_count, .last_boot] | @csv'

Import Clients from CSV#

#!/bin/bash
# import-clients.sh

ADMIN_PASSWORD="${ADMIN_PASSWORD:-your-password}"
CSV_FILE="clients.csv"

# Skip header line and process CSV
tail -n +2 "$CSV_FILE" | while IFS=',' read -r mac name description enabled; do
  # Remove quotes from CSV values
  mac=$(echo $mac | tr -d '"')
  name=$(echo $name | tr -d '"')
  description=$(echo $description | tr -d '"')
  enabled=$(echo $enabled | tr -d '"')

  curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients \
    -H "Content-Type: application/json" \
    -d "{
      \"mac_address\":\"$mac\",
      \"name\":\"$name\",
      \"description\":\"$description\",
      \"enabled\":$enabled
    }"

  echo "Imported $name ($mac)"
done

Next Boot Action#

Set a one-time boot image for a client. On the next PXE boot, the selected image will be pre-selected as the default menu item with a timeout. The action auto-clears after use - subsequent boots return to normal.

Via Web Interface#

Click “Next Boot” on a client row
Select an image from the dropdown
Click “Set Next Boot” to just set the image, or “Set & Wake” to also send a Wake-on-LAN packet

Via API#

# Set next boot image
curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients/next-boot \
  -H "Content-Type: application/json" \
  -d '{"mac_address":"00:11:22:33:44:55","image_filename":"ubuntu-24.04.iso"}'

# Clear next boot action
curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients/next-boot \
  -H "Content-Type: application/json" \
  -d '{"mac_address":"00:11:22:33:44:55","image_filename":""}'

Behaviour#

The boot menu is displayed as normal but with the next boot image pre-selected as default
If the global menu timeout is disabled (set to 0), a 10-second timeout is applied as an override
If the client doesn’t boot before the action is consumed, the next boot clears on the first PXE request
Empty groups are hidden from the menu when a client has assigned images

Wake-on-LAN#

Send a WOL magic packet to wake a client remotely. Combine with Next Boot to wake a machine and have it boot into a specific image.

Via API#

# Wake a client
curl -H "Authorization: Bearer $TOKEN" -X POST "http://localhost:8081/api/clients/wake?mac=00:11:22:33:44:55"

# Wake with custom broadcast address
curl -H "Authorization: Bearer $TOKEN" -X POST "http://localhost:8081/api/clients/wake?mac=00:11:22:33:44:55" \
  -H "Content-Type: application/json" \
  -d '{"broadcast_addr":"192.168.1.255"}'

Hardware Inventory#

Bootimus collects hardware information from PXE clients during boot, including:

CPU, memory, platform, and architecture
Manufacturer, product name, and serial number
UUID and NIC chip info
IP address

View inventory from the Edit & Assign Images modal for any client, or use the API:

# Latest inventory
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients/inventory?mac=00:11:22:33:44:55"

# Inventory history
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients/inventory/history?mac=00:11:22:33:44:55&limit=10"

Troubleshooting#

Symptoms: Client boots but shows empty menu or “No boot images available”

Possible causes:

Client is disabled
No public images available
No images assigned to client
All images are disabled

Solution:

# Check client status
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" | jq

# Enable client
curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

# Check available images
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/images | jq '.data[] | {filename, enabled, public}'

# Make images public
curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/images?filename=ubuntu.iso" \
  -H "Content-Type: application/json" \
  -d '{"public":true,"enabled":true}'

MAC Address Not Detected#

Symptoms: Boot logs show “unknown” MAC address

Possible causes:

iPXE cannot detect MAC address from network interface
Client using multiple network interfaces

Solution:

# Check boot logs for actual IP address
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/logs | jq '.data[] | {mac_address, ip_address}'

# Register client by IP if MAC is unknown
# (Note: Less reliable, IP may change)

Assigned Images Not Showing#

Symptoms: Client can only see public images, not assigned ones

Possible causes:

Client not enabled
Images not enabled
Wrong MAC address format
Database sync issue

Solution:

# Verify client exists and is enabled
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" | jq

# Verify image assignments
curl -H "Authorization: Bearer $TOKEN" "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" | \
  jq '.data.allowed_images'

# Re-assign images
curl -H "Authorization: Bearer $TOKEN" -X POST http://localhost:8081/api/clients/assign \
  -H "Content-Type: application/json" \
  -d '{
    "mac_address":"00:11:22:33:44:55",
    "image_filenames":["ubuntu.iso","debian.iso"]
  }'

# Check database directly (SQLite)
sqlite3 data/bootimus.db "SELECT * FROM clients WHERE mac_address='00:11:22:33:44:55';"

Duplicate Client Error#

Symptoms: “Client already exists” or UNIQUE constraint error

Cause: MAC address already registered

Solution:

# Find existing client
curl -H "Authorization: Bearer $TOKEN" http://localhost:8081/api/clients | \
  jq '.data[] | select(.mac_address=="00:11:22:33:44:55")'

# Update existing client instead
curl -H "Authorization: Bearer $TOKEN" -X PUT "http://localhost:8081/api/clients?mac=00:11:22:33:44:55" \
  -H "Content-Type: application/json" \
  -d '{"name":"Updated Name","enabled":true}'

# Or delete and re-create
curl -H "Authorization: Bearer $TOKEN" -X DELETE "http://localhost:8081/api/clients?mac=00:11:22:33:44:55"

Next Steps#

Configure Image Management to add ISOs
Use Admin Console for management
Set up DHCP Configuration for network booting
View Boot Logs for monitoring

Client Management Guide#

Table of Contents#

Overview#

Key Concepts#

Client Auto-Discovery#

Database Modes#

Adding Clients#

Via Web Interface#

Via API#

MAC Address Format#

Client Permissions#

Assign Images to Client#

View Client Permissions#

Public vs Private Images#

Public Images#

Private Images#

Access Control Matrix#

Client Statistics#

View Statistics#

Boot Logs#

Bulk Operations#

Bulk Add Clients#

Bulk Assign Images#

Bulk Enable/Disable#

Export Client List#

Import Clients from CSV#

Next Boot Action#

Via Web Interface#

Via API#

Behaviour#

Wake-on-LAN#

Via API#

Hardware Inventory#

Troubleshooting#

Client Not Seeing Boot Menu#

MAC Address Not Detected#

Assigned Images Not Showing#

Duplicate Client Error#

Next Steps#