1PACEMAKER(8) System Administration Utilities PACEMAKER(8)
2
6 Pacemaker - Part of the Pacemaker cluster resource manager
7
9 cibadmin <command> [options]
10
12 query and edit the Pacemaker configuration
13
15 Help Options:
16 -?, --help
17 Show help options
18 --help-all
20 Show all help options
21 --help-commands
23 Show command help
24 --help-data
26 Show data help
27 --help-additional
29 Show additional options
30 Commands:
32 -u, --upgrade
33 Upgrade the configuration to the latest syntax
34 -Q, --query
36 Query the contents of the CIB
37 -E, --erase
39 Erase the contents of the whole CIB
40 -B, --bump
42 Increase the CIB's epoch value by 1
43 -C, --create
45 Create an object in the CIB (will fail if object already exists)
46 -M, --modify
48 Find object somewhere in CIB's XML tree and update it (fails if
49 object does not exist unless -c is also specified)
50 -P, --patch
52 Supply an update in the form of an XML diff (see crm_diff(8))
53 -R, --replace
55 Recursively replace an object in the CIB
56 -D, --delete
58 Delete first object matching supplied criteria (for example, <op
59 id="rsc1_op1" name="monitor"/>). The XML element name and all
60 attributes must match in order for the element to be deleted.
61 -d, --delete-all
63 When used with --xpath, remove all matching objects in the con‐
64 figuration instead of just the first one
65 -a, --empty=[schema]
67 Output an empty CIB. Accepts an optional schema name argument to
68 use as the validate-with value. If no schema is given, the lat‐
69 est will be used.
70 -5, --md5-sum
72 Calculate the on-disk CIB digest
73 -6, --md5-sum-versioned
75 Calculate an on-the-wire versioned CIB digest
76 Data:
78 -X, --xml-text=value
79 Retrieve XML from the supplied string
80 -x, --xml-file=value
82 Retrieve XML from the named file
83 -p, --xml-pipe
85 Retrieve XML from stdin
86 Additional Options:
88 -f, --force
89 Force the action to be performed
90 -t, --timeout=value
92 Time (in seconds) to wait before declaring the operation failed
93 -U, --user=value
95 Run the command with permissions of the named user (valid only
96 for the root and hacluster accounts)
97 -s, --sync-call
99 Wait for call to complete before returning
100 -l, --local
102 Command takes effect locally (should be used only for queries)
103 -o, --scope=value
105 Limit scope of operation to specific section of CIB Valid val‐
106 ues: configuration, nodes, resources, constraints, crm_config,
107 rsc_defaults,
108 op_defaults, acls, fencing-topology, tags, alerts, status
110 If both --scope/-o and --xpath/-a are specified, the last one to
111 appear takes effect
112 -A, --xpath=value
114 A valid XPath to use instead of --scope/-o If both --scope/-o
115 and --xpath/-a are specified, the last one to appear takes ef‐
116 fect
117 -e, --node-path
119 When performing XPath queries, return paths of any matches found
120 (for example, "/cib/configuration/re‐
121 sources/clone[@id='dummy-clone']/primitive[@id='dummy']")
122 -S, --show-access=[value]
124 Whether to use syntax highlighting for ACLs (with -Q/--query and
125 -U/--user) Allowed values: 'color' (default for terminal),
126 'text' (plain text, default for non-terminal),
127 'namespace', or 'auto' (use default value)
129 Default value: 'auto'
130 -c, --allow-create
132 (Advanced) Allow target of --modify/-M to be created if it does
133 not exist
134 -n, --no-children
136 (Advanced) When querying an object, do not include its children
137 in the result
138 -N, --node=value
140 (Advanced) Send command to the specified host
141 Application Options:
143 -$, --version
144 Display software version and exit
145 -V, --verbose
147 Increase debug output (may be specified multiple times)
148
150 Query the configuration from the local node:
151 # cibadmin --query --local
153 Query just the cluster options configuration:
155 # cibadmin --query --scope crm_config
157 Query all 'target-role' settings:
159 # cibadmin --query --xpath "//nvpair[@name='target-role']"
161 Remove all 'is-managed' settings:
163 # cibadmin --delete-all --xpath "//nvpair[@name='is-managed']"
165 Remove the resource named 'old':
167 # cibadmin --delete --xml-text '<primitive id="old"/>'
169 Remove all resources from the configuration:
171 # cibadmin --replace --scope resources --xml-text '<resources/>'
173 Replace complete configuration with contents of $HOME/pacemaker.xml:
175 # cibadmin --replace --xml-file $HOME/pacemaker.xml
177 Replace constraints section of configuration with contents of
179 $HOME/constraints.xml:
180 # cibadmin --replace --scope constraints --xml-file $HOME/con‐
182 straints.xml
183 Increase configuration version to prevent old configurations from being
185 loaded accidentally:
186 # cibadmin --modify --xml-text '<cib admin_epoch="ad‐
188 min_epoch++"/>'
189 Edit the configuration with your favorite $EDITOR:
191 # cibadmin --query > $HOME/local.xml
193 # $EDITOR $HOME/local.xml
195 # cibadmin --replace --xml-file $HOME/local.xml
197 Assuming terminal, render configuration in color (green for writable,
199 blue for readable, red for denied) to visualize permissions for user
200 tony:
201 # cibadmin --show-access=color --query --user tony | less -r
203 SEE ALSO:
205 crm(8), pcs(8), crm_shadow(8), crm_diff(8)
206
208 Written by Andrew Beekhof and the Pacemaker project contributors
209Pacemaker 2.1.7-0.3.rc2.fc38 November 2023 PACEMAKER(8)