1DPM_GETPOOLS(3)              DPM Library Functions             DPM_GETPOOLS(3)
2
3
4

NAME

6       dpm_getpools - get list of pools
7

SYNOPSIS

9       #include <sys/types.h>
10       #include "dpm_api.h"
11
12       int dpm_getpools (int *nbpools, struct dpm_pool **dpm_pools)
13

DESCRIPTION

15       dpm_getpools gets list of pools.
16
17       The output arguments are:
18
19       nbpools
20              will be set to the number of replies in the array of pools.
21
22       dpm_pools
23              will  be  set  to the address of an array of dpm_pool structures
24              allocated by the API. The client application is responsible  for
25              freeing  the  array when not needed anymore. This is also neces‐
26              sary for the gids entry of each dpm_pool.
27
28       struct dpm_pool {
29            char      poolname[CA_MAXPOOLNAMELEN+1];
30            u_signed64     defsize;
31            int       gc_start_thresh;
32            int       gc_stop_thresh;
33            int       def_lifetime;
34            int       defpintime;
35            int       max_lifetime;
36            int       maxpintime;
37            char      fss_policy[CA_MAXPOLICYLEN+1];
38            char      gc_policy[CA_MAXPOLICYLEN+1];
39            char      mig_policy[CA_MAXPOLICYLEN+1];
40            char      rs_policy[CA_MAXPOLICYLEN+1];
41            int       nbgids
42            gid_t          *gids;         /* restrict the pool to given group(s) */
43            char      ret_policy;    /* retention policy: 'R', 'O' or 'C' */
44            char      s_type;        /* space type: 'V', 'D' or 'P' */
45            u_signed64     capacity;
46            u_signed64     free;
47            struct dpm_fs  *elemp;
48            int       nbelem;
49            int       next_elem;     /* next pool element to be used */
50       };
51

RETURN VALUE

53       This routine returns 0 if the operation was successful  or  -1  if  the
54       operation failed. In the latter case, serrno is set appropriately.
55

ERRORS

57       EFAULT       nbpools or dpm_pools is a NULL pointer.
58
59       ENOMEM       Memory could not be allocated for storing the reply.
60
61       SENOSHOST    Host unknown.
62
63       SECOMERR     Communication error.
64
65
66
67LCG                      $Date: 2007/04/30 06:39:28 $          DPM_GETPOOLS(3)
Impressum