This guide will show you how to add your network switches to the Infrastructure tab and associate them with your Site Map locations.
Why Add your Managed Network Switches to Foreman?
Our system queries your switches to retrieve the MAC address on each port and associates it with a specific location on the Site Map. This allows for the automatic generation and regular updates of the Site Map whenever infrastructure queries are performed. Consequently, your technicians can easily relocate miners, and the site map will be automatically updated to reflect these changes.
Uploading Multiple Smart Switches to Infrastructure at Once
If you have more than one Smart Switch, you can perform a CSV upload to add them to Infrastructure in a single operation.
From the Infrastructure tab on the left panel of Foreman, click the 'Upload Infrastructure' button and select 'Managed Switch' from the dropdown list. You'll see that an option to download a CSV template file has now appeared. This file will contain your existing Smart Switches if you added some previously. Otherwise, it will be blank if this is your first time adding a Smart Switch.
Enter the details of the Smart Switches into the CSV file, ensuring that you enter data in the Name, Pickaxe Key, IP, Port, and SNMP Community String columns. The Name column will be the name of your switch (ex. 'switch01'). Pickaxe Key is the ID number on the Pickaxe page - (this is the Pickaxe responsible for querying the switch). The 'Port' value is typically 161. Our switch integrations work off SNMP v2c querying, so you'll need SNMP v2 with a community string set on every device. Typically, this is "public" by default. Foreman only needs read permissions for your smart switches. Accuracy at this step is critical because your upload will only be successful if you have data entered for each of these five columns.
If you have the ports in a VLAN, the VLAN ID must be appended to the community string. Example: if the ports are in VLAN 401, the community string will be public@401
Once you've checked your CSV file for accuracy, you can upload it to Foreman. Click 'Choose File' from the window you downloaded the template file and select your completed CSV file. Next, click the 'Upload' button to finish the process. Your Infrastructure page will now be populated with the Smart Switches from your file.
The rate that the switches are queried is configurable, and we recommend lowering that to 2 minutes so you get information a little quicker. On the Pickaxe page, click the Gear icon on the Pickaxe card and then select 'Configure.' Under the Timeouts tab, set 'Infrastructure Collect Delay' to 90 SECONDS and 'Infrastructure Push Delay' to 2 minutes.
Associating IP Addresses with Locations on Your Site Map
Now that you have items added to Infrastructure for your network switches, you're ready to start associating them with Site Map locations. Click 'Upload Associations' at the top of the Infrastructure screen. Select 'Managed Switch - Managed Switch' from the dropdown list, then download your CSV template file.
To ensure a successful upload of your CSV, some required headers must be included in your file. These include Name, Association Type, Association Name, Identifier, Location Row, and Location Index. The 'Name' column will be the name you entered when you created the item for a Managed Switch on the Infrastructure tab. Since you want to associate IP addresses with individual locations on your Site Map, enter "Location" under the 'Association Type' column. Next, enter the Site Map group name you want to associate miners to under the 'Association Name' column. The 'Identifier' column is where you will enter your list of IP Addresses that you have assigned to your miners. Lastly, the 'Location Row' and 'Location Index' columns are where you will specify the position on the rack you'd like to associate the miner with that IP address to.
Once your CSV has been filled out with all information necessary for your associations, click 'Choose File,' select your CSV, and click 'Upload' to complete the process.
If everything in your CSV was entered correctly, you should see your miners populate your specified locations on your Site Map tab.
If you have any questions or need assistance, please email us at firstname.lastname@example.org, and we would be happy to assist you.