.\" 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_shadow <query>|<command> [options]
.SH DESCRIPTION
perform Pacemaker configuration changes in a sandbox
.PP
This command sets up an environment in which configuration tools (cibadmin,
crm_resource, etc.) work offline instead of against a live cluster, allowing
changes to be previewed and tested for side effects.
.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\-queries\fR
Show query help
.TP
\fB\-\-help\-commands\fR
Show command help
.TP
\fB\-\-help\-additional\fR
Show additional 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 "Queries:"
.TP
\fB\-w\fR, \fB\-\-which\fR
Indicate the active shadow copy
.TP
\fB\-p\fR, \fB\-\-display\fR
Display the contents of the active shadow copy
.TP
\fB\-d\fR, \fB\-\-diff\fR
Display the changes in the active shadow copy
.TP
\fB\-F\fR, \fB\-\-file\fR
Display the location of the active shadow copy file
.SS "Commands:"
.TP
\fB\-c\fR, \fB\-\-create\fR=\fI\,name\/\fR
Create the named shadow copy of the active cluster configuration
.TP
\fB\-e\fR, \fB\-\-create\-empty\fR=\fI\,name\/\fR
Create the named shadow copy with an empty cluster configuration.
Optional: \fB\-\-validate\-with\fR
.TP
\fB\-C\fR, \fB\-\-commit\fR=\fI\,name\/\fR
Upload the contents of the named shadow copy to the cluster
.TP
\fB\-D\fR, \fB\-\-delete\fR=\fI\,name\/\fR
Delete the contents of the named shadow copy
.TP
\fB\-E\fR, \fB\-\-edit\fR
Edit the contents of the active shadow copy with your favorite $EDITOR
.TP
\fB\-r\fR, \fB\-\-reset\fR=\fI\,name\/\fR
Recreate named shadow copy from the active cluster configuration
.TP
\fB\-s\fR, \fB\-\-switch\fR=\fI\,name\/\fR
(Advanced) Switch to the named shadow copy
.SS "Additional Options:"
.TP
\fB\-f\fR, \fB\-\-force\fR
(Advanced) Force the action to be performed
.TP
\fB\-b\fR, \fB\-\-batch\fR
(Advanced) Don't spawn a new shell
.TP
\fB\-a\fR, \fB\-\-all\fR
(Advanced) Upload entire CIB, including status, with \fB\-\-commit\fR
.TP
\fB\-v\fR, \fB\-\-validate\-with\fR
(Advanced) Create an older configuration version
.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)
.SH EXAMPLES
Create a blank shadow configuration:
.IP
# crm_shadow \-\-create\-empty myShadow
.PP
Create a shadow configuration from the running cluster
.IP
# crm_shadow \-\-create myShadow
.PP
Display the current shadow configuration:
.IP
# crm_shadow \-\-display
.PP
Discard the current shadow configuration (named myShadow):
.IP
# crm_shadow \-\-delete myShadow \-\-force
.PP
Upload current shadow configuration (named myShadow) to running cluster:
.IP
# crm_shadow \-\-commit myShadow
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors