/
ua_cmds.c
2580 lines (2297 loc) · 78.5 KB
/
ua_cmds.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
BAREOS® - Backup Archiving REcovery Open Sourced
Copyright (C) 2000-2012 Free Software Foundation Europe e.V.
Copyright (C) 2011-2012 Planets Communications B.V.
Copyright (C) 2013-2016 Bareos GmbH & Co. KG
This program is Free Software; you can redistribute it and/or
modify it under the terms of version three of the GNU Affero General Public
License as published by the Free Software Foundation and included
in the file LICENSE.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/*
* BAREOS Director -- User Agent Commands
*
* Kern Sibbald, September MM
*/
#include "bareos.h"
#include "dird.h"
/* Imported subroutines */
/* Imported variables */
/*
* Imported functions
*/
/* dird.c */
extern bool do_reload_config();
/* ua_cmds.c */
extern bool autodisplay_cmd(UAContext *ua, const char *cmd);
extern bool configure_cmd(UAContext *ua, const char *cmd);
extern bool gui_cmd(UAContext *ua, const char *cmd);
extern bool label_cmd(UAContext *ua, const char *cmd);
extern bool list_cmd(UAContext *ua, const char *cmd);
extern bool llist_cmd(UAContext *ua, const char *cmd);
extern bool messages_cmd(UAContext *ua, const char *cmd);
extern bool prune_cmd(UAContext *ua, const char *cmd);
extern bool purge_cmd(UAContext *ua, const char *cmd);
extern bool query_cmd(UAContext *ua, const char *cmd);
extern bool relabel_cmd(UAContext *ua, const char *cmd);
extern bool restore_cmd(UAContext *ua, const char *cmd);
extern bool show_cmd(UAContext *ua, const char *cmd);
extern bool sqlquery_cmd(UAContext *ua, const char *cmd);
extern bool status_cmd(UAContext *ua, const char *cmd);
extern bool update_cmd(UAContext *ua, const char *cmd);
/* ua_dotcmds.c */
extern bool dot_catalogs_cmd(UAContext *ua, const char *cmd);
extern bool dot_admin_cmds(UAContext *ua, const char *cmd);
extern bool dot_jobdefs_cmd(UAContext *ua, const char *cmd);
extern bool dot_jobs_cmd(UAContext *ua, const char *cmd);
extern bool dot_jobstatus_cmd(UAContext *ua, const char *cmd);
extern bool dot_filesets_cmd(UAContext *ua, const char *cmd);
extern bool dot_clients_cmd(UAContext *ua, const char *cmd);
extern bool dot_consoles_cmd(UAContext *ua, const char *cmd);
extern bool dot_msgs_cmd(UAContext *ua, const char *cmd);
extern bool dot_pools_cmd(UAContext *ua, const char *cmd);
extern bool dot_schedule_cmd(UAContext *ua, const char *cmd);
extern bool dot_storage_cmd(UAContext *ua, const char *cmd);
extern bool dot_defaults_cmd(UAContext *ua, const char *cmd);
extern bool dot_types_cmd(UAContext *ua, const char *cmd);
extern bool dot_levels_cmd(UAContext *ua, const char *cmd);
extern bool dot_getmsgs_cmd(UAContext *ua, const char *cmd);
extern bool dot_volstatus_cmd(UAContext *ua, const char *cmd);
extern bool dot_mediatypes_cmd(UAContext *ua, const char *cmd);
extern bool dot_locations_cmd(UAContext *ua, const char *cmd);
extern bool dot_media_cmd(UAContext *ua, const char *cmd);
extern bool dot_profiles_cmd(UAContext *ua, const char *cmd);
extern bool dot_aop_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_lsdirs_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_lsfiles_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_update_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_get_jobids_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_versions_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_restore_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_cleanup_cmd(UAContext *ua, const char *cmd);
extern bool dot_bvfs_clear_cache_cmd(UAContext *ua, const char *cmd);
extern bool dot_api_cmd(UAContext *ua, const char *cmd);
extern bool dot_sql_cmd(UAContext *ua, const char *cmd);
extern bool dot_authorized_cmd(UAContext *ua, const char *cmd);
/* ua_status.c */
extern bool dot_status_cmd(UAContext *ua, const char *cmd);
/* Forward referenced functions */
static bool add_cmd(UAContext *ua, const char *cmd);
static bool automount_cmd(UAContext *ua, const char *cmd);
static bool cancel_cmd(UAContext *ua, const char *cmd);
static bool create_cmd(UAContext *ua, const char *cmd);
static bool delete_cmd(UAContext *ua, const char *cmd);
static bool disable_cmd(UAContext *ua, const char *cmd);
static bool enable_cmd(UAContext *ua, const char *cmd);
static bool estimate_cmd(UAContext *ua, const char *cmd);
static bool help_cmd(UAContext *ua, const char *cmd);
static bool dot_help_cmd(UAContext *ua, const char *cmd);
static bool memory_cmd(UAContext *ua, const char *cmd);
static bool mount_cmd(UAContext *ua, const char *cmd);
static bool noop_cmd(UAContext *ua, const char *cmd);
static bool release_cmd(UAContext *ua, const char *cmd);
static bool reload_cmd(UAContext *ua, const char *cmd);
static bool setdebug_cmd(UAContext *ua, const char *cmd);
static bool setbwlimit_cmd(UAContext *ua, const char *cmd);
static bool setip_cmd(UAContext *ua, const char *cmd);
static bool time_cmd(UAContext *ua, const char *cmd);
static bool resolve_cmd(UAContext *ua, const char *cmd);
static bool trace_cmd(UAContext *ua, const char *cmd);
static bool unmount_cmd(UAContext *ua, const char *cmd);
static bool use_cmd(UAContext *ua, const char *cmd);
static bool var_cmd(UAContext *ua, const char *cmd);
static bool version_cmd(UAContext *ua, const char *cmd);
static bool wait_cmd(UAContext *ua, const char *cmd);
static void do_job_delete(UAContext *ua, JobId_t JobId);
static bool delete_job_id_range(UAContext *ua, char *tok);
static bool delete_volume(UAContext *ua);
static bool delete_pool(UAContext *ua);
static void delete_job(UAContext *ua);
bool quit_cmd(UAContext *ua, const char *cmd);
/*
* Not all in alphabetical order.
* New commands are added after existing commands with similar letters
* to prevent breakage of existing user scripts.
*/
struct cmdstruct {
const char *key; /* Command */
bool (*func)(UAContext *ua, const char *cmd); /* Handler */
const char *help; /* Main purpose */
const char *usage; /* All arguments to build usage */
const bool use_in_rs; /* Can use it in Console RunScript */
const bool audit_event; /* Log an audit event when this Command is executed */
};
static struct cmdstruct commands[] = {
{ NT_("."), noop_cmd, _("no op"),
NULL, true, false },
{ NT_(".actiononpurge"), dot_aop_cmd, _("List possible actions on purge"),
NULL, true, false },
{ NT_(".api"), dot_api_cmd, _("Switch between different api modes"),
NT_("[ 0 | 1 | 2 | off | on | json ] [compact=<yes|no>]"), false, false },
{ NT_(".authorized"), dot_authorized_cmd, _("Check for authorization"),
NT_("job=<job-name> | client=<client-name> | storage=<storage-name | \n"
"schedule=<schedule-name> | pool=<pool-name> | cmd=<command> | \n"
"fileset=<fileset-name> | catalog=<catalog>"), false, false },
{ NT_(".catalogs"), dot_catalogs_cmd, _("List all catalog resources"),
NULL, false, false },
{ NT_(".clients"), dot_clients_cmd, _("List all client resources"),
NULL, true, false },
{ NT_(".consoles"), dot_consoles_cmd, _("List all console resources"),
NULL, true, false },
{ NT_(".defaults"), dot_defaults_cmd, _("Get default settings"),
NT_("job=<job-name> | client=<client-name> | storage=<storage-name | pool=<pool-name>"), false, false },
#ifdef DEVELOPER
{ NT_(".die"), dot_admin_cmds, _("Generate Segmentation Fault"),
NT_("[dir | director] [client=<client>] [storage=<storage>]"), false, true },
{ NT_(".dump"), dot_admin_cmds, _("Dump memory statistics"),
NT_("[dir | director] [client=<client>] [storage=<storage>]"), false, true },
{ NT_(".memcheck"), dot_admin_cmds, _("Checks for internal memory leaks"),
NT_("[dir | director] [client=<client>] [storage=<storage>]"), false, true },
{ NT_(".exit"), dot_admin_cmds, _("Close connection"),
NT_("[dir | director] [client=<client>] [storage=<storage>]"), false, true },
#endif
{ NT_(".filesets"), dot_filesets_cmd, _("List all filesets"),
NULL, false, false },
{ NT_(".help"), dot_help_cmd, _("Print parsable information about a command"),
NT_("[ all | item=cmd ]"), false, false },
{ NT_(".jobdefs"), dot_jobdefs_cmd, _("List add JobDef resources"),
NULL, true, false },
{ NT_(".jobs"), dot_jobs_cmd, _("List job resources"),
NT_("type=<jobtype>"), true, false },
{ NT_(".jobstatus"), dot_jobstatus_cmd, _("List jobstatus information"),
NT_("[ =<jobstatus> ]"), true, false },
{ NT_(".levels"), dot_levels_cmd, _("List all backup levels"),
NULL, false, false },
{ NT_(".locations"), dot_locations_cmd, NULL, NULL, true, false },
{ NT_(".messages"), dot_getmsgs_cmd, _("Display pending messages"),
NULL, false, false },
{ NT_(".media"), dot_media_cmd, _("List all medias"),
NULL, true, false },
{ NT_(".mediatypes"), dot_mediatypes_cmd, _("List all media types"),
NULL, true, false },
{ NT_(".msgs"), dot_msgs_cmd, _("List all message resources"),
NULL, false, false },
{ NT_(".pools"), dot_pools_cmd, _("List all pool resources"),
NT_("type=<pooltype>"), true, false },
{ NT_(".profiles"), dot_profiles_cmd, _("List all profile resources"),
NULL, true, false },
{ NT_(".quit"), quit_cmd, _("Close connection"),
NULL, false, false },
{ NT_(".sql"), dot_sql_cmd, _("Send an arbitary SQL command"),
NT_("query=<sqlquery>"), false, true },
{ NT_(".schedule"), dot_schedule_cmd, _("List all schedule resources"),
NULL, false, false },
{ NT_(".status"), dot_status_cmd, _("Report status"),
NT_("dir ( current | last | header | scheduled | running | terminated ) |\n"
"storage=<storage> [ header | waitreservation | devices | volumes | spooling | running | terminated ] |\n"
"client=<client> [ header | terminated | running ]"),
false, true },
{ NT_(".storages"), dot_storage_cmd, _("List all storage resources"),
NULL, true, false },
{ NT_(".types"), dot_types_cmd, _("List all job types"),
NULL, false, false },
{ NT_(".volstatus"), dot_volstatus_cmd, _("List all volume status"),
NULL, true, false },
{ NT_(".bvfs_lsdirs"), dot_bvfs_lsdirs_cmd, _("List directories using BVFS"),
NT_("jobid=<jobid> path=<path> | pathid=<pathid> [limit=<limit>] [offset=<offset>]"), true, true },
{ NT_(".bvfs_lsfiles"),dot_bvfs_lsfiles_cmd, _("List files using BVFS"),
NT_("jobid=<jobid> path=<path> | pathid=<pathid> [limit=<limit>] [offset=<offset>]"), true, true },
{ NT_(".bvfs_update"), dot_bvfs_update_cmd, _("Update BVFS cache"),
NT_("[jobid=<jobid>]"), true, true },
{ NT_(".bvfs_get_jobids"), dot_bvfs_get_jobids_cmd, _("Get jobids required for a restore"),
NT_("jobid=<jobid> | ujobid=<unique-jobid> [all]"), true, true },
{ NT_(".bvfs_versions"), dot_bvfs_versions_cmd, _("List versions of a file"),
NT_("jobid=0 client=<client-name> pathid=<path-id> fnid=<filename-id> [copies] [versions]"), true, true },
{ NT_(".bvfs_restore"), dot_bvfs_restore_cmd, _("Mark BVFS files/directories for restore. Stored in handle."),
NT_("path=<handle> jobid=<jobid> [fileid=<file-id>] [dirid=<dirid>] [hardlink=<hardlink>]"), true, true },
{ NT_(".bvfs_cleanup"), dot_bvfs_cleanup_cmd, _("Cleanup BVFS cache for a certain handle"),
NT_("path=<handle>"), true, true },
{ NT_(".bvfs_clear_cache"), dot_bvfs_clear_cache_cmd, _("Clear BVFS cache"),
NT_("yes"), false, true },
{ NT_("add"), add_cmd, _("Add media to a pool"),
NT_("pool=<pool-name> storage=<storage-name> jobid=<jobid>"), false, true },
{ NT_("autodisplay"), autodisplay_cmd,_("Autodisplay console messages"),
NT_("on | off"), false, false },
{ NT_("automount"), automount_cmd, _("Automount after label"),
NT_("on | off"), false, true },
{ NT_("cancel"), cancel_cmd, _("Cancel a job"),
NT_("storage=<storage-name> | jobid=<jobid> | job=<job-name> | ujobid=<unique-jobid> | state=<job_state> | all yes"), false, true },
{ NT_("configure"), configure_cmd, _("Configure director resources"),
NT_(get_configure_usage_string()), false, true },
{ NT_("create"), create_cmd, _("Create DB Pool from resource"),
NT_("pool=<pool-name>"), false, true },
{ NT_("delete"), delete_cmd, _("Delete volume, pool or job"),
NT_("volume=<vol-name> pool=<pool-name> jobid=<jobid>"), true, true },
{ NT_("disable"), disable_cmd, _("Disable a job/client/schedule"),
NT_("job=<job-name> client=<client-name> schedule=<schedule-name>"), true, true },
{ NT_("enable"), enable_cmd, _("Enable a job/client/schedule"),
NT_("job=<job-name> client=<client-name> schedule=<schedule-name>"), true, true },
{ NT_("estimate"), estimate_cmd, _("Performs FileSet estimate, listing gives full listing"),
NT_("fileset=<fileset-name> client=<client-name> level=<level> accurate=<yes/no> job=<job-name> listing"), true, true },
{ NT_("exit"), quit_cmd, _("Terminate Bconsole session"),
NT_(""), false, false },
{ NT_("export"), export_cmd,_("Export volumes from normal slots to import/export slots"),
NT_("storage=<storage-name> srcslots=<slot-selection> [ dstslots=<slot-selection> volume=<volume-name> scan ]"), true, true },
{ NT_("gui"), gui_cmd, _("Switch between interactive (gui off) and non-interactive (gui on) mode"),
NT_("on | off"), false, false },
{ NT_("help"), help_cmd, _("Print help on specific command"),
NT_("add autodisplay automount cancel configure create delete disable\n"
"\tenable estimate exit gui label list llist\n"
"\tmessages memory mount prune purge quit query\n"
"\trestore relabel release reload run status\n"
"\tsetbandwidth setdebug setip show sqlquery time trace unmount\n"
"\tumount update use var version wait"), false, false },
{ NT_("import"), import_cmd, _("Import volumes from import/export slots to normal slots"),
NT_("storage=<storage-name> [ srcslots=<slot-selection> dstslots=<slot-selection> volume=<volume-name> scan ]"), true, true },
{ NT_("label"), label_cmd, _("Label a tape"),
NT_("storage=<storage-name> volume=<volume-name> pool=<pool-name> slot=<slot> [ drive = <drivenum>] [ barcodes ] [ encrypt ] [ yes ]"), false, true },
{ NT_("list"), list_cmd, _("List objects from catalog"),
NT_("basefiles jobid=<jobid> | basefiles ujobid=<complete_name> |\n"
"backups client=<client-name> [fileset=<fileset-name>] [jobstatus=<status>] [level=<level>] [order=<asc|desc>] [limit=<number>] |\n"
"clients | copies jobid=<jobid> |\n"
"files jobid=<jobid> | files ujobid=<complete_name> |\n"
"filesets |\n"
"fileset [ jobid=<jobid> ] | fileset [ ujobid=<complete_name> ] |\n"
"fileset [ filesetid=<filesetid> ] | fileset [ jobid=<jobid> ] |\n"
"jobs [job=<job-name>] [client=<client-name>] [jobstatus=<status>] [volume=<volumename>] [days=<number>] [hours=<number>] [last] [count] |\n"
"job=<job-name> [client=<client-name>] [jobstatus=<status>] [volume=<volumename>] [days=<number>] [hours=<number>] |\n"
"jobid=<jobid> | ujobid=<complete_name> |\n"
"joblog jobid=<jobid> | joblog ujobid=<complete_name> |\n"
"jobmedia jobid=<jobid> | jobmedia ujobid=<complete_name> |\n"
"jobtotals |\n"
"log [ limit=<number> [ offset=<number> ] ] [reverse]|\n"
"media [ jobid=<jobid> | ujobid=<complete_name> | pool=<pool-name> | all ] |\n"
"media=<media-name> |\n"
"nextvol job=<job-name> | nextvolume ujobid=<complete_name> |\n"
"pools |\n"
"pool=<pool-name> |\n"
"storages |\n"
"volumes [ jobid=<jobid> | ujobid=<complete_name> | pool=<pool-name> | all ] |\n"
"volume=<volume-name> |\n"
"[ limit=<number> [ offset=<number> ] ]"), true, true },
{ NT_("llist"), llist_cmd, _("Full or long list like list command"),
NT_("basefiles jobid=<jobid> | basefiles ujobid=<complete_name> |\n"
"backups client=<client-name> [fileset=<fileset-name>] [jobstatus=<status>] [level=<level>] [order=<asc|desc>] [limit=<number>] [days=<number>] [hours=<number>]|\n"
"clients | copies jobid=<jobid> |\n"
"files jobid=<jobid> | files ujobid=<complete_name> |\n"
"filesets |\n"
"fileset jobid=<jobid> | fileset ujobid=<complete_name> |\n"
"fileset [ filesetid=<filesetid> ] | fileset [ jobid=<jobid> ] |\n"
"jobs [job=<job-name>] [client=<client-name>] [jobstatus=<status>] [volume=<volumename>] [days=<number>] [hours=<number>] [last] [count] |\n"
"job=<job-name> [client=<client-name>] [jobstatus=<status>] [volume=<volumename>] [days=<number>] [hours=<number>] |\n"
"jobid=<jobid> | ujobid=<complete_name> |\n"
"joblog jobid=<jobid> | joblog ujobid=<complete_name> |\n"
"jobmedia jobid=<jobid> | jobmedia ujobid=<complete_name> |\n"
"jobtotals |\n"
"media [ jobid=<jobid> | ujobid=<complete_name> | pool=<pool-name> | all ] |\n"
"media=<media-name> |\n"
"nextvol job=<job-name> | nextvolume ujobid=<complete_name> |\n"
"pools |\n"
"pool=<pool-name> |\n"
"volumes [ jobid=<jobid> | ujobid=<complete_name> | pool=<pool-name> | all ] |\n"
"volume=<volume-name> |\n"
"[ limit=<num> [ offset=<number> ] ]"), true, true },
{ NT_("messages"), messages_cmd, _("Display pending messages"),
NT_(""), false, false },
{ NT_("memory"), memory_cmd, _("Print current memory usage"),
NT_(""), true, false },
{ NT_("mount"), mount_cmd, _("Mount storage"),
NT_("storage=<storage-name> slot=<num> drive=<drivenum>\n"
"\tjobid=<jobid> | job=<job-name> | ujobid=<complete_name>"), false, true },
{ NT_("move"), move_cmd, _("Move slots in an autochanger"),
NT_("storage=<storage-name> srcslots=<slot-selection> dstslots=<slot-selection>"), true, true },
{ NT_("prune"), prune_cmd, _("Prune records from catalog"),
NT_("files | jobs | jobtype=<jobtype> | pool=<pool-name> | client=<client-name> | volume=<volume-name> | directory=<directory> | recursive"), true, true },
{ NT_("purge"), purge_cmd, _("Purge records from catalog"),
NT_("files jobs volume=<volume-name> [ action=<action> devicetype=<type> pool=<pool-name>\n"
"\tallpools storage=<storage-name> drive=<drivenum> ]"), true, true },
{ NT_("quit"), quit_cmd, _("Terminate Bconsole session"),
NT_(""), false, false },
{ NT_("query"), query_cmd, _("Query catalog"),
NT_(""), false, true },
{ NT_("restore"), restore_cmd, _("Restore files"),
NT_("where=</path> client=<client-name> storage=<storage-name> bootstrap=<file>\n"
"\trestorejob=<job-name> comment=<text> jobid=<jobid> fileset=<fileset-name>\n"
"\treplace=<always|never|ifolder|ifnewer> pluginoptions=<plugin-options-string>\n"
"\tregexwhere=<regex> restoreclient=<client-name> backupformat=<format>\n"
"\tpool=<pool-name> file=<filename> directory=<directory> before=<date>\n"
"\tstrip_prefix=<prefix> add_prefix=<prefix> add_suffix=<suffix>\n"
"\tselect=<date> select before current copies done all"), false, true },
{ NT_("relabel"), relabel_cmd, _("Relabel a tape"),
NT_("storage=<storage-name> oldvolume=<old-volume-name>\n"
"\tvolume=<new-volume-name> pool=<pool-name> [ encrypt ]"), false, true },
{ NT_("release"), release_cmd, _("Release storage"),
NT_("storage=<storage-name> [ drive=<drivenum> ] [ alldrives ]"), false, true },
{ NT_("reload"), reload_cmd, _("Reload conf file"),
NT_(""), true, true },
{ NT_("rerun"), rerun_cmd, _("Rerun a job"),
NT_("jobid=<jobid> | since_jobid=<jobid> [ until_jobid=<jobid> ] | days=<nr_days> | hours=<nr_hours> | yes"), false, true },
{ NT_("resolve"), resolve_cmd, _("Resolve a hostname"),
NT_("client=<client-name> | storage=<storage-name> <host-name>"), false, true },
{ NT_("run"), run_cmd, _("Run a job"),
NT_("job=<job-name> client=<client-name> fileset=<fileset-name> level=<level>\n"
"\tstorage=<storage-name> where=<directory-prefix> when=<universal-time-specification>\n"
"\tpool=<pool-name> pluginoptions=<plugin-options-string> accurate=<yes|no> comment=<text>\n"
"\tspooldata=<yes|no> priority=<number> jobid=<jobid> catalog=<catalog> migrationjob=<>\n"
"\tbackupclient=<client-name> backupformat=<format> nextpool=<pool-name>\n"
"\tsince=<universal-time-specification> verifyjob=<job-name> verifylist=<verify-list>\n"
"\tmigrationjob=<complete_name> yes"), false, true },
{ NT_("status"), status_cmd, _("Report status"),
NT_("all | dir=<dir-name> | director | scheduler | schedule=<schedule-name> | client=<client-name> |\n"
"\tstorage=<storage-name> slots | days=<nr_days> | job=<job-name> |\n"
"\tsubscriptions"), true, true },
{ NT_("setbandwidth"), setbwlimit_cmd, _("Sets bandwidth"),
NT_("client=<client-name> | storage=<storage-name> | jobid=<jobid> |\n"
"\tjob=<job-name> | ujobid=<unique-jobid> state=<job_state> | all\n"
"\tlimit=<nn-kbs> [ yes ]"), true, true },
{ NT_("setdebug"), setdebug_cmd, _("Sets debug level"),
NT_("level=<nn> trace=0/1 timestamp=0/1 client=<client-name> | dir | storage=<storage-name> | all"), true, true },
{ NT_("setip"), setip_cmd, _("Sets new client address -- if authorized"),
NT_(""), false, true },
{ NT_("show"), show_cmd, _("Show resource records"),
NT_("jobdefs=<job-defaults> | job=<job-name> | pool=<pool-name> | fileset=<fileset-name> |\n"
"schedule=<schedule-name> | client=<client-name> | message=<message-resource-name> |\n"
"profile=<profile-name> | jobdefs | jobs | pools | filesets | schedules | clients |\n"
"messages | profiles | consoles | disabled [ clients | jobs | schedules ] | all [verbose]"), true, true },
{ NT_("sqlquery"), sqlquery_cmd, _("Use SQL to query catalog"),
NT_(""), false, true },
{ NT_("time"), time_cmd, _("Print current time"),
NT_(""), true, false },
{ NT_("trace"), trace_cmd, _("Turn on/off trace to file"),
NT_("on | off"), true, true },
{ NT_("unmount"), unmount_cmd, _("Unmount storage"),
NT_("storage=<storage-name> [ drive=<drivenum> ]\n"
"\tjobid=<jobid> | job=<job-name> | ujobid=<complete_name>"), false, true },
{ NT_("umount"), unmount_cmd, _("Umount - for old-time Unix guys, see unmount"),
NT_("storage=<storage-name> [ drive=<drivenum> ]\n"
"\tjobid=<jobid> | job=<job-name> | ujobid=<complete_name>"), false, true },
{ NT_("update"), update_cmd, _("Update volume, pool, job or stats"),
NT_("stats\n"
"\tpool=<pool-name>\n"
"\tslots storage=<storage-name> scan\n"
"\tvolume=<volume-name> volstatus=<status> volretention=<time-def>\n"
"\tpool=<pool-name> recycle=<yes/no> slot=<number>\n"
"\tinchanger=<yes/no>\n"
"\tmaxvolbytes=<size> maxvolfiles=<nb> maxvoljobs=<nb>\n"
"\tenabled=<yes/no> recyclepool=<pool-name> actiononpurge=<action>\n"
"\tjobid=<jobid> jobname=<name> starttime=<time-def> client=<client-name>\n"
"\tfilesetid=<fileset-id> jobtype=<job-type>"), true, true },
{ NT_("use"), use_cmd, _("Use specific catalog"),
NT_("catalog=<catalog>"), false, true },
{ NT_("var"), var_cmd, _("Does variable expansion"),
NT_(""), false, true },
{ NT_("version"), version_cmd, _("Print Director version"),
NT_(""), true, false },
{ NT_("wait"), wait_cmd, _("Wait until no jobs are running"),
NT_("jobname=<name> | jobid=<jobid> | ujobid=<complete_name> | mount [timeout=<number>]"), false, false }
};
#define comsize ((int)(sizeof(commands)/sizeof(struct cmdstruct)))
/*
* Execute a command from the UA
*/
bool do_a_command(UAContext *ua)
{
int i;
int len;
bool ok = false;
bool found = false;
BSOCK *user = ua->UA_sock;
Dmsg1(900, "Command: %s\n", ua->argk[0]);
if (ua->argc == 0) {
return false;
}
while (ua->jcr->res.wstorage->size()) {
ua->jcr->res.wstorage->remove(0);
}
len = strlen(ua->argk[0]);
for (i = 0; i < comsize; i++) { /* search for command */
if (bstrncasecmp(ua->argk[0], commands[i].key, len)) {
/*
* Check if command permitted, but "quit" is always OK
*/
if (!bstrcmp(ua->argk[0], NT_("quit")) &&
!acl_access_ok(ua, Command_ACL, ua->argk[0], len, true)) {
break;
}
/*
* Check if this command is authorized in RunScript
*/
if (ua->runscript && !commands[i].use_in_rs) {
ua->error_msg(_("Can't use %s command in a runscript"), ua->argk[0]);
break;
}
/*
* If we need to audit this event do it now.
*/
if (audit_event_wanted(ua, commands[i].audit_event)) {
log_audit_event_cmdline(ua);
}
/*
* Some commands alter the JobStatus of the JCR.
* As the console JCR keeps running,
* we set it to running state again.
* ua->jcr->setJobStatus(JS_Running)
* isn't enough, as it does not overwrite error states.
*/
ua->jcr->JobStatus = JS_Running;
if (ua->api) {
user->signal(BNET_CMD_BEGIN);
}
ua->send->set_mode(ua->api);
ok = (*commands[i].func)(ua, ua->cmd); /* go execute command */
if (ua->api) {
user->signal(ok ? BNET_CMD_OK : BNET_CMD_FAILED);
}
found = true;
break;
}
}
if (!found) {
ua->error_msg(_("%s: is an invalid command.\n"), ua->argk[0]);
ok = false;
}
ua->send->finalize_result(ok);
return ok;
}
static bool is_dot_command(const char *cmd)
{
if (cmd && (strlen(cmd) > 0) && (cmd[0] == '.')) {
return true;
}
return false;
}
/*
* Add Volumes to an existing Pool
*/
static bool add_cmd(UAContext *ua, const char *cmd)
{
POOL_DBR pr;
MEDIA_DBR mr;
int num, i, max, startnum;
char name[MAX_NAME_LENGTH];
STORERES *store;
slot_number_t Slot = 0;
int8_t InChanger = 0;
ua->send_msg(_("You probably don't want to be using this command since it\n"
"creates database records without labeling the Volumes.\n"
"You probably want to use the \"label\" command.\n\n"));
if (!open_client_db(ua)) {
return true;
}
memset(&pr, 0, sizeof(pr));
memset(&mr, 0, sizeof(mr));
if (!get_pool_dbr(ua, &pr)) {
return true;
}
Dmsg4(120, "id=%d Num=%d Max=%d type=%s\n", pr.PoolId, pr.NumVols,
pr.MaxVols, pr.PoolType);
while (pr.MaxVols > 0 && pr.NumVols >= pr.MaxVols) {
ua->warning_msg(_("Pool already has maximum volumes=%d\n"), pr.MaxVols);
if (!get_pint(ua, _("Enter new maximum (zero for unlimited): "))) {
return true;
}
pr.MaxVols = ua->pint32_val;
}
/*
* Get media type
*/
if ((store = get_storage_resource(ua)) != NULL) {
bstrncpy(mr.MediaType, store->media_type, sizeof(mr.MediaType));
} else if (!get_media_type(ua, mr.MediaType, sizeof(mr.MediaType))) {
return true;
}
if (pr.MaxVols == 0) {
max = 1000;
} else {
max = pr.MaxVols - pr.NumVols;
}
for (;;) {
char buf[100];
bsnprintf(buf, sizeof(buf), _("Enter number of Volumes to create. 0=>fixed name. Max=%d: "), max);
if (!get_pint(ua, buf)) {
return true;
}
num = ua->pint32_val;
if (num < 0 || num > max) {
ua->warning_msg(_("The number must be between 0 and %d\n"), max);
continue;
}
break;
}
for (;;) {
if (num == 0) {
if (!get_cmd(ua, _("Enter Volume name: "))) {
return true;
}
} else {
if (!get_cmd(ua, _("Enter base volume name: "))) {
return true;
}
}
/*
* Don't allow | in Volume name because it is the volume separator character
*/
if (!is_volume_name_legal(ua, ua->cmd)) {
continue;
}
if (strlen(ua->cmd) >= MAX_NAME_LENGTH-10) {
ua->warning_msg(_("Volume name too long.\n"));
continue;
}
if (strlen(ua->cmd) == 0) {
ua->warning_msg(_("Volume name must be at least one character long.\n"));
continue;
}
break;
}
bstrncpy(name, ua->cmd, sizeof(name));
if (num > 0) {
bstrncat(name, "%04d", sizeof(name));
for (;;) {
if (!get_pint(ua, _("Enter the starting number: "))) {
return true;
}
startnum = ua->pint32_val;
if (startnum < 1) {
ua->warning_msg(_("Start number must be greater than zero.\n"));
continue;
}
break;
}
} else {
startnum = 1;
num = 1;
}
if (store && store->autochanger) {
if (!get_pint(ua, _("Enter slot (0 for none): "))) {
return true;
}
Slot = (slot_number_t)ua->pint32_val;
if (!get_yesno(ua, _("InChanger? yes/no: "))) {
return true;
}
InChanger = ua->pint32_val;
}
set_pool_dbr_defaults_in_media_dbr(&mr, &pr);
for (i=startnum; i < num+startnum; i++) {
bsnprintf(mr.VolumeName, sizeof(mr.VolumeName), name, i);
mr.Slot = Slot++;
mr.InChanger = InChanger;
mr.Enabled = VOL_ENABLED;
set_storageid_in_mr(store, &mr);
Dmsg1(200, "Create Volume %s\n", mr.VolumeName);
if (!db_create_media_record(ua->jcr, ua->db, &mr)) {
ua->error_msg("%s", db_strerror(ua->db));
return true;
}
}
pr.NumVols += num;
Dmsg0(200, "Update pool record.\n");
if (db_update_pool_record(ua->jcr, ua->db, &pr) != 1) {
ua->warning_msg("%s", db_strerror(ua->db));
return true;
}
ua->send_msg(_("%d Volumes created in pool %s\n"), num, pr.Name);
return true;
}
/*
* Turn auto mount on/off
*
* automount on
* automount off
*/
static bool automount_cmd(UAContext *ua, const char *cmd)
{
char *onoff;
if (ua->argc != 2) {
if (!get_cmd(ua, _("Turn on or off? "))) {
return true;
}
onoff = ua->cmd;
} else {
onoff = ua->argk[1];
}
ua->automount = (bstrcasecmp(onoff, NT_("off"))) ? 0 : 1;
return true;
}
static inline bool cancel_storage_daemon_job(UAContext *ua, const char *cmd)
{
int i;
STORERES *store;
store = get_storage_resource(ua);
if (store) {
/*
* See what JobId to cancel on the storage daemon.
*/
i = find_arg_with_value(ua, NT_("jobid"));
if (i >= 0) {
if (!is_a_number(ua->argv[i])) {
ua->warning_msg(_("JobId %s not a number\n"), ua->argv[i]);
}
cancel_storage_daemon_job(ua, store, ua->argv[i]);
} else {
ua->warning_msg(_("Missing jobid=JobId specification\n"));
}
}
return true;
}
static inline bool cancel_jobs(UAContext *ua, const char *cmd)
{
JCR *jcr;
JobId_t *JobId;
alist *selection;
selection = select_jobs(ua, "cancel");
if (!selection) {
return true;
}
/*
* Loop over the different JobIds selected.
*/
foreach_alist(JobId, selection) {
if (!(jcr = get_jcr_by_id(*JobId))) {
continue;
}
cancel_job(ua, jcr);
free_jcr(jcr);
}
delete selection;
return true;
}
/*
* Cancel a job
*/
static bool cancel_cmd(UAContext *ua, const char *cmd)
{
int i;
/*
* See if we need to explicitly cancel a storage daemon Job.
*/
i = find_arg_with_value(ua, NT_("storage"));
if (i >= 0) {
return cancel_storage_daemon_job(ua, cmd);
} else {
return cancel_jobs(ua, cmd);
}
}
/*
* Create a Pool Record in the database.
* It is always created from the Resource record.
*/
static bool create_cmd(UAContext *ua, const char *cmd)
{
POOLRES *pool;
if (!open_client_db(ua)) {
return true;
}
pool = get_pool_resource(ua);
if (!pool) {
return true;
}
switch (create_pool(ua->jcr, ua->db, pool, POOL_OP_CREATE)) {
case 0:
ua->error_msg(_("Error: Pool %s already exists.\n"
"Use update to change it.\n"), pool->name());
break;
case -1:
ua->error_msg("%s", db_strerror(ua->db));
break;
default:
break;
}
ua->send_msg(_("Pool %s created.\n"), pool->name());
return true;
}
static inline bool setbwlimit_filed(UAContext *ua, CLIENTRES *client, int64_t limit, char *Job)
{
/*
* Connect to File daemon
*/
ua->jcr->res.client = client;
ua->jcr->max_bandwidth = limit;
/*
* Try to connect for 15 seconds
*/
ua->send_msg(_("Connecting to Client %s at %s:%d\n"),
client->name(), client->address, client->FDport);
if (!connect_to_file_daemon(ua->jcr, 1, 15, false)) {
ua->error_msg(_("Failed to connect to Client.\n"));
return true;
}
Dmsg0(120, "Connected to file daemon\n");
if (!send_bwlimit_to_fd(ua->jcr, Job)) {
ua->error_msg(_("Failed to set bandwidth limit on Client.\n"));
} else {
ua->info_msg(_("OK Limiting bandwidth to %lldkb/s %s\n"), limit / 1024, Job);
}
ua->jcr->file_bsock->signal(BNET_TERMINATE);
ua->jcr->file_bsock->close();
delete ua->jcr->file_bsock;
ua->jcr->file_bsock = NULL;
ua->jcr->res.client = NULL;
ua->jcr->max_bandwidth = 0;
return true;
}
static inline bool setbwlimit_stored(UAContext *ua, STORERES *store,
int64_t limit, char *Job)
{
/*
* Check the storage daemon protocol.
*/
switch (store->Protocol) {
case APT_NDMPV2:
case APT_NDMPV3:
case APT_NDMPV4:
ua->error_msg(_("Storage selected is NDMP storage which cannot have a bandwidth limit\n"));
return true;
default:
break;
}
/*
* Connect to Storage daemon
*/
ua->jcr->res.wstore = store;
ua->jcr->max_bandwidth = limit;
/*
* Try to connect for 15 seconds
*/
ua->send_msg(_("Connecting to Storage daemon %s at %s:%d\n"),
store->name(), store->address, store->SDport);
if (!connect_to_storage_daemon(ua->jcr, 1, 15, false)) {
ua->error_msg(_("Failed to connect to Storage daemon.\n"));
return true;
}
Dmsg0(120, "Connected to Storage daemon\n");
if (!send_bwlimit_to_fd(ua->jcr, Job)) {
ua->error_msg(_("Failed to set bandwidth limit on Storage daemon.\n"));
} else {
ua->info_msg(_("OK Limiting bandwidth to %lldkb/s %s\n"), limit / 1024, Job);
}
ua->jcr->store_bsock->signal(BNET_TERMINATE);
ua->jcr->store_bsock->close();
delete ua->jcr->store_bsock;
ua->jcr->store_bsock = NULL;
ua->jcr->res.wstore = NULL;
ua->jcr->max_bandwidth = 0;
return true;
}
static bool setbwlimit_cmd(UAContext *ua, const char *cmd)
{
int i;
int64_t limit = -1;
CLIENTRES *client = NULL;
STORERES *store = NULL;
char Job[MAX_NAME_LENGTH];
const char *lst[] = {
"job",
"jobid",
"ujobid",
"all",
"state",
NULL
};
memset(Job, 0, sizeof(Job));
i = find_arg_with_value(ua, NT_("limit"));
if (i >= 0) {
limit = ((int64_t)atoi(ua->argv[i]) * 1024);
}
if (limit < 0) {
if (!get_pint(ua, _("Enter new bandwidth limit kb/s: "))) {
return true;
}
limit = ((int64_t)ua->pint32_val * 1024); /* kb/s */
}
if (find_arg_keyword(ua, lst) > 0) {
JCR *jcr;
JobId_t *JobId;
alist *selection;
selection = select_jobs(ua, "limit");
if (!selection) {
return true;
}
/*
* Loop over the different JobIds selected.
*/
foreach_alist(JobId, selection) {
if (!(jcr = get_jcr_by_id(*JobId))) {
continue;
}
jcr->max_bandwidth = limit;
bstrncpy(Job, jcr->Job, sizeof(Job));
switch (jcr->getJobType()) {
case JT_COPY:
case JT_MIGRATE:
store = jcr->res.rstore;
break;
default:
client = jcr->res.client;
break;
}
free_jcr(jcr);
}
delete selection;
} else if (find_arg(ua, NT_("storage")) >= 0) {
store = get_storage_resource(ua);
} else {
client = get_client_resource(ua);
}
if (client) {
return setbwlimit_filed(ua, client, limit, Job);
}
if (store) {
return setbwlimit_stored(ua, store, limit, Job);
}
return true;
}
/*
* Set a new address in a Client resource. We do this only
* if the Console name is the same as the Client name
* and the Console can access the client.
*/
static bool setip_cmd(UAContext *ua, const char *cmd)
{
CLIENTRES *client;
char buf[1024];
if (!ua->cons || !acl_access_ok(ua, Client_ACL, ua->cons->name(), true)) {
ua->error_msg(_("Unauthorized command from this console.\n"));
return true;
}
LockRes();
client = GetClientResWithName(ua->cons->name());
if (!client) {
ua->error_msg(_("Client \"%s\" not found.\n"), ua->cons->name());
goto get_out;
}
if (client->address) {
free(client->address);
}
sockaddr_to_ascii(&(ua->UA_sock->client_addr), buf, sizeof(buf));
client->address = bstrdup(buf);
ua->send_msg(_("Client \"%s\" address set to %s\n"), client->name(), client->address);
get_out:
UnlockRes();
return true;
}
static void do_en_disable_cmd(UAContext *ua, bool setting)
{
SCHEDRES *sched = NULL;
CLIENTRES *client = NULL;
JOBRES *job = NULL;
int i;
i = find_arg(ua, NT_("schedule"));
if (i >= 0) {
i = find_arg_with_value(ua, NT_("schedule"));
if (i >= 0) {
LockRes();
sched = GetScheduleResWithName(ua->argv[i]);
UnlockRes();
} else {
sched = select_enable_disable_schedule_resource(ua, setting);
if (!sched) {
return;
}
}