.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH PACEMAKER "8" "November 2020" "Pacemaker 2.0.1" "System Administration Utilities"
.SH NAME
Pacemaker \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
.B cibadmin
\fI\,command \/\fR[\fI\,options\/\fR] [\fI\,data\/\fR]
.SH DESCRIPTION
cibadmin \- Provides direct access to the cluster configuration.
.PP
Allows the configuration, or sections of it, to be queried, modified, replaced and deleted.
.PP
Where necessary, XML data will be obtained using the \fB\-X\fR, \fB\-x\fR, or \fB\-p\fR options.
.SH OPTIONS
.TP
\-?, \fB\-\-help\fR
This text
.TP
\-$, \fB\-\-version\fR
Version information
.TP
\fB\-V\fR, \fB\-\-verbose\fR
Increase debug output
.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 the object already exists.
.TP
\fB\-M\fR, \fB\-\-modify\fR
Find the object somewhere in the CIB's XML tree and update it.  Fails if the object does not exist unless \fB\-c\fR is specified
.TP
\fB\-P\fR, \fB\-\-patch\fR
Supply an update in the form of an xml diff (See also: crm_diff)
.TP
\fB\-R\fR, \fB\-\-replace\fR
Recursively replace an object in the CIB
.TP
\fB\-D\fR, \fB\-\-delete\fR
Delete the first object matching the supplied criteria, Eg. <op id="rsc1_op1" name="monitor"/>
.IP
The tagname 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
Output an empty CIB
.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 "Additional options:"
.HP
\fB\-f\fR, \fB\-\-force\fR    
.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 only be used for queries
.TP
\fB\-c\fR, \fB\-\-allow\-create\fR
(Advanced) Allow the target of a \fB\-\-modify\fR,\-M operation to be created if they do not exist
.TP
\fB\-n\fR, \fB\-\-no\-children\fR
(Advanced) When querying an object, do not return include its children in the result
.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
.HP
\fB\-p\fR, \fB\-\-xml\-pipe\fR Retrieve XML from stdin
.TP
\fB\-o\fR, \fB\-\-scope\fR=\fI\,value\/\fR
Limit the scope of the operation to a specific section of the CIB.
.IP
Valid values are: nodes, resources, constraints, crm_config, rsc_defaults, op_defaults, status
.TP
\fB\-A\fR, \fB\-\-xpath\fR=\fI\,value\/\fR
A valid XPath to use instead of \fB\-\-scope\fR,\-o
.TP
\fB\-e\fR, \fB\-\-node\-path\fR
When performing XPath queries, return the address of any matches found.
.IP
Eg: /cib/configuration/resources/clone[@id='ms_RH1_SCS']/primitive[@id='prm_RH1_SCS']
.TP
\fB\-N\fR, \fB\-\-node\fR=\fI\,value\/\fR
(Advanced) Send command to the specified host
.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 the complete configuration with the contents of $HOME/pacemaker.xml:
.IP
# cibadmin \-\-replace \-\-xml\-file $HOME/pacemaker.xml
.PP
Replace the constraints section of the configuration with the contents of $HOME/constraints.xml:
.IP
# cibadmin \-\-replace \-\-scope constraints \-\-xml\-file $HOME/constraints.xml
.PP
Increase the 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
.SS "SEE ALSO:"
.IP
crm(8), pcs(8), crm_shadow(8), crm_diff(8)
.SH AUTHOR
Written by Andrew Beekhof
.SH "REPORTING BUGS"
Report bugs to users@clusterlabs.org