pacemaker  2.0.4-2deceaa
Scalable High-Availability cluster resource manager
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
msg_xml.h
Go to the documentation of this file.
1 /*
2  * Copyright 2004-2020 the Pacemaker project contributors
3  *
4  * The version control history for this file may have further details.
5  *
6  * This source code is licensed under the GNU Lesser General Public License
7  * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
8  */
9 
10 #ifndef XML_TAGS__H
11 # define XML_TAGS__H
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 # ifndef F_ORIG
18 # define F_ORIG "src"
19 # endif
20 
21 # ifndef F_SEQ
22 # define F_SEQ "seq"
23 # endif
24 
25 # ifndef F_SUBTYPE
26 # define F_SUBTYPE "subt"
27 # endif
28 
29 # ifndef F_TYPE
30 # define F_TYPE "t"
31 # endif
32 
33 # ifndef F_CLIENTNAME
34 # define F_CLIENTNAME "cn"
35 # endif
36 
37 # ifndef F_XML_TAGNAME
38 # define F_XML_TAGNAME "__name__"
39 # endif
40 
41 # ifndef T_CRM
42 # define T_CRM "crmd"
43 # endif
44 
45 # ifndef T_ATTRD
46 # define T_ATTRD "attrd"
47 # endif
48 
49 # define CIB_OPTIONS_FIRST "cib-bootstrap-options"
50 
51 # define F_CRM_DATA "crm_xml"
52 # define F_CRM_TASK "crm_task"
53 # define F_CRM_HOST_TO "crm_host_to"
54 # define F_CRM_MSG_TYPE F_SUBTYPE
55 # define F_CRM_SYS_TO "crm_sys_to"
56 # define F_CRM_SYS_FROM "crm_sys_from"
57 # define F_CRM_HOST_FROM F_ORIG
58 # define F_CRM_REFERENCE XML_ATTR_REFERENCE
59 # define F_CRM_VERSION XML_ATTR_VERSION
60 # define F_CRM_ORIGIN "origin"
61 # define F_CRM_USER "crm_user"
62 # define F_CRM_JOIN_ID "join_id"
63 # define F_CRM_DC_LEAVING "dc-leaving"
64 # define F_CRM_ELECTION_ID "election-id"
65 # define F_CRM_ELECTION_AGE_S "election-age-sec"
66 # define F_CRM_ELECTION_AGE_US "election-age-nano-sec"
67 # define F_CRM_ELECTION_OWNER "election-owner"
68 # define F_CRM_TGRAPH "crm-tgraph-file"
69 # define F_CRM_TGRAPH_INPUT "crm-tgraph-in"
70 
71 # define F_CRM_THROTTLE_MODE "crm-limit-mode"
72 # define F_CRM_THROTTLE_MAX "crm-limit-max"
73 
74 /*---- Common tags/attrs */
75 # define XML_DIFF_MARKER "__crm_diff_marker__"
76 # define XML_TAG_CIB "cib"
77 # define XML_TAG_FAILED "failed"
78 
79 # define XML_ATTR_CRM_VERSION "crm_feature_set"
80 # define XML_ATTR_DIGEST "digest"
81 # define XML_ATTR_VALIDATION "validate-with"
82 # define XML_ATTR_RA_VERSION "ra-version"
83 
84 # define XML_ATTR_QUORUM_PANIC "no-quorum-panic"
85 # define XML_ATTR_HAVE_QUORUM "have-quorum"
86 # define XML_ATTR_HAVE_WATCHDOG "have-watchdog"
87 # define XML_ATTR_GENERATION "epoch"
88 # define XML_ATTR_GENERATION_ADMIN "admin_epoch"
89 # define XML_ATTR_NUMUPDATES "num_updates"
90 # define XML_ATTR_TIMEOUT "timeout"
91 # define XML_ATTR_ORIGIN "crm-debug-origin"
92 # define XML_ATTR_TSTAMP "crm-timestamp"
93 # define XML_CIB_ATTR_WRITTEN "cib-last-written"
94 # define XML_ATTR_VERSION "version"
95 # define XML_ATTR_DESC "description"
96 # define XML_ATTR_ID "id"
97 # define XML_ATTR_IDREF "id-ref"
98 # define XML_ATTR_ID_LONG "long-id"
99 # define XML_ATTR_TYPE "type"
100 # define XML_ATTR_VERBOSE "verbose"
101 # define XML_ATTR_OP "op"
102 # define XML_ATTR_DC_UUID "dc-uuid"
103 # define XML_ATTR_UPDATE_ORIG "update-origin"
104 # define XML_ATTR_UPDATE_CLIENT "update-client"
105 # define XML_ATTR_UPDATE_USER "update-user"
106 
107 # define XML_BOOLEAN_TRUE "true"
108 # define XML_BOOLEAN_FALSE "false"
109 # define XML_BOOLEAN_YES XML_BOOLEAN_TRUE
110 # define XML_BOOLEAN_NO XML_BOOLEAN_FALSE
111 
112 # define XML_TAG_OPTIONS "options"
113 
114 /*---- top level tags/attrs */
115 # define XML_ATTR_REQUEST "request"
116 # define XML_ATTR_RESPONSE "response"
117 
118 # define XML_ATTR_UNAME "uname"
119 # define XML_ATTR_UUID "id"
120 # define XML_ATTR_REFERENCE "reference"
121 
122 # define XML_CRM_TAG_PING "ping_response"
123 # define XML_PING_ATTR_STATUS "result"
124 # define XML_PING_ATTR_SYSFROM "crm_subsystem"
125 # define XML_PING_ATTR_CRMDSTATE "crmd_state"
126 
127 # define XML_TAG_FRAGMENT "cib_fragment"
128 
129 # define XML_FAIL_TAG_CIB "failed_update"
130 
131 # define XML_FAILCIB_ATTR_ID "id"
132 # define XML_FAILCIB_ATTR_OBJTYPE "object_type"
133 # define XML_FAILCIB_ATTR_OP "operation"
134 # define XML_FAILCIB_ATTR_REASON "reason"
135 
136 /*---- CIB specific tags/attrs */
137 # define XML_CIB_TAG_SECTION_ALL "all"
138 # define XML_CIB_TAG_CONFIGURATION "configuration"
139 # define XML_CIB_TAG_STATUS "status"
140 # define XML_CIB_TAG_RESOURCES "resources"
141 # define XML_CIB_TAG_NODES "nodes"
142 # define XML_CIB_TAG_DOMAINS "domains"
143 # define XML_CIB_TAG_CONSTRAINTS "constraints"
144 # define XML_CIB_TAG_CRMCONFIG "crm_config"
145 # define XML_CIB_TAG_OPCONFIG "op_defaults"
146 # define XML_CIB_TAG_RSCCONFIG "rsc_defaults"
147 # define XML_CIB_TAG_ACLS "acls"
148 # define XML_CIB_TAG_ALERTS "alerts"
149 # define XML_CIB_TAG_ALERT "alert"
150 # define XML_CIB_TAG_ALERT_RECIPIENT "recipient"
151 # define XML_CIB_TAG_ALERT_SELECT "select"
152 # define XML_CIB_TAG_ALERT_ATTRIBUTES "select_attributes"
153 # define XML_CIB_TAG_ALERT_FENCING "select_fencing"
154 # define XML_CIB_TAG_ALERT_NODES "select_nodes"
155 # define XML_CIB_TAG_ALERT_RESOURCES "select_resources"
156 # define XML_CIB_TAG_ALERT_ATTR "attribute"
157 
158 # define XML_CIB_TAG_STATE "node_state"
159 # define XML_CIB_TAG_NODE "node"
160 # define XML_CIB_TAG_NVPAIR "nvpair"
161 
162 # define XML_CIB_TAG_PROPSET "cluster_property_set"
163 # define XML_TAG_ATTR_SETS "instance_attributes"
164 # define XML_TAG_META_SETS "meta_attributes"
165 # define XML_TAG_ATTRS "attributes"
166 # define XML_TAG_RSC_VER_ATTRS "rsc_versioned_attrs"
167 # define XML_TAG_OP_VER_ATTRS "op_versioned_attrs"
168 # define XML_TAG_OP_VER_META "op_versioned_meta"
169 # define XML_TAG_PARAMS "parameters"
170 # define XML_TAG_PARAM "param"
171 # define XML_TAG_UTILIZATION "utilization"
172 
173 # define XML_TAG_RESOURCE_REF "resource_ref"
174 # define XML_CIB_TAG_RESOURCE "primitive"
175 # define XML_CIB_TAG_GROUP "group"
176 # define XML_CIB_TAG_INCARNATION "clone"
177 # define XML_CIB_TAG_MASTER "master" // deprecated since 2.0.0
178 # define XML_CIB_TAG_CONTAINER "bundle"
179 
180 # define XML_CIB_TAG_RSC_TEMPLATE "template"
181 
182 # define XML_RSC_ATTR_TARGET "container-attribute-target"
183 # define XML_RSC_ATTR_RESTART "restart-type"
184 # define XML_RSC_ATTR_ORDERED "ordered"
185 # define XML_RSC_ATTR_INTERLEAVE "interleave"
186 # define XML_RSC_ATTR_INCARNATION "clone"
187 # define XML_RSC_ATTR_INCARNATION_MAX "clone-max"
188 # define XML_RSC_ATTR_INCARNATION_MIN "clone-min"
189 # define XML_RSC_ATTR_INCARNATION_NODEMAX "clone-node-max"
190 # define XML_RSC_ATTR_PROMOTABLE "promotable"
191 # define XML_RSC_ATTR_PROMOTED_MAX "promoted-max"
192 # define XML_RSC_ATTR_PROMOTED_NODEMAX "promoted-node-max"
193 # define XML_RSC_ATTR_MASTER_MAX "master-max" // deprecated since 2.0.0
194 # define XML_RSC_ATTR_MASTER_NODEMAX "master-node-max" // deprecated since 2.0.0
195 # define XML_RSC_ATTR_MANAGED "is-managed"
196 # define XML_RSC_ATTR_TARGET_ROLE "target-role"
197 # define XML_RSC_ATTR_UNIQUE "globally-unique"
198 # define XML_RSC_ATTR_NOTIFY "notify"
199 # define XML_RSC_ATTR_STICKINESS "resource-stickiness"
200 # define XML_RSC_ATTR_FAIL_STICKINESS "migration-threshold"
201 # define XML_RSC_ATTR_FAIL_TIMEOUT "failure-timeout"
202 # define XML_RSC_ATTR_MULTIPLE "multiple-active"
203 # define XML_RSC_ATTR_REQUIRES "requires"
204 # define XML_RSC_ATTR_PROVIDES "provides"
205 # define XML_RSC_ATTR_CONTAINER "container"
206 # define XML_RSC_ATTR_INTERNAL_RSC "internal_rsc"
207 # define XML_RSC_ATTR_MAINTENANCE "maintenance"
208 # define XML_RSC_ATTR_REMOTE_NODE "remote-node"
209 # define XML_RSC_ATTR_CLEAR_OP "clear_failure_op"
210 # define XML_RSC_ATTR_CLEAR_INTERVAL "clear_failure_interval"
211 # define XML_RSC_ATTR_REMOTE_RA_ADDR "addr"
212 # define XML_RSC_ATTR_REMOTE_RA_SERVER "server"
213 # define XML_RSC_ATTR_REMOTE_RA_PORT "port"
214 
215 # define XML_REMOTE_ATTR_RECONNECT_INTERVAL "reconnect_interval"
216 
217 # define XML_OP_ATTR_ON_FAIL "on-fail"
218 # define XML_OP_ATTR_START_DELAY "start-delay"
219 # define XML_OP_ATTR_ALLOW_MIGRATE "allow-migrate"
220 # define XML_OP_ATTR_ORIGIN "interval-origin"
221 # define XML_OP_ATTR_PENDING "record-pending"
222 # define XML_OP_ATTR_DIGESTS_ALL "digests-all"
223 # define XML_OP_ATTR_DIGESTS_SECURE "digests-secure"
224 
225 # define XML_CIB_TAG_LRM "lrm"
226 # define XML_LRM_TAG_RESOURCES "lrm_resources"
227 # define XML_LRM_TAG_RESOURCE "lrm_resource"
228 # define XML_LRM_TAG_RSC_OP "lrm_rsc_op"
229 # define XML_AGENT_ATTR_CLASS "class"
230 # define XML_AGENT_ATTR_PROVIDER "provider"
231 
232 # define XML_CIB_ATTR_REPLACE "replace"
233 # define XML_CIB_ATTR_SOURCE "source"
234 
235 # define XML_CIB_ATTR_PRIORITY "priority"
236 # define XML_CIB_ATTR_SOURCE "source"
237 
238 # define XML_NODE_JOIN_STATE "join"
239 # define XML_NODE_EXPECTED "expected"
240 # define XML_NODE_IN_CLUSTER "in_ccm"
241 # define XML_NODE_IS_PEER "crmd"
242 # define XML_NODE_IS_REMOTE "remote_node"
243 # define XML_NODE_IS_FENCED "node_fenced"
244 # define XML_NODE_IS_MAINTENANCE "node_in_maintenance"
245 
246 # define XML_CIB_ATTR_SHUTDOWN "shutdown"
247 
248 /* Aside from being an old name for the executor, LRM is a misnomer here because
249  * the controller and scheduler use these to track actions, which are not always
250  * executor operations.
251  */
252 
253 // XML attribute that takes interval specification (user-facing configuration)
254 # define XML_LRM_ATTR_INTERVAL "interval"
255 
256 // XML attribute that takes interval in milliseconds (daemon APIs)
257 // (identical value as above, but different constant allows clearer code intent)
258 # define XML_LRM_ATTR_INTERVAL_MS XML_LRM_ATTR_INTERVAL
259 
260 # define XML_LRM_ATTR_TASK "operation"
261 # define XML_LRM_ATTR_TASK_KEY "operation_key"
262 # define XML_LRM_ATTR_TARGET "on_node"
263 # define XML_LRM_ATTR_TARGET_UUID "on_node_uuid"
264 
268 # define XML_LRM_ATTR_ROUTER_NODE "router_node"
269 # define XML_LRM_ATTR_RSCID "rsc-id"
270 # define XML_LRM_ATTR_OPSTATUS "op-status"
271 # define XML_LRM_ATTR_RC "rc-code"
272 # define XML_LRM_ATTR_CALLID "call-id"
273 # define XML_LRM_ATTR_OP_DIGEST "op-digest"
274 # define XML_LRM_ATTR_OP_RESTART "op-force-restart"
275 # define XML_LRM_ATTR_OP_SECURE "op-secure-params"
276 # define XML_LRM_ATTR_RESTART_DIGEST "op-restart-digest"
277 # define XML_LRM_ATTR_SECURE_DIGEST "op-secure-digest"
278 # define XML_LRM_ATTR_EXIT_REASON "exit-reason"
279 
280 # define XML_RSC_OP_LAST_CHANGE "last-rc-change"
281 # define XML_RSC_OP_LAST_RUN "last-run" // deprecated since 2.0.3
282 # define XML_RSC_OP_T_EXEC "exec-time"
283 # define XML_RSC_OP_T_QUEUE "queue-time"
284 
285 # define XML_LRM_ATTR_MIGRATE_SOURCE "migrate_source"
286 # define XML_LRM_ATTR_MIGRATE_TARGET "migrate_target"
287 
288 # define XML_TAG_GRAPH "transition_graph"
289 # define XML_GRAPH_TAG_RSC_OP "rsc_op"
290 # define XML_GRAPH_TAG_PSEUDO_EVENT "pseudo_event"
291 # define XML_GRAPH_TAG_CRM_EVENT "crm_event"
292 # define XML_GRAPH_TAG_DOWNED "downed"
293 # define XML_GRAPH_TAG_MAINTENANCE "maintenance"
294 
295 # define XML_TAG_RULE "rule"
296 # define XML_RULE_ATTR_SCORE "score"
297 # define XML_RULE_ATTR_SCORE_ATTRIBUTE "score-attribute"
298 # define XML_RULE_ATTR_ROLE "role"
299 # define XML_RULE_ATTR_BOOLEAN_OP "boolean-op"
300 
301 # define XML_TAG_EXPRESSION "expression"
302 # define XML_EXPR_ATTR_ATTRIBUTE "attribute"
303 # define XML_EXPR_ATTR_OPERATION "operation"
304 # define XML_EXPR_ATTR_VALUE "value"
305 # define XML_EXPR_ATTR_TYPE "type"
306 # define XML_EXPR_ATTR_VALUE_SOURCE "value-source"
307 
308 # define XML_CONS_TAG_RSC_DEPEND "rsc_colocation"
309 # define XML_CONS_TAG_RSC_ORDER "rsc_order"
310 # define XML_CONS_TAG_RSC_LOCATION "rsc_location"
311 # define XML_CONS_TAG_RSC_TICKET "rsc_ticket"
312 # define XML_CONS_TAG_RSC_SET "resource_set"
313 # define XML_CONS_ATTR_SYMMETRICAL "symmetrical"
314 
315 # define XML_LOCATION_ATTR_DISCOVERY "resource-discovery"
316 
317 # define XML_COLOC_ATTR_SOURCE "rsc"
318 # define XML_COLOC_ATTR_SOURCE_ROLE "rsc-role"
319 # define XML_COLOC_ATTR_TARGET "with-rsc"
320 # define XML_COLOC_ATTR_TARGET_ROLE "with-rsc-role"
321 # define XML_COLOC_ATTR_NODE_ATTR "node-attribute"
322 # define XML_COLOC_ATTR_SOURCE_INSTANCE "rsc-instance"
323 # define XML_COLOC_ATTR_TARGET_INSTANCE "with-rsc-instance"
324 
325 # define XML_LOC_ATTR_SOURCE "rsc"
326 # define XML_LOC_ATTR_SOURCE_PATTERN "rsc-pattern"
327 
328 # define XML_ORDER_ATTR_FIRST "first"
329 # define XML_ORDER_ATTR_THEN "then"
330 # define XML_ORDER_ATTR_FIRST_ACTION "first-action"
331 # define XML_ORDER_ATTR_THEN_ACTION "then-action"
332 # define XML_ORDER_ATTR_FIRST_INSTANCE "first-instance"
333 # define XML_ORDER_ATTR_THEN_INSTANCE "then-instance"
334 # define XML_ORDER_ATTR_KIND "kind"
335 
336 # define XML_TICKET_ATTR_TICKET "ticket"
337 # define XML_TICKET_ATTR_LOSS_POLICY "loss-policy"
338 
339 # define XML_NVPAIR_ATTR_NAME "name"
340 # define XML_NVPAIR_ATTR_VALUE "value"
341 
342 # define XML_NODE_ATTR_RSC_DISCOVERY "resource-discovery-enabled"
343 
344 # define XML_CONFIG_ATTR_DC_DEADTIME "dc-deadtime"
345 # define XML_CONFIG_ATTR_ELECTION_FAIL "election-timeout"
346 # define XML_CONFIG_ATTR_FORCE_QUIT "shutdown-escalation"
347 # define XML_CONFIG_ATTR_RECHECK "cluster-recheck-interval"
348 # define XML_CONFIG_ATTR_FENCE_REACTION "fence-reaction"
349 # define XML_CONFIG_ATTR_SHUTDOWN_LOCK "shutdown-lock"
350 # define XML_CONFIG_ATTR_SHUTDOWN_LOCK_LIMIT "shutdown-lock-limit"
351 # define XML_CONFIG_ATTR_PRIORITY_FENCING_DELAY "priority-fencing-delay"
352 
353 # define XML_ALERT_ATTR_PATH "path"
354 # define XML_ALERT_ATTR_TIMEOUT "timeout"
355 # define XML_ALERT_ATTR_TSTAMP_FORMAT "timestamp-format"
356 # define XML_ALERT_ATTR_REC_VALUE "value"
357 
358 # define XML_CIB_TAG_GENERATION_TUPPLE "generation_tuple"
359 
360 # define XML_ATTR_TRANSITION_MAGIC "transition-magic"
361 # define XML_ATTR_TRANSITION_KEY "transition-key"
362 
363 # define XML_ATTR_TE_NOWAIT "op_no_wait"
364 # define XML_ATTR_TE_TARGET_RC "op_target_rc"
365 # define XML_TAG_TRANSIENT_NODEATTRS "transient_attributes"
366 
367 # define XML_TAG_DIFF_ADDED "diff-added"
368 # define XML_TAG_DIFF_REMOVED "diff-removed"
369 
370 # define XML_ACL_TAG_USER "acl_target"
371 # define XML_ACL_TAG_USERv1 "acl_user"
372 # define XML_ACL_TAG_GROUP "acl_group"
373 # define XML_ACL_TAG_ROLE "acl_role"
374 # define XML_ACL_TAG_PERMISSION "acl_permission"
375 # define XML_ACL_TAG_ROLE_REF "role"
376 # define XML_ACL_TAG_ROLE_REFv1 "role_ref"
377 # define XML_ACL_ATTR_KIND "kind"
378 # define XML_ACL_TAG_READ "read"
379 # define XML_ACL_TAG_WRITE "write"
380 # define XML_ACL_TAG_DENY "deny"
381 # define XML_ACL_ATTR_REF "reference"
382 # define XML_ACL_ATTR_REFv1 "ref"
383 # define XML_ACL_ATTR_TAG "object-type"
384 # define XML_ACL_ATTR_TAGv1 "tag"
385 # define XML_ACL_ATTR_XPATH "xpath"
386 # define XML_ACL_ATTR_ATTRIBUTE "attribute"
387 
388 # define XML_CIB_TAG_TICKETS "tickets"
389 # define XML_CIB_TAG_TICKET_STATE "ticket_state"
390 
391 # define XML_CIB_TAG_TAGS "tags"
392 # define XML_CIB_TAG_TAG "tag"
393 # define XML_CIB_TAG_OBJ_REF "obj_ref"
394 
395 # define XML_TAG_FENCING_TOPOLOGY "fencing-topology"
396 # define XML_TAG_FENCING_LEVEL "fencing-level"
397 # define XML_ATTR_STONITH_INDEX "index"
398 # define XML_ATTR_STONITH_TARGET "target"
399 # define XML_ATTR_STONITH_TARGET_VALUE "target-value"
400 # define XML_ATTR_STONITH_TARGET_PATTERN "target-pattern"
401 # define XML_ATTR_STONITH_TARGET_ATTRIBUTE "target-attribute"
402 # define XML_ATTR_STONITH_DEVICES "devices"
403 
404 # define XML_TAG_DIFF "diff"
405 # define XML_DIFF_VERSION "version"
406 # define XML_DIFF_VSOURCE "source"
407 # define XML_DIFF_VTARGET "target"
408 # define XML_DIFF_CHANGE "change"
409 # define XML_DIFF_LIST "change-list"
410 # define XML_DIFF_ATTR "change-attr"
411 # define XML_DIFF_RESULT "change-result"
412 # define XML_DIFF_OP "operation"
413 # define XML_DIFF_PATH "path"
414 # define XML_DIFF_POSITION "position"
415 
416 # include <crm/common/xml.h>
417 
418 # define ID(x) crm_element_value(x, XML_ATTR_ID)
419 # define TYPE(x) crm_element_name(x)
420 
421 #ifdef __cplusplus
422 }
423 #endif
424 
425 #endif
Wrappers for and extensions to libxml2.