.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CRM_REPORT "8" "January 2024" "crm_report 2.1.6-6fdc9deea29" "System Administration Utilities"
.SH NAME
crm_report \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
.B crm_report
[\fI\,options\/\fR] [\fI\,DEST\/\fR]
.SH DESCRIPTION
crm_report \- Create archive of everything needed when reporting cluster problems
.SS "Required option:"
.TP
\fB\-f\fR, \fB\-\-from\fR TIME
time prior to problems beginning
(as "YYYY\-M\-D H:M:S" including the quotes)
.SH OPTIONS
.TP
\fB\-V\fR
increase verbosity (may be specified multiple times)
.TP
\fB\-h\fR, \fB\-\-help\fR
display this message
.TP
\fB\-v\fR, \fB\-\-version\fR
display software version
.TP
\fB\-\-features\fR
display software features
.TP
\fB\-t\fR, \fB\-\-to\fR TIME
time at which all problems were resolved
(as "YYYY\-M\-D H:M:S" including the quotes; default "now")
.TP
\fB\-T\fR, \fB\-\-cts\fR TEST
CTS test or set of tests to extract
.TP
\fB\-\-cts\-log\fR
CTS master logfile
.TP
\fB\-n\fR, \fB\-\-nodes\fR NODES
node names for this cluster (only needed if cluster is
not active on this host; accepts \fB\-n\fR "a b" or \fB\-n\fR a \fB\-n\fR b)
.TP
\fB\-M\fR
do not search for cluster logs
.TP
\fB\-l\fR, \fB\-\-logfile\fR FILE
log file to collect (in addition to detected logs if \fB\-M\fR
is not specified; may be specified multiple times)
.TP
\fB\-p\fR PATT
additional regular expression to match variables to be
masked in output (default: "passw.*")
.TP
\fB\-L\fR PATT
additional regular expression to match in log files for
analysis (default: CRIT: ERROR:)
.TP
\fB\-S\fR, \fB\-\-single\-node\fR
don't attempt to collect data from other nodes
.TP
\fB\-c\fR, \fB\-\-cluster\fR TYPE
force the cluster type instead of detecting
(currently only corosync is supported)
.TP
\fB\-C\fR, \fB\-\-corosync\fR
force the cluster type to be corosync
.TP
\fB\-u\fR, \fB\-\-user\fR USER
username to use when collecting data from other nodes
(default root)
.TP
\fB\-D\fR, \fB\-\-max\-depth\fR
search depth to use when attempting to locate files
.TP
\fB\-e\fR, \fB\-\-rsh\fR
command to use to run commands on other nodes
(default ssh \fB\-T\fR)
.TP
\fB\-d\fR, \fB\-\-as\-directory\fR
leave result as a directory tree instead of archiving
.TP
\fB\-\-sos\-mode\fR
use defaults suitable for being called by sosreport tool
(behavior subject to change and not useful to end users)
.TP
DEST, \fB\-\-dest\fR DEST
custom destination directory or file name
.PP
crm_report works best when run from a cluster node on a running cluster,
but can be run from a stopped cluster node or a Pacemaker Remote node.
.PP
If neither \fB\-\-nodes\fR nor \fB\-\-single\-node\fR is given, crm_report will guess the
node list, but may have trouble detecting Pacemaker Remote nodes.
Unless \fB\-\-single\-node\fR is given, the node names (whether specified by \fB\-\-nodes\fR
or detected automatically) must be resolvable and reachable via the command
specified by \fB\-e\fR/\-\-rsh using the user specified by \fB\-u\fR/\-\-user.
.SH EXAMPLES
.IP
crm_report \-f "2011\-12\-14 13:05:00" unexplained\-apache\-failure
crm_report \-f 2011\-12\-14 \-t 2011\-12\-15 something\-that\-took\-multiple\-days
crm_report \-f 13:05:00   \-t 13:12:00   brief\-outage