APIRef_tm_ltm_profile_analytics

mgmt/tm/ltm/profile/analytics

/tm/ltm/profile

Virtual server analytics profile configuration

REST Endpoints

Collection URI
/mgmt/tm/ltm/profile/analytics
Collection Methods
OPTIONS, GET
Resource URI
/mgmt/tm/ltm/profile/analytics/~resource id
Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key
name, partition, subPath

Properties

Name Type Default Value Required Access Description
appService string   optional read/write The application service to which the object belongs.
capturedTrafficExternalLogging string   optional read/write Enables or disables the external logging of captured traffic.
capturedTrafficInternalLogging string   optional read/write Enables or disables the internal logging of captured traffic.
collectGeo string   optional read/write Enables or disables the collection of the names of the countries from where the traffic was sent.
collectHttpThroughput string   optional read/write Enables or disables the collection of throughput statistics. Deprecated: HTTP throughput is always collected.
collectHttpTimingMetrics string disabled optional read/write Enables or disables the collection of HTTP timing metrics.
collectIp string   optional read/write Enables or disables the collection of client IPs statistics.
collectMaxTpsAndThroughput string   optional read/write Enables or disables the collection of maximum TPS and throughput for all collected entities.
collectMethods string   optional read/write Enables or disables the collection of HTTP methods statistics.
collectPageLoadTime string   optional read/write Enables or disables the collection of the page load time statistics.
collectResponseCodes string   optional read/write Enables or disables the collection of HTTP response codes returned by the servers.
collectServerLatency string   optional read/write Enables or disables the collection of server latency statistics. Deprecated: server latency is always collected.
collectSubnets string   optional read/write Enables or disables the collection of client side subnets.
collectUrl string   optional read/write Enables or disables the collection of URL statistics.
collectUserAgent string   optional read/write Enables or disables the collection of user agents statistics.
collectUserSessions string   optional read/write Enables or disables the collection of user sessions.
collectedStatsExternalLogging string   optional read/write Enables or disables the external logging of the collected statistics.
collectedStatsInternalLogging string   optional read/write Enables or disables the internal logging of the collected statistics.
defaultsFrom string   optional read/write Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
description string   optional read/write User defined description.
externalLoggingPublisher string   optional read/write Specifies the external logging publisher used to send statistical data to one or more destinations.
notificationByEmail string   optional read/write Enables or disables sending the analytics alerts by email.
notificationBySnmp string   optional read/write Enables or disables sending the analytics alerts by SNMP traps (notification-by-syslog must be enabled).
notificationBySyslog string   optional read/write Enables or disables logging of the analytics alerts into the Syslog.
notificationEmailAddresses string   optional read/write Specifies which email addresses receive alerts by email when notification-by-email is enabled.
tmPartition string Common optional read/write Displays the administrative partition within which this profile resides.
publishIruleStatistics string disabled optional read/write Enables or disables publishing analytics statistics for iRules.
sampling string enabled optional read/write Enables or disables transaction sampling. This attribute can be set in the default profile only.
samplingRatio integer 2 optional read/write  
sessionCookieSecurity string ssl-only optional read/write Specifies the condition for adding a secure attribute to the session cookie. The default value is ssl-only.
sessionTimeout integer 1800 optional read/write  
sessionTimeoutMinutes string 30 optional read/write Specifies the number of minutes of user non-activity before the system considers the session to be over.
smtpConfig string   optional read/write The SMTP configuration to be used with analytics

Subcollections

Name Type Default Value Required Access Description
alerts array_structure   optional read/write Manage the set of analytics alerts that are associated with an analytics profile.
traffic-capture array_structure   optional read/write Manage the set of analytics alerts that are associated with an analytics profile.

Array Structures

Name Type Default Value Required Access Description
/subnet-masks array_structure   optional read/write Manage the set of predefined subnet addresses that are associated with an analytics profile.
/subnet-masks/app-service string   optional read/write  
/subnet-masks/subnet string   optional read/write Subnet address. IPv4 addresses will be masked by 255.255.255.0. IPv6 addresses will be masked by ffff:ffff:ffff:ffff:: .
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.