.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PACEMAKER "8" "February 2024" "Pacemaker 2.1.6" "System Administration Utilities"
.SH NAME
Pacemaker \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
crm_simulate <data source> <operation> [options]
.SH DESCRIPTION
crm_simulate \- simulate a Pacemaker cluster's response to events
.SH OPTIONS
.SS "Help Options:"
.TP
\fB\-h\fR, \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\-operations\fR
Show operations options
.TP
\fB\-\-help\-synthetic\fR
Show synthetic cluster event options
.TP
\fB\-\-help\-artifact\fR
Show artifact options
.TP
\fB\-\-help\-source\fR
Show data source options
.SS "Output Options:"
.TP
\fB\-\-output\-as\fR=\fI\,FORMAT\/\fR
Specify output format as one of: text (default), xml
.TP
\fB\-\-output\-to\fR=\fI\,DEST\/\fR
Specify file name for output (or "\-" for stdout)
.TP
\fB\-\-text\-fancy\fR
Use more highly formatted output (requires \fB\-\-output\-as\fR=\fI\,text\/\fR)
.SS "Operations:"
.TP
\fB\-R\fR, \fB\-\-run\fR
Process the supplied input and show what actions the cluster will take in response
.TP
\fB\-S\fR, \fB\-\-simulate\fR
Like \fB\-\-run\fR, but also simulate taking those actions and show the resulting new status
.TP
\fB\-X\fR, \fB\-\-in\-place\fR
Like \fB\-\-simulate\fR, but also store the results back to the input file
.TP
\fB\-A\fR, \fB\-\-show\-attrs\fR
Show node attributes
.TP
\fB\-c\fR, \fB\-\-show\-failcounts\fR
Show resource fail counts
.TP
\fB\-s\fR, \fB\-\-show\-scores\fR
Show allocation scores
.TP
\fB\-U\fR, \fB\-\-show\-utilization\fR
Show utilization information
.TP
\fB\-P\fR, \fB\-\-profile\fR=\fI\,DIR\/\fR
Process all the XML files in the named directory to create profiling data
.TP
\fB\-N\fR, \fB\-\-repeat\fR=\fI\,N\/\fR
With \fB\-\-profile\fR, repeat each test N times and print timings
.SS "Synthetic Cluster Events:"
.TP
\fB\-u\fR, \fB\-\-node\-up\fR=\fI\,NODE\/\fR
Simulate bringing a node online
.TP
\fB\-d\fR, \fB\-\-node\-down\fR=\fI\,NODE\/\fR
Simulate taking a node offline
.TP
\fB\-f\fR, \fB\-\-node\-fail\fR=\fI\,NODE\/\fR
Simulate a node failing
.TP
\fB\-i\fR, \fB\-\-op\-inject\fR=\fI\,OPSPEC\/\fR
Generate a failure for the cluster to react to in the simulation.
See `Operation Specification` help for more information.
.TP
\fB\-F\fR, \fB\-\-op\-fail\fR=\fI\,OPSPEC\/\fR
If the specified task occurs during the simulation, have it fail with return code ${rc}.
The transition will normally stop at the failed action.
Save the result with \fB\-\-save\-output\fR and re\-run with \fB\-\-xml\-file\fR.
See `Operation Specification` help for more information.
.TP
\fB\-t\fR, \fB\-\-set\-datetime\fR=\fI\,DATETIME\/\fR
Set date/time (ISO 8601 format, see https://en.wikipedia.org/wiki/ISO_8601)
.TP
\fB\-q\fR, \fB\-\-quorum\fR=\fI\,QUORUM\/\fR
Set to '1' (or 'true') to indicate cluster has quorum
.TP
\fB\-w\fR, \fB\-\-watchdog\fR=\fI\,DEVICE\/\fR
Set to '1' (or 'true') to indicate cluster has an active watchdog device
.TP
\fB\-g\fR, \fB\-\-ticket\-grant\fR=\fI\,TICKET\/\fR
Simulate granting a ticket
.TP
\fB\-r\fR, \fB\-\-ticket\-revoke\fR=\fI\,TICKET\/\fR
Simulate revoking a ticket
.TP
\fB\-b\fR, \fB\-\-ticket\-standby\fR=\fI\,TICKET\/\fR
Simulate making a ticket standby
.TP
\fB\-e\fR, \fB\-\-ticket\-activate\fR=\fI\,TICKET\/\fR
Simulate activating a ticket
.SS "Artifact Options:"
.TP
\fB\-I\fR, \fB\-\-save\-input\fR=\fI\,FILE\/\fR
Save the input configuration to the named file
.TP
\fB\-O\fR, \fB\-\-save\-output\fR=\fI\,FILE\/\fR
Save the output configuration to the named file
.TP
\fB\-G\fR, \fB\-\-save\-graph\fR=\fI\,FILE\/\fR
Save the transition graph (XML format) to the named file
.TP
\fB\-D\fR, \fB\-\-save\-dotfile\fR=\fI\,FILE\/\fR
Save the transition graph (DOT format) to the named file
.TP
\fB\-a\fR, \fB\-\-all\-actions\fR
Display all possible actions in DOT graph (even if not part of transition)
.SS "Data Source:"
.TP
\fB\-L\fR, \fB\-\-live\-check\fR
Connect to CIB manager and use the current CIB contents as input
.TP
\fB\-x\fR, \fB\-\-xml\-file\fR=\fI\,FILE\/\fR
Retrieve XML from the named file
.TP
\fB\-p\fR, \fB\-\-xml\-pipe\fR
Retrieve XML from stdin
.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
Display only essential output
.SH OPERATION SPECIFICATION
The OPSPEC in any command line option is of the form
${resource}_${task}_${interval_in_ms}@${node}=${rc}
(memcached_monitor_20000@bart.example.com=7, for example).
${rc} is an OCF return code.  For more information on these
return codes, refer to https://clusterlabs.org/pacemaker/doc/2.1/Pacemaker_Administration/html/agents.html#ocf\-return\-codes
.SH EXAMPLES
Pretend a recurring monitor action found memcached stopped on node
fred.example.com and, during recovery, that the memcached stop
action failed:
.IP
crm_simulate \-LS \-\-op\-inject memcached:0_monitor_20000@bart.example.com=7 \-\-op\-fail memcached:0_stop_0@fred.example.com=1 \-\-save\-output /tmp/memcached\-test.xml
.PP
Now see what the reaction to the stop failed would be:
.IP
crm_simulate \-S \-\-xml\-file /tmp/memcached\-test.xml
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors