← Back to branch summary

~ubuntu-branches/ubuntu/vivid/slurm-llnl/vivid

« back to all changes in this revision

Viewing changes to doc/html/accounting_storageplugins.shtml

  • Committer: Bazaar Package Importer
  • Author(s): Gennaro Oliva
  • Date: 2009-09-24 23:28:15 UTC
  • mfrom: (1.1.11 upstream) (3.2.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090924232815-enh65jn32q1ebg07
Tags: 2.0.5-1
http://bugs.debian.org/541252
* New upstream release 
* Changed dependecy from lib-mysqlclient15 to lib-mysqlclient 
* Added Default-Start for runlevel 2 and 4 and $remote_fs requirement in
  init.d scripts (Closes: #541252)
* Postinst checks for wrong runlevels 2 and 4 links
* Upgraded to standard version 3.8.3
* Add lintian overrides for missing slurm-llnl-configurator.html in doc
  base registration
* modified postrm scripts to ignore pkill return value in order to avoid
  postrm failure when no slurm process is running
* Checking for slurmctld.pid before cancelling running and pending
  jobs during package removal 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/accounting_storageplugins.shtml
11
11
SLURM Plugin API with the following specifications:
12
12
 
13
13
<p><span class="commandline">const char
14
 
plugin_name[]="<i>full&nbsp;text&nbsp;name</i>"
 
14
plugin_name[]="<i>full&nbsp;text&nbsp;name</i>"</span>
15
15
<p style="margin-left:.2in">
16
16
A free-formatted ASCII text string that identifies the plugin.
17
17
 
58
58
<span class="commandline">make_agent</span> (input) to make an agent
59
59
thread of not.  This is primarily used in the slurmdbd plugin.<br>
60
60
<span class="commandline">conn_num</span> (input) connection number to
61
 
the plugin.  In many cases you should plan on multiple simultanious
 
61
the plugin.  In many cases you should plan on multiple simultaneous
62
62
connections to the plugin.  This number is useful since the debug
63
63
messages can print this out to determine which connection the message
64
64
is from.<br>
77
77
<p style="margin-left:.2in"><b>Arguments</b>: <br>
78
78
<span class="commandline">db_conn</span> (input/output) connection to
79
79
the storage type, all memory will be freed inside this function and
80
 
NULLed out. 
 
80
set to NULL. 
81
81
<p style="margin-left:.2in"><b>Returns</b>: <br>
82
82
<span class="commandline">SLURM_SUCCESS</span> on success, or<br>
83
83
<span class="commandline">SLURM_ERROR</span> on failure.
199
199
<span class="commandline">SLURM_ERROR</span> on failure.
200
200
 
201
201
<p class="commandline">
 
202
int acct_storage_p_add_reservation(void *db_conn,
 
203
acct_reservation_rec_t *resv)
 
204
<p style="margin-left:.2in"><b>Description</b>:<br>
 
205
Called to add reservations to the storage type.
 
206
<p style="margin-left:.2in"><b>Arguments</b>: <br>
 
207
<span class="commandline">db_conn</span> (input) connection to
 
208
the storage type. <br>
 
209
<span class="commandline">resv</span> (input) Reservation to be added. <br>
 
210
<p style="margin-left:.2in"><b>Returns</b>: <br>
 
211
<span class="commandline">SLURM_SUCCESS</span> on success, or<br>
 
212
<span class="commandline">SLURM_ERROR</span> on failure.
 
213
 
 
214
<p class="commandline">
202
215
List acct_storage_p_modify_users(void *db_conn, uint32_t uid,
203
216
acct_user_cond_t *user_cond, acct_user_rec_t *user)
204
217
<p style="margin-left:.2in"><b>Description</b>:<br>
205
218
Used to modify existing users in the storage type.  The condition
206
 
  could include very vaque information about the user, so this
 
219
  could include very vague information about the user, so this
207
220
  function should be robust in the ability to give everything the user
208
221
  is asking for.  This is the reason a list of modified users is
209
222
  returned so the caller knows what has been changed, sometimes by mistake.
225
238
acct_account_cond_t *acct_cond, acct_account_rec_t *acct)
226
239
<p style="margin-left:.2in"><b>Description</b>:<br>
227
240
Used to modify existing accounts in the storage type.  The condition
228
 
  could include very vaque information about the account, so this
 
241
  could include very vague information about the account, so this
229
242
  function should be robust in the ability to give everything the account
230
243
  is asking for.  This is the reason a list of modified accounts is
231
244
  returned so the caller knows what has been changed, sometimes by mistake.
247
260
acct_cluster_cond_t *cluster_cond, acct_cluster_rec_t *cluster)
248
261
<p style="margin-left:.2in"><b>Description</b>:<br>
249
262
Used to modify existing clusters in the storage type.  The condition
250
 
  could include very vaque information about the cluster, so this
 
263
  could include very vague information about the cluster, so this
251
264
  function should be robust in the ability to give everything the cluster
252
265
  is asking for.  This is the reason a list of modified clusters is
253
266
  returned so the caller knows what has been changed, sometimes by mistake.
269
282
acct_association_cond_t *assoc_cond, acct_association_rec_t *assoc)
270
283
<p style="margin-left:.2in"><b>Description</b>:<br>
271
284
Used to modify existing associations in the storage type.  The condition
272
 
  could include very vaque information about the association, so this
 
285
  could include very vague information about the association, so this
273
286
  function should be robust in the ability to give everything the association
274
287
  is asking for.  This is the reason a list of modified associations is
275
288
  returned so the caller knows what has been changed, sometimes by mistake.
291
304
acct_qos_cond_t *qos_cond, acct_qos_rec_t *qos)
292
305
<p style="margin-left:.2in"><b>Description</b>:<br>
293
306
Used to modify existing qos in the storage type.  The condition
294
 
  could include very vaque information about the qos, so this
 
307
  could include very vague information about the qos, so this
295
308
  function should be robust in the ability to give everything the qos
296
309
  is asking for.  This is the reason a list of modified qos is
297
310
  returned so the caller knows what has been changed, sometimes by mistake.
313
326
acct_wckey_cond_t *wckey_cond, acct_wckey_rec_t *wckey)
314
327
<p style="margin-left:.2in"><b>Description</b>:<br>
315
328
Used to modify existing wckeys in the storage type.  The condition
316
 
  could include very vaque information about the wckeys, so this
 
329
  could include very vague information about the wckeys, so this
317
330
  function should be robust in the ability to give everything the wckey
318
331
  is asking for.  This is the reason a list of modified wckey is
319
332
  returned so the caller knows what has been changed, sometimes by mistake.
331
344
<span class="commandline">NULL</span> on failure.
332
345
 
333
346
<p class="commandline">
 
347
int acct_storage_p_modify_reservation(void *db_conn,
 
348
acct_reservation_rec_t *resv)
 
349
<p style="margin-left:.2in"><b>Description</b>:<br>
 
350
Called to modify reservations in the storage type.
 
351
<p style="margin-left:.2in"><b>Arguments</b>: <br>
 
352
<span class="commandline">db_conn</span> (input) connection to
 
353
the storage type. <br>
 
354
<span class="commandline">resv</span> (input) Reservation to be
 
355
modified (id) must be set in the structure. <br>
 
356
<p style="margin-left:.2in"><b>Returns</b>: <br>
 
357
<span class="commandline">SLURM_SUCCESS</span> on success, or<br>
 
358
<span class="commandline">SLURM_ERROR</span> on failure.
 
359
 
 
360
<p class="commandline">
334
361
List acct_storage_p_remove_users(void *db_conn, uint32_t uid,
335
362
acct_user_cond_t *user_cond)
336
363
<p style="margin-left:.2in"><b>Description</b>:<br>
454
481
<span class="commandline">NULL</span> on failure.
455
482
 
456
483
<p class="commandline">
 
484
int acct_storage_p_remove_reservation(void *db_conn,
 
485
acct_reservation_rec_t *resv)
 
486
<p style="margin-left:.2in"><b>Description</b>:<br>
 
487
Called to remove reservations in the storage type.
 
488
<p style="margin-left:.2in"><b>Arguments</b>: <br>
 
489
<span class="commandline">db_conn</span> (input) connection to
 
490
the storage type. <br>
 
491
<span class="commandline">resv</span> (input) Reservation to be
 
492
removed (id) must be set in the structure. <br>
 
493
<p style="margin-left:.2in"><b>Returns</b>: <br>
 
494
<span class="commandline">SLURM_SUCCESS</span> on success, or<br>
 
495
<span class="commandline">SLURM_ERROR</span> on failure.
 
496
 
 
497
<p class="commandline">
457
498
List acct_storage_p_get_users(void *db_conn, uint32_t uid,
458
499
acct_user_cond_t *user_cond)
459
500
<p style="margin-left:.2in"><b>Description</b>:<br>
471
512
on success, or<br>
472
513
<span class="commandline">NULL</span> on failure.
473
514
 
474
 
                <p class="commandline">
 
515
<p class="commandline">
475
516
List acct_storage_p_get_accts(void *db_conn, uint32_t uid,
476
517
acct_account_cond_t *acct_cond)
477
518
<p style="margin-left:.2in"><b>Description</b>:<br>
590
631
<span class="commandline">uid</span> (input) uid of user calling the
591
632
function.<br> 
592
633
<span class="commandline">in</span> (input/out) can be anything that
593
 
gathers usage like acct_associaiton_rec_t * or acct_wckey_rec_t *.<br> 
 
634
gathers usage like acct_association_rec_t * or acct_wckey_rec_t *.<br> 
594
635
<span class="commandline">type</span> (input) really
595
636
slurmdbd_msg_type_t should let the plugin know what the structure is
596
637
that was sent in some how.<br> 
650
691
 
651
692
<p class="commandline">
652
693
int clusteracct_storage_p_cluster_procs(void *db_conn, char *cluster,
653
 
uint32_t procs, time_t event_time)
 
694
char *cluster_nodes, uint32_t procs, time_t event_time)
654
695
<p style="margin-left:.2in"><b>Description</b>:<br>
655
696
Update storage type with the current number of processors on a given cluster.
656
697
<p style="margin-left:.2in"><b>Arguments</b>: <br>
657
698
<span class="commandline">db_conn</span> (input) connection to
658
699
the storage type. <br>
659
700
<span class="commandline">cluster</span> (input) name of cluster.<br>
 
701
<span class="commandline">cluster_nodes</span> (input) ranged list of
 
702
nodes on system.<br>
660
703
<span class="commandline">procs</span> (input) number of processors on
661
704
system.<br>
662
705
<span class="commandline">event_time</span> (input) time event happened.<br>
867
910
<dt><span class="commandline">AccountingStoragePass</span>
868
911
<dd>Let the plugin know the password of the user connecting to the database.
869
912
<dt><span class="commandline">AccountingStorageEnforce</span>
870
 
<dd>Specifies if we should enforce certain things be in existance
 
913
<dd>Specifies if we should enforce certain things be in existence
871
914
  before allowing job submissions and such valid options are
872
915
  "associations, limits, and wckeys". You can use any combination of
873
916
  those listed.
880
923
for SLURM plugins.
881
924
<p class="footer"><a href="#top">top</a>
882
925
 
883
 
<p style="text-align:center;">Last modified 10 February 2009</p>
 
926
<p style="text-align:center;">Last modified 2 March 2009</p>
884
927
 
885
928
<!--#include virtual="footer.txt"-->