sys icall handler perpetual

sys icall handler perpetual(1)			  BIG-IP TMSH Manual		       sys icall handler perpetual(1)

NAME
       perpetual - Make or configure a perpetual handler for the BIG-IP(r) system.

MODULE
       sys icall handler

SYNTAX
       Modify the perpetual component within the sys icall handler module using the syntax shown in the following
       sections.

   CREATE/MODIFY
	create perpetual [name]
	modify perpetual [name]
	 options:
	  description [string]
	  script [script name]
	  status [active | inactive | suspend ]
	  subscriptions [add | delete | modify | replace-all-with] {
	   [subscription name] {
	    options:
	     event-name [event name]
	     filters [add | delete | modify | replace-all-with] {
	      [filter name] {
	       options:
		value [string]
		match-algorithm [accept-all | exact | glob | regex | subnet]
	      }
	     }
	   }
	  }
	restart perpetual [name]
	start perpetual [name]
	stop perpetual [name]

	mv perpetual [ [ [source-name] [destination-name] ]    |
		       [ [name] to-folder [folder-name] ]      |
		       [ [name...name] to-folder [folder-name] ] ]
	  options:
	    to-folder

   DISPLAY
	list perpetual
	list perpetual [ [ [name] | [glob] | [regex] ] ... ]
	show perpetual
	show perpetual [ [ [name] | [glob] | [regex] ] ... ]

   DELETE
	delete perpetual [name]

DESCRIPTION
       You can create a perpetual handler to run continuously executing code and to receive events by specifying
       subscriptions.

EXAMPLES
       create perpetual my_handler1 script script1 subscriptions add { sub1 { event-name LTM_POOL_UP } }

       Creates a new perpetual handler run the program defined in "script1". Anytime an event called "LTM_POOL_UP" is
       generated in the system, a copy will be sent to my_handler1.

       mv perpetual /Common/my_perpetual to-folder /Common/my_folder

       Moves a perpetual icall handler named my_perpetual to a folder named my_folder, where my_folder has already
       been created and exists within /Common.

OPTIONS
       description
	    A user defined description of the item.

       script
	    The iCall Tcl script the handler will execute upon creation. The user is responsible for creating a
	    script with perpetual execution. If the script is changed, the handler will not change its executing code
	    until the handler is restarted or put into inactive and then active status.

	    Note that this script must be an object in sys icall script; a cli script will not work.

       status
	    Specify active, inactive, or suspend. Active is the default value.

	    Inactive status indicated that the handler is to no longer execute and to no longer receive events. The
	    handler's state is lost and all pending events are deleted. Use this status to eliminate a handler in the
	    system but to keep its information stored.

	    The handler may also be set to suspend which will keep the handler script executing, but the system will
	    send no new events to the handler. Events waiting to be processed remain in queue.

       subscriptions
	    Create one or more subscription items to specify the conditions of this handler's execution. The handler
	    subscribes generally to events by the event name, and specifically to data by using filters. The use of
	    filters is optional.

	    The handler will be sent events by the system as defined by the subscription property, but the code
	    inside the handler must use EVENT::get_next function in order to receive the data into the handler. See
	    sys icall script for more information.

       to-folder
	    A perpetual icall handler can be moved to any folder under /Common, but configuration dependencies may
	    restrict it from moving out of /Common.

SEE ALSO
       create, delete, edit, list, modify, mv, show, sys icall event, sys icall script, 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 2009-2013, 2016. All rights reserved.

BIG-IP						      2016-03-14		       sys icall handler perpetual(1)