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
|
.. ###################################################
.. ## 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 ##
.. ###################################################
==================================================
Key Manager service (barbican) command-line client
==================================================
The barbican client is the command-line interface (CLI) for
the Key Manager service (barbican) API and its extensions.
This chapter documents :command:`barbican` version ``4.3.0``.
For help on a specific :command:`barbican` command, enter:
.. code-block:: console
$ barbican help COMMAND
.. _barbican_command_usage:
barbican usage
~~~~~~~~~~~~~~
.. code-block:: console
usage: barbican [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--no-auth] [--os-identity-api-version <identity-api-version>]
[--os-auth-url <auth-url>] [--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>] [--endpoint <barbican-url>]
[--interface <barbican-interface>]
[--service-type <barbican-service-type>]
[--service-name <barbican-service-name>]
[--region-name <barbican-region-name>]
[--barbican-api-version <barbican-api-version>] [--insecure]
[--os-cacert <ca-certificate>] [--os-cert <certificate>]
[--os-key <key>] [--timeout <seconds>] [--collect-timing]
.. _barbican_command_options:
barbican 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-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]``.
``--endpoint <barbican-url>, -E <barbican-url>``
Defaults to ``env[BARBICAN_ENDPOINT]``.
``--interface <barbican-interface>``
Defaults to ``env[BARBICAN_INTERFACE]``.
``--service-type <barbican-service-type>``
Defaults to ``env[BARBICAN_SERVICE_TYPE]``.
``--service-name <barbican-service-name>``
Defaults to ``env[BARBICAN_SERVICE_NAME]``.
``--region-name <barbican-region-name>``
Defaults to ``env[BARBICAN_REGION_NAME]``.
``--barbican-api-version <barbican-api-version>``
Defaults to ``env[BARBICAN_API_VERSION]``.
.. _barbican_acl_delete:
barbican acl delete
-------------------
.. code-block:: console
usage: barbican acl delete [-h] URI
Delete ACLs for a secret or container as identified by its href.
**Positional arguments:**
``URI``
The URI reference for the secret or container.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_acl_get:
barbican acl get
----------------
.. code-block:: console
usage: barbican acl get [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
URI
Retrieve ACLs for a secret or container by providing its href.
**Positional arguments:**
``URI``
The URI reference for the secret or container.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_acl_submit:
barbican acl submit
-------------------
.. code-block:: console
usage: barbican acl submit [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URI
Submit ACL on a secret or container as identified by its href.
**Positional arguments:**
``URI``
The URI reference for the secret or container.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--user [USERS], -u [USERS]``
Keystone userid(s) for ACL.
``--project-access``
Flag to enable project access behavior.
``--no-project-access``
Flag to disable project access behavior.
``--operation-type {read}, -o {read}``
Type of Barbican operation ACL is set for
.. _barbican_acl_user_add:
barbican acl user add
---------------------
.. code-block:: console
usage: barbican acl user add [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URI
Add ACL users to a secret or container as identified by its href.
**Positional arguments:**
``URI``
The URI reference for the secret or container.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--user [USERS], -u [USERS]``
Keystone userid(s) for ACL.
``--project-access``
Flag to enable project access behavior.
``--no-project-access``
Flag to disable project access behavior.
``--operation-type {read}, -o {read}``
Type of Barbican operation ACL is set for
.. _barbican_acl_user_remove:
barbican acl user remove
------------------------
.. code-block:: console
usage: barbican acl user remove [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--user [USERS]]
[--project-access | --no-project-access]
[--operation-type {read}]
URI
Remove ACL users from a secret or container as identified by its href.
**Positional arguments:**
``URI``
The URI reference for the secret or container.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--user [USERS], -u [USERS]``
Keystone userid(s) for ACL.
``--project-access``
Flag to enable project access behavior.
``--no-project-access``
Flag to disable project access behavior.
``--operation-type {read}, -o {read}``
Type of Barbican operation ACL is set for
.. _barbican_ca_get:
barbican ca get
---------------
.. code-block:: console
usage: barbican ca get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent] [--prefix PREFIX]
URI
Retrieve a CA by providing its URI.
**Positional arguments:**
``URI``
The URI reference for the CA.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_ca_list:
barbican ca list
----------------
.. code-block:: console
usage: barbican ca list [-h] [-f {csv,html,json,table,value,yaml}] [-c COLUMN]
[--max-width <integer>] [--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]
List CAs.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--limit LIMIT, -l LIMIT``
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
``--offset OFFSET, -o OFFSET``
specify the page offset (default: 0)
``--name NAME, -n NAME``
specify the ca name (default: None)
.. _barbican_secret_container_create:
barbican secret container create
--------------------------------
.. code-block:: console
usage: barbican secret container create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [--name NAME]
[--type TYPE] [--secret SECRET]
Store a container in Barbican.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--name NAME, -n NAME``
a human-friendly name.
``--type TYPE``
type of container to create (default: generic).
``--secret SECRET, -s SECRET``
one secret to store in a container (can be set
multiple times). Example: --secret
"private_key=https://url.test/v1/secrets/1-2-3-4"
.. _barbican_secret_container_delete:
barbican secret container delete
--------------------------------
.. code-block:: console
usage: barbican secret container delete [-h] URI
Delete a container by providing its href.
**Positional arguments:**
``URI``
The URI reference for the container
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_secret_container_get:
barbican secret container get
-----------------------------
.. code-block:: console
usage: barbican secret container get [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
URI
Retrieve a container by providing its URI.
**Positional arguments:**
``URI``
The URI reference for the container.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_secret_container_list:
barbican secret container list
------------------------------
.. code-block:: console
usage: barbican secret container list [-h]
[-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]
[--name NAME] [--type TYPE]
List containers.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--limit LIMIT, -l LIMIT``
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
``--offset OFFSET, -o OFFSET``
specify the page offset (default: 0)
``--name NAME, -n NAME``
specify the container name (default: None)
``--type TYPE, -t TYPE``
specify the type filter for the list (default: None).
.. _barbican_secret_delete:
barbican secret delete
----------------------
.. code-block:: console
usage: barbican secret delete [-h] [--force] URI
Delete a secret by providing its URI.
**Positional arguments:**
``URI``
The URI reference for the secret
**Optional arguments:**
``-h, --help``
show this help message and exit
``--force, -f``
if specified, forces the deletion of secrets that have consumers.
.. _barbican_secret_get:
barbican secret get
-------------------
.. code-block:: console
usage: barbican secret get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--print-empty]
[--noindent] [--prefix PREFIX] [--decrypt]
[--payload]
[--payload_content_type PAYLOAD_CONTENT_TYPE]
URI
Retrieve a secret by providing its URI.
**Positional arguments:**
``URI``
The URI reference for the secret.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--decrypt, -d``
if specified, retrieve the unencrypted secret data;
the data type can be specified with
--payload_content_type.
``--payload, -p``
if specified, retrieve the unencrypted secret data;
the data type can be specified with
--payload_content_type. If the user wishes to only
retrieve the value of the payload they must add "-f
value" to format returning only the value of the
payload
``--payload_content_type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
the content type of the decrypted secret (default:
text/plain).
.. _barbican_secret_list:
barbican secret list
--------------------
.. code-block:: console
usage: barbican secret list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET] [--name NAME]
[--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
[--mode MODE]
List secrets.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--limit LIMIT, -l LIMIT``
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
``--offset OFFSET, -o OFFSET``
specify the page offset (default: 0)
``--name NAME, -n NAME``
specify the secret name (default: None)
``--algorithm ALGORITHM, -a ALGORITHM``
the algorithm filter for the list(default: None).
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
the bit length filter for the list (default: 0).
``--mode MODE, -m MODE``
the algorithm mode filter for the list (default:
None).
.. _barbican_secret_order_create:
barbican secret order create
----------------------------
.. code-block:: console
usage: barbican secret order create [-h]
[-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX] [--name NAME]
[--algorithm ALGORITHM]
[--bit-length BIT_LENGTH] [--mode MODE]
[--payload-content-type PAYLOAD_CONTENT_TYPE]
[--expiration EXPIRATION]
[--request-type REQUEST_TYPE]
[--subject-dn SUBJECT_DN]
[--source-container-ref SOURCE_CONTAINER_REF]
[--ca-id CA_ID] [--profile PROFILE]
[--request-file REQUEST_FILE]
type
Create a new order.
**Positional arguments:**
``type``
the type of the order (key, asymmetric, certificate)
to create.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--name NAME, -n NAME``
a human-friendly name.
``--algorithm ALGORITHM, -a ALGORITHM``
the algorithm to be used with the requested key
(default: aes).
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
the bit length of the requested secret key (default:
256).
``--mode MODE, -m MODE``
the algorithm mode to be used with the requested key
(default: cbc).
``--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
the type/format of the secret to be generated
(default: application/octet-stream).
``--expiration EXPIRATION, -x EXPIRATION``
the expiration time for the secret in ISO 8601 format.
``--request-type REQUEST_TYPE``
the type of the certificate request.
``--subject-dn SUBJECT_DN``
the subject of the certificate.
``--source-container-ref SOURCE_CONTAINER_REF``
the source of the certificate when using stored-key
requests.
``--ca-id CA_ID``
the identifier of the CA to use for the certificate
request.
``--profile PROFILE``
the profile of certificate to use.
``--request-file REQUEST_FILE``
the file containing the CSR.
.. _barbican_secret_order_delete:
barbican secret order delete
----------------------------
.. code-block:: console
usage: barbican secret order delete [-h] URI
Delete an order by providing its href.
**Positional arguments:**
``URI``
The URI reference for the order
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_secret_order_get:
barbican secret order get
-------------------------
.. code-block:: console
usage: barbican secret order get [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--prefix PREFIX]
URI
Retrieve an order by providing its URI.
**Positional arguments:**
``URI``
The URI reference order.
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_secret_order_list:
barbican secret order list
--------------------------
.. code-block:: console
usage: barbican secret order list [-h] [-f {csv,html,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--limit LIMIT] [--offset OFFSET]
List orders.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--limit LIMIT, -l LIMIT``
specify the limit to the number of items to list per
page (default: 10; maximum: 100)
``--offset OFFSET, -o OFFSET``
specify the page offset (default: 0)
.. _barbican_secret_store:
barbican secret store
---------------------
.. code-block:: console
usage: barbican secret store [-h] [-f {html,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--print-empty] [--noindent] [--prefix PREFIX]
[--name NAME] [--payload PAYLOAD]
[--secret-type SECRET_TYPE]
[--payload-content-type PAYLOAD_CONTENT_TYPE]
[--payload-content-encoding PAYLOAD_CONTENT_ENCODING]
[--algorithm ALGORITHM] [--bit-length BIT_LENGTH]
[--mode MODE] [--expiration EXPIRATION]
Store a secret in Barbican.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--name NAME, -n NAME``
a human-friendly name.
``--payload PAYLOAD, -p PAYLOAD``
the unencrypted secret; if provided, you must also
provide a payload_content_type
``--secret-type SECRET_TYPE, -s SECRET_TYPE``
the secret type; must be one of symmetric, public,
private, certificate, passphrase, opaque (default)
``--payload-content-type PAYLOAD_CONTENT_TYPE, -t PAYLOAD_CONTENT_TYPE``
the type/format of the provided secret data;
"text/plain" is assumed to be UTF-8; required when
--payload is supplied.
``--payload-content-encoding PAYLOAD_CONTENT_ENCODING, -e PAYLOAD_CONTENT_ENCODING``
required if --payload-content-type is "application
/octet-stream".
``--algorithm ALGORITHM, -a ALGORITHM``
the algorithm (default: aes).
``--bit-length BIT_LENGTH, -b BIT_LENGTH``
the bit length (default: 256).
``--mode MODE, -m MODE``
the algorithm mode; used only for reference (default:
cbc)
``--expiration EXPIRATION, -x EXPIRATION``
the expiration time for the secret in ISO 8601 format.
.. _barbican_secret_update:
barbican secret update
----------------------
.. code-block:: console
usage: barbican secret update [-h] URI payload
Update a secret with no payload in Barbican.
**Positional arguments:**
``URI``
The URI reference for the secret.
``payload``
the unencrypted secret
**Optional arguments:**
``-h, --help``
show this help message and exit
.. _barbican_secret_consumer_create:
barbican secret consumer create
-------------------------------
.. code-block:: console
usage: barbican secret consumer create [-h] --service-type-name SERVICE_TYPE_NAME
--resource-type RESOURCE_TYPE
--resource-id RESOURCE_ID URI
Create a consumer for a secret.
**Positional arguments:**
``URI``
The URI reference for the secret.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--service-type-name SERVICE_TYPE_NAME, -s SERVICE_TYPE_NAME``
the service that will consume the secret
``--resource-type RESOURCE_TYPE, -t RESOURCE_TYPE``
the type of resource that will consume the secret
``--resource-id RESOURCE_ID, -i RESOURCE_ID``
the id of the resource that will consume the secret
.. _barbican_secret_consumer_delete:
barbican secret consumer delete
-------------------------------
.. code-block:: console
usage: barbican secret consumer delete [-h] --service-type-name SERVICE_TYPE_NAME
--resource-type RESOURCE_TYPE
--resource-id RESOURCE_ID URI
Delete a consumer from a secret.
**Positional arguments:**
``URI``
The URI reference for the secret.
**Optional arguments:**
``-h, --help``
show this help message and exit
``--service-type-name SERVICE_TYPE_NAME, -s SERVICE_TYPE_NAME``
the service that will consume the secret
``--resource-type RESOURCE_TYPE, -t RESOURCE_TYPE``
the type of resource that will consume the secret
``--resource-id RESOURCE_ID, -i RESOURCE_ID``
the id of the resource that will consume the secret
.. _barbican_secret_consumer_list:
barbican secret consumer list
-----------------------------
.. code-block:: console
usage: barbican secret consumer list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN] [--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty] [--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending] [--limit LIMIT]
[--offset OFFSET]
URI
List consumers of a secret.
**Positional arguments:**
``URI``
The URI reference for the secret
**Optional arguments:**
``-h, --help``
show this help message and exit
``--limit LIMIT, -l LIMIT``
specify the limit to the number of items to list per page (default: 10; maximum: 100)
``--offset OFFSET, -o OFFSET``
specify the page offset (default: 0)
**Output formatters:**
``-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml}``
the output format, defaults to table
``-c COLUMN, --column COLUMN``
specify the column(s) to include, can be repeated to show multiple columns
``--sort-column SORT_COLUMN``
specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated
``--sort-ascending``
sort the column(s) in ascending order
``--sort-descending``
sort the column(s) in descending order
**CSV Formatter:**
``--quote {all,minimal,none,nonnumeric}``
when to include quotes, defaults to nonnumeric
**json formatter:**
``--noindent``
whether to disable indenting the JSON
**table formatter:**
``--max-width <integer>``
Maximum display width, <1 to disable. You can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence.
``--fit-width``
Fit the table to the display width. Implied if --max-width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable
``--print-empty``
Print empty table if there is no data to show.
|
