gtm global-settings metrics¶

gtm global-settings metrics(1) BIG-IP TMSH Manual gtm global-settings metrics(1)

NAME
metrics - Configures metrics for the Global Traffic Manager(tm).

MODULE
gtm global-settings

SYNTAX
Modify or display the metrics component within the gtm global-settings module using the syntax in the
following sections.

MODIFY
modify metrics
options:
default-probe-limit [integer]
hops-ttl [integer]
hops-packet-length [integer]
hops-sample-count [integer]
hops-timeout [integer]
inactive-ldns-ttl [integer]
ldns-update-interval [integer]
inactive-paths-ttl [integer]
max-synchronous-monitor-requests [integer]
metrics-caching [integer]
metrics-collection-protocols none
metrics-collection-protocols
[add | delete | replace-all-with] {
[dns-dot | dns-rev | icmp | tcp | udp] ...
}
path-ttl [integer]
paths-retry [integer]

edit metrics
options:
all-properties
non-default-properties
one-line

DISPLAY
list
list metrics
show running-config metrics
show running-config metrics [option]
options:
all-properties
non-default-properties

DESCRIPTION
You can use the metrics component to modify or display the Global Traffic Manager metrics settings.

EXAMPLES
modify metrics default-probe-limit 10

Sets the default probe limit for the Global Traffic Manager to 10.

list metrics all-properties

Displays all properties of the metrics settings for the Global Traffic Manager.

OPTIONS
default-probe-limit
Specifies the number of probe attempts that the system performs before removing the path from the
metrics. The default value is 12.

hops-ttl
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 this option must be greater than
the hops-timeout option.

hops-packet-length
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.

hops-sample-count
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.

hops-timeout
Specifies the number of seconds that the big3d daemon waits for a probe. Valid values are 1 - 10. The
default value is 3.

inactive-ldns-ttl
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).

ldns-update-interval
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.

inactive-paths-ttl
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).

max-synchronous-monitor-requests
Specifies how many monitor requests are executed simultaneously. This value should only be changed if
requested by F5 Support. The default value is 20.

metrics-caching
Specifies the interval (in seconds) at which the system dumps path and other metrics data. Valid values
are 0 through 604800. The default value is 3600; 0 (zero) turns this feature off.

metrics-collection-protocols
Specifies the protocols that the system uses to collect metrics information relevant to LDNS servers.

path-ttl
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. Note that this option must be greater than the paths-
retry option and less than or equal to 2419200 (28 days).

paths-retry
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.

SEE ALSO
edit, gtm global-settings general, gtm global-settings load-balancing, gtm global-settings metrics-exclusions,
list, modify, show, tmsh

COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.

BIG-IP 2020-01-24 gtm global-settings metrics(1)