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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
|
.. ###################################################
.. ## WARNING ######################################
.. ############## WARNING ##########################
.. ########################## WARNING ##############
.. ###################################### WARNING ##
.. ###################################################
.. ###################################################
.. ##
.. This file is tool-generated. Do not edit manually.
.. http://docs.openstack.org/contributor-guide/
.. doc-tools/cli-reference.html
.. ##
.. ## WARNING ######################################
.. ############## WARNING ##########################
.. ########################## WARNING ##############
.. ###################################### WARNING ##
.. ###################################################
=================================================================
Infrastructure Optimization service (watcher) command-line client
=================================================================
The watcher client is the command-line interface (CLI) for the
Infrastructure Optimization service (watcher) API
and its extensions.
This chapter documents watcherclient version ``4.9.0``.
For help on a specific :command:`watcher` command, enter:
.. code-block:: console
$ watcher help COMMAND
.. _watcher_command_usage:
watcher usage
~~~~~~~~~~~~~
.. code-block:: console
usage: watcher [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--no-auth] [--os-identity-api-version <identity-api-version>]
[--os-auth-url <auth-url>] [--os-region-name <region-name>]
[--os-username <auth-user-name>] [--os-user-id <auth-user-id>]
[--os-password <auth-password>]
[--os-user-domain-id <auth-user-domain-id>]
[--os-user-domain-name <auth-user-domain-name>]
[--os-tenant-name <auth-tenant-name>]
[--os-tenant-id <tenant-id>]
[--os-project-id <auth-project-id>]
[--os-project-name <auth-project-name>]
[--os-project-domain-id <auth-project-domain-id>]
[--os-project-domain-name <auth-project-domain-name>]
[--os-auth-token <auth-token>]
[--os-watcher-api-version <os-watcher-api-version>]
[--os-endpoint-type OS_ENDPOINT_TYPE]
[--os-endpoint-override <endpoint-override>] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>]
.. _watcher_command_options:
watcher optional arguments
~~~~~~~~~~~~~~~~~~~~~~~~~~
``--version``
show program's version number and exit
``-v, --verbose``
Increase verbosity of output. Can be repeated.
``-q, --quiet``
Suppress output except warnings and errors.
``--log-file LOG_FILE``
Specify a file to log output. Disabled by default.
``-h, --help``
Show help message and exit.
``--debug``
Show tracebacks on errors.
``--no-auth, -N``
Do not use authentication.
``--os-identity-api-version <identity-api-version>``
Specify Identity API version to use. Defaults to
``env[OS_IDENTITY_API_VERSION]`` or 3.
``--os-auth-url <auth-url>, -A <auth-url>``
Defaults to ``env[OS_AUTH_URL]``.
``--os-region-name <region-name>, -R <region-name>``
Defaults to ``env[OS_REGION_NAME]``.
``--os-username <auth-user-name>, -U <auth-user-name>``
Defaults to ``env[OS_USERNAME]``.
``--os-user-id <auth-user-id>``
Defaults to ``env[OS_USER_ID]``.
``--os-password <auth-password>, -P <auth-password>``
Defaults to ``env[OS_PASSWORD]``.
``--os-user-domain-id <auth-user-domain-id>``
Defaults to ``env[OS_USER_DOMAIN_ID]``.
``--os-user-domain-name <auth-user-domain-name>``
Defaults to ``env[OS_USER_DOMAIN_NAME]``.
``--os-tenant-name <auth-tenant-name>, -T <auth-tenant-name>``
Defaults to ``env[OS_TENANT_NAME]``.
``--os-tenant-id <tenant-id>, -I <tenant-id>``
Defaults to ``env[OS_TENANT_ID]``.
``--os-project-id <auth-project-id>``
Another way to specify tenant ID. This option is
mutually exclusive with --os-tenant-id. Defaults to
``env[OS_PROJECT_ID]``.
``--os-project-name <auth-project-name>``
Another way to specify tenant name. This option is
mutually exclusive with --os-tenant-name. Defaults to
``env[OS_PROJECT_NAME]``.
``--os-project-domain-id <auth-project-domain-id>``
Defaults to ``env[OS_PROJECT_DOMAIN_ID]``.
``--os-project-domain-name <auth-project-domain-name>``
Defaults to ``env[OS_PROJECT_DOMAIN_NAME]``.
``--os-auth-token <auth-token>``
Defaults to ``env[OS_AUTH_TOKEN]``.
``--os-watcher-api-version <os-watcher-api-version>``
Defaults to ``env[OS_INFRA_OPTIM_API_VERSION]``.
``--os-endpoint-type OS_ENDPOINT_TYPE``
Defaults to ``env[OS_ENDPOINT_TYPE]`` or "publicURL"
``--os-endpoint-override <endpoint-override>``
Use this API endpoint instead of the Service Catalog.
.. _watcher_action_list:
watcher action list
-------------------
.. code-block:: console
usage: watcher action list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--action-plan <action-plan>] [--audit <audit>]
[--detail] [--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>] [--marker <marker>]
List information on retrieved actions.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--action-plan <action-plan>``
UUID of the action plan used for filtering.
``--audit <audit>``
UUID of the audit used for filtering.
``--detail``
Show detailed information about actions.
``--limit <limit>``
Maximum number of actions to return per request, 0 for
no limit. Default is the maximum number used by the
Watcher API Service.
``--sort-key <field>``
Action field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
``--marker <marker>``
UUID of the last action in the previous page; displays
list of actions after "marker".
.. _watcher_action_show:
watcher action show
-------------------
.. code-block:: console
usage: watcher action show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<action>
Show detailed information about a given action.
**Positional arguments:**
``<action>``
UUID of the action
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_action_update:
watcher action update
---------------------
.. code-block:: console
usage: watcher action update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
[--state <state>] [--reason <reason>] <action>
Update action command.
**Positional arguments:**
``<action>``
UUID of the action
**Optional arguments:**
``-h, --help``
show this help message and exit
``--state <state>``
New state for the action (e.g., SKIPPED)
``--reason <reason>``
Reason for the action state change.
.. _watcher_actionplan_cancel:
watcher actionplan cancel
-------------------------
.. code-block:: console
usage: watcher actionplan cancel [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>
Cancel action plan command.
**Positional arguments:**
``<action-plan>``
UUID of the action_plan.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_actionplan_create:
watcher actionplan create
-------------------------
.. code-block:: console
usage: watcher actionplan create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX] -a <audit_template>
[-t <audit_type>]
Create new audit.
**Optional arguments:**
``-h, --help``
show this help message and exit
``-a <audit_template>, --audit-template <audit_template>``
Audit template used for this audit (name or uuid).
``-t <audit_type>, --audit_type <audit_type>``
Audit type. It must be ONESHOT or CONTINUOUS. Default
is ONESHOT.
.. _watcher_actionplan_delete:
watcher actionplan delete
-------------------------
.. code-block:: console
usage: watcher actionplan delete [-h] <action-plan> [<action-plan> ...]
Delete action plan command.
**Positional arguments:**
``<action-plan>``
UUID of the action plan
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_actionplan_list:
watcher actionplan list
-----------------------
.. code-block:: console
usage: watcher actionplan list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--audit <audit>] [--detail] [--limit <limit>]
[--marker <actionplan>] [--sort-key <field>]
[--sort-dir <direction>]
List information on retrieved action plans.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--audit <audit>``
UUID of an audit used for filtering.
``--detail``
Show detailed information about action plans.
``--limit <limit>``
Maximum number of action plans to return per request,
0 for no limit. Default is the maximum number used by
the Watcher API Service.
``--marker <actionplan>``
The last actionplan UUID of the previous page;
displays list of actionplans after "marker".
``--sort-key <field>``
Action Plan field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
.. _watcher_actionplan_show:
watcher actionplan show
-----------------------
.. code-block:: console
usage: watcher actionplan show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>
Show detailed information about a given action plan.
**Positional arguments:**
``<action-plan>``
UUID of the action plan
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_actionplan_start:
watcher actionplan start
------------------------
.. code-block:: console
usage: watcher actionplan start [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan>
Start action plan command.
**Positional arguments:**
``<action-plan>``
UUID of the action_plan.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_actionplan_update:
watcher actionplan update
-------------------------
.. code-block:: console
usage: watcher actionplan update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<action-plan> <op> <path=value>
[<path=value> ...]
Update action plan command.
**Positional arguments:**
``<action-plan>``
UUID of the action_plan.
``<op>``
Operation: 'add', 'replace', or 'remove'.
``<path=value>``
Attribute to add, replace, or remove. Can be specified
multiple times. For 'remove', only <path> is
necessary.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audit_create:
watcher audit create
--------------------
.. code-block:: console
usage: watcher audit create [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
[-t <audit_type>] [-p <name=value>]
[-i <interval>] [-g <goal>] [-s <strategy>]
[-a <audit_template>] [--auto-trigger]
Create new audit.
**Optional arguments:**
``-h, --help``
show this help message and exit
``-t <audit_type>, --audit_type <audit_type>``
Audit type. It must be ONESHOT or CONTINUOUS. Default
is ONESHOT.
``-p <name=value>, --parameter <name=value>``
Record strategy parameter/value metadata. Can be
specified multiple times.
``-i <interval>, --interval <interval>``
Audit interval (in seconds or cron format). Cron
inteval can be used like: "\*/5 \* \* \* \*". Only used if
the audit is CONTINUOUS.
``-g <goal>, --goal <goal>``
Goal UUID or name associated to this audit.
``-s <strategy>, --strategy <strategy>``
Strategy UUID or name associated to this audit.
``-a <audit_template>, --audit-template <audit_template>``
Audit template used for this audit (name or uuid).
``--auto-trigger``
Trigger automatically action plan once audit is
succeeded.
.. _watcher_audit_delete:
watcher audit delete
--------------------
.. code-block:: console
usage: watcher audit delete [-h] <audit> [<audit> ...]
Delete audit command.
**Positional arguments:**
``<audit>``
UUID or name of the audit
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audit_list:
watcher audit list
------------------
.. code-block:: console
usage: watcher audit list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--goal <goal>] [--strategy <strategy>]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>]
List information on retrieved audits.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--detail``
Show detailed information about audits.
``--goal <goal>``
UUID or name of the goal used for filtering.
``--strategy <strategy>``
UUID or name of the strategy used for filtering.
``--limit <limit>``
Maximum number of audits to return per request, 0 for
no limit. Default is the maximum number used by the
Watcher API Service.
``--sort-key <field>``
Audit field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
.. _watcher_audit_show:
watcher audit show
------------------
.. code-block:: console
usage: watcher audit show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<audit>
Show detailed information about a given audit.
**Positional arguments:**
``<audit>``
UUID or name of the audit
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audit_update:
watcher audit update
--------------------
.. code-block:: console
usage: watcher audit update [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<audit> <op> <path=value> [<path=value> ...]
Update audit command.
**Positional arguments:**
``<audit>``
UUID or name of the audit.
``<op>``
Operation: 'add', 'replace', or 'remove'.
``<path=value>``
Attribute to add, replace, or remove. Can be specified
multiple times. For 'remove', only <path> is
necessary.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audittemplate_create:
watcher audittemplate create
----------------------------
.. code-block:: console
usage: watcher audittemplate create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX] [-s <strategy>]
[-d <description>] [--scope <path>]
<name> <goal>
Create new audit template.
**Positional arguments:**
``<name>``
Name for this audit template.
``<goal>``
Goal UUID or name associated to this audit template.
**Optional arguments:**
``-h, --help``
show this help message and exit
``-s <strategy>, --strategy <strategy>``
Strategy UUID or name associated to this audit
template.
``-d <description>, --description <description>``
Description of the audit template.
``--scope <path>``
Part of the cluster on which an audit will be done.
Can be provided either in yaml or json file.
YAML example:
::
---
- host_aggregates:
- id: 1
- id: 2
- id: 3
- availability_zones:
- name: AZ1
- name: AZ2
- exclude:
- instances:
- uuid: UUID1
- uuid: UUID2
- compute_nodes:
- name: compute1
JSON example:
::
[
{'host_aggregates': [
{'id': 1},
{'id': 2},
{'id': 3}]},
{'availability_zones': [
{'name': 'AZ1'},
{'name': 'AZ2'}]},
{'exclude': [
{'instances': [
{'uuid': 'UUID1'},
{'uuid': 'UUID2'}]},
{'compute_nodes': [
{'name': 'compute1'}]}]}
]
.. _watcher_audittemplate_delete:
watcher audittemplate delete
----------------------------
.. code-block:: console
usage: watcher audittemplate delete [-h]
<audit-template> [<audit-template> ...]
Delete audit template command.
**Positional arguments:**
``<audit-template>``
UUID or name of the audit template
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audittemplate_list:
watcher audittemplate list
--------------------------
.. code-block:: console
usage: watcher audittemplate list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--detail] [--goal <goal>]
[--strategy <strategy>] [--limit <limit>]
[--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]
List information on retrieved audit templates.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--detail``
Show detailed information about audit templates.
``--goal <goal>``
UUID or name of the goal used for filtering.
``--strategy <strategy>``
UUID or name of the strategy used for filtering.
``--limit <limit>``
Maximum number of audit templates to return per
request, 0 for no limit. Default is the maximum number
used by the Watcher API Service.
``--sort-key <field>``
Audit template field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
``--marker <marker>``
UUID of the last audittemplate in the previous page; displays
list of audittemplates after "marker".
.. _watcher_audittemplate_show:
watcher audittemplate show
--------------------------
.. code-block:: console
usage: watcher audittemplate show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<audit-template>
Show detailed information about a given audit template.
**Positional arguments:**
``<audit-template>``
UUID or name of the audit template
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_audittemplate_update:
watcher audittemplate update
----------------------------
.. code-block:: console
usage: watcher audittemplate update [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<audit-template> <op> <path=value>
[<path=value> ...]
Update audit template command.
**Positional arguments:**
``<audit-template>``
UUID or name of the audit_template.
``<op>``
Operation: 'add', 'replace', or 'remove'.
``<path=value>``
Attribute to add, replace, or remove. Can be specified
multiple times. For 'remove', only <path> is
necessary.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_goal_list:
watcher goal list
-----------------
.. code-block:: console
usage: watcher goal list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]
List information on retrieved goals.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--detail``
Show detailed information about each goal.
``--limit <limit>``
Maximum number of goals to return per request, 0 for
no limit. Default is the maximum number used by the
Watcher API Service.
``--sort-key <field>``
Goal field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
``--marker <marker>``
UUID of the last goal in the previous page; displays
list of goals after "marker".
.. _watcher_goal_show:
watcher goal show
-----------------
.. code-block:: console
usage: watcher goal show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<goal>
Show detailed information about a given goal.
**Positional arguments:**
``<goal>``
UUID or name of the goal
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_scoringengine_list:
watcher scoringengine list
--------------------------
.. code-block:: console
usage: watcher scoringengine list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--detail] [--limit <limit>]
[--sort-key <field>]
[--sort-dir <direction>][--marker <marker>]
List information on retrieved scoring engines.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--detail``
Show detailed information about scoring engines.
``--limit <limit>``
Maximum number of actions to return per request, 0 for
no limit. Default is the maximum number used by the
Watcher API Service.
``--sort-key <field>``
Action field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
``--marker <marker>``
UUID of the last scoringengine in the previous page; displays
list of scoringengines after "marker".
.. _watcher_scoringengine_show:
watcher scoringengine show
--------------------------
.. code-block:: console
usage: watcher scoringengine show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--prefix PREFIX]
<scoring_engine>
Show detailed information about a given scoring engine.
**Positional arguments:**
``<scoring_engine>``
Name of the scoring engine
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_service_list:
watcher service list
--------------------
.. code-block:: console
usage: watcher service list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}] [--detail]
[--limit <limit>] [--sort-key <field>]
[--sort-dir <direction>]
List information on retrieved services.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--detail``
Show detailed information about each service.
``--limit <limit>``
Maximum number of services to return per request, 0
for no limit. Default is the maximum number used by
the Watcher API Service.
``--sort-key <field>``
Goal field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
.. _watcher_service_show:
watcher service show
--------------------
.. code-block:: console
usage: watcher service show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<service>
Show detailed information about a given service.
**Positional arguments:**
``<service>``
ID or name of the service
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_datamodel_list:
watcher datamodel list
----------------------
.. code-block:: console
usage: watcher datamodel list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN] [--type <type>]
[--audit <audit>] [--detail]
List information on retrieved data model.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--type <type>``
Type of Datamodel user want to list. Supported values:
compute. Future support values: storage, baremetal.
Default type is compute.
``--audit <audit>``
UUID of the audit. used to filter data model
by the scope in audit.
``--detail``
Show detailed information about data model.
.. _watcher_strategy_list:
watcher strategy list
---------------------
.. code-block:: console
usage: watcher strategy list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--goal <goal>] [--detail] [--limit <limit>]
[--sort-key <field>] [--sort-dir <direction>]
[--marker <marker>]
List information on retrieved strategies.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--goal <goal>``
UUID or name of the goal
``--detail``
Show detailed information about each strategy.
``--limit <limit>``
Maximum number of strategies to return per request, 0
for no limit. Default is the maximum number used by
the Watcher API Service.
``--sort-key <field>``
Goal field that will be used for sorting.
``--sort-dir <direction>``
Sort direction: "asc" (the default) or "desc".
``--marker <marker>``
UUID of the last strategy in the previous page; displays
list of strategies after "marker".
.. _watcher_strategy_show:
watcher strategy show
---------------------
.. code-block:: console
usage: watcher strategy show [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--fit-width]
[--print-empty] [--noindent] [--prefix PREFIX]
<strategy>
Show detailed information about a given strategy.
**Positional arguments:**
``<strategy>``
UUID or name of the strategy
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _watcher_strategy_state:
watcher strategy state
----------------------
.. code-block:: console
usage: watcher strategy state [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--sort-column SORT_COLUMN]
<strategy>
Retrieve information about strategy requirements.
**Positional arguments:**
``<strategy>``
Name of the strategy
**Optional arguments:**
``-h, --help``
show this help message and exit
|
