lustre/doc/llapi_pccdev_set.3

   1 .TH llapi_pccdev_set 3 "2019 April 20" "Lustre User API"
   2 .SH NAME
   3 llapi_pccdev_set \- Add/delete a PCC backend on a client
   4 .SH SYNOPSIS
   5 .nf
   6 .B #include <lustre/lustreapi.h>
   7 .PP
   8 .BI "int llapi_pccdev_set(const char *" path ", const char *" cmd ");"
   9 .fi
  10 .SH DESCRIPTION
  11 .PP
  12 The function
  13 .BR llapi_pccdev_set()
  14 adds or deletes a PCC backend on the client with the mount point referenced by
  15 .IR path .
  16 The input argument
  17 .IR cmd
  18 could be in the following forms:
  19 .TP
  20 .B \ "add\ $PCCPATH\ $PARAM"
  21 Add a PCC backend referenced by the HSM root path
  22 .IR $PCCPATH .
  23 .TP
  24 .B \ "del\ $PCCPATH"
  25 Delete a PCC backend referenced by the HSM root path
  26 .IR $PCCPATH .
  27 .TP
  28 .B \ "clear"
  29 Clear and remove all PCC backends on a client.
  30 .SH RETURN VALUES
  31 .PP
  32 .B llapi_pccdev_set()
  33 return 0 on success or a negative errno value on failure.
  34 .SH ERRORS
  35 .TP 15
  36 .SM -ENOMEM
  37 Insufficient memory to complete operation.
  38 .TP
  39 .SM -EFAULT
  40 Memory region is not properly mapped.
  41 .TP
  42 .SM -EINVAL
  43 One or more invalid arguments are given.
  44 .TP
  45 .SM -EOPNOTSUPP
  46 PCC backend operation is not supported.
  47 .SH "SEE ALSO"
  48 .BR lustreapi (7)