APIRef_tm_gtm_global-settings_metricsΒΆ
mgmt/tm/gtm/global-settings/metrics
Metrics configuration options
REST Endpoints
- Collection URI
/mgmt/tm/gtm/global-settings/metrics- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/global-settings/metrics/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
defaultProbeLimit |
integer | 12 | optional | read/write | Specifies the number of probe attempts that the system performs before removing the path from the metrics. The default value is 12. |
hopsPacketLength |
integer | 64 | optional | read/write | Specifies the length of packets, in bytes, that the system sends to a local DNS server to determine the path information between the two systems. Valid values are 64 - 500. The default value is 64. |
hopsSampleCount |
integer | 3 | optional | read/write | Specifies the number of packets that the system sends to a local DNS server to determine the path information between those two systems. Valid values are 1 - 10. The default value is 3. |
hopsTimeout |
integer | 3 | optional | read/write | Specifies the number of seconds that the big3d agent waits for a probe. Valid values are 1 - 10. The default value is 3. |
hopsTtl |
integer | 604800 | optional | read/write | Specifies the number of seconds that the system considers traceroute utility data to be valid for name resolution and load balancing. The default value is 604800. Note that the this option should be greater than the hops-timeout option. |
inactiveLdnsTtl |
integer | 2419200 | optional | read/write | Specifies the number of seconds that an inactive LDNS remains in the cache. Each time an LDNS makes a request, the clock starts again. Valid values are 60 - 31536000 (1 year). The default value is 2419200 (28 days). |
inactivePathsTtl |
integer | 604800 | optional | read/write | Specifies the number of seconds that a path remains in the cache after its last access. Valid values are 60 - 31536000 (1 year). The default value is 604800 (7 days). |
ldnsUpdateInterval |
integer | 20 | optional | read/write | Specifies the number of seconds that a tmm will wait before sending an update for a LDNS which has been accessed. The default value is 20 seconds. |
maxSynchronousMonitorRequests |
integer | 20 | optional | read/write | Specifies how many monitors can attempt to verify the availability of a given resource at the same time. The default value is 20. |
metricsCaching |
integer | 3600 | optional | read/write | Specifies the interval (in seconds) at which the system dumps path and other metrics data. Valid values are 0 - 604800. The default value is 3600; 0 (zero) turns this feature off. |
metricsCollectionProtocols |
string | icmp | optional | read/write | Specifies the protocol(s) that the system uses to collect metrics information relevant to LDNS servers. |
pathTtl |
integer | 2400 | optional | read/write | Specifies the number of seconds that the system considers path data to be valid for name resolution and load balancing purposes. The default value is 2400. Maximum valid value is 2419200 (28 days). Note that this option must be greater than the paths-retry option. |
pathsRetry |
integer | 120 | optional | read/write | Specifies the interval (in seconds) at which the system retries the path data. Valid values are 1 - 600 (10 minutes). The default value is 120. |
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.