.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PACEMAKER "8" "March 2024" "Pacemaker 2.1.7" "System Administration Utilities"
.SH NAME
Pacemaker \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
crm_mon [options]
.SH DESCRIPTION
Provides a summary of cluster's current state.
.PP
Outputs varying levels of detail in a number of different formats.
.SH OPTIONS
.SS "Help Options:"
.TP
\-?, \fB\-\-help\fR
Show help options
.TP
\fB\-\-help\-all\fR
Show all help options
.TP
\fB\-\-help\-output\fR
Show output help
.TP
\fB\-\-help\-display\fR
Show display options
.TP
\fB\-\-help\-additional\fR
Show additional options
.TP
\fB\-\-help\-deprecated\fR
Show deprecated options
.SS "Output Options:"
.TP
\fB\-\-output\-as\fR=\fI\,FORMAT\/\fR
Specify output format as one of: console (default), html, text, xml, none
.TP
\fB\-\-output\-to\fR=\fI\,DEST\/\fR
Specify file name for output (or "\-" for stdout)
.TP
\fB\-\-html\-cgi\fR
Add CGI headers (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-html\-stylesheet\fR=\fI\,URI\/\fR
Link to an external stylesheet (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-html\-title\fR=\fI\,TITLE\/\fR
Specify a page title (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-text\-fancy\fR
Use more highly formatted output (requires \fB\-\-output\-as\fR=\fI\,text\/\fR)
.SS "Display Options:"
.TP
\fB\-I\fR, \fB\-\-include\fR=\fI\,SECTION\/\fR(s)
A list of sections to include in the output.
See `Output Control` help for more information.
.TP
\fB\-U\fR, \fB\-\-exclude\fR=\fI\,SECTION\/\fR(s)
A list of sections to exclude from the output.
See `Output Control` help for more information.
.TP
\fB\-\-node\fR=\fI\,NODE\/\fR
When displaying information about nodes, show only what's related to the given
node, or to all nodes tagged with the given tag
.TP
\fB\-\-resource\fR=\fI\,RSC\/\fR
When displaying information about resources, show only what's related to the given
resource, or to all resources tagged with the given tag
.TP
\fB\-n\fR, \fB\-\-group\-by\-node\fR
Group resources by node
.TP
\fB\-r\fR, \fB\-\-inactive\fR
Display inactive resources
.TP
\fB\-f\fR, \fB\-\-failcounts\fR
Display resource fail counts
.TP
\fB\-o\fR, \fB\-\-operations\fR
Display resource operation history
.TP
\fB\-t\fR, \fB\-\-timing\-details\fR
Display resource operation history with timing details
.TP
\fB\-c\fR, \fB\-\-tickets\fR
Display cluster tickets
.TP
\fB\-m\fR, \fB\-\-fence\-history\fR=\fI\,LEVEL\/\fR
Show fence history:
0=off, 1=failures and pending (default without option),
2=add successes (default without value for option),
3=show full history without reduction to most recent of each flavor
.TP
\fB\-L\fR, \fB\-\-neg\-locations\fR
Display negative location constraints [optionally filtered by id prefix]
.TP
\fB\-A\fR, \fB\-\-show\-node\-attributes\fR
Display node attributes
.TP
\fB\-D\fR, \fB\-\-hide\-headers\fR
Hide all headers
.TP
\fB\-R\fR, \fB\-\-show\-detail\fR
Show more details (node IDs, individual clone instances)
.TP
\fB\-\-show\-description\fR
Show resource descriptions
.TP
\fB\-b\fR, \fB\-\-brief\fR
Brief output
.SS "Additional Options:"
.TP
\fB\-i\fR, \fB\-\-interval\fR=\fI\,TIMESPEC\/\fR
Update frequency (default is 5 seconds)
.TP
\fB\-1\fR, \fB\-\-one\-shot\fR
Display the cluster status once and exit
.TP
\fB\-d\fR, \fB\-\-daemonize\fR
Run in the background as a daemon.
Requires at least one of \fB\-\-output\-to\fR and \fB\-\-external\-agent\fR.
.TP
\fB\-p\fR, \fB\-\-pid\-file\fR=\fI\,FILE\/\fR
(Advanced) Daemon pid file location
.TP
\fB\-E\fR, \fB\-\-external\-agent\fR=\fI\,FILE\/\fR
A program to run when resource operations take place
.TP
\fB\-e\fR, \fB\-\-external\-recipient\fR=\fI\,RCPT\/\fR
A recipient for your program (assuming you want the program to send something to someone).
.TP
\fB\-W\fR, \fB\-\-watch\-fencing\fR
Listen for fencing events. For use with \fB\-\-external\-agent\fR.
.SS "Deprecated Options:"
.TP
\fB\-h\fR, \fB\-\-as\-html\fR=\fI\,FILE\/\fR
Write cluster status to the named HTML file.
Use \fB\-\-output\-as\fR=\fI\,html\/\fR \fB\-\-output\-to\fR=\fI\,FILE\/\fR instead.
.TP
\fB\-X\fR, \fB\-\-as\-xml\fR
Write cluster status as XML to stdout. This will enable one\-shot mode.
Use \fB\-\-output\-as\fR=\fI\,xml\/\fR instead.
.TP
\fB\-s\fR, \fB\-\-simple\-status\fR
Display the cluster status once as a simple one line output
(suitable for nagios)
.TP
\fB\-N\fR, \fB\-\-disable\-ncurses\fR
Disable the use of ncurses.
Use \fB\-\-output\-as\fR=\fI\,text\/\fR instead.
.TP
\fB\-w\fR, \fB\-\-web\-cgi\fR
Web mode with output suitable for CGI (preselected when run as *.cgi).
Use \fB\-\-output\-as\fR=\fI\,html\/\fR \fB\-\-html\-cgi\fR instead.
.SS "Application Options:"
.TP
\-$, \fB\-\-version\fR
Display software version and exit
.TP
\fB\-V\fR, \fB\-\-verbose\fR
Increase debug output (may be specified multiple times)
.TP
\fB\-Q\fR, \fB\-\-quiet\fR
Be less descriptive in output.
.SH NOTES
If this program is called as crm_mon.cgi, \fB\-\-output\-as\fR=\fI\,html\/\fR and
\fB\-\-html\-cgi\fR are automatically added to the command line
arguments.
.PP
Time Specification:
.PP
The TIMESPEC in any command line option can be specified in many
different formats. It can be an integer number of seconds, a
number plus units (us/usec/ms/msec/s/sec/m/min/h/hr), or an ISO
8601 period specification.
.SH OUTPUT CONTROL
By default, a particular set of sections are written to the
output destination. The default varies based on the output
format: XML includes all sections by default, while other output
formats include less. This set can be modified with the \fB\-\-include\fR
and \fB\-\-exclude\fR command line options. Each option may be passed
multiple times, and each can specify a comma\-separated list of
sections. The options are applied to the default set, in order
from left to right as they are passed on the command line. For a
list of valid sections, pass \fB\-\-include\fR=\fI\,list\/\fR or \fB\-\-exclude\fR=\fI\,list\/\fR.
.SH INTERACTIVE USE
When run interactively, crm_mon can be told to hide and show
various sections of output. To see a help screen explaining the
options, press '?'. Any key stroke aside from those listed will
cause the screen to refresh.
.SH EXAMPLES
Display the cluster status on the console with updates as they
occur:
.IP
crm_mon
.PP
Display the cluster status once and exit:
.IP
crm_mon \-1
.PP
Display the cluster status, group resources by node, and include
inactive resources in the list:
.IP
crm_mon \-\-group\-by\-node \-\-inactive
.PP
Start crm_mon as a background daemon and have it write the
cluster status to an HTML file:
.IP
crm_mon \-\-daemonize \-\-output\-as html \-\-output\-to /path/to/docroot/filename.html
.PP
Display the cluster status as XML:
.IP
crm_mon \-\-output\-as xml
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors