BQN Documentation
BQN Documentation

Subscriber Groups

A subscriber group is a set of subscribers. A subscriber can be associated to a group by an IP address or a subscriber ID. A subscriber can belong to up to eight different subscriber groups.

The BQN can show network metrics per subscriber group. Depending on how the groups are defined, those metrics allow analysis per access points, network subnets or any customer categorization that can be mapped into groups.

Create Subscriber Groups

To create a subscriber group, go to Status->Subscribers->Subscriber Groups and click on Add Subscriber Group

A subscriber group is given a name, without spaces.

Subscriber members can be defined:

  • By IP address, clicking on Add IP address
  • By subscriber ID, clicking on Add Subscriber ID…

IP addresses and/or IDs can be added loading a textual file with one entry per line. File loading options are in the menu in the upper right. Examples:

  • The menu option Merge IP Address from File… will add the IP addresses contained in the file to those already existing in the group.
  • The menu option Replace Subscriber IDs with File… will replace current set of subscriber IDs by those contained in the loadedfile.

The table on the right, Current IP Addresses, shows all the IP addresses part of the group, either because directly added or because they are associated to a subscriber ID part of the group. The table also indicates which IP addresses have traffic (Active yes).

The created subscriber groups are listed in Status->Subscribers->Subscriber Groups table and can be edited clicking on the edit icon.

See Subscriber Group Metrics

In Status->Subscribers->Subscriber Groups, a chart at the top of the page shows metrics of the created groups:

Metrics can be for the downlink or uplink directions, and for a time period of up to three months.

The available metrics are:

  • Average speed.
  • Active flows.
  • Flows created per minute.
  • Latency.
  • Retransmission.
  • Congestion.
  • % of traffic going at maximum speed.

Those metrics are similar to the ones shown for a subscriber(see the Subscriber Dashboard description in the Network Visibility section for details).

By default, up to thirty groups are shown in the chart. You can decide which groups to include selecting or not their PLOT boxes.

It is possible to use a filter, to select only the groups that have as member an IP address or a subscriber ID:

Clicking a subscriber group name will show a subscriber group dashboard, with the metrics in separate charts:

Manage Subscriber Groups from REST API

In addition to the GUI, the BQN REST API can be used to manage subscriber groups.

To add an existing IP to a subscriber group “city-north”:

curl -k -u myuser:mypassword -X PUT -H "Content-Type: application/json" --data '{"subscriberGroups": ["city-north”]}'

The subscriber group will be automatically created if it didnot exist.

The list of groups should reflect always the full list of membership. For example, to add an existing IP to a subscriber group “vip”:

curl -k -u myuser:mypassword -X PUT -H "Content-Type: application/json" --data '{"subscriberGroups": ["city-north”, “vip”]}'

If the IP has group memberships, they will be returned by a GET:

curl -k -u myuser:mypassword -X GET

  "subscriberIp" : "",
  "subscriberId" : "sub-12",
  "subscriberGroups" : [ "city-north", "vips" ],
  "policyRate" : "Plan-200Mbps"

The membership of a specific subscriber group can be obtained as follows:

curl -k -u myuser:mypassword -X GET

  "subscriberGroupName" : "city-north",
  "memberSubscriberIps" : [ "", "", "", "" ]

And to get the full list of subscriber groups:

curl -k -u myuser:mypassword -X GET

  "items" : [
      "subscriberGroupName" : "city-north",
      "memberSubscriberIps" : [ "", "", "", "" ]
      "subscriberGroupName" : "vips",
      "memberSubscriberIps" : [ "", "", "", "" ]

You can add to a group subscribers by their IDs, sending a PORT with the ID list to the subscriber group end point:

curl -k -u myuser:mypassword -X POST -H "Content-Type: application/json" --data '{memberSubscriberIds: [“sub-1”, “sub-2”, “sub-3”]}’

See REST API reference for more details.