gtm monitor bigip¶

gtm monitor bigip(1) BIG-IP TMSH Manual gtm monitor bigip(1)

NAME
bigip - Configures a BIG-IP(r) monitor.

MODULE
gtm monitor

SYNTAX
Configure the bigip component within the gtm monitor module using the syntax in the following sections.

CREATE/MODIFY
create bigip [name]
modify bigip [name]
options:
aggregate-dynamic-ratios [average-members | average-nodes | none |
sum-members | sum-nodes]
app-service [[string] | none]
defaults-from [name]
description [string]
destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
ignore-down-response [enabled | disabled]
interval [integer]
timeout [integer]

edit bigip [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default properties

DISPLAY
list bigip
list bigip [ [name] | [glob] | [regex] ] ... ]
show running-config bigip
show running-config bigip [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition

DELETE
delete bigip [name]

Note: You cannot delete default monitors.

DESCRIPTION
You can use the bigip component in the gtm monitor module to configure a custom monitor, or you can use the
default BIG-IP(r) monitor that the Global Traffic Manager(tm) provides. The BIG-IP monitor is both a health
and performance monitor. This type of monitor acquires data captured through monitors managed by a BIG-IP
Local Traffic Manager(tm).

You can monitor only the following components with a BIG-IP monitor:

Global Traffic Manager server
Global Traffic Manager virtual server
Local Traffic Manager server
Local Traffic Manager virtual server

EXAMPLES
create bigip my_bigip defaults-from bigip

Creates a monitor named my_bigip that inherits properties from the default BIG-IP monitor.

list bigip

Displays the properties of all of the BIG-IP monitors.

OPTIONS
aggregate-dynamic-ratios
Specifies the monitor's response to a query. By default, the BIG-IP monitor uses the gtm_score value as
the vs_score for a Local Traffic Manager virtual server.

You can use this option to override the default behavior using the following values:

average-members
Specifies that the monitor uses the average of the dynamic ratio values of the pool members
associated with the pools that are associated with the virtual server as a response to a query.

average-nodes
Specifies that the monitor uses the average value of all of the nodes associated with the pool
members that are associated with the pools that are associated with the virtual server as a response
to a query.

none This is the default value.

sum-members
Specifies that the monitor uses the sum of the pool members as a response to a query.

sum-nodes
Specifies that the monitor uses the sum of the dynamic ratios of all of the nodes as a response to a
query.

app-service
Specifies the name of the application service to which the monitor belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the monitor. Only the application service can modify or delete the monitor.

defaults-from
Specifies the name of the monitor from which you want your custom monitor to inherit settings. The
default value is bigip.

description
User defined description.

destination
Specifies the IP address and service port of the resource that is the destination of this monitor. The
default value is *:*.

Possible values are:

*:* Specifies to perform a health check on the address and port supplied by a virtual server.

*:port
Specifies to perform a health check on the virtual server with the IP address supplied by the
virtual server and the port you specify.

IP address:port
Specifies to mark a pool member up or down based on the response of the virtual server at the IP
address and port you specify.

glob Displays the items that match the glob expression. See help glob for a description of glob expression
syntax.

ignore-down-response
Specifies whether the monitor ignores a down response from the system it is monitoring. The default value
is disabled.

interval
Specifies the frequency at which the system issues the monitor check. The default value is 30 seconds.

name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.

partition
Displays the administrative partition within which the component resides.

regex
Displays the items that match the regular expression. The regular expression must be preceded by an at
sign (@[regular expression]) to indicate that the identifier is a regular expression. See help regex for
a description of regular expression syntax.

timeout
Specifies the number of seconds the target has in which to respond to the monitor request. The default
value is 90 seconds.

If the target responds within the set time period, it is considered up. If the target does not respond
within the set time period, it is considered down. Also, if the target responds with a RESET packet, the
system immediately flags the target as down without waiting for the timeout interval to expire.

SEE ALSO
create, delete, edit, glob, gtm pool, gtm server, list, modify, regex, 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 2017-08-15 gtm monitor bigip(1)