1DPM_GETPOOLS(3)                   DPM      Library      Functions
2DPM_GETPOOLS(3)
3
4
5
6[1mNAME[0m
7       dpm_getpools ‐ get list of pools
8
9[1mSYNOPSIS[0m
10       [1m#include <sys/types.h>[0m
11       [1m#include "dpm_api.h"[0m
12
13       [1mint dpm_getpools  (int  *[4m[22mnbpools[24m[1m,  struct
14dpm_pool **[4m[22mdpm_pools[24m[1m)[0m
15
16[1mDESCRIPTION[0m
17       [1mdpm_getpools [22mgets list of pools.
18
19       The output arguments are:
20
21       [4mnbpools[0m
22              will  be  set to the number of replies in the array
23of pools.
24
25       [4mdpm_pools[0m
26              will  be  set   to  the  address  of  an  array  of
27dpm_pool structures
28              allocated by the API. The client application is re‐
29sponsible  for
30              freeing  the  array when not needed  anymore.  This
31is also neces‐
32              sary for the gids entry of each dpm_pool.
33
34       struct dpm_pool {
35            char      poolname[CA_MAXPOOLNAMELEN+1];
36            u_signed64     defsize;
37            int       gc_start_thresh;
38            int       gc_stop_thresh;
39            int       def_lifetime;
40            int       defpintime;
41            int       max_lifetime;
42            int       maxpintime;
43            char      fss_policy[CA_MAXPOLICYLEN+1];
44            char      gc_policy[CA_MAXPOLICYLEN+1];
45            char      mig_policy[CA_MAXPOLICYLEN+1];
46            char      rs_policy[CA_MAXPOLICYLEN+1];
47            int       nbgids
48            gid_t          *gids;         /* restrict the pool to
49given group(s) */
50            char      ret_policy;    /*  retention  policy:  ’R’,
51’O’ or ’C’ */
52            char       s_type;         /* space type: ’V’, ’D’ or
53’P’ */
54            u_signed64     capacity;
55            u_signed64     free;
56            struct dpm_fs  *elemp;
57            int       nbelem;
58            int       next_elem;     /* next pool element  to  be
59used */
60       };
61
62[1mRETURN VALUE[0m
63       This routine returns 0 if the operation was successful  or
64‐1  if  the
65       operation failed. In the latter case, [1mserrno [22mis set
66appropriately.
67
68[1mERRORS[0m
69       [1mEFAULT        [4m[22mnbpools[24m or [4mdpm_pools[24m is
70a NULL pointer.
71
72       [1mENOMEM       [22mMemory  could  not  be  allocated  for
73storing the reply.
74
75       [1mSENOSHOST    [22mHost unknown.
76
77       [1mSECOMERR     [22mCommunication error.
78
79
80
81LCG                         $Date:    2007/04/30    06:39:28    $
82DPM_GETPOOLS(3)
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132