1PACEMAKER(8)            System Administration Utilities           PACEMAKER(8)
2
3
4

NAME

6       Pacemaker - Part of the Pacemaker cluster resource manager
7

SYNOPSIS

9       cibadmin <command> [options]
10

DESCRIPTION

12       cibadmin - query and edit the Pacemaker configuration
13

OPTIONS

15       -?, --help
16              This text
17
18       -$, --version
19              Version information
20
21       -V, --verbose
22              Increase debug output
23
24   Commands:
25       -u, --upgrade
26              Upgrade the configuration to the latest syntax
27
28       -Q, --query
29              Query the contents of the CIB
30
31       -E, --erase
32              Erase the contents of the whole CIB
33
34       -B, --bump
35              Increase the CIB's epoch value by 1
36
37       -C, --create
38              Create an object in the CIB (will fail if object already exists)
39
40       -M, --modify
41              Find  object somewhere in CIB's XML tree and update it (fails if
42              object does not exist unless -c is also specified)
43
44       -P, --patch
45              Supply an update in the form of an XML diff (see crm_diff(8))
46
47       -R, --replace
48              Recursively replace an object in the CIB
49
50       -D, --delete
51              Delete first object matching supplied criteria (for example, <op
52              id="rsc1_op1" name="monitor"/>)
53
54              The  XML element name and all attributes must match in order for
55              the element to be deleted.
56
57       -d, --delete-all
58              When used with --xpath, remove all matching objects in the  con‐
59              figuration instead of just the first one
60
61       -a, --empty
62              Output an empty CIB
63
64       -5, --md5-sum
65              Calculate the on-disk CIB digest
66
67       -6, --md5-sum-versioned
68              Calculate an on-the-wire versioned CIB digest
69
70       -S, --show-access[=value]
71              Whether to use syntax highlighting for ACLs (with -Q/--query and
72              -U/--user)
73
74              That amounts to one of "color" (default  for  terminal),  "text"
75              (otherwise), "namespace", or "auto" (per former defaults).
76
77   Additional options:
78       -f, --force
79
80       -t, --timeout=value
81              Time (in seconds) to wait before declaring the operation failed
82
83       -U, --user=value
84              Run  the  command with permissions of the named user (valid only
85              for the root and hacluster accounts)
86
87       -s, --sync-call
88              Wait for call to complete before returning
89
90       -l, --local
91              Command takes effect locally (should be used only for queries)
92
93       -c, --allow-create
94              (Advanced) Allow target of --modify/-M to be created if it  does
95              not exist
96
97       -n, --no-children
98              (Advanced)  When querying an object, do not include its children
99              in the result
100
101   Data:
102       -X, --xml-text=value
103              Retrieve XML from the supplied string
104
105       -x, --xml-file=value
106              Retrieve XML from the named file
107
108       -p, --xml-pipe Retrieve XML from stdin
109
110       -o, --scope=value
111              Limit scope of operation to specific section of CIB
112
113              Valid  values:  configuration,  nodes,  resources,  constraints,
114              crm_config,  rsc_defaults,  op_defaults, acls, fencing-topology,
115              tags, alerts
116
117       -A, --xpath=value
118              A valid XPath to use instead of --scope/-o
119
120       -e, --node-path
121              When performing XPath queries, return path of any matches found
122
123              (for              example,               "/cib/configuration/re‐
124              sources/clone[@id='ms_RH1_SCS']/primitive[@id='prm_RH1_SCS']")
125
126       -N, --node=value
127              (Advanced) Send command to the specified host
128

EXAMPLES

130       Query the configuration from the local node:
131
132              # cibadmin --query --local
133
134       Query just the cluster options configuration:
135
136              # cibadmin --query --scope crm_config
137
138       Query all 'target-role' settings:
139
140              # cibadmin --query --xpath "//nvpair[@name='target-role']"
141
142       Remove all 'is-managed' settings:
143
144              # cibadmin --delete-all --xpath "//nvpair[@name='is-managed']"
145
146       Remove the resource named 'old':
147
148              # cibadmin --delete --xml-text '<primitive id="old"/>'
149
150       Remove all resources from the configuration:
151
152              # cibadmin --replace --scope resources --xml-text '<resources/>'
153
154       Replace complete configuration with contents of $HOME/pacemaker.xml:
155
156              # cibadmin --replace --xml-file $HOME/pacemaker.xml
157
158       Replace   constraints   section   of  configuration  with  contents  of
159       $HOME/constraints.xml:
160
161              # cibadmin --replace --scope constraints  --xml-file  $HOME/con‐
162              straints.xml
163
164       Increase configuration version to prevent old configurations from being
165       loaded accidentally:
166
167              #   cibadmin   --modify   --xml-text   '<cib    admin_epoch="ad‐
168              min_epoch++"/>'
169
170       Edit the configuration with your favorite $EDITOR:
171
172              # cibadmin --query > $HOME/local.xml
173
174              # $EDITOR $HOME/local.xml
175
176              # cibadmin --replace --xml-file $HOME/local.xml
177
178       Assuming  terminal,  render configuration in color (green for writable,
179       blue for readable, red for denied) to visualize  permissions  for  user
180       tony:
181
182              # cibadmin --show-access=color --query --user tony | less -r
183
184   SEE ALSO:
185              crm(8), pcs(8), crm_shadow(8), crm_diff(8)
186

AUTHOR

188       Written by Andrew Beekhof and the Pacemaker project contributors
189

REPORTING BUGS

191       Report bugs to users@clusterlabs.org
192
193
194
195Pacemaker 2.1.5-3.fc37           December 2022                    PACEMAKER(8)
Impressum