1PACEMAKER(8)            System Administration Utilities           PACEMAKER(8)
2
3
4

NAME

6       Pacemaker - Part of the Pacemaker cluster resource manager
7

SYNOPSIS

9       crm_mon [options]
10

DESCRIPTION

12       Provides a summary of cluster's current state.
13
14       Outputs varying levels of detail in a number of different formats.
15

OPTIONS

17   Help Options:
18       -?, --help
19              Show help options
20
21       --help-all
22              Show all help options
23
24       --help-output
25              Show output help
26
27       --help-display
28              Show display options
29
30       --help-additional
31              Show additional options
32
33       --help-deprecated
34              Show deprecated options
35
36   Output Options:
37       --output-as=FORMAT
38              Specify  output format as one of: console (default), html, text,
39              xml, none
40
41       --output-to=DEST
42              Specify file name for output (or "-" for stdout)
43
44       --html-cgi
45              Add CGI headers (requires --output-as=html)
46
47       --html-stylesheet=URI
48              Link to an external stylesheet (requires --output-as=html)
49
50       --html-title=TITLE
51              Specify a page title (requires --output-as=html)
52
53       --text-fancy
54              Use more highly formatted output (requires --output-as=text)
55
56   Display Options:
57       -I, --include=SECTION(s)
58              A list of sections to include in the output.  See  `Output  Con‐
59              trol` help for more information.
60
61       -U, --exclude=SECTION(s)
62              A list of sections to exclude from the output.  See `Output Con‐
63              trol` help for more information.
64
65       --node=NODE
66              When displaying information about nodes, show  only  what's  re‐
67              lated  to  the given node, or to all nodes tagged with the given
68              tag
69
70       --resource=RSC
71              When displaying information about resources,  show  only  what's
72              related  to  the given resource, or to all resources tagged with
73              the given tag
74
75       -n, --group-by-node
76              Group resources by node
77
78       -r, --inactive
79              Display inactive resources
80
81       -f, --failcounts
82              Display resource fail counts
83
84       -o, --operations
85              Display resource operation history
86
87       -t, --timing-details
88              Display resource operation history with timing details
89
90       -c, --tickets
91              Display cluster tickets
92
93       -m, --fence-history=LEVEL
94              Show fence history: 0=off, 1=failures and pending (default with‐
95              out option), 2=add successes (default without value for option),
96              3=show full history without reduction to  most  recent  of  each
97              flavor
98
99       -L, --neg-locations
100              Display negative location constraints [optionally filtered by id
101              prefix]
102
103       -A, --show-node-attributes
104              Display node attributes
105
106       -D, --hide-headers
107              Hide all headers
108
109       -R, --show-detail
110              Show more details (node IDs, individual clone instances)
111
112       --show-description
113              Show resource descriptions
114
115       -b, --brief
116              Brief output
117
118   Additional Options:
119       -i, --interval=TIMESPEC
120              Update frequency (default is 5 seconds)
121
122       -1, --one-shot
123              Display the cluster status once and exit
124
125       -d, --daemonize
126              Run in the background as a daemon.  Requires  at  least  one  of
127              --output-to and --external-agent.
128
129       -p, --pid-file=FILE
130              (Advanced) Daemon pid file location
131
132       -E, --external-agent=FILE
133              A program to run when resource operations take place
134
135       -e, --external-recipient=RCPT
136              A  recipient  for your program (assuming you want the program to
137              send something to someone).
138
139       -W, --watch-fencing
140              Listen for fencing events. For use with --external-agent.
141
142   Deprecated Options:
143       -h, --as-html=FILE
144              Write cluster  status  to  the  named  HTML  file.   Use  --out‐
145              put-as=html --output-to=FILE instead.
146
147       -X, --as-xml
148              Write cluster status as XML to stdout. This will enable one-shot
149              mode.  Use --output-as=xml instead.
150
151       -s, --simple-status
152              Display the cluster status once as  a  simple  one  line  output
153              (suitable for nagios)
154
155       -N, --disable-ncurses
156              Disable the use of ncurses.  Use --output-as=text instead.
157
158       -w, --web-cgi
159              Web  mode  with output suitable for CGI (preselected when run as
160              *.cgi).  Use --output-as=html --html-cgi instead.
161
162   Application Options:
163       -$, --version
164              Display software version and exit
165
166       -V, --verbose
167              Increase debug output (may be specified multiple times)
168
169       -Q, --quiet
170              Be less descriptive in output.
171

NOTES

173       If  this  program  is  called  as  crm_mon.cgi,  --output-as=html   and
174       --html-cgi are automatically added to the command line arguments.
175
176       Time Specification:
177
178       The  TIMESPEC  in any command line option can be specified in many dif‐
179       ferent formats. It can be an integer number of seconds, a  number  plus
180       units  (us/usec/ms/msec/s/sec/m/min/h/hr), or an ISO 8601 period speci‐
181       fication.
182

OUTPUT CONTROL

184       By default, a particular set of sections are written to the output des‐
185       tination.  The  default varies based on the output format: XML includes
186       all sections by default, while other output formats include less.  This
187       set  can  be modified with the --include and --exclude command line op‐
188       tions. Each option may be passed multiple times, and each can specify a
189       comma-separated  list  of  sections. The options are applied to the de‐
190       fault set, in order from left to right as they are passed on  the  com‐
191       mand  line.  For a list of valid sections, pass --include=list or --ex‐
192       clude=list.
193

INTERACTIVE USE

195       When run interactively, crm_mon can be told to hide  and  show  various
196       sections  of output. To see a help screen explaining the options, press
197       '?'. Any key stroke aside from those listed will cause  the  screen  to
198       refresh.
199

EXAMPLES

201       Display the cluster status on the console with updates as they occur:
202
203              crm_mon
204
205       Display the cluster status once and exit:
206
207              crm_mon -1
208
209       Display  the cluster status, group resources by node, and include inac‐
210       tive resources in the list:
211
212              crm_mon --group-by-node --inactive
213
214       Start crm_mon as a background daemon and have it write the cluster sta‐
215       tus to an HTML file:
216
217              crm_mon  --daemonize  --output-as html --output-to /path/to/doc‐
218              root/filename.html
219
220       Display the cluster status as XML:
221
222              crm_mon --output-as xml
223

AUTHOR

225       Written by Andrew Beekhof and the Pacemaker project contributors
226
227
228
229Pacemaker 2.1.7-0.3.rc2.fc38     November 2023                    PACEMAKER(8)
Impressum