pacemaker  1.1.17-b36b869ca8
Scalable High-Availability cluster resource manager
msg_xml.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2004 Andrew Beekhof <andrew@beekhof.net>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This software is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 #ifndef XML_TAGS__H
19 # define XML_TAGS__H
20 
21 # ifndef F_ORIG
22 # define F_ORIG "src"
23 # endif
24 
25 # ifndef F_SEQ
26 # define F_SEQ "seq"
27 # endif
28 
29 # ifndef F_SUBTYPE
30 # define F_SUBTYPE "subt"
31 # endif
32 
33 # ifndef F_TYPE
34 # define F_TYPE "t"
35 # endif
36 
37 # ifndef F_CLIENTNAME
38 # define F_CLIENTNAME "cn"
39 # endif
40 
41 # ifndef F_XML_TAGNAME
42 # define F_XML_TAGNAME "__name__"
43 # endif
44 
45 # ifndef T_CRM
46 # define T_CRM "crmd"
47 # endif
48 
49 # ifndef T_ATTRD
50 # define T_ATTRD "attrd"
51 # endif
52 
53 # define CIB_OPTIONS_FIRST "cib-bootstrap-options"
54 
55 # define F_CRM_DATA "crm_xml"
56 # define F_CRM_TASK "crm_task"
57 # define F_CRM_HOST_TO "crm_host_to"
58 # define F_CRM_MSG_TYPE F_SUBTYPE
59 # define F_CRM_SYS_TO "crm_sys_to"
60 # define F_CRM_SYS_FROM "crm_sys_from"
61 # define F_CRM_HOST_FROM F_ORIG
62 # define F_CRM_REFERENCE XML_ATTR_REFERENCE
63 # define F_CRM_VERSION XML_ATTR_VERSION
64 # define F_CRM_ORIGIN "origin"
65 # define F_CRM_USER "crm_user"
66 # define F_CRM_JOIN_ID "join_id"
67 # define F_CRM_DC_LEAVING "dc-leaving"
68 # define F_CRM_ELECTION_ID "election-id"
69 # define F_CRM_ELECTION_AGE_S "election-age-sec"
70 # define F_CRM_ELECTION_AGE_US "election-age-nano-sec"
71 # define F_CRM_ELECTION_OWNER "election-owner"
72 # define F_CRM_TGRAPH "crm-tgraph"
73 # define F_CRM_TGRAPH_INPUT "crm-tgraph-in"
74 
75 # define F_CRM_THROTTLE_MODE "crm-limit-mode"
76 # define F_CRM_THROTTLE_MAX "crm-limit-max"
77 
78 /*---- Common tags/attrs */
79 # define XML_DIFF_MARKER "__crm_diff_marker__"
80 # define XML_ATTR_TAGNAME F_XML_TAGNAME
81 # define XML_TAG_CIB "cib"
82 # define XML_TAG_FAILED "failed"
83 
84 # define XML_ATTR_CRM_VERSION "crm_feature_set"
85 # define XML_ATTR_DIGEST "digest"
86 # define XML_ATTR_VALIDATION "validate-with"
87 
88 # define XML_ATTR_QUORUM_PANIC "no-quorum-panic"
89 # define XML_ATTR_HAVE_QUORUM "have-quorum"
90 # define XML_ATTR_HAVE_WATCHDOG "have-watchdog"
91 # define XML_ATTR_EXPECTED_VOTES "expected-quorum-votes"
92 # define XML_ATTR_GENERATION "epoch"
93 # define XML_ATTR_GENERATION_ADMIN "admin_epoch"
94 # define XML_ATTR_NUMUPDATES "num_updates"
95 # define XML_ATTR_TIMEOUT "timeout"
96 # define XML_ATTR_ORIGIN "crm-debug-origin"
97 # define XML_ATTR_TSTAMP "crm-timestamp"
98 # define XML_CIB_ATTR_WRITTEN "cib-last-written"
99 # define XML_ATTR_VERSION "version"
100 # define XML_ATTR_DESC "description"
101 # define XML_ATTR_ID "id"
102 # define XML_ATTR_IDREF "id-ref"
103 # define XML_ATTR_ID_LONG "long-id"
104 # define XML_ATTR_TYPE "type"
105 # define XML_ATTR_FILTER_TYPE "type-filter"
106 # define XML_ATTR_FILTER_ID "id-filter"
107 # define XML_ATTR_FILTER_PRIORITY "priority-filter"
108 # define XML_ATTR_VERBOSE "verbose"
109 # define XML_ATTR_OP "op"
110 # define XML_ATTR_DC "is_dc"
111 # define XML_ATTR_DC_UUID "dc-uuid"
112 # define XML_ATTR_UPDATE_ORIG "update-origin"
113 # define XML_ATTR_UPDATE_CLIENT "update-client"
114 # define XML_ATTR_UPDATE_USER "update-user"
115 
116 # define XML_BOOLEAN_TRUE "true"
117 # define XML_BOOLEAN_FALSE "false"
118 # define XML_BOOLEAN_YES XML_BOOLEAN_TRUE
119 # define XML_BOOLEAN_NO XML_BOOLEAN_FALSE
120 
121 # define XML_TAG_OPTIONS "options"
122 
123 /*---- top level tags/attrs */
124 # define XML_MSG_TAG "crm_message"
125 # define XML_MSG_TAG_DATA "msg_data"
126 # define XML_ATTR_REQUEST "request"
127 # define XML_ATTR_RESPONSE "response"
128 
129 # define XML_ATTR_UNAME "uname"
130 # define XML_ATTR_UUID "id"
131 # define XML_ATTR_REFERENCE "reference"
132 
133 # define XML_FAIL_TAG_RESOURCE "failed_resource"
134 
135 # define XML_FAILRES_ATTR_RESID "resource_id"
136 # define XML_FAILRES_ATTR_REASON "reason"
137 # define XML_FAILRES_ATTR_RESSTATUS "resource_status"
138 
139 # define XML_CRM_TAG_PING "ping_response"
140 # define XML_PING_ATTR_STATUS "result"
141 # define XML_PING_ATTR_SYSFROM "crm_subsystem"
142 
143 # define XML_TAG_FRAGMENT "cib_fragment"
144 # define XML_ATTR_RESULT "result"
145 # define XML_ATTR_SECTION "section"
146 
147 # define XML_FAIL_TAG_CIB "failed_update"
148 
149 # define XML_FAILCIB_ATTR_ID "id"
150 # define XML_FAILCIB_ATTR_OBJTYPE "object_type"
151 # define XML_FAILCIB_ATTR_OP "operation"
152 # define XML_FAILCIB_ATTR_REASON "reason"
153 
154 /*---- CIB specific tags/attrs */
155 # define XML_CIB_TAG_SECTION_ALL "all"
156 # define XML_CIB_TAG_CONFIGURATION "configuration"
157 # define XML_CIB_TAG_STATUS "status"
158 # define XML_CIB_TAG_RESOURCES "resources"
159 # define XML_CIB_TAG_NODES "nodes"
160 # define XML_CIB_TAG_DOMAINS "domains"
161 # define XML_CIB_TAG_CONSTRAINTS "constraints"
162 # define XML_CIB_TAG_CRMCONFIG "crm_config"
163 # define XML_CIB_TAG_OPCONFIG "op_defaults"
164 # define XML_CIB_TAG_RSCCONFIG "rsc_defaults"
165 # define XML_CIB_TAG_ACLS "acls"
166 # define XML_CIB_TAG_ALERTS "alerts"
167 # define XML_CIB_TAG_ALERT "alert"
168 # define XML_CIB_TAG_ALERT_RECIPIENT "recipient"
169 
170 # define XML_CIB_TAG_STATE "node_state"
171 # define XML_CIB_TAG_NODE "node"
172 # define XML_CIB_TAG_DOMAIN "domain"
173 # define XML_CIB_TAG_CONSTRAINT "constraint"
174 # define XML_CIB_TAG_NVPAIR "nvpair"
175 
176 # define XML_CIB_TAG_PROPSET "cluster_property_set"
177 # define XML_TAG_ATTR_SETS "instance_attributes"
178 # define XML_TAG_META_SETS "meta_attributes"
179 # define XML_TAG_ATTRS "attributes"
180 #ifdef ENABLE_VERSIONED_ATTRS
181 # define XML_TAG_VER_ATTRS "versioned_attributes"
182 #endif
183 # define XML_TAG_PARAMS "parameters"
184 # define XML_TAG_PARAM "param"
185 # define XML_TAG_UTILIZATION "utilization"
186 
187 # define XML_TAG_RESOURCE_REF "resource_ref"
188 # define XML_CIB_TAG_RESOURCE "primitive"
189 # define XML_CIB_TAG_GROUP "group"
190 # define XML_CIB_TAG_INCARNATION "clone"
191 # define XML_CIB_TAG_MASTER "master"
192 # define XML_CIB_TAG_CONTAINER "bundle"
193 
194 # define XML_CIB_TAG_RSC_TEMPLATE "template"
195 
196 # define XML_RSC_ATTR_ISOLATION_INSTANCE "isolation-instance"
197 # define XML_RSC_ATTR_ISOLATION_WRAPPER "isolation-wrapper"
198 # define XML_RSC_ATTR_ISOLATION_HOST "isolation-host"
199 # define XML_RSC_ATTR_ISOLATION "isolation"
200 # define XML_RSC_ATTR_RESTART "restart-type"
201 # define XML_RSC_ATTR_ORDERED "ordered"
202 # define XML_RSC_ATTR_INTERLEAVE "interleave"
203 # define XML_RSC_ATTR_INCARNATION "clone"
204 # define XML_RSC_ATTR_INCARNATION_MAX "clone-max"
205 # define XML_RSC_ATTR_INCARNATION_MIN "clone-min"
206 # define XML_RSC_ATTR_INCARNATION_NODEMAX "clone-node-max"
207 # define XML_RSC_ATTR_MASTER_MAX "master-max"
208 # define XML_RSC_ATTR_MASTER_NODEMAX "master-node-max"
209 # define XML_RSC_ATTR_STATE "clone-state"
210 # define XML_RSC_ATTR_MANAGED "is-managed"
211 # define XML_RSC_ATTR_TARGET_ROLE "target-role"
212 # define XML_RSC_ATTR_UNIQUE "globally-unique"
213 # define XML_RSC_ATTR_NOTIFY "notify"
214 # define XML_RSC_ATTR_STICKINESS "resource-stickiness"
215 # define XML_RSC_ATTR_FAIL_STICKINESS "migration-threshold"
216 # define XML_RSC_ATTR_FAIL_TIMEOUT "failure-timeout"
217 # define XML_RSC_ATTR_MULTIPLE "multiple-active"
218 # define XML_RSC_ATTR_PRIORITY "priority"
219 # define XML_RSC_ATTR_REQUIRES "requires"
220 # define XML_RSC_ATTR_PROVIDES "provides"
221 # define XML_RSC_ATTR_CONTAINER "container"
222 # define XML_RSC_ATTR_INTERNAL_RSC "internal_rsc"
223 # define XML_RSC_ATTR_MAINTENANCE "maintenance"
224 # define XML_RSC_ATTR_REMOTE_NODE "remote-node"
225 # define XML_RSC_ATTR_CLEAR_OP "clear_failure_op"
226 # define XML_RSC_ATTR_CLEAR_INTERVAL "clear_failure_interval"
227 
228 # define XML_REMOTE_ATTR_RECONNECT_INTERVAL "reconnect_interval"
229 
230 # define XML_OP_ATTR_ON_FAIL "on-fail"
231 # define XML_OP_ATTR_START_DELAY "start-delay"
232 # define XML_OP_ATTR_ALLOW_MIGRATE "allow-migrate"
233 # define XML_OP_ATTR_DEPENDENT "dependent-on"
234 # define XML_OP_ATTR_ORIGIN "interval-origin"
235 # define XML_OP_ATTR_PENDING "record-pending"
236 
237 # define XML_CIB_TAG_LRM "lrm"
238 # define XML_LRM_TAG_RESOURCES "lrm_resources"
239 # define XML_LRM_TAG_RESOURCE "lrm_resource"
240 # define XML_LRM_TAG_AGENTS "lrm_agents"
241 # define XML_LRM_TAG_AGENT "lrm_agent"
242 # define XML_LRM_TAG_RSC_OP "lrm_rsc_op"
243 # define XML_AGENT_ATTR_CLASS "class"
244 # define XML_AGENT_ATTR_PROVIDER "provider"
245 # define XML_LRM_TAG_ATTRIBUTES "attributes"
246 
247 # define XML_CIB_ATTR_REPLACE "replace"
248 # define XML_CIB_ATTR_SOURCE "source"
249 
250 # define XML_CIB_ATTR_HEALTH "health"
251 # define XML_CIB_ATTR_WEIGHT "weight"
252 # define XML_CIB_ATTR_PRIORITY "priority"
253 # define XML_CIB_ATTR_CLEAR "clear_on"
254 # define XML_CIB_ATTR_SOURCE "source"
255 
256 # define XML_NODE_JOIN_STATE "join"
257 # define XML_NODE_EXPECTED "expected"
258 # define XML_NODE_IN_CLUSTER "in_ccm"
259 # define XML_NODE_IS_PEER "crmd"
260 # define XML_NODE_IS_REMOTE "remote_node"
261 # define XML_NODE_IS_FENCED "node_fenced"
262 # define XML_NODE_IS_MAINTENANCE "node_in_maintenance"
263 
264 # define XML_CIB_ATTR_SHUTDOWN "shutdown"
265 # define XML_CIB_ATTR_STONITH "stonith"
266 # define XML_CIB_ATTR_STANDBY "standby"
267 
268 /* LRM is a bit of a misnomer here; the crmd and pengine use these to track
269  * actions, which usually but not always are LRM operations
270  */
271 # define XML_LRM_ATTR_INTERVAL "interval"
272 # define XML_LRM_ATTR_TASK "operation"
273 # define XML_LRM_ATTR_TASK_KEY "operation_key"
274 # define XML_LRM_ATTR_TARGET "on_node"
275 # define XML_LRM_ATTR_TARGET_UUID "on_node_uuid"
276 
280 # define XML_LRM_ATTR_ROUTER_NODE "router_node"
281 # define XML_LRM_ATTR_RSCID "rsc-id"
282 # define XML_LRM_ATTR_OPSTATUS "op-status"
283 # define XML_LRM_ATTR_RC "rc-code"
284 # define XML_LRM_ATTR_CALLID "call-id"
285 # define XML_LRM_ATTR_OP_DIGEST "op-digest"
286 # define XML_LRM_ATTR_OP_RESTART "op-force-restart"
287 # define XML_LRM_ATTR_OP_SECURE "op-secure-params"
288 # define XML_LRM_ATTR_RESTART_DIGEST "op-restart-digest"
289 # define XML_LRM_ATTR_SECURE_DIGEST "op-secure-digest"
290 # define XML_LRM_ATTR_EXIT_REASON "exit-reason"
291 
292 # define XML_RSC_OP_LAST_CHANGE "last-rc-change"
293 # define XML_RSC_OP_LAST_RUN "last-run"
294 # define XML_RSC_OP_T_EXEC "exec-time"
295 # define XML_RSC_OP_T_QUEUE "queue-time"
296 
297 # define XML_LRM_ATTR_MIGRATE_SOURCE "migrate_source"
298 # define XML_LRM_ATTR_MIGRATE_TARGET "migrate_target"
299 
300 # define XML_TAG_GRAPH "transition_graph"
301 # define XML_GRAPH_TAG_RSC_OP "rsc_op"
302 # define XML_GRAPH_TAG_PSEUDO_EVENT "pseudo_event"
303 # define XML_GRAPH_TAG_CRM_EVENT "crm_event"
304 # define XML_GRAPH_TAG_DOWNED "downed"
305 # define XML_GRAPH_TAG_MAINTENANCE "maintenance"
306 
307 # define XML_TAG_RULE "rule"
308 # define XML_RULE_ATTR_SCORE "score"
309 # define XML_RULE_ATTR_SCORE_ATTRIBUTE "score-attribute"
310 /* following has no use (hardly ever meaningful); kept for compatibility */
311 # define XML_RULE_ATTR_SCORE_MANGLED "score-attribute-mangled"
312 # define XML_RULE_ATTR_ROLE "role"
313 # define XML_RULE_ATTR_RESULT "result"
314 # define XML_RULE_ATTR_BOOLEAN_OP "boolean-op"
315 
316 # define XML_TAG_EXPRESSION "expression"
317 # define XML_EXPR_ATTR_ATTRIBUTE "attribute"
318 # define XML_EXPR_ATTR_OPERATION "operation"
319 # define XML_EXPR_ATTR_VALUE "value"
320 # define XML_EXPR_ATTR_TYPE "type"
321 # define XML_EXPR_ATTR_VALUE_SOURCE "value-source"
322 
323 # define XML_CONS_TAG_RSC_DEPEND "rsc_colocation"
324 # define XML_CONS_TAG_RSC_ORDER "rsc_order"
325 # define XML_CONS_TAG_RSC_LOCATION "rsc_location"
326 # define XML_CONS_TAG_RSC_TICKET "rsc_ticket"
327 # define XML_CONS_TAG_RSC_SET "resource_set"
328 # define XML_CONS_ATTR_SYMMETRICAL "symmetrical"
329 
330 # define XML_LOCATION_ATTR_DISCOVERY "resource-discovery"
331 
332 # define XML_COLOC_ATTR_SOURCE "rsc"
333 # define XML_COLOC_ATTR_SOURCE_ROLE "rsc-role"
334 # define XML_COLOC_ATTR_TARGET "with-rsc"
335 # define XML_COLOC_ATTR_TARGET_ROLE "with-rsc-role"
336 # define XML_COLOC_ATTR_NODE_ATTR "node-attribute"
337 # define XML_COLOC_ATTR_SOURCE_INSTANCE "rsc-instance"
338 # define XML_COLOC_ATTR_TARGET_INSTANCE "with-rsc-instance"
339 
340 # define XML_LOC_ATTR_SOURCE "rsc"
341 # define XML_LOC_ATTR_SOURCE_PATTERN "rsc-pattern"
342 
343 # define XML_ORDER_ATTR_FIRST "first"
344 # define XML_ORDER_ATTR_THEN "then"
345 # define XML_ORDER_ATTR_FIRST_ACTION "first-action"
346 # define XML_ORDER_ATTR_THEN_ACTION "then-action"
347 # define XML_ORDER_ATTR_FIRST_INSTANCE "first-instance"
348 # define XML_ORDER_ATTR_THEN_INSTANCE "then-instance"
349 # define XML_ORDER_ATTR_KIND "kind"
350 
351 # define XML_TICKET_ATTR_TICKET "ticket"
352 # define XML_TICKET_ATTR_LOSS_POLICY "loss-policy"
353 
354 # define XML_NVPAIR_ATTR_NAME "name"
355 # define XML_NVPAIR_ATTR_VALUE "value"
356 
357 # define XML_NODE_ATTR_STATE "state"
358 # define XML_NODE_ATTR_RSC_DISCOVERY "resource-discovery-enabled"
359 
360 # define XML_CONFIG_ATTR_DC_DEADTIME "dc-deadtime"
361 # define XML_CONFIG_ATTR_ELECTION_FAIL "election-timeout"
362 # define XML_CONFIG_ATTR_FORCE_QUIT "shutdown-escalation"
363 # define XML_CONFIG_ATTR_RECHECK "cluster-recheck-interval"
364 
365 # define XML_ALERT_ATTR_PATH "path"
366 # define XML_ALERT_ATTR_TIMEOUT "timeout"
367 # define XML_ALERT_ATTR_TSTAMP_FORMAT "timestamp-format"
368 # define XML_ALERT_ATTR_REC_VALUE "value"
369 
370 # define XML_CIB_TAG_GENERATION_TUPPLE "generation_tuple"
371 
372 # define XML_ATTR_TRANSITION_MAGIC "transition-magic"
373 # define XML_ATTR_TRANSITION_KEY "transition-key"
374 
375 # define XML_ATTR_TE_NOWAIT "op_no_wait"
376 # define XML_ATTR_TE_TARGET_RC "op_target_rc"
377 # define XML_ATTR_LRM_PROBE "lrm-is-probe"
378 # define XML_TAG_TRANSIENT_NODEATTRS "transient_attributes"
379 
380 # define XML_TAG_DIFF_ADDED "diff-added"
381 # define XML_TAG_DIFF_REMOVED "diff-removed"
382 
383 # define XML_ACL_TAG_USER "acl_target"
384 # define XML_ACL_TAG_USERv1 "acl_user"
385 # define XML_ACL_TAG_GROUP "acl_group"
386 # define XML_ACL_TAG_ROLE "acl_role"
387 # define XML_ACL_TAG_PERMISSION "acl_permission"
388 # define XML_ACL_TAG_ROLE_REF "role"
389 # define XML_ACL_TAG_ROLE_REFv1 "role_ref"
390 # define XML_ACL_ATTR_KIND "kind"
391 # define XML_ACL_TAG_READ "read"
392 # define XML_ACL_TAG_WRITE "write"
393 # define XML_ACL_TAG_DENY "deny"
394 # define XML_ACL_ATTR_REF "reference"
395 # define XML_ACL_ATTR_REFv1 "ref"
396 # define XML_ACL_ATTR_TAG "object-type"
397 # define XML_ACL_ATTR_TAGv1 "tag"
398 # define XML_ACL_ATTR_XPATH "xpath"
399 # define XML_ACL_ATTR_ATTRIBUTE "attribute"
400 
401 # define XML_CIB_TAG_TICKETS "tickets"
402 # define XML_CIB_TAG_TICKET_STATE "ticket_state"
403 
404 # define XML_CIB_TAG_TAGS "tags"
405 # define XML_CIB_TAG_TAG "tag"
406 # define XML_CIB_TAG_OBJ_REF "obj_ref"
407 
408 # define XML_TAG_FENCING_TOPOLOGY "fencing-topology"
409 # define XML_TAG_FENCING_LEVEL "fencing-level"
410 # define XML_ATTR_STONITH_INDEX "index"
411 # define XML_ATTR_STONITH_TARGET "target"
412 # define XML_ATTR_STONITH_TARGET_VALUE "target-value"
413 # define XML_ATTR_STONITH_TARGET_PATTERN "target-pattern"
414 # define XML_ATTR_STONITH_TARGET_ATTRIBUTE "target-attribute"
415 # define XML_ATTR_STONITH_DEVICES "devices"
416 
417 # define XML_TAG_DIFF "diff"
418 # define XML_DIFF_VERSION "version"
419 # define XML_DIFF_VSOURCE "source"
420 # define XML_DIFF_VTARGET "target"
421 # define XML_DIFF_CHANGE "change"
422 # define XML_DIFF_LIST "change-list"
423 # define XML_DIFF_ATTR "change-attr"
424 # define XML_DIFF_RESULT "change-result"
425 # define XML_DIFF_OP "operation"
426 # define XML_DIFF_PATH "path"
427 # define XML_DIFF_POSITION "position"
428 
429 /* Defined for backward API compatibility but no longer used by Pacemaker */
430 # define XML_ATTR_TE_ALLOWFAIL "op_allow_fail"
431 
432 # include <crm/common/xml.h>
433 
434 # define ID(x) crm_element_value(x, XML_ATTR_ID)
435 # define INSTANCE(x) crm_element_value(x, XML_CIB_ATTR_INSTANCE)
436 # define TSTAMP(x) crm_element_value(x, XML_ATTR_TSTAMP)
437 # define TYPE(x) crm_element_name(x)
438 # define NAME(x) crm_element_value(x, XML_NVPAIR_ATTR_NAME)
439 # define VALUE(x) crm_element_value(x, XML_NVPAIR_ATTR_VALUE)
440 
441 #endif
Wrappers for and extensions to libxml2.