glite-lb-notify(1)

1GLITE-LB-NOTIFY(1)            Logging&Bookkeeping           GLITE-LB-NOTIFY(1)
2
3
4

NAME

6       glite-lb-notify - Register and receive notification from L&B
7
8

SYNOPSIS

10       glite-lb-notify
11            new  [  {  -s  socket_fd | -a fake_addr } -t requested_validity -j
12       jobid | { -o owner  | -O  } -n network_server  -v  virtual_organization
13       -c -J -B -T -E -f flags ]
14            bind   [  {  -s socket_fd | -a fake_addr } -t requested_validity ]
15       notifid
16            change  notifid jobid
17            refresh [ -t requested_validity  ] notifid
18            receive [ { -s socket_fd | -a fake_addr } -t requested_validity  ]
19       [ -i timeout ] [ -r] [ -f field1,field2,... notifid
20            drop notifid
21            help
22
23
24

DESCRIPTION

26       glite-lb-notify is a fairly simple wrapper on the L&B notification API.
27       It allows to create a notification (with a restricted richness of spec‐
28       ifying conditions), bind to it for receiving notifications, and drop it
29       finally.
30
31       L&B notification is a user-initiated trigger at the server.  Whenever a
32       job enters a state matching conditions specified with the notification,
33       the current state of the job is sent to the  notification  client.   On
34       the  other  hand,  the  notification client is a network listener which
35       receives server-initiated connections to get the notifications.  Unless
36       -s is specified, the notification library creates the listener socket.
37
38       Within  the  notification  validity,  clients  can  disappear  and even
39       migrate.  However, only a single active client for  a  notification  is
40       allowed.
41
42       This  command  is  intended to be used in user scripts, graphical tools
43       etc. where direct access to the API is difficult.
44
45       L&B server and port to contact is specified with GLITE_WMS_NOTIF_SERVER
46       environment variable.
47
48

USAGE

50       Common options (mostly)
51
52       -t     specifies  a  requested validity of the notification (in seconds
53              of UNIX Epoch), the server can truncate the value  according  to
54              its policy.
55
56       -a     allows  to  specify a fake listener address to register with the
57              notification, i.e. to overcome firewalls  etc.   When  notifica‐
58              tions are delivered, the server tries to connect to this address
59              rather than the true address of the listening socket.   Requires
60              re-binding therefore it can't be used in conjunction with -s
61
62       -s     allows  to  pass  a opened listening socket (filedescriptor num‐
63              ber), see EXAMPLE bellow.  In this case there is no need to  re-
64              bind  the  notification  (it  is assumed the socket is recycled)
65              This is critical for a real usage, as the re-bind  operation  is
66              rather expensive.
67
68
69
70       Subcommands:
71
72       new    Create a new notification. Conditions on matching jobs are spec‐
73              ified with exacltly one of -j, -o, -n, -v options. If the option
74              -O  is  used, credentials are retrieved from environment. The -c
75              set matching only on state change.  Prints  ID  of  the  created
76              notification.
77
78
79       bind
80
81              Binds to an existing notification, changing its listener eventu‐
82              ally.  Useful for debugging purposes mostly.
83
84
85       change
86
87              Connect notification with another job.
88
89
90       refresh
91
92              Extend validity of an existing notification.
93
94
95       receive
96
97              Bind to an existing  notification,  and  start  waiting  for  an
98              incoming  event,  at  most the time specified with -i (seconds).
99              -r attempts to refresh the notification handle in 1/2 of current
100              validity.   -f  allows to specify a custom list of fields of the
101              job status to display. Run glite-lb-notify to get list of avail‐
102              able fields.
103
104
105       drop
106
107              Drop  the notification from the server, removing all messages on
108              the way eventually.
109
110
111
112       Options for the new subcommand:
113
114       -o     match on events for jobs belonging to the given DN.
115
116       -O     match on events for jobs belonging to the current user.
117
118       -v     match on events for jobs belonging to users from the given VO.
119
120       -c     match only if job state has actually changed. Notification  mes‐
121              sages  won't  be  sent  for events that do not trigger job state
122              change.
123
124       -S     match only on jobs in certain states listed in a comma-separated
125              list.
126
127       -J     pack JDL with the job status structure.
128
129       -B     bootstrap -- send past events matching conditions.
130
131       -T     match only on reaching a terminal state.
132
133       -H     match  only on reaching a terminal state and pack all events for
134              that job.
135
136       -N     anonymize all owner data in all messages  under  this  registra‐
137              tion.
138
139

EXAMPLE

141       Installed   with   the  package  as  share/examples/glite-lb-notify.pl.
142       Demontstrates using the non-trivial -s option.
143
144

BUGS

146       Please report all bugs to CESNET gLite L&B issue tracker  available  at
147       https://github.com/CESNET/glite-lb/issues
148
149

AUTHOR

157       EU EGEE, JRA1.
158
159
160
161EU EGEE Project                    Apr 2008                 GLITE-LB-NOTIFY(1)