802.1Q VLAN tagging can be enabled on any monitoring point by adding a VLAN interface type to an Ethernet port.

Add a VLAN interface

Web admin

  1. Complete monitoring point setup.
  2. Log in to Web Admin.
  3. Navigate to Network Settings > Network Interfaces.
  4. Click Add Network Interface and select Ethernet.
  5. Select the ‘VLAN’ interface type and update the configuration as appropriate.
  6. Restart networking.

Admin API

  1. Complete monitoring point setup.
  2. Navigate to Interface > POST /interface/.
  3. In the Parameters section, paste the following in the body field (where <interface name> is the name of the interface you are adding (in the form: ethX.Y), <method> is either ‘manual’, ‘static’, or ‘dhcp’, <IP address> is the IP address to use (if <method> is not ‘dhcp’), and <network mask> is the network mask to use (if <method> is not ‘dhcp’)):

    {
      "name": "<interface name>",
      "method": "<method>",
      "address":"<IP address>",
      "netmask":"<network mask>"
    }
    
  4. Click Submit.
    • In the Response Body section, look for "success": true to confirm that the interface was added.
  5. Restart networking. You will briefly lose connectivity to the Admin API.
    • The interface is available to use.

curl

  1. Complete monitoring point setup.
  2. Discover your monitoring point hostname at > Manage Monitoring Points.
  3. Find out what interfaces are already configured.

    curl -X GET --header "Accept: application/json" "https://<hostname>/api/v1/interface/?config_state=active"
    
  4. Add a new VLAN interface (where <interface name> is the name of the interface you are adding (in the form: ethX.Y), <method> is either ‘manual’, ‘static’, or ‘dhcp’, <IP address> is the IP address to use (if <method> is not ‘dhcp’), and <network mask> is the network mask to use (if <method> is not ‘dhcp’)).

    curl -k -X POST --header "Content-Type: application/json" -d '{"name": "<interface name>", "method": "<method>", "address":"<IP address>", "netmask":"<network mask>"}' https://admin:<password>@<hostname>/api/v1/interface/
    
  5. Verify that your changes are pending.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/?config_state=pending
    
  6. Restart networking. You will briefly lose connectivity to the Admin API.

    curl -k -X PUT --header "Content-Type: application/json" -d {} https://admin:<password>@<hostname>/api/v1/service/networking/?action=restart
    
  7. Verify that your new interface exists by repeating Step 3.

USB

To add a VLAN interface:

  1. Download the VLAN interface config file.
  2. 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).
  3. Copy the file onto a USB stick.
  4. Make sure the monitoring point is ready.
  5. 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.
  6. Wait until the monitoring point is finished.
  7. 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.
  8. Verify that the interface acquired an IP address.
    1. In APM, navigate to > Manage Monitoring Points.
    2. Select the monitoring point you are interested in.
    3. On the right side panel, check Local Network Interfaces for an IP address on the interface.

Web admin

  1. Complete monitoring point setup.
  2. Log in to Web Admin.
  3. Click Network Configuration.
  4. Click Add VLAN tagged interface.
  5. Make your changes.
  6. Restart networking.

Edit a VLAN interface configuration

Web admin

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
  3. For the interface you want to edit, select > Edit.
  4. Update the configuration as appropriate.
  5. Click Submit.
  6. Restart networking.
    • The interface is reconfigured when networking restarts.

Admin API

  1. Access the Admin API.
  2. Navigate to Interface > PUT /interface/{interface name}/.
  3. In the Parameters section, in the interface_name field, enter the interface you want to edit (e.g., eth1.4094).
  4. In the body section, click the Model Schema on the right.
    • The text is copied to the body field.
  5. Update the fields as appropriate.
  6. Click Submit.
    • In the Response Body section, look for "success": true to confirm that the interface was updated.
  7. Restart networking. You will briefly lose connectivity to the Admin API.
    • The interface is available to use.

Web admin

  1. Log in to Web Admin.
  2. Click Network Configuration.
  3. For the interface you want to edit, click the interface name.
  4. Make your changes.
  5. Click Save.
  6. Restart networking.

Delete a VLAN interface

Web admin

  1. Log in to Web Admin.
  2. Navigate to Network Settings > Network Interfaces.
  3. For the interface you want to delete, select > Delete
  4. Click Confirm.
  5. Restart networking.
    • The interface is deleted when networking restarts.

Admin API

  1. Access the Admin API.
  2. Navigate to Interface > DELETE /interface/{interface name}/.
  3. In the Parameters section, in the interface_name field, enter the interface you want to delete (e.g., eth1.4094).
  4. Click Submit.
    • In the Response Body section, look for "success": true to confirm that the interface was deleted from the configuration.
  5. Restart networking. You will briefly lose connectivity to the Admin API.
    • The interface is deleted.

Web admin

  1. Log in to Web Admin.
  2. Click Network Configuration.
  3. For the interface you want to delete, click Delete Interface.
  4. Restart networking.
    • The interface is deleted.