Whamcloud - gitweb
dc8f6397fdfa5e736e25e5453c36de918ab8623c
[fs/lustre-release.git] / lustre / doc / lctl-set_param.8
1 .TH lctl 8 "2019 Jun 17" Lustre "configuration utilities"
2 .SH NAME
3 lctl set_param \- Low level Lustre filesystem configuration utility
4 .SH SYNOPSIS
5 .IR "\fBlctl set_param " [ -n "] [" -P "] [" -d "] <" parameter \B= value ...>
6 .br
7 .IR "\fBlctl set_param -F " < filename >
8 .SH DESCRIPTION
9 Set the value of the named Lustre or LNet
10 .I parameter
11 to
12 .I value
13 on the local node.  Parameter names consist of one or more components,
14 separated by a '.' (period).  Each component may be specified by plain text
15 or by a wildcard in the
16 .BR glob (7)
17 format.  When wildcards are used, more than one parameter may match and
18 be changed.  Parameters are often, but not always, of the form
19 .IR obd_name.obd_instance.parameter_name ,
20 where
21 .I obd_name
22 is one of the OBD object types, like
23 .BR ldlm ", " llite ", " lmv ", " lov ", " mdc ", " osc ,
24 etc., and
25 .I obd_instance
26 is the name of a Lustre device, like
27 .BR testfs-OST0000 ,
28 but may be a specific component, or contain wildcards to match some or all
29 devices on the node.  Parameters can only be modified by the root user for
30 security reasons.
31 .TP
32 .B -d
33 Remove the permanent setting (only for parameters set with the
34 .B -P
35 option).
36 .TP
37 .B -F
38 Set parameters from
39 .I filename
40 instead of from the command-line.  The contents of
41 .I filename
42 is YAML format, created as an output from
43 .BR "lctl --device MGS llog_print " < \fIfsname >- client
44 fR or any other valid llog configuration log as listed by
45 .B lctl --device MGS llog_catlist
46 .TP
47 .B -n
48 Disable printing of the parameter name after setting it.
49 .TP
50 .B -P
51 Set
52 .I parameter
53 permanently on
54 .B all
55 nodes connected to the MGS on which the command is run.  To limit wildcard
56 .I parameter
57 matching to specific filesystems or parameters, ensure that
58 .I parameter
59 contains a suitably-specific expression for the
60 .I obd_name
61 and
62 .IR obd_instance ,
63 such as the filesystem and/or target name.  This option is only available
64 in Lustre 2.5.0 and later clients, older clients cannot set persistent
65 parameters, nor will they see them.
66 .SH EXAMPLES
67 .B # lctl set_param fail_loc=0 timeout=20
68 .br
69 fail_loc=0
70 .br
71 timeout=20
72 .br
73 .B # lctl set_param -n fail_loc=0 timeout=20
74 .br
75 0
76 .br
77 20
78 .br
79 .B # lctl set_param -P osc.testfs-OST*.max_dirty_mb=512
80 .br
81 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_dirty_mb=512
82 .br
83 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_dirty_mb=512
84 .br
85 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_dirty_mb=512
86 .br
87 osc.testfs-OST0003-osc-ffff8803c9c0f000.max_dirty_mb=512
88 .br
89 osc.testfs-OST0004-osc-ffff8803c9c0f000.max_dirty_mb=512
90 .br
91 .SH SEE ALSO
92 .BR lustre (7),
93 .BR lctl (8),
94 .BR lctl-get_param (8),
95 .BR lctl-list_param (8),
96 .BR lctl-llog_catlist (8),
97 .BR lctl-llog_print (8)