gtm monitor external

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



NAME
       external - Configures an external monitor.

MODULE
       gtm monitor

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

   CREATE/MODIFY
	create external [name]
	modify external [name]
	  options:
	    args [ [arguments] | none]
	    defaults-from [name]
	    description [string]
	    destination [ [ ipv4 address[:port] ] | [ ipv6 address[.port] ] ]
	    ignore-down-response [enabled | disabled]
	    interval [integer]
	    probe-timeout [integer]
	    run [none | [external monitor] ]
	    timeout [integer]
	    user-defined [ [name] [value] | [name] none ]

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

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

   DELETE
	delete external [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the external component to configure a custom monitor, or
       you can use the default external monitor that the Global Traffic
       Manager provides. You can use this type of monitor to monitor services
       using your own programs.

EXAMPLES
       create external my_external defaults-from external

       Creates a monitor named my_external that inherits properties from the
       default external monitor.

       list external

       Displays the properties of all of the external monitors.

OPTIONS
       args Specifies any command-line arguments that the external program
	    requires. The default value is none.

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

       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.

       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-timeout
	    Specifies the number of seconds after which the BIG-IP(r) 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.

       run  Specifies the external monitor file to be executed by the external
	    monitor. The default value is none.

       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.

       user-defined
	    Specifies any user-defined command-line arguments and variables
	    that the external program requires. Use the following syntax to
	    specify a user defined parameter.

		 modify external my_external user-defined my_param_name
		 my_param_value

	    Use the following syntax to remove a user defined parameter.

		 modify external my_external user-defined my_param_name none

SEE ALSO
       create, delete, edit, glob, gtm pool, 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 external(1)