sys icall handler triggered
sys icall handler triggered(1)BIG-IP TMSH Manualsys icall handler triggered(1)
NAME
triggered - Make or configure an event-triggered handler for the
BIG-IP(r) system.
MODULE
sys icall handler
SYNTAX
Modify the triggered component within the sys icall handler module
using the syntax shown in the following sections.
CREATE/MODIFY
create triggered [name]
modify triggered [name]
options:
description [string]
script [script name]
status [active | inactive]
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]
}
}
}
}
mv triggered [ [ [source-name] [destination-name] ] |
[ [name] to-folder [folder-name] ] |
[ [name...name] to-folder [folder-name] ] ]
options:
to-folder
DISPLAY
list triggered
list triggered [ [ [name] | [glob] | [regex] ] ... ]
show triggered
show triggered [ [ [name] | [glob] | [regex] ] ... ]
DELETE
delete triggered [name]
DESCRIPTION
You can create a triggered handler to automatically run a script when a
specified event occurs.
EXAMPLES
create triggered my_handler1 script script1 subscriptions add { pools {
event-name LTM_POOL_UP filters add { pool_name { value pool1 }
node_name { value node1 } } } }
Creates a new triggered handler that will execute the script called
"script1" when an event called "LTM_POOL_UP" is generated in the system
and contains the contexts { pool_name, pool1 } and { node_name, node1
}.
mv triggered /Common/my_triggered to-folder /Common/my_folder
Moves a triggered icall handler named my_triggered 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 when invoked by an
appropriate event. 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.
subscriptions
Specify one or more subscriptions to define 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.
A handler that specifies more than one subscription will execute
when any one subscription is matched to an event.
to-folder
A triggered 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 triggered(1)