lustre/doc/llapi_pccdev_get.3

   1 .TH llapi_pccdev_get 3 "2019 April 20" "Lustre User API"
   2 .SH NAME
   3 llapi_pccdev_get \- List all PCC backends on a client
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_pccdev_get(const char *" path ");"
   9 .fi
  10 .SH DESCRIPTION
  11 .PP
  12 The function
  13 .BR llapi_pccdev_get()
  14 lists all PCC backends on the client with the mount point referenced by
  15 .IR path ,
  16 and output the results to stdout in YAML format.
  17 .SH RETURN VALUES
  18 .PP
  19 .B llapi_pccdev_get()
  20 return 0 on success or a negative errno value on failure.
  21 .SH ERRORS
  22 .TP 15
  23 .SM -ENOMEM
  24 Insufficient memory to complete operation.
  25 .TP
  26 .SM -EFAULT
  27 Memory region is not properly mapped.
  28 .TP
  29 .SM -EINVAL
  30 One or more invalid arguments are given.
  31 .TP
  32 .SM -EOPNOTSUPP
  33 PCC backend operation is not supported.
  34 .SH "SEE ALSO"
  35 .BR llapi_pccdev_set (3)
  36 .BR lustreapi (7)