gtm monitor real-server

gtm monitor real-server(1)			  BIG-IP TMSH Manual			   gtm monitor real-server(1)

NAME
       real-server - Configures a RealServer(r) monitor.

MODULE
       gtm monitor

SYNTAX
       Configure the real-server component within the gtm monitor module using the syntax in the following sections.

   CREATE/MODIFY
	create real-server [name]
	modify real-server [name]
	  options:
	    defaults-from [name]
	    description [string]
	    ignore-down-response [enabled | disabled]
	    interval [integer]
	    metrics [ [metrics] | none]
	    probe-timeout [integer]
	    timeout [integer]

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

   DISPLAY
	list real-server
	list real-server [ [ [name] | [glob] | [regex] ] ... ]
	show running-config real-server
	show running-config real-server [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    agent
	    all-properties
	    command
	    method
	    non-default-properties
	    one-line
	    partition

   DELETE
	delete real-server [name]

       Note: You cannot delete default monitors.

DESCRIPTION
       You can use the real-server component to configure a custom monitor, or you can use the default RealServer
       monitor that the Global Traffic Manager provides. This type of monitor checks the performance of a pool, pool
       member, or virtual server that is running the RealServer data collection agent, and then dynamically load
       balances traffic accordingly.

EXAMPLES
       create real-server my_real-server defaults-from real_server

       Creates a monitor named my_real-server that inherits properties from the default RealServer monitor.

       list real-server

       Displays the properties of all of the RealServer monitors.

OPTIONS
       agent
	    Displays the agent for the monitor. The default agent is Mozilla/4.0 (compatible: MSIE 5.0; Windows NT).
	    You cannot modify the agent.

       command
	    Displays the command that the system uses to obtain the metrics from the resource. See the documentation
	    for this resource for information on available commands. You cannot modify the command.

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

       description
	    User defined description.

       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.

       method
	    Displays the GET method. You cannot modify the method.

       metrics
	    Specifies the performance metrics that the commands collect from the target. The default value is
	    ServerBandwidth:1.5, CPUPercentUsage, MemoryUsage, TotalClientCount.

       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.

       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.

SEE ALSO
       create, delete, edit, glob, gtm pool, gtm server, list, ltm node, 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						      2010-07-02			   gtm monitor real-server(1)