APIRef_tm_security_analytics_settings

mgmt/tm/security/analytics/settings

/tm/security/analytics

Analytics settings for the advanced firewall module.

REST Endpoints

Collection URI
/mgmt/tm/security/analytics/settings
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/security/analytics/settings/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, POST

Properties

Name Type Default Value Required Access Description
collectAllDosStatistic string disabled optional read/write  
collectedStatsExternalLogging string   optional read/write Enables or disables the external logging of the collected statistics.
collectedStatsInternalLogging string enabled optional read/write Enables or disables the internal logging of the collected statistics.
tmName string   optional read/write  
tmPartition string Common optional read/write  
publisher string   optional read/write Specifies the external logging publisher used to send statistical data to one or more destinations.
smtpConfig string   optional read/write Specifies the default SMTP configuration used for exporting CSV or PDF security analytics reports.

Structures

Name Type Default Value Required Access Description
/acl-rules array_structure   optional read/write  
/acl-rules/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for ACL rule matching.
/acl-rules/collect-client-port string disabled optional read/write Specifies whether source/client port should be collected for ACL rule matching.
/acl-rules/collect-dest-ip string enabled optional read/write Specifies whether the destination IP address should be collected for ACL rule matching.
/acl-rules/collect-dest-port string enabled optional read/write Specifies whether the destination port should be collected for ACL rule matching.
/acl-rules/collect-server-side-stats string disabled optional read/write Specifies whether server side statistics (source address translation information, self IP address and pool member address) should be collected for ACL rule matching.
/acl-rules/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for ACL rule matching.
/acl-rules/collect-client-port string disabled optional read/write Specifies whether source/client port should be collected for ACL rule matching.
/acl-rules/collect-dest-ip string enabled optional read/write Specifies whether the destination IP address should be collected for ACL rule matching.
/acl-rules/collect-dest-port string enabled optional read/write Specifies whether the destination port should be collected for ACL rule matching.
/acl-rules/collect-server-side-stats string disabled optional read/write Specifies whether server side statistics (source address translation information, self IP address and pool member address) should be collected for ACL rule matching.
/dns array_structure   optional read/write  
/dns/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for DNS security.
/dns/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for DNS security.
/dos-l2-l4 array_structure   optional read/write  
/dos-l2-l4/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for network layer’s DoS security.
/dos-l2-l4/collect-dest-geo string enabled optional read/write  
/dos-l2-l4/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for network layer’s DoS security.
/dos-l2-l4/collect-dest-geo string enabled optional read/write  
/l3-l4-errors array_structure   optional read/write  
/l3-l4-errors/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for firewall errors.
/l3-l4-errors/collect-dest-ip string enabled optional read/write Specifies whether the destination IP address should be collected for firewall errors.
/l3-l4-errors/collect-client-ip string enabled optional read/write Specifies whether source/client IP address should be collected for firewall errors.
/l3-l4-errors/collect-dest-ip string enabled optional read/write Specifies whether the destination IP address should be collected for firewall errors.
/stale-rules array_structure   optional read/write  
/stale-rules/collect string disabled optional read/write Specifies whether statistics about all firewall rules should be collected in order to present information regarding rule staleness.
/stale-rules/collect string disabled optional read/write Specifies whether statistics about all firewall rules should be collected in order to present information regarding rule staleness.
iControl Reference Index
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.