Whamcloud - gitweb
LU-16901 utils: l_getidentity with nss module support
[fs/lustre-release.git] / lustre / doc / lctl-set_param.8
1 .TH LCTL-SET_PARAM 8 "2019-05-10" Lustre "configuration utilities"
2 .SH NAME
3 lctl-set_param \- Lustre filesystem set parameter utility
4 .SH SYNOPSIS
5 .B "\fBlctl set_param "
6 .RB [ \-d ]
7 .RB [ \-h ]
8 .RB [ \-n ]
9 .RB [ \-P ]
10 .RB [ \-t [ \fITHREAD_COUNT ]]
11 .RI < parameter \= value ...>
12 .br
13 .IR "\fBlctl set_param -F " < filename >
14 .SH DESCRIPTION
15 Set the value of the named Lustre or LNet
16 .I parameter
17 to
18 .I value
19 on the local node.  Parameter names consist of one or more components,
20 separated by a '.' (period).  Each component may be specified by plain text
21 or by a wildcard in the
22 .BR glob (7)
23 format.  When wildcards are used, more than one parameter may match and
24 be changed.  Parameters are often, but not always, of the form
25 .IR obd_name.obd_instance.parameter_name ,
26 where
27 .I obd_name
28 is one of the OBD object types, like
29 .BR ldlm ", " llite ", " lmv ", " lov ", " mdc ", " osc ,
30 etc., and
31 .I obd_instance
32 is the name of a Lustre device, like
33 .BR testfs-OST0000 ,
34 but may be a specific component, or contain wildcards to match some or all
35 devices on the node.  Parameters can only be modified by the root user for
36 security reasons.
37 .TP
38 .B -d
39 Remove the permanent setting (only for parameters set with the
40 .B -P
41 option).
42 .TP
43 .B -F
44 Set parameters from
45 .I filename
46 instead of from the command-line.  The contents of
47 .I filename
48 is YAML format, created as an output from
49 .BR  ' "lctl --device MGS llog_print " < \fIfsname\fR >- client '
50 or any other valid llog configuration log as listed by
51 .RB ' "lctl --device MGS llog_catlist" '
52 .TP
53 .B -n
54 Disable printing of the parameter name after setting it.
55 .TP
56 .B -P
57 Set
58 .I parameter
59 permanently on
60 .B all
61 nodes connected to the MGS on which the command is run.  To limit wildcard
62 .I parameter
63 matching to specific filesystems or parameters, ensure that
64 .I parameter
65 contains a suitably-specific expression for the
66 .I obd_name
67 and
68 .IR obd_instance ,
69 such as the filesystem and/or target name.  This option is only available
70 in Lustre 2.5.0 and later clients, older clients cannot set persistent
71 parameters, nor will they see them.
72 .TP
73 .B -t
74 Spawn threads to set multiple parameters in parallel, optionally specifying
75 the maximum number of threads to run (with no space between
76 .B -t
77 and
78 .IR THREAD_COUNT ).
79 Without this option parameter(s) are set serially.
80 If
81 .B lctl
82 was compiled without pthread support, a warning message will be
83 printed and parameters will be set serially.  If
84 .B -t
85 is specified without any argument, it runs up to 8 threads by default.
86 .SH EXAMPLES
87 .B # lctl set_param fail_loc=0 timeout=20
88 .br
89 fail_loc=0
90 .br
91 timeout=20
92 .br
93 .B # lctl set_param -n fail_loc=0 timeout=20
94 .br
95 0
96 .br
97 20
98 .br
99 .B
100 # lctl set_param -t2 "ldlm.namespaces.*osc*.lru_size=clear"
101 .br
102 ldlm.namespaces.fsname-OST0001-osc-MDT0000.lru_size=clear
103 .br
104 ldlm.namespaces.fsname-OST0000-osc-MDT0000.lru_size=clear
105 .br
106 .B # lctl set_param -P osc.testfs-OST*.max_dirty_mb=512
107 .br
108 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_dirty_mb=512
109 .br
110 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_dirty_mb=512
111 .br
112 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_dirty_mb=512
113 .br
114 osc.testfs-OST0003-osc-ffff8803c9c0f000.max_dirty_mb=512
115 .br
116 osc.testfs-OST0004-osc-ffff8803c9c0f000.max_dirty_mb=512
117 .br
118 .SH SEE ALSO
119 .BR lustre (7),
120 .BR lctl (8),
121 .BR lctl-get_param (8),
122 .BR lctl-list_param (8),
123 .BR lctl-llog_catlist (8),
124 .BR lctl-llog_print (8)