dpm_getpools man page

DPM_GETPOOLS(3)              DPM Library Functions             DPM_GETPOOLS(3)

[1mNAME[0m
      dpm_getpools - get list of pools

[1mSYNOPSIS[0m
      [1m#include <sys/types.h>[0m
      [1m#include "dpm_api.h"[0m

      [1mint dpm_getpools (int *[4m[22mnbpools[24m[1m, struct dpm_pool **[4m[22mdpm_pools[24m[1m)[0m

[1mDESCRIPTION[0m
      [1mdpm_getpools [22mgets list of pools.

      The output arguments are:

      [4mnbpools[0m
             will be set to the number of replies in the array of pools.

      [4mdpm_pools[0m
             will  be  set  to the address of an array of dpm_pool structures
             allocated by the API. The client application is responsible  for
             freeing  the  array when not needed anymore. This is also neces-
             sary for the gids entry of each dpm_pool.

      struct dpm_pool {
           char      poolname[CA_MAXPOOLNAMELEN+1];
           u_signed64     defsize;
           int       gc_start_thresh;
           int       gc_stop_thresh;
           int       def_lifetime;
           int       defpintime;
           int       max_lifetime;
           int       maxpintime;
           char      fss_policy[CA_MAXPOLICYLEN+1];
           char      gc_policy[CA_MAXPOLICYLEN+1];
           char      mig_policy[CA_MAXPOLICYLEN+1];
           char      rs_policy[CA_MAXPOLICYLEN+1];
           int       nbgids
           gid_t          *gids;         /* restrict the pool to given group(s) */
           char      ret_policy;    /* retention policy: 'R', 'O' or 'C' */
           char      s_type;        /* space type: 'V', 'D' or 'P' */
           u_signed64     capacity;
           u_signed64     free;
           struct dpm_fs  *elemp;
           int       nbelem;
           int       next_elem;     /* next pool element to be used */
      };

[1mRETURN VALUE[0m
      This routine returns 0 if the operation was successful  or  -1  if  the
      operation failed. In the latter case, [1mserrno [22mis set appropriately.

[1mERRORS[0m
      [1mEFAULT       [4m[22mnbpools[24m or [4mdpm_pools[24m is a NULL pointer.

      [1mENOMEM       [22mMemory could not be allocated for storing the reply.

      [1mSENOSHOST    [22mHost unknown.

      [1mSECOMERR     [22mCommunication error.

LCG                      $Date: 2007/04/30 06:39:28 $          DPM_GETPOOLS(3)