Whamcloud - gitweb
LU-930 doc: fix format man page sections for lctl
[fs/lustre-release.git] / lustre / doc / lctl-llog_cancel.8
1 .TH LCTL-LLOG_CANCEL 8 "2020-06-12" Lustre "configuration utilities"
2 .SH NAME
3 lctl-llog_cancel \- cancel a record in a Lustre log file
4 .SH SYNOPSIS
5 .B lctl
6 .B llog_cancel --log_idx
7 .RI < index >
8 .RI < logname >
9
10 .SH DESCRIPTION
11 .B lctl llog_cancel
12 is used to cancel the configuration record given by
13 .I index
14 from the
15 .I logname
16 configuration log, typically on the MGS.  This is useful if a persistent
17 configuration record was set incorrectly or is no longer needed.  Note
18 that cancelling a record does not "undo" any effect it had on currently
19 mounted clients, it only prevents the record from being seen in the future.
20 See
21 .BR lctl-llog_catlist (8)
22 for a list of configuration logs.
23 .SH OPTIONS
24 .TP
25 .B --log_idx
26 .I index
27 The record
28 .I index
29 number to cancel, as printed by
30 .B lctl llog_print
31 for that log.
32 .TP
33 .SH EXAMPLES
34 .TP
35 To cancel record 15 from the \fBtestfs-client\fR conf_param log:
36 .br
37 # lctl llog_cancel --log_idx=15 testfs-client
38 .TP
39 To cancel record 22 from the \fBparams\fR set_param log:
40 .br
41 # lctl llog_cancel --log_idx=22 params
42 .SH AVAILABILITY
43 .B lctl llog_cancel
44 is a subcommand of
45 .BR lctl (8)
46 and is distributed as part of the
47 .BR lustre (7)
48 filesystem package.
49 .SH SEE ALSO
50 .BR lctl (8),
51 .BR lctl-llog_info (8),
52 .BR lctl-llog_catlist (8),
53 .BR lctl-llog_print (8)