lustre/doc/lctl-get_param.8

   1 .TH LCTL-GET_PARAM 8 "2019-06-17" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl-get_param \- retrieve configuration parameters
   4 .SH SYNOPSIS
   5 .br
   6 .IR "\fBlctl get_param " [ -F "] [" -H "] [" -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 -H
  40 Prefix each parameter value line with the parameter name, as a header. It
  41 also print a line for empty values. It could be useful when wildcards are
  42 used and filtering the output.
  43 .TP
  44 .B -n
  45 Print only the parameter value and not parameter name.  This may be confusing
  46 if multiple parameter names are specified, as the parameters are not
  47 identified, and may not be returned in the order that they are specified.
  48 .TP
  49 .B -N
  50 Print only matched parameter names and not the values. This is especially
  51 useful when using patterns.
  52 .TP
  53 .B -R
  54 Recursively show all of the parameter names below the specified name.
  55 .TP
  56 .B -y
  57 Some paramters can be presented in a YAML format but are not by default. This
  58 will format the parameter data in YAML. If the YAML provides a source: field
  59 it can be suppressed with the -n option.
  60
  61 .SH EXAMPLES
  62 .B $ lctl get_param osc.*.max_pages_per_rpc
  63 .br
  64 osc.myth-OST0000-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
  65 .br
  66 osc.myth-OST0001-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
  67 .br
  68 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
  69 .br
  70 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
  71 .br
  72 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_pages_per_rpc=1024
  73 .br
  74 .B $ lctl get_param -n debug
  75 .br
  76 super warning dlmtrace error emerg rpctrace vfstrace config console
  77 .br
  78 .B $ lctl get_param {mdc,osc}.testfs-*.max_rpcs_in_flight
  79 .br
  80 mdc.testfs-MDT0000-mdc-ffff8803c9c0f000.max_rpcs_in_flight=16
  81 .br
  82 osc.testfs-OST0000-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
  83 .br
  84 osc.testfs-OST0001-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
  85 .br
  86 osc.testfs-OST0002-osc-ffff8803c9c0f000.max_rpcs_in_flight=8
  87 .br
  88 .B $ lctl get_param -n devices
  89 .br
  90  0 UP osd-ldiskfs MGS-osd MGS-osd_UUID 4
  91 .br
  92 .B $ lctl get_param -y devices
  93 .br
  94 devices:
  95 .br
  96 - index: 0
  97 .br
  98   status: UP
  99 .br
 100   type: osd-ldiskfs
 101 .br
 102   name: MGS-osd
 103 .br
 104   uuid: MGS-osd_UUID
 105 .br
 106   refcount: 4
 107 .SH SEE ALSO
 108 .BR lustre (7),
 109 .BR lctl (8),
 110 .BR lctl-list_param (8),
 111 .BR lctl-set_param (8)