sys icall handler periodic

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

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

MODULE
       sys icall handler

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

   CREATE/MODIFY
	create periodic [name]
	modify periodic [name]
	 options:
	  arguments {
	   {
	     name [string]
	     value [string]
	   }
	   ...
	  }
	  description [string]
	  first-occurrence [date/time]
	  interval [integer]
	  last-occurrence [date/time]
	  script [script name]
	  status [active | inactive]

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

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

   DELETE
	delete periodic [name]

DESCRIPTION
       You can create a periodic handler to run scripts automatically based on clock time.

EXAMPLES
       create periodic my_handler1 script script1 first-occurrence now+1h interval 45 arguments { { name user value
       j.han } { name role value manager } }

       Create a new periodic handler that will execute script1 every 45 seconds. The handler will wait one hour
       before beginning, but continue to execute indefinitely. Each 45 seconds, when the script executes, the
       provided arguments will be passed into the script as EVENT::context() data.

       mv periodic /Common/my_periodic to-folder /Common/my_folder

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

OPTIONS
       arguments
	    Specifies a set of name/value pairs that will be passed to the script at the start of each execution on
	    each interval.

	    The use of arguments is optional and may be changed at any time.

       description
	    A user defined description of the item.

       first-occurrence
	    A specific date and time for this handler to begin executing. If not specified, the current date and time
	    of creation will be used.

       interval
	    The number of seconds between each time this handler should execute.

       last-occurrence
	    A specific date and time for this handler to stop executing. If not specified, the script will run
	    indefinitely.

       script
	    The iCall Tcl script the handler when execute at each time interval. Note that this script must be an
	    object in sys icall script; a cli script will not work.

       status
	    Specify either active or inactive. Active is the default value.

	    When the handler status is active, the handler accepts events and executes the script as expected.
	    However, when the status is inactive, the handler will no longer accept incoming events and the script
	    will not execute. Use the inactive status when you wish to keep the handler as a configuration item and
	    do not wish to delete it, but also do not wish the handler to run.

       to-folder
	    A periodic 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 periodic(1)