Wireless Interfaces
You can configure a Monitoring Point for wireless network connectivity if required and if your Monitoring Point supports it. When adding a wireless interface, you will need to know the SSID, the security type, and the pass phrase for the wifi network you want to connect to.
To change the SSID on a wireless interface, you need to delete the interface, restart networking, then add a new interface with the new SSID and restart networking again.
Add a wireless interface
Note: At this time, WPA2 Enterprise configuration must be done through the Admin API or by using curl.
Web admin
- Complete device setup.
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- Click Add Interface and select Wireless.
- Click the wireless network you want to connect to.
- Wait for the configuration page to appear.
- Update security settings.
- In the Security field, select the security type.
- In the Passphrase field, specify the wireless network passphrase.
- Click Next.
- Update the interface configuration.
- In the Address Family field, select the type of IP addressing (IPv4 or IPv6) for the interface.
- Configure addressing.
- (optional) Configure DNS.
- (optional) Configure transmission parameters.
- (optional) Configure static routes.
- Click Submit.
- Restart networking.
- You will briefly lose connectivity.
- The interface is operational when networking restarts.
- Check the interface status.
- Navigate to Home.
- In the Network State section, check the Status for the interface.
- It should be Up.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
Admin API
- Complete device setup.
- Access the Admin API.
- Determine which interfaces are already configured:
- Navigate to Interface > GET /interface/.
- Click Try it out.
- Click Execute.
- The Server response section should show Code “200” and show the configured interfaces.
- Confirm that the wireless interface is not already configured.
- If you are connecting to an access point that uses WPA2 Enterprise authentication, load the appropriate certificate/key files:
- Navigate to Interface > POST /interface/file/.
- Click Try it out.
- In the Parameters section:
- For the wpa_ca_cert field, click Choose File and browse to the file containing the CA certificate (PEM/DER format).
- For the wpa_client_cert field, click Choose File and browse to the file containing the client certificate (PEM/DER format).
- For the wpa_private_key field, click Choose File and browse to the file containing the client private key (PEM/DER/PFX format).
- Click Execute.
- The Server response section should show Code “200” and the specified files are loaded onto the Monitoring Point.
- Add the interface.
- Navigate to Interface > POST /interface/.
- Click Try it out.
- Copy the section of JSON text depending on the security protocol you are using:
- Edit the JSON text substituting the variables as appropriate.
- In the Parameters section, in the body field, paste the JSON text.
- Click Execute.
- The Server response section should show Code “200” to confirm that the interface was successfully created and configured.
- Restart networking.
- You will briefly lose connectivity to the Admin API.
- Verify that your new interface exists by repeating Step 3.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
curl
- Complete device setup.
- In APM, navigate to > Manage Monitoring Points to determine the device hostname.
-
Find out which interfaces are already configured.
curl -k -u <username> -X GET -H 'Accept: application/json' 'https://<hostname>/api/v1/interface/?config_state=active' | python -m json.tool
-
If you are connecting to an access point that uses WPA2 Enterprise (TLS) authentication, load the appropriate certificate/key files:
curl -k -u <username> -X POST -H 'Expect:' -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F wpa_ca_cert=@<full_path_to_file> -F wpa_client_cert=@<full_path_to_file> -F wpa_private_key=@<full_path_to_file> https://<hostname>/api/v1/interface/file/ | python -m json.tool
- <full_path_to_file> - the full path to the appropriate file.
- Add the interface.
- Copy the section of JSON text depending on the security protocol you are using:
- Edit the JSON text substituting the variables as appropriate.
- Save the text to a file called wifi-config.json.
-
Create the interface.
curl -k -X POST -H "Content-Type: application/json" --data-binary @wifi-config.json https://admin:<password>@<hostname>/api/v1/interface/
-
Restart networking to apply the changes.
curl -k https://admin:<password>@<hostname>/api/v1/interface/?config_state=pending
-
Restart networking. You will briefly lose connectivity to the Admin API.
curl -k -X PUT -H "Content-Type: application/json" -d {} https://admin:<password>@<hostname>/api/v1/service/networking/action=restart
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
The variables above are defined as follows:
- <username> - the user name on the Monitoring Point.
- <hostname> - the hostname or IP address of the Monitoring Point.
USB
If you are connecting to an access point that uses WPA2 Enterprise authentication, you will need to upload a CA certificate, client certificate, and/or a client private key to the Monitoring Point before configuring the interface. Use the steps in the curl or the Admin API instructions above to upload these files.
To add a wireless interface:
- Complete device setup.
- Download the wireless interface config file.
- Edit the downloaded config file for your needs.
- Uncomment sections to be used (if required).
- Replace content in arrow brackets (no arrow brackets should remain).
- Copy the file onto a USB stick.
- Make sure the Monitoring Point is ready.
- Insert the USB stick into the Monitoring Point.
- The Monitoring Point reads the configuration from the USB stick and indicates that it is doing so.
- Wait until the Monitoring Point is finished.
- Remove the USB stick.
- The Monitoring Point configuration is updated.
- Any problems updating the configuration are logged in the
usb.log
file on the USB stick.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
Web admin
- Complete device setup.
- Log in to Web Admin.
- Click Network Configuration.
- Click Add Wi-fi Interface.
- Make your changes.
- Click Restart Networking.
- You will briefly lose connectivity.
- The interface is operational when networking restarts.
- Check the interface status.
- The Web Admin home page shows the status of the wireless interface; there are three possible states: connected, configured but not connected, not configured. The wireless LED, if present, indicates the same three states.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
Edit a wireless interface configuration
Web admin
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- For the interface you want to edit, navigate to > Edit.
- Wait for the configuration page to appear.
- Make your changes.
- Restart networking.
- You will briefly lose connectivity.
- The interface is operational when networking restarts.
- Check the interface status.
- Navigate to Home.
- In the Network State section, check the Status for the interface.
- It should be Up.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
Admin API
- Access the Admin API.
- Navigate to Interface > PUT /interface/{interface name}/.
- Click Try it out.
- In the Parameters section:
- In the interface_name field, enter the interface you want to edit (e.g., wlan0).
- In the body field, update the fields as appropriate.
- Click Execute.
- The Server response section should show Code “200” to confirm that the interface was updated.
- Restart networking.
- You will briefly lose connectivity to the Admin API.
- The interface is available to use.
Web admin
- Log in to Web Admin.
- Click Network Configuration.
- Click the Wi-Fi interface name.
- Make your changes.
- Click Restart Networking.
- You will briefly lose connectivity.
- The interface is operational when networking restarts.
- Check the interface status.
- The Web Admin home page shows the status of the wireless interface; there are three possible states: connected, configured but not connected, not configured. The wireless LED, if present, indicates the same three states.
- Verify that the interface acquired an IP address.
- In APM, navigate to > Manage Monitoring Points.
- Select the Monitoring Point you are interested in.
- On the right side panel, check Local Network Interfaces for an IP address on the interface.
Delete a wireless interface
Web admin
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- For the interface you want to delete, navigate to > Delete.
- Click Confirm.
- Restart networking.
- You will briefly lose connectivity.
- The interface is deleted when networking restarts.
- Confirm that the interface was removed.
- Navigate to Home.
- In the Network State section:
- The Status should be Down.
- The Info should be SSID: None.
Admin API
- Access the Admin API.
- Navigate to Interface > DELETE /interface/{interface_name}.
- Click Try it out.
- In the Parameters section, in the interface_name field, enter the name of the interface you are removing.
- Click Execute.
- The Server response section should show Code “200” to confirm that the interface was successfully deleted.
- Click Execute.
- Restart networking.
- You will briefly lose connectivity to the Admin API.
- Confirm that the interface was deleted.
- Navigate to Interface > GET /interface/.
- Click Try it out.
- Click Execute.
- The Server response section should show Code “200” and the configured interfaces.
curl
- Discover your Monitoring Point hostname at > Manage Monitoring Points.
-
Find out which interfaces are configured.
curl -k -u <username> -X GET -H 'Accept: application/json' 'https://<hostname>/api/v1/interface/?config_state=active' | python -m json.tool
-
Delete the interface.
curl -k -u <username> -X DELETE -H 'Accept: application/json' 'https://<hostname>/api/v1/interface/<interface_name>/?family=<family>' | python -m json.tool
-
Restart networking to apply the changes.
curl -k -u <username> -X PUT -H 'Content-Type: application/json' -d {} 'https://<hostname>/api/v1/service/networking/?action=restart' | python -m json.tool
- You will briefly lose connectivity.
- The interface is deleted when networking restarts.
The variables above are defined as follows:
- <username> - the user name on the Monitoring Point.
- <hostname> - the hostname or IP address of the Monitoring Point.
- <interface name> - the name of the interface you are deleting (e.g., eth1).
- <family> - either ‘inet’ for IPv4 or ‘inet6’ for IPv6.
Web admin
- Log in to Web Admin.
- Click Network Configuration.
- For the wireless interface you want to delete, click Delete Interface.
- Click Restart Networking.
- You will briefly lose connectivity.
- The interface is deleted when networking restarts.
- Confirm that the interface was removed.