gtm prober-pool

gtm prober-pool(1)				  BIG-IP TMSH Manual				   gtm prober-pool(1)

NAME
       prober-pool - Configures prober pools for the Global Traffic Manager(tm).

MODULE
       gtm

SYNTAX
       Modify the Global Traffic Manager prober-pool component within the gtm module using the syntax shown in the
       following sections.

   CREATE/MODIFY
	create prober-pool [name]
	modify prober-pool [name]
	 options:
	  app-service [[string] | none]
	  description [string]
	  [disabled | enabled]
	  load-balancing-mode [global-availability | round-robin]
	  members none
	  members
	    [ add | delete | modify | replace-all-with ] {
	      [name] {
		options:
		  app-service [[string] | none]
		  description [string]
		  [disabled | enabled]
		  order [integer]
	     }...
	  }

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

	reset-stats prober-pool
	reset-stats prober-pool [ [ [name] | [glob] | [regex] ] ... ]

   DISPLAY
	list prober-pool
	list prober-pool [ [ [name] | [glob] | [regex] ] ... ]

	show running-config prober-pool
	show running-config prober-pool [ [ [name] | [glob] | [regex] ] ... ]
	 options:
	  all-properties
	  non-default-properties

	show prober-pool
	show prober-pool [name]
	 options:
	  (default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
	  detail
	  field-fmt

   DELETE
	delete prober-pool [name]

       Note: You must remove all references to a prober-pool before you can delete the prober-pool.

DESCRIPTION
       You can use the prober-pool component to configure prober pool definitions on the Global Traffic Manager. You
       use prober pools to control which BIG-IP servers on your network are utilized by GTM to monitor the up/down
       state of GTM resources. Once defined, prober pools can be set to monitor whole data centers or individual
       servers.

EXAMPLES
       create prober-pool my_pool members add {
	     bigip-dallas
	     bigip-london
	     }

       Creates a Global Traffic Manager prober pool with two members bigip-dallas and bigip-london. Members are
       selected using the global-availability load balancing method.

       delete prober-pool my_pool

       Deletes the prober pool my_pool.

       show prober-pool

       Displays statistics for all prober pools.

       list prober-pool my_pool

       Displays settings of prober pool my_pool.

OPTIONS
       app-service
	    Specifies the name of the application service to which this prober pool 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 this prober pool. Only the application service can modify or delete this prober
	    pool.

       description
	    User defined description.

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

       load-balancing-mode
	    Specifies the load balancing mode that the system uses to select members of this pool. The default value
	    is global-availability.

	    The options are:

	    global-availability
		 Specifies that the Global Traffic Manager selects the first available pool member in the order in
		 which they are listed.

	    round-robin
		 Specifies that the Global Traffic Manager selects members using a circular, sequential pattern among
		 available pool members.

       members
	    Specifies the BIG-IP server names of the pool members. The default value is none.

	    You can also use the following options with prober pool members:

	    app-service
		 Specifies the name of the application service to which this prober pool member 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 this prober pool member. Only the application service can
		 modify or delete this prober pool member.

	    description
		 User defined description.

	    [enabled | disabled]
		 Specifies whether this pool member is available to issue probes. The default value is enabled.

	    order
		 Specifies the order number of the pool member. The system uses this number with load balancing
		 methods that involve prioritizing pool members by listed order.

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

       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.

SEE ALSO
       create, delete, edit, glob, gtm server, gtm datacenter, list, modify, regex, reset-stats, 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-2013. All rights reserved.

BIG-IP						      2013-04-12				   gtm prober-pool(1)