Whamcloud - gitweb
LU-10918 llite: Rule based auto PCC caching when create files
[fs/lustre-release.git] / lustre / doc / lctl-pcc.8
1 .TH lctl-pcc 8 2019-04-15 "Lustre" "configuration Utilities"
2 .SH NAME
3 lctl pcc commands used to interact with PCC features.
4 .SH SYNOPSIS
5 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
6 .br
7 .B lctl pcc del <\fImntpath\fR> <\fIpccpath\fR>
8 .br
9 .B lctl pcc clear <\fImntpath\fR>
10 .br
11 .B lctl pcc list <\fImntpath\fR>
12 .SH DESCRIPTION
13 .TP
14 .B lctl pcc add \fR<\fImntpath\fR> <\fIpccpath\fR> [\fB--param\fR|\fB-p\fR <\fIparam\fR>]
15 Add a PCC backend specified by HSM root path
16 .IR pccpath
17 on a Lustre filesystem client instances with the mount point referenced by
18 .IR mntpath .
19 The parameter
20 .IR param
21 is a string in the form of name-value pairs to config the PCC backend such as
22 read-write attach id (archive ID) or read-only attach id and auto caching rule.
23 i.e. for the string "projid={500}&fname={*.h5} rwid=2", the first substring of
24 the config parameter is the auto caching rule. Where "&" represents the logical
25 conjunction operator while "," represents the logical disjunction operator. The
26 example rule means that new files are only auto cached if the project ID is 500
27 and the suffix of the file name is "h5". "rwid" represents the read-write
28 attach id (2) which value is same as the archive ID of the copytool agent
29 running on this PCC node.
30 .TP
31 .B lctl pcc del <\fImntpath\fR> <\fIpccpath\fR>
32 Delete a PCC backend specified by path
33 .IR pccpath
34 on a Lustre client referenced by the mount point of
35 .IR mntpath .
36 .TP
37 .B lctl pcc clear <\fImntpath\fR>
38 Remove all PCC backend on a Lustre client referenced by the mount point of
39 .IR mntpath .
40 .TP
41 .B lctl pcc list <\fImntpath\fR>
42 List all PCC backends on a Lustre client referenced by the mount point of
43 .IR mntpath .
44 .SH OPTIONS
45 .TP
46 .B --param | -p
47 Specifies the configuration parameters for a PCC backend.
48 .TP
49 .SH SEE ALSO
50 .BR lfs (1),
51 .BR lfs-hsm (1),
52 .BR lfs-pcc (1)