ltm monitor real-server

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



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

MODULE
       ltm monitor

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

   CREATE/MODIFY
	create real-server [name]
	modify real-server [name]
	  options:
	    app-service [[string] | none]
	    defaults-from [name]
	    description [string]
	    interval [integer]
	    metrics [ [metrics] | none]
	    time-until-up [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 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 Local 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.

       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.

       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.

       interval
	    Specifies the frequency at which the system issues the monitor
	    check. The default value is 5 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.

       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.

       time-until-up
	    Specifies the amount of time, in seconds, after the first
	    successful response before a node is marked up. A value of 0
	    (zero) causes a node to be marked up immediately after a valid
	    response is received from the node. The default value is 0 (zero).

       timeout
	    Specifies the number of seconds the target has in which to respond
	    to the monitor request. The default value is 16 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, 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, 2012. All rights
       reserved.



BIG-IP				  2013-09-10	    ltm monitor real-server(1)