Alert Rules¶
Overview¶
This document describes the API to define alert rules for auto-scaling and monitoring the health of the BIG-IP devices.
Requests¶
Examples¶
List an alert rule¶
GET /mgmt/cm/shared/policymgmt/alert-rules/<name>
Response¶
HTTP/1.1 200 OK
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
List all alert rules¶
GET /mgmt/cm/shared/policymgmt/alert-rules
Response¶
HTTP/1.1 200 OK
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
Create an alert rules¶
POST /mgmt/cm/shared/policymgmt/alert-rules
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
Response¶
HTTP/1.1 200 OK
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
Edit an alert rule¶
PATCH /mgmt/cm/shared/policymgmt/alert-rules/<name>
{
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
Response¶
HTTP/1.1 200 OK
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}
Delete an alert rules¶
DELETE /mgmt/cm/shared/policymgmt/alert-rules/<name>
Response¶
HTTP/1.1 200 OK
{
"name": "my-device-health-rule",
"description": "Device health rules for devices in Data Center 1",
"alertTypeId": "device-health",
"isDefault": false,
"producerType": "device",
"alertType": "active",
"alertContext": "health",
"includeInternalAlerts": true,
"aggregationMethod": "or",
"external": false,
"nestedRules": [{
"alertTypeId": "device-cpu",
"alertRuleType": "nested-metric",
"warningThreshold": 60,
"errorThreshold": 80,
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"unit": "percent",
"operator": "greater-than",
"enabled": true
}],
"alertRuleReferences": [{
"name": "custom-health-rule-dc2",
"link": "https://localhost/mgmt/cm/shared/policymgmt/alert-rules/custom-health-rule-dc2",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"applicationReferences": [{
"name": "app1",
"link": "https://configuration/app1",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceReferences": [{
"name": "bigip1.mgmt.foo.bar.com",
"link": "https://configuration/device/uri",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"ssgReferences": [{
"name": "ssg1",
"link": "https://localhost/mgmt/cm/cloud/service-scaling-groups/9aa32232-2d42-4df3-4d33-sdc2313454fb",
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"deviceGroupReferences": [{
"name": No example value specified,
"link": No example value specified,
"filter": {
"field": No example value specified,
"value": No example value specified
}
}],
"alertRuleType": "metric",
"warningThreshold": -1.0,
"errorThreshold": 0.1,
"unit": "percent",
"operator": "greater-than",
"observation": 1440,
"referenceObservation": 10080,
"errorDelta": 3,
"enabled": true,
"isPublic": true
}