There are instances when more than one IP address is required on an interface. The procedures described below are for adding, deleting, and viewing static IP addresses on an interface. Addresses can be added to interfaces already configured for DHCP or to those configured with at least one static IP address. Up to 128 IP addresses can be configured on an interface and at least one is required (either static or DHCP). Both IPv4 and IPv6 addresses are supported. Multiple IP addressing is supported on Ethernet, VLAN, and Wireless interface types.

Web admin - view multiple addresses

In the current release, you cannot configure additional static IP addresses on an interface using the Web Admin interface. You can only view the configuration.

  1. Log in to Web Admin.
  2. Navigate to Home.
  3. In the Network State section, find the interface in the table and check the Info column to view the interface IP addresses.

Admin API - add an address

  1. In APM, navigate to > Manage Monitoring Points.
  2. Find the hostname of your monitoring point in the Name column of the table.
  3. Access the Admin API using https://<hostname>/swagger/index.html.
    • Substitute <hostname> with the hostname of your monitoring point.
  4. Determine which interfaces are available.
    1. Navigate to Interface > GET /interface/ and click Submit.
      • The Response Body section shows the configured interfaces.
  5. Configure an additional IP address for an interface using the following JSON text.

    {
      "address": "<address>",
      "netmask": "<netmask>",
      "gateway": "<gateway>"
    }
    
    1. Substitute the appropriate values for <address>, <netmask>, and <gateway> in the text above and copy it to the clipboard.
      • <address> - the IP address you are adding to the interface. Either an IPv4 or an IPv6 address can be specified.
      • <gateway> - (optional) the IP address of the gateway the monitoring point uses to access the Internet for the configured address. If not specified, the default gateway configured on the interface is used.
      • <netmask> - the netmask of the IP address you are adding. Use a prefix (e.g., 64) for IPv6. Use either a prefix or a dotted decimal mask (e.g., 255.255.255.0) for IPv4.
    2. Navigate to Interface > POST /interface/{interface_name}/address/.
    3. In the Parameters section:
      1. Set interface_name to the name of the interface you are configuring.
      2. Set family as appropriate. “inet” for IPv4, and “inet6” for IPv6.
      3. In the body field, paste the contents of the clipboard.
      4. Click Submit.
        • In the Response Body section, look for "success": true to confirm that the address was added successfully.
  6. Restart networking to apply the changes.
    1. Navigate to Service > PUT /service/{service_name}/.
    2. In the Parameters section:
      1. Set service_name to “networking”.
      2. Set action to “restart”.
      3. Click Submit.
        • You will briefly lose connectivity to the Admin API.
  7. Verify that the changes were properly applied.
    1. Navigate to Interface > GET /interface/{interface_name}/address/.
    2. In the Parameters section:
      1. Set interface_name to the name of the interface you configured.
      2. Set config_state to “active”.
      3. Set family as appropriate. “inet” for IPv4, and “inet6” for IPv6.
      4. Click Submit.
        • The Response Body section shows the addresses configured on the interface.

Admin API - delete an address

  1. In APM, navigate to > Manage Monitoring Points.
  2. Find the hostname of your monitoring point in the Name column of the table.
  3. Access the Admin API using https://<hostname>/swagger/index.html.
    • Substitute <hostname> with the hostname of your monitoring point.
  4. Determine which interfaces are available.
    1. Navigate to Interface > GET /interface/ and click Submit.
      • The Response Body section shows the configured interfaces.
  5. Specify the IP address to delete from an interface using the following JSON text.

    {
      "address": "<address>"
    }
    
    1. Substitute the appropriate values for <address> in the text above and copy it to the clipboard.
      • <address> - the IP address you are adding to the interface. Either an IPv4 or an IPv6 address can be specified.
    2. Navigate to Interface > DELETE /interface/{interface_name}/address/.
    3. In the Parameters section:
      1. Set interface_name to the name of the interface you are configuring.
      2. In the body field, paste the contents of the clipboard.
      3. Click Submit.
        • In the Response Body section, look for "success": true to confirm that the address was added successfully.
  6. Restart networking to apply the changes.
    1. Navigate to Service > PUT /service/{service_name}/.
    2. In the Parameters section:
      1. Set service_name to “networking”.
      2. Set action to “restart”.
      3. Click Submit.
        • You will briefly lose connectivity to the Admin API.
  7. Verify that the changes were properly applied.
    1. Navigate to Interface > GET /interface/{interface_name}/address/.
    2. In the Parameters section:
      1. Set interface_name to the name of the interface you configured.
      2. Set config_state to “active”.
      3. Set family as appropriate. “inet” for IPv4, and “inet6” for IPv6.
      4. Click Submit.
        • The Response Body section shows the addresses configured on the interface.

curl - add an address

  1. In APM, navigate to > Manage Monitoring Points.
  2. Find the hostname of your monitoring point in the Name column of the table.
  3. Determine which interfaces are available.

    curl -k -X GET --header "Accept: application/json" "https://<hostname>/api/v1/interface/?config_state=active"
    
  4. Configure an additional IP address for an interface.

    curl -k -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"address": "<address>", "netmask": "<netmask>", "gateway": "<gateway>"}' 'https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?family=<addr_type>'
    
    • gateway is optional.
  5. Verify that your changes are pending.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?config_state=pending
    
  6. Restart networking.

    curl -k -X PUT --header "Content-Type: application/json" -d {} https://admin:<password>@<hostname>/api/v1/service/networking/?action=restart
    
    • You will briefly lose connectivity to the Admin API.
  7. Verify that the new address exists on the interface.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?config_state=active
    

The variables above are defined as follows:

  • <address> - the IP address you are adding to the interface. Either an IPv4 or an IPv6 address can be specified.
  • <addr_type> - the type of IP address. Use “inet” for IPv4 and “inet6” for IPv6 addresses.
  • <gateway> - (optional) the IP address of the gateway the monitoring point uses to access the Internet for the configured address. If not specified, the default gateway configured on the interface is used.
  • <hostname> - the monitoring point hostname. Alternatively, the monitoring point IP address can be used.
  • <interface_name> - the name of the interface you are configuring.
  • <netmask> - the netmask of the IP address you are adding. Use a prefix (e.g., 64) for IPv6. Use either a prefix or a dotted decimal mask (e.g., 255.255.255.0) for IPv4.
  • <password> - the administrator password on the monitoring point.

curl - delete an address

  1. In APM, navigate to > Manage Monitoring Points.
  2. Find the hostname of your monitoring point in the Name column of the table.
  3. Determine which interfaces are available.

    curl -k -X GET --header "Accept: application/json" "https://<hostname>/api/v1/interface/?config_state=active"
    
  4. Determine which addresses exist on the interface.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?config_state=active
    
  5. Delete an IP address from an interface.

    curl -k -X DELETE --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"address": "<address>"}' 'https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?family=<addr_type>'
    
    • You cannot delete the last address on an interface.
  6. Verify that your changes are pending.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?config_state=pending
    
  7. Restart networking.

    curl -k -X PUT --header "Content-Type: application/json" -d {} https://admin:<password>@<hostname>/api/v1/service/networking/?action=restart
    
    • You will briefly lose connectivity to the Admin API.
  8. Verify that the address was removed from the interface.

    curl -k https://admin:<password>@<hostname>/api/v1/interface/<interface_name>/address/?config_state=active
    

The variables above are defined as follows:

  • <address> - the IP address you are deleting from the interface. Either an IPv4 or an IPv6 address can be specified.
  • <addr_type> - the type of IP address. Use “inet” for IPv4 and “inet6” for IPv6 addresses.
  • <hostname> - the monitoring point hostname. Alternatively, the monitoring point IP address can be used.
  • <interface_name> - the name of the interface you are configuring.
  • <password> - the administrator password on the monitoring point.

USB - add an address

To add an IP address to an interface:

  1. Download the multiple IP addresses config file.
  2. Edit the downloaded config file for your needs.
    • Uncomment sections to be used.
    • Replace content in arrow brackets.
  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.