Welcome To The Foreman Knowledge Base

How To: Automatically Populate Your Site Map in Foreman - 2 Setup Methods

In Foreman, your Site Map can be automatically populated and updated in two distinct ways:

  1. Using Managed Switches, or

  2. Associating IP Addresses directly to Site Map locations.

Each method has its own setup process, and this guide walks you through both so you can choose the best approach for your operation.


Why Auto-Populate Your Site Map?

Automatically updating your Site Map based on infrastructure data allows you to quickly and accurately track the physical location of devices such as miners. This saves technicians time when relocating equipment, ensures up-to-date mapping, and reduces the need for manual updates.

ChatGPT Image Apr 24, 2025, 11_17_51 AM.png


Method 1: Auto-Mapping with Managed Switches

This method uses the MAC addresses detected on switch ports to determine where devices are physically located.

Step 1: Upload Your Managed Switches to the Infrastructure Page

To get started:

  1. Navigate to the Infrastructure tab in Foreman.

  2. Click Upload Infrastructure and choose Managed Switch from the dropdown.

  3. Download the provided CSV template. This will either be blank (if this is your first time) or pre-filled with existing switches.

Screenshot 2025-04-24 at 11.05.51 AM.png

Fill out the CSV with the following required fields:

  • Name: e.g., switch01

  • Pickaxe Key: the Pickaxe ID that will query this switch

  • IP: IP address of the switch

  • Port: usually 161 (used for SNMP)

  • SNMP Community String: typically public (use public@VLAN_ID if querying a VLAN)

Note: We support SNMP v2c, and only read permissions are needed.

Once completed, upload the file via Choose File and then click Upload.

Step 2: Configure Query Frequency

To optimize performance:

  • Go to the Pickaxe tab

  • Click the Gear icon on the relevant Pickaxe

  • Under the Timeouts tab:

    • Set Infrastructure Collect Delay to 90 seconds

    • Set Infrastructure Push Delay to 2 minutes

Screenshot 2025-04-24 at 11.09.51 AM.png

Step 3: Associate Switch Ports with Site Map Locations

  1. Back in the Infrastructure tab, click Upload Associations.

  2. Select Managed Switch – Managed Switch as the association type.

  3. Download the CSV template and fill out the following fields:

    • Name: Name of the managed switch

    • Association Type: Must be Location

    • Association Name: The Site Map rack name

    • Identifier: Port number (e.g., 0, 1, 2, ...)

    • Location Row and Location Index: Specific rack placementScreenshot 2025-04-24 at 11.11.43 AM.png

Example:

Screenshot 2025-04-24 at 2.28.17 PM.png

Upload this completed file. Foreman will now auto-map miners to their locations based on MAC addresses detected on those switch ports. 🎉


Method 2: Auto-Mapping Using IP Address Associations

This method allows you to associate miners to specific Site Map locations based on their IP address—ideal for network setups that assign a static IP per switch port.

Step 1: Add an IP Address Item to Infrastructure

Before uploading associations, you'll need to create a single Infrastructure item of type IP Address:

  1. Go to the Infrastructure tab in Foreman.

  2. Click Add Infrastructure, then select IP Address from the type dropdown.

  3. Assign a name, then click save.Screenshot 2025-04-24 at 12.47.57 PM.png

Note: This setup is specifically for networks where each device has a static IP tied to a switch port. This allows accurate and consistent Site Map placement based on IP alone.

Step 2: Upload IP Address Associations

Once the IP Address item is in place:

  1. Click Upload Associations in the Infrastructure tab.

  2. Select IP Address – IP Address as the association type.

  3. Download and fill out the CSV with these required columns:

    • Name: Must match the name of your IP Address Infrastructure item (e.g., ip-map-01)

    • Association Type: Must be Location

    • Association Name: The Site Map group name

    • Identifier: The static IP address of the miner

    • Location Row and Location Index: Rack placement on the Site Map

Screenshot 2025-04-24 at 12.49.08 PM.png

Example:

Screenshot 2025-04-24 at 11.32.49 AM.png

Upload your CSV, and Foreman will automatically assign each IP address to the specified location on your Site Map. 🎉


Need Help?

If you have any questions or run into issues, feel free to reach out to our support team. We’re happy to help you get your site map running smoothly.

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Article is closed for comments.