Interface Traffic¶

Overview¶

Device Interface network information

Module Name in API¶

interface-traffic

Product Name in API¶

device

Dimensions¶

Dimension	Name in API	Description
BIG-IP Host Name	hostname	The hostname given to the BIG-IP
BIG-IP Service Cluster	dsc-name	Clusters of BIG-IPs grouped together to have the same config
Service Scaling Group	ssg	The name of the Service Scaling Group
Interface Name	interface-name

MetricSets¶

Interface Packets Out¶

Description¶

Name In API¶

interface-packets-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Packets Out	sum	packets
Average Interface Packets Out	avg-value-per-sec	pps

Interface Multi-Cast In¶

Description¶

Name In API¶

interface-mcast-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Multi-Cast Packets In	sum	packets
Avg Interface Multi-Cast Packets In	avg-value-per-sec	pps

Interface Bits Out¶

Description¶

Name In API¶

interface-bytes-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Bits Out	sum	bits
Average Interface Bits Out	avg-value-per-sec	bps

Interface Bits In¶

Description¶

Name In API¶

interface-bytes-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Bits In	sum	bits
Average Interface Bits In	avg-value-per-sec	bps

Interface Multi-Cast Packets Out¶

Description¶

Name In API¶

interface-mcast-out

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Multi-Cast Packets Out	sum	packets
Avg Interface Multi-Cast Packets Out	avg-value-per-sec	pps

Interface Packets In¶

Description¶

Name In API¶

interface-packets-in

Metrics in the metricSet¶

Metric	Name in API	Unit	Description
Total Interface Packets In	sum	packets
Average Interface Packets In	avg-value-per-sec	pps

Examples¶

By Time Query¶

A query by time returns a series of data points in time, based on optional filters, time range, and time granularity. This query kind is identified by the keyword: “ap:query:stats:byTime”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/device/metric-query

This example for JSON body in the post, filters by dimension hostname and get the sum of interface-packets-out

{
    "kind": "ap:query:stats:byTime",
    "module": "interface-traffic",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    },
    "timeGranularity": {
            "duration": 30,
            "unit": "SECONDS"
    },
    "aggregations": {
            "interface-packets-out$sum": {
                    "metricSet": "interface-packets-out",
                    "metric": "sum"
            }
    },
    "dimensionFilter": {
            "type": "eq",
            "dimension": "hostname",
            "value": "value to filter by"
    }
}

By Entities Query¶

A query by entities returns a sort set of entities, based on optional filters, time range, and choosen metric to sort by. This query kind is identified by the keyword: “ap:query:stats:byEntities”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/device/metric-query

This example for JSON body in the post, gets top entities of type hostname, sorted by sum of interface-packets-out

{
    "kind": "ap:query:stats:byEntities",
    "module": "interface-traffic",
    "timeRange": {
            "from": "-1H",
            "to": "now"
    },
    "dimension": "hostname",
    "sortMetric": "interface-packets-out$sum",
    "sortOrder": "desc",
    "aggregations": {
            "interface-packets-out$sum": {
                    "metricSet": "interface-packets-out",
                    "metric": "sum"
            }
    },
    "limit": 5
}

Entities Count Query¶

An entities count query returns the distinct count of entities, based on optional filters, time range, and choosen entity type. This query kind is identified by the keyword: “ap:query:stats:entitiesCount”

POST https://<address>/mgmt/ap/query/v1/tenants/default/products/device/metric-query

This example for JSON body in the post, gets the distinct count of entities of type hostname

{
    "kind": "ap:query:stats:entitiesCount",
    "module": "interface-traffic",
    "dimension": "hostname",
    "timeRange": {
            "from": "-1h",
            "to": "now"
    }
}

Previous Next