This source file includes following definitions.
- add_env_params
- add_stonith_device
- add_tolerance
- add_stonith_params
- set_tag
- build_arg_context
- request_fencing
- main
1
2
3
4
5
6
7
8
9
10 #include <crm_internal.h>
11
12 #include <sys/param.h>
13 #include <stdio.h>
14 #include <sys/types.h>
15 #include <sys/stat.h>
16 #include <unistd.h>
17 #include <sys/utsname.h>
18
19 #include <errno.h>
20 #include <fcntl.h>
21 #include <stdbool.h>
22 #include <stdlib.h>
23 #include <string.h>
24
25 #include <crm/crm.h>
26 #include <crm/msg_xml.h>
27 #include <crm/common/ipc.h>
28 #include <crm/cluster/internal.h>
29 #include <crm/common/cmdline_internal.h>
30 #include <crm/common/output_internal.h>
31
32 #include <crm/stonith-ng.h>
33 #include <crm/fencing/internal.h>
34 #include <crm/cib.h>
35 #include <crm/pengine/status.h>
36
37 #include <crm/common/xml.h>
38 #include <pacemaker-internal.h>
39
40 #define SUMMARY "stonith_admin - Access the Pacemaker fencing API"
41
42 char action = 0;
43
44 struct {
45 gboolean as_nodeid;
46 gboolean broadcast;
47 gboolean cleanup;
48 gboolean installed;
49 gboolean metadata;
50 gboolean registered;
51 gboolean validate_cfg;
52 stonith_key_value_t *devices;
53 stonith_key_value_t *params;
54 int fence_level;
55 int timeout ;
56 int tolerance;
57 int delay;
58 char *agent;
59 char *confirm_host;
60 char *fence_host;
61 char *history;
62 char *last_fenced;
63 char *query;
64 char *reboot_host;
65 char *register_dev;
66 char *register_level;
67 char *targets;
68 char *terminate;
69 char *unfence_host;
70 char *unregister_dev;
71 char *unregister_level;
72 } options = {
73 .timeout = 120,
74 .delay = 0
75 };
76
77 gboolean add_env_params(const gchar *option_name, const gchar *optarg, gpointer data, GError **error);
78 gboolean add_stonith_device(const gchar *option_name, const gchar *optarg, gpointer data, GError **error);
79 gboolean add_stonith_params(const gchar *option_name, const gchar *optarg, gpointer data, GError **error);
80 gboolean add_tolerance(const gchar *option_name, const gchar *optarg, gpointer data, GError **error);
81 gboolean set_tag(const gchar *option_name, const gchar *optarg, gpointer data, GError **error);
82
83 #define INDENT " "
84
85
86 static GOptionEntry defn_entries[] = {
87 { "register", 'R', 0, G_OPTION_ARG_STRING, &options.register_dev,
88 "Register the named stonith device. Requires: --agent.\n"
89 INDENT "Optional: --option, --env-option.",
90 "DEVICE" },
91 { "deregister", 'D', 0, G_OPTION_ARG_STRING, &options.unregister_dev,
92 "De-register the named stonith device.",
93 "DEVICE" },
94 { "register-level", 'r', 0, G_OPTION_ARG_STRING, &options.register_level,
95 "Register a stonith level for the named target,\n"
96 INDENT "specified as one of NAME, @PATTERN, or ATTR=VALUE.\n"
97 INDENT "Requires: --index and one or more --device entries.",
98 "TARGET" },
99 { "deregister-level", 'd', 0, G_OPTION_ARG_STRING, &options.unregister_level,
100 "Unregister a stonith level for the named target,\n"
101 INDENT "specified as for --register-level. Requires: --index",
102 "TARGET" },
103
104 { NULL }
105 };
106
107 static GOptionEntry query_entries[] = {
108 { "list", 'l', 0, G_OPTION_ARG_STRING, &options.terminate,
109 "List devices that can terminate the specified host.\n"
110 INDENT "Optional: --timeout",
111 "HOST" },
112 { "list-registered", 'L', 0, G_OPTION_ARG_NONE, &options.registered,
113 "List all registered devices. Optional: --timeout.",
114 NULL },
115 { "list-installed", 'I', 0, G_OPTION_ARG_NONE, &options.installed,
116 "List all installed devices. Optional: --timeout.",
117 NULL },
118 { "list-targets", 's', 0, G_OPTION_ARG_STRING, &options.targets,
119 "List the targets that can be fenced by the\n"
120 INDENT "named device. Optional: --timeout.",
121 "DEVICE" },
122 { "metadata", 'M', 0, G_OPTION_ARG_NONE, &options.metadata,
123 "Show agent metadata. Requires: --agent.\n"
124 INDENT "Optional: --timeout.",
125 NULL },
126 { "query", 'Q', 0, G_OPTION_ARG_STRING, &options.query,
127 "Check the named device's status. Optional: --timeout.",
128 "DEVICE" },
129 { "history", 'H', 0, G_OPTION_ARG_STRING, &options.history,
130 "Show last successful fencing operation for named node\n"
131 INDENT "(or '*' for all nodes). Optional: --timeout, --cleanup,\n"
132 INDENT "--quiet (show only the operation's epoch timestamp),\n"
133 INDENT "--verbose (show all recorded and pending operations),\n"
134 INDENT "--broadcast (update history from all nodes available).",
135 "NODE" },
136 { "last", 'h', 0, G_OPTION_ARG_STRING, &options.last_fenced,
137 "Indicate when the named node was last fenced.\n"
138 INDENT "Optional: --as-node-id.",
139 "NODE" },
140 { "validate", 'K', 0, G_OPTION_ARG_NONE, &options.validate_cfg,
141 "Validate a fence device configuration.\n"
142 INDENT "Requires: --agent. Optional: --option, --env-option,\n"
143 INDENT "--quiet (print no output, only return status).",
144 NULL },
145
146 { NULL }
147 };
148
149 static GOptionEntry fence_entries[] = {
150 { "fence", 'F', 0, G_OPTION_ARG_STRING, &options.fence_host,
151 "Fence named host. Optional: --timeout, --tolerance, --delay.",
152 "HOST" },
153 { "unfence", 'U', 0, G_OPTION_ARG_STRING, &options.unfence_host,
154 "Unfence named host. Optional: --timeout, --tolerance, --delay.",
155 "HOST" },
156 { "reboot", 'B', 0, G_OPTION_ARG_STRING, &options.reboot_host,
157 "Reboot named host. Optional: --timeout, --tolerance, --delay.",
158 "HOST" },
159 { "confirm", 'C', 0, G_OPTION_ARG_STRING, &options.confirm_host,
160 "Tell cluster that named host is now safely down.",
161 "HOST", },
162
163 { NULL }
164 };
165
166 static GOptionEntry addl_entries[] = {
167 { "cleanup", 'c', 0, G_OPTION_ARG_NONE, &options.cleanup,
168 "Cleanup wherever appropriate. Requires --history.",
169 NULL },
170 { "broadcast", 'b', 0, G_OPTION_ARG_NONE, &options.broadcast,
171 "Broadcast wherever appropriate.",
172 NULL },
173 { "agent", 'a', 0, G_OPTION_ARG_STRING, &options.agent,
174 "The agent to use (for example, fence_xvm;\n"
175 INDENT "with --register, --metadata, --validate).",
176 "AGENT" },
177 { "option", 'o', 0, G_OPTION_ARG_CALLBACK, add_stonith_params,
178 "Specify a device configuration parameter as NAME=VALUE\n"
179 INDENT "(may be specified multiple times; with --register,\n"
180 INDENT "--validate).",
181 "PARAM" },
182 { "env-option", 'e', 0, G_OPTION_ARG_CALLBACK, add_env_params,
183 "Specify a device configuration parameter with the\n"
184 INDENT "specified name, using the value of the\n"
185 INDENT "environment variable of the same name prefixed with\n"
186 INDENT "OCF_RESKEY_ (may be specified multiple times;\n"
187 INDENT "with --register, --validate).",
188 "PARAM" },
189 { "tag", 'T', 0, G_OPTION_ARG_CALLBACK, set_tag,
190 "Identify fencing operations in logs with the specified\n"
191 INDENT "tag; useful when multiple entities might invoke\n"
192 INDENT "stonith_admin (used with most commands).",
193 "TAG" },
194 { "device", 'v', 0, G_OPTION_ARG_CALLBACK, add_stonith_device,
195 "Device ID (with --register-level, device to associate with\n"
196 INDENT "a given host and level; may be specified multiple times)"
197 #if SUPPORT_CIBSECRETS
198 "\n" INDENT "(with --validate, name to use to load CIB secrets)"
199 #endif
200 ".",
201 "DEVICE" },
202 { "index", 'i', 0, G_OPTION_ARG_INT, &options.fence_level,
203 "The stonith level (1-9) (with --register-level,\n"
204 INDENT "--deregister-level).",
205 "LEVEL" },
206 { "timeout", 't', 0, G_OPTION_ARG_INT, &options.timeout,
207 "Operation timeout in seconds (default 120;\n"
208 INDENT "used with most commands).",
209 "SECONDS" },
210 { "delay", 'y', 0, G_OPTION_ARG_INT, &options.delay,
211 "Apply a fencing delay in seconds. Any static/random delays from\n"
212 INDENT "pcmk_delay_base/max will be added, otherwise all\n"
213 INDENT "disabled with the value -1\n"
214 INDENT "(default 0; with --fence, --reboot, --unfence).",
215 "SECONDS" },
216 { "as-node-id", 'n', 0, G_OPTION_ARG_NONE, &options.as_nodeid,
217 "(Advanced) The supplied node is the corosync node ID\n"
218 INDENT "(with --last).",
219 NULL },
220 { "tolerance", 0, 0, G_OPTION_ARG_CALLBACK, add_tolerance,
221 "(Advanced) Do nothing if an equivalent --fence request\n"
222 INDENT "succeeded less than this many seconds earlier\n"
223 INDENT "(with --fence, --unfence, --reboot).",
224 "SECONDS" },
225
226 { NULL }
227 };
228
229
230 static pcmk__supported_format_t formats[] = {
231 PCMK__SUPPORTED_FORMAT_HTML,
232 PCMK__SUPPORTED_FORMAT_NONE,
233 PCMK__SUPPORTED_FORMAT_TEXT,
234 PCMK__SUPPORTED_FORMAT_XML,
235 { NULL, NULL, NULL }
236 };
237
238 static const int st_opts = st_opt_sync_call | st_opt_allow_suicide;
239
240 static char *name = NULL;
241
242 gboolean
243 add_env_params(const gchar *option_name, const gchar *optarg, gpointer data, GError **error) {
244 char *key = crm_strdup_printf("OCF_RESKEY_%s", optarg);
245 const char *env = getenv(key);
246 gboolean retval = TRUE;
247
248 if (env == NULL) {
249 g_set_error(error, PCMK__EXITC_ERROR, CRM_EX_INVALID_PARAM, "Invalid option: -e %s", optarg);
250 retval = FALSE;
251 } else {
252 crm_info("Got: '%s'='%s'", optarg, env);
253 options.params = stonith_key_value_add(options.params, optarg, env);
254 }
255
256 free(key);
257 return retval;
258 }
259
260 gboolean
261 add_stonith_device(const gchar *option_name, const gchar *optarg, gpointer data, GError **error) {
262 options.devices = stonith_key_value_add(options.devices, NULL, optarg);
263 return TRUE;
264 }
265
266 gboolean
267 add_tolerance(const gchar *option_name, const gchar *optarg, gpointer data, GError **error) {
268 options.tolerance = crm_get_msec(optarg) / 1000;
269 return TRUE;
270 }
271
272 gboolean
273 add_stonith_params(const gchar *option_name, const gchar *optarg, gpointer data, GError **error) {
274 char *name = NULL;
275 char *value = NULL;
276 int rc = 0;
277 gboolean retval = TRUE;
278
279 crm_info("Scanning: -o %s", optarg);
280
281 rc = pcmk__scan_nvpair(optarg, &name, &value);
282
283 if (rc != 2) {
284 rc = pcmk_legacy2rc(rc);
285 g_set_error(error, PCMK__RC_ERROR, rc, "Invalid option: -o %s: %s", optarg, pcmk_rc_str(rc));
286 retval = FALSE;
287 } else {
288 crm_info("Got: '%s'='%s'", name, value);
289 options.params = stonith_key_value_add(options.params, name, value);
290 }
291
292 free(name);
293 free(value);
294 return retval;
295 }
296
297 gboolean
298 set_tag(const gchar *option_name, const gchar *optarg, gpointer data, GError **error) {
299 free(name);
300 name = crm_strdup_printf("%s.%s", crm_system_name, optarg);
301 return TRUE;
302 }
303
304 static GOptionContext *
305 build_arg_context(pcmk__common_args_t *args, GOptionGroup **group) {
306 GOptionContext *context = NULL;
307
308 GOptionEntry extra_prog_entries[] = {
309 { "quiet", 'q', 0, G_OPTION_ARG_NONE, &(args->quiet),
310 "Be less descriptive in output.",
311 NULL },
312
313 { NULL }
314 };
315
316 context = pcmk__build_arg_context(args, "text (default), html, xml", group, NULL);
317
318
319
320
321 pcmk__add_main_args(context, extra_prog_entries);
322
323 pcmk__add_arg_group(context, "definition", "Device Definition Commands:",
324 "Show device definition help", defn_entries);
325 pcmk__add_arg_group(context, "queries", "Queries:",
326 "Show query help", query_entries);
327 pcmk__add_arg_group(context, "fence", "Fencing Commands:",
328 "Show fence help", fence_entries);
329 pcmk__add_arg_group(context, "additional", "Additional Options:",
330 "Show additional options", addl_entries);
331 return context;
332 }
333
334
335 static int
336 request_fencing(stonith_t *st, const char *target, const char *command,
337 GError **error)
338 {
339 char *reason = NULL;
340 int rc = pcmk__request_fencing(st, target, command, name,
341 options.timeout * 1000,
342 options.tolerance * 1000,
343 options.delay, &reason);
344
345 if (rc != pcmk_rc_ok) {
346 const char *rc_str = pcmk_rc_str(rc);
347 const char *what = (strcmp(command, "on") == 0)? "unfence" : "fence";
348
349
350 if (pcmk__str_eq(rc_str, reason, pcmk__str_none)) {
351 free(reason);
352 reason = NULL;
353 }
354
355 g_set_error(error, PCMK__RC_ERROR, rc,
356 "Couldn't %s %s: %s%s%s%s",
357 what, target, rc_str,
358 ((reason == NULL)? "" : " ("),
359 ((reason == NULL)? "" : reason),
360 ((reason == NULL)? "" : ")"));
361 }
362 free(reason);
363 return rc;
364 }
365
366 int
367 main(int argc, char **argv)
368 {
369 int rc = 0;
370 crm_exit_t exit_code = CRM_EX_OK;
371 bool no_connect = false;
372 bool required_agent = false;
373
374 char *target = NULL;
375 const char *device = NULL;
376 stonith_t *st = NULL;
377
378 GError *error = NULL;
379
380 pcmk__output_t *out = NULL;
381
382 GOptionGroup *output_group = NULL;
383 pcmk__common_args_t *args = pcmk__new_common_args(SUMMARY);
384 gchar **processed_args = pcmk__cmdline_preproc(argv, "adehilorstvyBCDFHQRTU");
385 GOptionContext *context = build_arg_context(args, &output_group);
386
387 pcmk__register_formats(output_group, formats);
388 if (!g_option_context_parse_strv(context, &processed_args, &error)) {
389 exit_code = CRM_EX_USAGE;
390 goto done;
391 }
392
393 pcmk__cli_init_logging("stonith_admin", args->verbosity);
394
395 if (name == NULL) {
396 name = strdup(crm_system_name);
397 }
398
399 rc = pcmk__output_new(&out, args->output_ty, args->output_dest, argv);
400 if (rc != pcmk_rc_ok) {
401 exit_code = CRM_EX_ERROR;
402 g_set_error(&error, PCMK__EXITC_ERROR, exit_code, "Error creating output format %s: %s",
403 args->output_ty, pcmk_rc_str(rc));
404 goto done;
405 }
406
407 stonith__register_messages(out);
408
409 if (args->version) {
410 out->version(out, false);
411 goto done;
412 }
413
414 if (options.validate_cfg) {
415 required_agent = true;
416 no_connect = true;
417 action = 'K';
418 }
419
420 if (options.installed) {
421 no_connect = true;
422 action = 'I';
423 }
424
425 if (options.registered) {
426 action = 'L';
427 }
428
429 if (options.register_dev != NULL) {
430 required_agent = true;
431 action = 'R';
432 device = options.register_dev;
433 }
434
435 if (options.query != NULL) {
436 action = 'Q';
437 device = options.query;
438 }
439
440 if (options.unregister_dev != NULL) {
441 action = 'D';
442 device = options.unregister_dev;
443 }
444
445 if (options.targets != NULL) {
446 action = 's';
447 device = options.targets;
448 }
449
450 if (options.terminate != NULL) {
451 action = 'L';
452 target = options.terminate;
453 }
454
455 if (options.metadata) {
456 no_connect = true;
457 required_agent = true;
458 action = 'M';
459 }
460
461 if (options.reboot_host != NULL) {
462 no_connect = true;
463 action = 'B';
464 target = options.reboot_host;
465 crm_log_args(argc, argv);
466 }
467
468 if (options.fence_host != NULL) {
469 no_connect = true;
470 action = 'F';
471 target = options.fence_host;
472 crm_log_args(argc, argv);
473 }
474
475 if (options.unfence_host != NULL) {
476 no_connect = true;
477 action = 'U';
478 target = options.unfence_host;
479 crm_log_args(argc, argv);
480 }
481
482 if (options.confirm_host != NULL) {
483 action = 'C';
484 target = options.confirm_host;
485 crm_log_args(argc, argv);
486 }
487
488 if (options.last_fenced != NULL) {
489 action = 'h';
490 target = options.last_fenced;
491 }
492
493 if (options.history != NULL) {
494 action = 'H';
495 target = options.history;
496 }
497
498 if (options.register_level != NULL) {
499 action = 'r';
500 target = options.register_level;
501 }
502
503 if (options.unregister_level != NULL) {
504 action = 'd';
505 target = options.unregister_level;
506 }
507
508 if (action == 0) {
509 char *help = g_option_context_get_help(context, TRUE, NULL);
510
511 out->err(out, "%s", help);
512 g_free(help);
513 exit_code = CRM_EX_USAGE;
514 goto done;
515 }
516
517 if (required_agent && options.agent == NULL) {
518 char *help = g_option_context_get_help(context, TRUE, NULL);
519
520 out->err(out, "Please specify an agent to query using -a,--agent [value]");
521 out->err(out, "%s", help);
522 g_free(help);
523 exit_code = CRM_EX_USAGE;
524 goto done;
525 }
526
527 out->quiet = args->quiet;
528
529 st = stonith_api_new();
530 if (st == NULL) {
531 rc = -ENOMEM;
532 } else if (!no_connect) {
533 rc = st->cmds->connect(st, name, NULL);
534 }
535 if (rc < 0) {
536 out->err(out, "Could not connect to fencer: %s", pcmk_strerror(rc));
537 exit_code = CRM_EX_DISCONNECT;
538 goto done;
539 }
540
541 switch (action) {
542 case 'I':
543 rc = pcmk__fence_installed(out, st, options.timeout*1000);
544 if (rc != pcmk_rc_ok) {
545 out->err(out, "Failed to list installed devices: %s", pcmk_strerror(rc));
546 }
547
548 break;
549
550 case 'L':
551 rc = pcmk__fence_registered(out, st, target, options.timeout*1000);
552 if (rc != pcmk_rc_ok) {
553 out->err(out, "Failed to list registered devices: %s", pcmk_strerror(rc));
554 }
555
556 break;
557
558 case 'Q':
559 rc = st->cmds->monitor(st, st_opts, device, options.timeout);
560 if (rc != pcmk_rc_ok) {
561 rc = st->cmds->list(st, st_opts, device, NULL, options.timeout);
562 }
563 rc = pcmk_legacy2rc(rc);
564 break;
565
566 case 's':
567 rc = pcmk__fence_list_targets(out, st, device, options.timeout*1000);
568 if (rc != pcmk_rc_ok) {
569 out->err(out, "Couldn't list targets: %s", pcmk_strerror(rc));
570 }
571
572 break;
573
574 case 'R':
575 rc = st->cmds->register_device(st, st_opts, device, NULL, options.agent,
576 options.params);
577 rc = pcmk_legacy2rc(rc);
578 if (rc != pcmk_rc_ok) {
579 out->err(out, "Can't register device %s using agent %s: %s",
580 device, options.agent, pcmk_rc_str(rc));
581 }
582 break;
583
584 case 'D':
585 rc = st->cmds->remove_device(st, st_opts, device);
586 rc = pcmk_legacy2rc(rc);
587 if (rc != pcmk_rc_ok) {
588 out->err(out, "Can't unregister device %s: %s",
589 device, pcmk_rc_str(rc));
590 }
591 break;
592
593 case 'd':
594 rc = pcmk__fence_unregister_level(st, target, options.fence_level);
595 if (rc != pcmk_rc_ok) {
596 out->err(out, "Can't unregister topology level %d for %s: %s",
597 options.fence_level, target, pcmk_rc_str(rc));
598 }
599 break;
600
601 case 'r':
602 rc = pcmk__fence_register_level(st, target, options.fence_level, options.devices);
603 if (rc != pcmk_rc_ok) {
604 out->err(out, "Can't register topology level %d for %s: %s",
605 options.fence_level, target, pcmk_rc_str(rc));
606 }
607 break;
608
609 case 'M':
610 rc = pcmk__fence_metadata(out, st, options.agent, options.timeout*1000);
611 if (rc != pcmk_rc_ok) {
612 out->err(out, "Can't get fence agent meta-data: %s",
613 pcmk_rc_str(rc));
614 }
615
616 break;
617
618 case 'C':
619 rc = st->cmds->confirm(st, st_opts, target);
620 rc = pcmk_legacy2rc(rc);
621 break;
622
623 case 'B':
624 rc = request_fencing(st, target, "reboot", &error);
625 break;
626
627 case 'F':
628 rc = request_fencing(st, target, "off", &error);
629 break;
630
631 case 'U':
632 rc = request_fencing(st, target, "on", &error);
633 break;
634
635 case 'h':
636 rc = pcmk__fence_last(out, target, options.as_nodeid);
637 break;
638
639 case 'H':
640 rc = pcmk__fence_history(out, st, target, options.timeout*1000, args->verbosity,
641 options.broadcast, options.cleanup);
642 break;
643
644 case 'K':
645 device = options.devices ? options.devices->key : NULL;
646 rc = pcmk__fence_validate(out, st, options.agent, device, options.params,
647 options.timeout*1000);
648 break;
649 }
650
651 crm_info("Command returned: %s (%d)", pcmk_rc_str(rc), rc);
652 exit_code = pcmk_rc2exitc(rc);
653
654 done:
655 g_strfreev(processed_args);
656 pcmk__free_arg_context(context);
657
658 pcmk__output_and_clear_error(&error, out);
659
660 if (out != NULL) {
661 out->finish(out, exit_code, true, NULL);
662 pcmk__output_free(out);
663 }
664 pcmk__unregister_formats();
665 free(name);
666 stonith_key_value_freeall(options.params, 1, 1);
667
668 if (st != NULL) {
669 st->cmds->disconnect(st);
670 stonith_api_delete(st);
671 }
672
673 return exit_code;
674 }
![[first]](../icons/first.png){kind=icon}
![[previous]](../icons/n_left.png){kind=icon}
![[next]](../icons/n_right.png){kind=icon}
![[last]](../icons/last.png){kind=icon}
![[top]](../icons/n_top.png){kind=icon}
![[bottom]](../icons/bottom.png){kind=icon}
![[index]](../icons/index.png){kind=icon}
![[help]](../icons/help.png){kind=icon}
*/
![[next]](../icons/right.png)
![[first]](../icons/n_first.png)
![[top]](../icons/top.png)
![[previous]](../icons/left.png)
![[last]](../icons/n_last.png)
![[bottom]](../icons/n_bottom.png){kind=icon}