.\" 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
cibadmin <command> [options]
.SH DESCRIPTION
query and edit the Pacemaker configuration
.SH OPTIONS
.SS "Help Options:"
.TP
\-?, \fB\-\-help\fR
Show help options
.TP
\fB\-\-help\-all\fR
Show all help options
.TP
\fB\-\-help\-commands\fR
Show command help
.TP
\fB\-\-help\-data\fR
Show data help
.TP
\fB\-\-help\-additional\fR
Show additional options
.SS "Commands:"
.TP
\fB\-u\fR, \fB\-\-upgrade\fR
Upgrade the configuration to the latest syntax
.TP
\fB\-Q\fR, \fB\-\-query\fR
Query the contents of the CIB
.TP
\fB\-E\fR, \fB\-\-erase\fR
Erase the contents of the whole CIB
.TP
\fB\-B\fR, \fB\-\-bump\fR
Increase the CIB's epoch value by 1
.TP
\fB\-C\fR, \fB\-\-create\fR
Create an object in the CIB (will fail if object already exists)
.TP
\fB\-M\fR, \fB\-\-modify\fR
Find object somewhere in CIB's XML tree and update it (fails if object does not exist unless \fB\-c\fR is also specified)
.TP
\fB\-P\fR, \fB\-\-patch\fR
Supply an update in the form of an XML diff (see crm_diff(8))
.TP
\fB\-R\fR, \fB\-\-replace\fR
Recursively replace an object in the CIB
.TP
\fB\-D\fR, \fB\-\-delete\fR
Delete first object matching supplied criteria (for example, <op id="rsc1_op1" name="monitor"/>).
The XML element name and all attributes must match in order for the element to be deleted.
.TP
\fB\-d\fR, \fB\-\-delete\-all\fR
When used with \fB\-\-xpath\fR, remove all matching objects in the configuration instead of just the first one
.TP
\fB\-a\fR, \fB\-\-empty\fR=\fI\,[schema]\/\fR
Output an empty CIB. Accepts an optional schema name argument to use as the validate\-with value.
If no schema is given, the latest will be used.
.TP
\fB\-5\fR, \fB\-\-md5\-sum\fR
Calculate the on\-disk CIB digest
.TP
\fB\-6\fR, \fB\-\-md5\-sum\-versioned\fR
Calculate an on\-the\-wire versioned CIB digest
.SS "Data:"
.TP
\fB\-X\fR, \fB\-\-xml\-text\fR=\fI\,value\/\fR
Retrieve XML from the supplied string
.TP
\fB\-x\fR, \fB\-\-xml\-file\fR=\fI\,value\/\fR
Retrieve XML from the named file
.TP
\fB\-p\fR, \fB\-\-xml\-pipe\fR
Retrieve XML from stdin
.SS "Additional Options:"
.TP
\fB\-f\fR, \fB\-\-force\fR
Force the action to be performed
.TP
\fB\-t\fR, \fB\-\-timeout\fR=\fI\,value\/\fR
Time (in seconds) to wait before declaring the operation failed
.TP
\fB\-U\fR, \fB\-\-user\fR=\fI\,value\/\fR
Run the command with permissions of the named user (valid only for the root and hacluster accounts)
.TP
\fB\-s\fR, \fB\-\-sync\-call\fR
Wait for call to complete before returning
.TP
\fB\-l\fR, \fB\-\-local\fR
Command takes effect locally (should be used only for queries)
.TP
\fB\-o\fR, \fB\-\-scope\fR=\fI\,value\/\fR
Limit scope of operation to specific section of CIB
Valid values: configuration, nodes, resources, constraints, crm_config, rsc_defaults,
.TP
op_defaults, acls, fencing\-topology, tags, alerts, status
If both \fB\-\-scope\fR/\-o and \fB\-\-xpath\fR/\-a are specified, the last one to appear takes effect
.TP
\fB\-A\fR, \fB\-\-xpath\fR=\fI\,value\/\fR
A valid XPath to use instead of \fB\-\-scope\fR/\-o
If both \fB\-\-scope\fR/\-o and \fB\-\-xpath\fR/\-a are specified, the last one to appear takes effect
.TP
\fB\-e\fR, \fB\-\-node\-path\fR
When performing XPath queries, return paths of any matches found
(for example, "/cib/configuration/resources/clone[@id='dummy\-clone']/primitive[@id='dummy']")
.TP
\fB\-S\fR, \fB\-\-show\-access\fR=\fI\,[value]\/\fR
Whether to use syntax highlighting for ACLs (with \fB\-Q\fR/\-\-query and \fB\-U\fR/\-\-user)
Allowed values: 'color' (default for terminal), 'text' (plain text, default for non\-terminal),
.TP
\&'namespace', or 'auto' (use default value)
Default value: 'auto'
.TP
\fB\-c\fR, \fB\-\-allow\-create\fR
(Advanced) Allow target of \fB\-\-modify\fR/\-M to be created if it does not exist
.TP
\fB\-n\fR, \fB\-\-no\-children\fR
(Advanced) When querying an object, do not include its children in the result
.TP
\fB\-N\fR, \fB\-\-node\fR=\fI\,value\/\fR
(Advanced) Send command to the specified host
.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
Query the configuration from the local node:
.IP
# cibadmin \-\-query \-\-local
.PP
Query just the cluster options configuration:
.IP
# cibadmin \-\-query \-\-scope crm_config
.PP
Query all 'target\-role' settings:
.IP
# cibadmin \-\-query \-\-xpath "//nvpair[@name='target\-role']"
.PP
Remove all 'is\-managed' settings:
.IP
# cibadmin \-\-delete\-all \-\-xpath "//nvpair[@name='is\-managed']"
.PP
Remove the resource named 'old':
.IP
# cibadmin \-\-delete \-\-xml\-text '<primitive id="old"/>'
.PP
Remove all resources from the configuration:
.IP
# cibadmin \-\-replace \-\-scope resources \-\-xml\-text '<resources/>'
.PP
Replace complete configuration with contents of $HOME/pacemaker.xml:
.IP
# cibadmin \-\-replace \-\-xml\-file $HOME/pacemaker.xml
.PP
Replace constraints section of configuration with contents of $HOME/constraints.xml:
.IP
# cibadmin \-\-replace \-\-scope constraints \-\-xml\-file $HOME/constraints.xml
.PP
Increase configuration version to prevent old configurations from being loaded accidentally:
.IP
# cibadmin \-\-modify \-\-xml\-text '<cib admin_epoch="admin_epoch++"/>'
.PP
Edit the configuration with your favorite $EDITOR:
.IP
# cibadmin \-\-query > $HOME/local.xml
.IP
# $EDITOR $HOME/local.xml
.IP
# cibadmin \-\-replace \-\-xml\-file $HOME/local.xml
.PP
Assuming terminal, render configuration in color (green for writable, blue for readable, red for
denied) to visualize permissions for user tony:
.IP
# cibadmin \-\-show\-access=color \-\-query \-\-user tony | less \-r
.SS "SEE ALSO:"
.IP
crm(8), pcs(8), crm_shadow(8), crm_diff(8)
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors