Whamcloud - gitweb
59449ed6797eb4a1cd7e3ad4ee8ab87cf1688fd5
[fs/lustre-release.git] / lustre / doc / lctl-get_param.8
1 .TH lctl 8 "2019 Jun 17" Lustre "configuration utilities"
2 .SH NAME
3 lctl get_param \- retrieve tunable parameters
4 .SH SYNOPSIS
5 .br
6 .IR "\fBlctl get_param " [ -F "] [" -n | -N "] [" -R "] <" parameter ...>
7 .br
8 .SH DESCRIPTION
9 Get the value of the named Lustre or LNet
10 .I parameter
11 on the local node.  Parameter names consist of one or more components,
12 separated by a '.' (period).  Each component may be specified by plain text
13 or by a wildcard in the
14 .BR glob (7)
15 format.  When wildcards are used, more than one parameter may match and
16 be returned.  Parameters are often, but not always, of the form
17 .IR obd_name.obd_instance.parameter_name ,
18 where
19 .I obd_name
20 is one of the OBD object types, like
21 .BR ldlm ", " llite ", " lmv ", " lov ", " mdc ", " osc ,
22 etc., and
23 .I obd_instance
24 is the name of a Lustre device, like
25 .BR testfs-OST0000 ,
26 but may be a specific component, or contain wildcards to match some or all
27 devices on the node.  Many parameters are readable as a regular user, though
28 some of them are accessible only by the root user for security or
29 implementation reasons.
30 .SH OPTIONS
31 .TP
32 .B -F
33 Append a '/', '@', or '=' suffix for directories, symlinks, and writeable
34 parameters, respectively.
35 .B "lctl get_param -NF"
36 is equivalent to
37 .BR "lctl list_param -F" .
38 .TP
39 .B -n
40 Print only the parameter value and not parameter name.  This may be confusing
41 if multiple parameter names are specified, as the parameters are not
42 identified, and may not be returned in the order that they are specified.
43 .TP
44 .B -N
45 Print only matched parameter names and not the values. This is especially
46 useful when using patterns.
47 .TP
48 .B -R
49 Recursively show all of the parameter names below the specified name.
50 .SH EXAMPLES
51 .B $ lctl get_param osc.*.max_pages_per_rpc
52 .br
53 osc.myth-OST0000-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
54 .br
55 osc.myth-OST0001-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
56 .br
57 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
58 .br
59 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
60 .br
61 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
62 .br
63 .B $ lctl get_param -n debug
64 .br
65 super warning dlmtrace error emerg rpctrace vfstrace config console
66 .br
67 .B $ lctl get_param {mdc,osc}.testfs-*.max_rpcs_in_flight
68 .br
69 mdc.testfs-MDT0000-mdc-ffff8803c9c0f000.max_rpcs_in_flight=16
70 .br
71 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
72 .br
73 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
74 .br
75 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
76 .SH SEE ALSO
77 .BR lustre (7),
78 .BR lctl (8),
79 .BR lctl-set_param (8)