gtm monitor gateway-icmp

gtm monitor gateway-icmp(1)			  BIG-IP TMSH Manual			  gtm monitor gateway-icmp(1)

NAME
       gateway-icmp - Configures a Gateway Internet Control Message Protocol (ICMP) monitor.

MODULE
       gtm monitor

SYNTAX
       Configure the gateway-icmp component within the gtm monitor module using the syntax in the following sections.

   CREATE/MODIFY
	create gateway-icmp [name]
	modify gateway-icmp [name]
	  options:
	    defaults-from [name]
	    description [string]
	    destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
	    ignore-down-response [enabled | disabled]
	    interval [integer]
	    probe-attempts [integer]
	    probe-interval [integer]
	    probe-timeout [integer]
	    timeout [integer]
	    transparent [enabled | disabled]

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

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

   DELETE
	delete gateway-icmp [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the gateway-icmp component to configure a custom monitor, or you can use the default Gateway ICMP
       monitor that the Global Traffic Manager provides. You can use a Gateway ICMP type of monitor for a virtual
       server, a server (that is, all of the virtuals on a specified server), a pool member, a pool (that is, all of
       the pool members of a specified pool), or a link.

EXAMPLES
       create gateway-icmp my_imcp defaults-from gateway_icmp

       Creates a monitor named my_icmp that inherits properties from the default Gateway ICMP monitor.

       list gateway-icmp

       Displays the properties of all of the Gateway ICMP monitors.

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

       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 IP address and port supplied by a pool member.

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

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

	    IP address:port (with the transparent option enabled)
		 Specifies to perform a health check on the server at the IP address and port specified in the
		 monitor, routing the check through the IP address and port supplied by the pool member. The pool
		 member (the gateway) is marked up or down accordingly.

       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.

       probe-attempts
	    Specifies the number of times the BIG-IP(r) system attempts to probe the host server, after which the
	    BIG-IP system considers the host server down or unavailable. The default value is 3 attempts.

       probe-interval
	    Specifies the frequency at which the BIG-IP system probes the host server. The default value is 1 second.

       probe-timeout
	    Specifies the number of seconds after which the BIG-IP system times out the probe request to the BIG-IP
	    system. The default value is 5 seconds.

       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 120 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.

       transparent
	    Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool
	    members through firewalls. The default value is disabled.

SEE ALSO
       create, delete, edit, glob, gtm link, 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.

       F5 Networks and BIG-IP (c) Copyright 2008-2010. All rights reserved.

BIG-IP						      2017-08-15			  gtm monitor gateway-icmp(1)