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

Video - A video is available for both APM Public and APM Private users that shows how to add a VLAN interface to a monitoring point.

Web admin

  1. Complete device setup.
  2. Log in to Web Admin.
  3. Navigate to Network Settings > Network Interfaces.
  4. Click Add Interface and select Ethernet.
    • The Add Network Interface page appears.
  5. Specify the interface:
    1. In the Interface Type field, select VLAN.
    2. In the Interface ID field, select the Ethernet interface.
    3. In the VLAN/Virtual ID field, specify the VLAN ID you want to add.
    4. In the Address Family field, select the type of IP addressing (IPv4 or IPv6) for the interface.
  6. Configure addressing.
  7. (optional) Configure DNS.
  8. (optional) Configure transmission parameters.
  9. (optional) Configure static routes.
  10. Click Submit.
  11. Restart networking.
    • You will briefly lose connectivity.
    • The interface is operational when networking restarts.

Admin API

  1. Complete device setup.
  2. Access the Admin API.
  3. Navigate to Interface > POST /interface/.
  4. Click Try it out.
  5. 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>",
      "family": "<family>",
      "method": "<method>",
      "address":"<IP address>",
      "netmask":"<network mask>",
      "gateway":"<gateway>"
    }
    
  6. Click Execute.
    • The Server response section should show Code “200” to confirm that the interface was added.
  7. Restart networking. You will briefly lose connectivity to the Admin API.
    • The interface is available to use.

curl

  1. Complete device setup.
  2. Discover your monitoring point hostname at > Manage Monitoring Points.
  3. Find out what 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
    
  4. Add a new interface.

    curl -k -u <username> -X POST -H "Content-Type: application/json" -d '{"name": "<interface name>", "family": "<family>", "method": "<method>", "address":"<IP address>", "netmask":"<network mask>", "gateway":"<gateway>"}' 'https://<hostname>/api/v1/interface/' | python -m json.tool
    
    • <interface name> - the name of the interface you are adding (in the form: ethX.Y).
    • <family> - either ‘inet’ for IPv4 or ‘inet6’ for IPv6.
    • <method> - either ‘static’ for static IP addresses, ‘dhcp’ for Stateless and Stateful DHCPv6 (IPv6), or ‘auto’ for SLAAC (IPv6).
    • <IP address> - (optional) the IP address to use (if <method> is ‘static’).
    • <network mask> - (optional) the network mask to use (if <method> is ‘static’).
    • <gateway> - (optional) the IP address of the gateway to use (if <method> is ‘static’).
      • Omit optional key:value pairs you are not using. Remove the comma after the final key:value pair.
  5. 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 operational when networking restarts.
  6. Verify that the new interface exists.

    curl -k -u <username> -X GET 'https://<hostname>/api/v1/interface/' | python -m json.tool
    

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

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 device setup.
  2. Log in to Web Admin.
  3. Click Network Configuration.
  4. Click Add VLAN tagged interface.
  5. Make your changes.
  6. Restart networking.
    • The interface is operational when networking restarts.

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.
    • The Edit Network Interface page appears.
  4. Configure addressing, DNS, transmission parameters, and static routes as required.
  5. Click Submit.
  6. Restart networking.
    • You will briefly lose connectivity.
    • The interface is reconfigured when networking restarts.

Admin API

  1. Access the Admin API.
  2. Navigate to Interface > PUT /interface/{interface name}/.
  3. Click Try it out.
  4. In the Parameters section:
    1. In the interface_name field, enter the interface you want to edit (e.g., eth1.4094).
    2. In the body field, update the fields as appropriate.
  5. Click Execute.
    • The Server response section should show Code “200” to confirm that the interface was updated.
  6. 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. Update the configuration as appropriate.
  5. Click Save.
  6. Restart networking.
    • You will briefly lose connectivity.
    • The interface is reconfigured when networking restarts.

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.
    • You will briefly lose connectivity.
    • The interface is deleted when networking restarts.

Admin API

  1. Access the Admin API.
  2. Navigate to Interface > DELETE /interface/{interface name}/.
  3. Click Try it out.
  4. In the Parameters section, in the interface_name field, enter the interface you want to delete (e.g., eth1.4094).
  5. Click Execute.
    • The Server response section should show Code “200” to confirm that the interface was deleted from the configuration.
  6. Restart networking. You will briefly lose connectivity to the Admin API.
    • The interface is deleted.

curl

  1. Discover your monitoring point hostname at > Manage Monitoring Points.
  2. 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
    
  3. 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
    
  4. 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

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