Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
! CloudDocs Home (/) > F5 BIG-IQ API (../../../index.html) > Memory Statistics
Memory Statistics¶
Overview¶
Memory consumption information
Module Name in API¶
bigip-memory
Product Name in API¶
device
Dimensions¶
Dimension Name in API Description
BIG-IP Host Name hostname The hostname given to the BIG-IP
SSG and BIG-IP ssg-hostname-slot
Blade
BIG-IP Service dsc-name Clusters of BIG-IPs grouped together
Cluster to have the same config
Service Scaling ssg The name of the Service Scaling Group
Group
BIG-IP Blade hostname-slot This is a combination of a BIG-IP
hostname and its blade number
MetricSets¶
System Free RAM¶
Description¶
Total free RAM on the BIG-IP
1 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
Name In API¶
free-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average System Free avg-value- bytes
RAM per-event
Other Total RAM¶
Description¶
Total RAM allocated for the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
other-total-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Other Total RAM avg-value- bytes Total Other RAM
per-event
System Used RAM¶
Description¶
Total used RAM on the BIG-IP
Name In API¶
used-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average System Used avg-value- %
RAM per-event
TMM Total RAM¶
Description¶
Total RAM allocated for TMM on the BIG-IP
Name In API¶
2 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
tmm-total-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average TMM Total RAM avg-value- bytes
per-event
Swap Total¶
Description¶
Total Swap memory that exist on the BIG-IP
Name In API¶
total-swap
Metrics in the metricSet¶
Metric Name in API Unit Description
Swap Size avg-value- bytes
per-event
System Total RAM¶
Description¶
Total RAM that exist on the BIG-IP
Name In API¶
total-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average System Total avg-value- bytes
RAM per-event
Other Free RAM¶
Description¶
Free RAM for the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
3 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
other-free-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Other Free RAM avg-value- bytes Total Other Free RAM
per-event
TMM Used RAM¶
Description¶
Used RAM by the TMM on the BIG-IP
Name In API¶
tmm-used-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average TMM Used RAM avg-value- %
per-event
Other Used RAM¶
Description¶
Used RAM by the Other, which are the non-TMM processes on the BIG-IP
Name In API¶
other-used-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Other Used RAM avg-value- % Total Other Used RAM
per-event
Swap Used¶
Description¶
Used Swap memory on the BIG-IP
Name In API¶
4 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
used-swap
Metrics in the metricSet¶
Metric Name in API Unit Description
Swap Used avg-value- %
per-event
Swap Free¶
Description¶
Free Swap memory on the BIG-IP
Name In API¶
free-swap
Metrics in the metricSet¶
Metric Name in API Unit Description
Swap Free avg-value- bytes
per-event
TMM Free RAM¶
Description¶
Free RAM for the TMM on the BIG-IP
Name In API¶
tmm-free-ram
Metrics in the metricSet¶
Metric Name in API Unit Description
Average TMM Free RAM avg-value- bytes
per-event
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”
5 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
POST https://<address>/mgmt/ap/query/v1/tenants/default/products/device/metric
This example for JSON body in the post, filters by dimension hostname and get the avg-
value-per-event of free-ram
{
"kind": "ap:query:stats:byTime",
"module": "bigip-memory",
"timeRange": {
"from": "-1h",
"to": "now"
},
"timeGranularity": {
"duration": 30,
"unit": "SECONDS"
},
"aggregations": {
"free-ram$avg-value-per-event": {
"metricSet": "free-ram",
"metric": "avg-value-per-event"
}
},
"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
This example for JSON body in the post, gets top entities of type hostname, sorted by avg-
value-per-event of free-ram
6 of 7 8/17/25, 1:24 PM
Firefox https://clouddocs.f5.com/products/big-iq/mgmt-api/v7.1.0/ApiReference...
{
"kind": "ap:query:stats:byEntities",
"module": "bigip-memory",
"timeRange": {
"from": "-1H",
"to": "now"
},
"dimension": "hostname",
"sortMetric": "free-ram$avg-value-per-event",
"sortOrder": "desc",
"aggregations": {
"free-ram$avg-value-per-event": {
"metricSet": "free-ram",
"metric": "avg-value-per-event"
}
},
"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
This example for JSON body in the post, gets the distinct count of entities of type hostname
{
"kind": "ap:query:stats:entitiesCount",
"module": "bigip-memory",
"dimension": "hostname",
"timeRange": {
"from": "-1h",
"to": "now"
}
}
7 of 7 8/17/25, 1:24 PM
