FBSNG Application Programmer’s Interface

Reference Manual

 

 

Version 1.5

 

 

Krzysztof Genser, Tanya Levshina, Igor Mandrichenko

 

Farms and Clustered Systems Group

Fermi National Accelerator Laboratory


Table of Contents

 

1     Introduction. 5

2     FBSNG API Overview. 5

3     Using FBSNG API 8

4     Common Features of API Classes 9

4.1     Returning Status 9

4.2     Generated Exceptions 9

5     FBSClient Class 11

5.1     FBSClient Methods 11

Constructor FBSClient 11

submitJob. 11

getJobList 11

getJob. 12

killJob. 12

getSection. 13

getSectionOutput 13

holdSection. 14

releaseSection. 14

incSectPrio. 15

killSection. 15

getProcess 16

createQueue. 16

getQueueList 17

getQueue. 17

holdQueue. 18

releaseQueue. 18

lockQueue. 19

unlockQueue. 19

removeQueue. 20

createGlobalResource. 20

setGlobalResource. 21

getGlobalRsrcList 21

getGblRsrcQuota. 21

getGblRsrcUsage. 22

removeGlobalResource. 22

createLocalResource. 23

getLocalRsrcList 23

getLclRsrcQuota. 24

getLclRsrcUsage. 24

removeLocalResource. 25

createRsrcPool 26

setRsrcPool 26

getLocalPoolList 27

getGlobalPoolList 27

getResourcePool 28

removeResourcePool 28

createNodeClass 29

getNodeClassList 29

getNodeClass 30

removeNodeClass 30

getNode. 31

holdNode. 31

releaseNode. 32

getProcessTypeList 32

createProcessType. 32

getProcessType. 33

removeProcessType. 33

setTimeOut 34

6     FBSJobDesc Class 35

6.1     Methods 35

Constructor 35

getSection. 35

addSection. 36

hasSection. 36

sections 37

validateDependencies 37

__repr__. 37

7     FBSSectionDesc Class 39

7.1     Data Members 39

7.2     Methods 40

Constructor 40

clone. 41

__repr__. 42

8     FBSJobInfo Class 43

8.1     Data Members 43

8.2     Methods 43

sections 43

getSection. 43

kill 44

refresh. 44

9     FBSSectionInfo Class 46

9.1     Data Members 46

9.2     Methods 47

getProcess 47

isHeld. 47

hold. 48

release. 48

incPrio. 49

kill 49

refresh. 50

10      FBSProcessInfo Class 51

10.1      Data Members 51

10.2      Methods 52

refresh. 52

11      FBSSubProcessInfo Class 53

11.1      Data Members 53

12      FBSNodeClassInfo Class 53

12.1      Data Members 53

12.2      Methods 54

refresh. 54

setRsrcCap. 54

setLocalDisks 55

addNode. 55

removeNode. 56

13      FBSNodeInfo Class 57

13.1      Data Members 57

13.2      Methods 57

refresh. 57

14      FBSQueueInfo Class 59

14.1      Data Members 59

14.2      Methods 59

hold. 59

release. 60

lock 60

unlock 61

update. 61

refresh. 62

15      FBSProcTypeInfo Class 64

15.1      Data Members 64

15.2      Methods 65

setSectRsrcDefs 65

setProcRsrcDefs 65

setRsrcQuota. 66

setMaxPrioInc. 66

setMaxNodeCount 66</