BIG-IQ Centralized Management Firewall Rule Order¶
Overview¶
You use this API to get firewall rule evaluation order information on a BIG-IQ Centralized Management system.
Refer to the F5 DevCentral web site, http://devcentral.f5.com for additional information on how to use the BIG-IQ Centralized Management APIs. In particular, see the information in BIG-IQ wiki > BIG-IQ Reference > API Reference, especially the topic ‘’Applying firewall policies to contexts and deploying them to BIG-IP devices.’’
URI Scheme¶
- Path: /mgmt/cm/firewalls/utility/expanded-rules
- Scheme: HTTPS
Consumes¶
- application/json
Produces¶
- application/json
Post to retrieve a list of rules in a rule list¶
Retrieves a list of rules in a rule list.
POST /mgmt/cm/firewalls/utility/expanded-rules
{
Body containerReference: { link: '<rule-list-selfLink>'
//Can be a working-config or current-config link
}
Post to retrieve a list of rules in a policy¶
Retrieves a list of rules in a firewall policy.
POST /mgmt/cm/firewalls/utility/expanded-rules
{
Body containerReference: { link: '<policy-selfLink>'
//Can be a working-config or current-config link
}
Post to retrieve a list of rules in a firewall context¶
Retrieves a list of rules in a firewall context.
POST /mgmt/cm/firewalls/utility/expanded-rules
{
Body containerReference: { link: '<firewall-selfLink>'
}
Response returns¶
The response returns the collection of rules in evaluation order or returns an error.
HTTP Code | Description | Schema |
---|---|---|
200 | Returns the rule collection. | properties_collection |
400 | Returns the error ``Bad Request.’’ | error_collection |
Response definitions¶
error_collection¶
Name | Description | Schema |
---|---|---|
errorStack | Error stack trace returned by Java. optional, read-only. | string |
items | Collection of rule number-error. optional. | <object> array |
kind | Type information for rule number object. optional, read-only. | string |
message | Error message returned from server. optional, read-only. | string |
requestBody | The data in the request body. GET (None). optional, read-only. | string |
requestOperationId | Unique identifier assigned to REST operation. optional, read-only. | integer(int64) |
properties_collection¶
Name | Description | Schema |
---|---|---|
containerReference | Unique identifier for this response. | string |
kind | Type information for the expanded rules object. | string |
items | Collection of rule-properties. | array |