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 mode [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
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       -b, --brief
113              Brief output
114
115       -s, --simple-status
116              Display the cluster status once as  a  simple  one  line  output
117              (suitable for nagios)
118
119   Additional Options:
120       -i, --interval=TIMESPEC
121              Update frequency (default is 5 seconds)
122
123       -1, --one-shot
124              Display the cluster status once on the console and exit
125
126       -d, --daemonize
127              Run  in  the  background  as a daemon.  Requires at least one of
128              --output-to and --external-agent.
129
130       -p, --pid-file=FILE
131              (Advanced) Daemon pid file location
132
133       -E, --external-agent=FILE
134              A program to run when resource operations take place
135
136       -e, --external-recipient=RCPT
137              A recipient for your program (assuming you want the  program  to
138              send something to someone).
139
140       -W, --watch-fencing
141              Listen for fencing events. For use with --external-agent.
142
143   Deprecated Options:
144       -h, --as-html=FILE
145              Write  cluster  status  to  the  named  HTML  file.   Use --out‐
146              put-as=html --output-to=FILE instead.
147
148       -X, --as-xml
149              Write cluster status as XML to stdout. This will enable one-shot
150              mode.  Use --output-as=xml instead.
151
152       -N, --disable-ncurses
153              Disable the use of ncurses.  Use --output-as=text instead.
154
155       -w, --web-cgi
156              Web  mode  with output suitable for CGI (preselected when run as
157              *.cgi).  Use --output-as=html --html-cgi instead.
158
159   Application Options:
160       -$, --version
161              Display software version and exit
162
163       -V, --verbose
164              Increase debug output (may be specified multiple times)
165
166       -Q, --quiet
167              Be less descriptive in output.
168

NOTES

170       If this program is called as crm_mon.cgi,  --output-as=html  --html-cgi
171       will automatically be added to the command line arguments.
172

TIME SPECIFICATION

174       The  TIMESPEC  in any command line option can be specified in many dif‐
175       ferent formats.  It can be just an integer number of seconds, a  number
176       plus  units  (ms/msec/us/usec/s/sec/m/min/h/hr),  or an ISO 8601 period
177       specification.
178

OUTPUT CONTROL

180       By default, a certain list of sections are written to the output desti‐
181       nation.   The  default varies based on the output format - XML includes
182       everything, while other output formats will display  less.   This  list
183       can  be modified with the --include and --exclude command line options.
184       Each option may be given multiple times on the command line,  and  each
185       can  give  a comma-separated list of sections.  The options are applied
186       to the default set, from left to right as seen  on  the  command  line.
187       For a list of valid sections, pass --include=list or --exclude=list.
188

INTERACTIVE USE

190       When run interactively, crm_mon can be told to hide and display various
191       sections of output.  To see a help screen explaining the  options,  hit
192       '?'.   Any  key stroke aside from those listed will cause the screen to
193       refresh.
194

EXAMPLES

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

AUTHOR

221       Written by Andrew Beekhof and the Pacemaker project contributors
222
223
224
225Pacemaker 2.1.5-3.fc37           December 2022                    PACEMAKER(8)
Impressum