Workflow Rules¶
Overview¶
This API defines workflow rules for auto-scaling and monitoring the health of the BIG-IPs.
Requests¶
Examples¶
List a workflow rule¶
GET /mgmt/cm/shared/policymgmt/workflow-rules/<name>
Response¶
HTTP/1.1 200 OK
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
List all workflow rules¶
GET /mgmt/cm/shared/policymgmt/workflow-rules
Response¶
HTTP/1.1 200 OK
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
Create a workflow rule¶
POST /mgmt/cm/shared/policymgmt/workflow-rules
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
Response¶
HTTP/1.1 200 OK
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
Edit a workflow rule¶
PATCH /mgmt/cm/shared/policymgmt/workflow-rules/<name>
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
Response¶
HTTP/1.1 200 OK
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}
Delete a workflow rule¶
DELETE /mgmt/cm/shared/policymgmt/workflow-rules/<name>
Response¶
HTTP/1.1 200 OK
{
"workflowRuleName": "ssg-workflow-rule",
"workflowRuleDescription": "This workflow rule is a SSG workflow rule",
"targetWorkflowUri": "https://localhost/mgmt/cm/cloud/tasks/handle-scaling-alert",
"workflowParameters": {
"parameters": {
}
},
"alertRuleReference": {
"link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
},
"sendEmail": true,
"sendEmailContacts": "demo@f5.com, demo2@f5.com",
"sendSNMP": true
}