VLAN Interfaces
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
- Complete device setup.
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- Click Add Interface and select Ethernet.
- The Add Network Interface page appears.
- Specify the interface:
- In the Interface Type field, select VLAN.
- In the Interface ID field, select the Ethernet interface.
- In the VLAN/Virtual ID field, specify the VLAN ID you want to add.
- 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.
Admin API
- Complete device setup.
- Access the Admin API.
- Navigate to Interface > POST /interface/.
- Click Try it out.
-
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>" }
- Click Execute.
- The Server response section should show Code “200” to confirm that the interface was added.
- Restart networking. You will briefly lose connectivity to the Admin API.
- The interface is available to use.
curl
- Complete device setup.
- Discover your Monitoring Point hostname at > Manage Monitoring Points.
-
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
-
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.
-
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.
-
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:
- Download the VLAN 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 VLAN tagged interface.
- Make your changes.
- Restart networking.
- The interface is operational when networking restarts.
Edit a VLAN interface configuration
Web admin
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- For the interface you want to edit, select > Edit.
- The Edit Network Interface page appears.
- Configure addressing, DNS, transmission parameters, and static routes as required.
- Click Submit.
- Restart networking.
- You will briefly lose connectivity.
- The interface is reconfigured when networking restarts.
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., eth1.4094).
- 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.
- For the interface you want to edit, click the interface name.
- Update the configuration as appropriate.
- Click Save.
- Restart networking.
- You will briefly lose connectivity.
- The interface is reconfigured when networking restarts.
Delete a VLAN interface
Web admin
- Log in to Web Admin.
- Navigate to Network Settings > Network Interfaces.
- For the interface you want to delete, select > Delete
- Click Confirm.
- Restart networking.
- You will briefly lose connectivity.
- The interface is deleted when networking restarts.
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 interface you want to delete (e.g., eth1.4094).
- Click Execute.
- The Server response section should show Code “200” to confirm that the interface was deleted from the configuration.
- Restart networking. You will briefly lose connectivity to the Admin API.
- The interface is deleted.
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 interface you want to delete, click Delete Interface.
- Restart networking.
- You will briefly lose connectivity.
- The interface is deleted when networking restarts.