forked from Azure/azure-cli-extensions
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_help.py
More file actions
1124 lines (952 loc) · 47.3 KB
/
_help.py
File metadata and controls
1124 lines (952 loc) · 47.3 KB
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
# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
from knack.help_files import helps # pylint: disable=unused-import
helps['vmware'] = """
type: group
short-summary: Commands to manage Azure VMware Solution.
"""
helps['vmware addon'] = """
type: group
short-summary: Commands to manage addons for a private cloud.
"""
helps['vmware addon hcx'] = """
type: group
short-summary: Commands to manage a HCX addon.
"""
helps['vmware addon srm'] = """
type: group
short-summary: Commands to manage a Site Recovery Manager (SRM) addon.
"""
helps['vmware addon vr'] = """
type: group
short-summary: Commands to manage a vSphere Replication (VR) addon.
"""
helps['vmware addon arc'] = """
type: group
short-summary: Commands to manage a Arc addon.
"""
helps['vmware private-cloud'] = """
type: group
short-summary: Commands to manage private clouds.
"""
helps['vmware cluster'] = """
type: group
short-summary: Commands to manage all the clusters in a private cloud, excluding the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud. For management cluster commands, use az vmware private-cloud.
"""
helps['vmware authorization'] = """
type: group
short-summary: Commands to manage the authorizations of an ExpressRoute Circuit for a private cloud.
"""
helps['vmware hcx-enterprise-site'] = """
type: group
short-summary: Commands to manage HCX Enterprise Sites in a private cloud.
"""
helps['vmware location'] = """
type: group
short-summary: Commands to check availability by location.
"""
helps['vmware datastore'] = """
type: group
short-summary: Commands to manage a datastore in a private cloud cluster.
"""
helps['vmware cluster create'] = """
type: command
short-summary: Create a cluster in a private cloud. The maximum number of clusters is 4.
"""
helps['vmware cluster delete'] = """
type: command
short-summary: Delete a cluster in a private cloud, excluding the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud. To delete the management cluster, use az vmware private-cloud delete.
"""
helps['vmware cluster list'] = """
type: command
short-summary: List clusters in a private cloud, excluding the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.
"""
helps['vmware cluster show'] = """
type: command
short-summary: Show details of a cluster in a private cloud, excluding the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud. To view details of the management cluster, use az vmware private-cloud show.
"""
helps['vmware cluster update'] = """
type: command
short-summary: Update a cluster in a private cloud, excluding the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud. To update details of the management cluster, use az vmware private-cloud update.
"""
helps['vmware cluster list-zones'] = """
type: command
short-summary: List hosts by zone in a cluster in a private cloud, including the first cluster which is the default management cluster. The default management cluster is created and managed as part of the private cloud.
"""
helps['vmware private-cloud add-identity-source'] = """
type: command
short-summary: Add a vCenter Single Sign On Identity Source to a private cloud.
"""
helps['vmware private-cloud addidentitysource'] = """
type: command
short-summary: Add a vCenter Single Sign On Identity Source to a private cloud.
"""
helps['vmware private-cloud add-cmk-encryption'] = """
type: command
short-summary: Add a Customer Managed Keys Encryption to a private cloud.
"""
helps['vmware private-cloud delete-cmk-encryption'] = """
type: command
short-summary: Delete a Customer Managed Keys Encryption from a private cloud.
"""
helps['vmware private-cloud enable-cmk-encryption'] = """
type: command
short-summary: Enable a Customer Managed Keys Encryption to a private cloud.
"""
helps['vmware private-cloud disable-cmk-encryption'] = """
type: command
short-summary: Disable a Customer Managed Keys Encryption from a private cloud.
"""
helps['vmware private-cloud identity'] = """
type: group
short-summary: Commands for Managed Identity in a private cloud.
"""
helps['vmware private-cloud identity assign'] = """
type: command
short-summary: Assign a Managed Identity in a private cloud.
"""
helps['vmware private-cloud identity remove'] = """
type: command
short-summary: Remove a Managed Identity in a private cloud.
"""
helps['vmware private-cloud identity show'] = """
type: command
short-summary: Show Managed Identities in a private cloud.
"""
helps['vmware private-cloud create'] = """
type: command
short-summary: Create a private cloud.
"""
helps['vmware private-cloud delete'] = """
type: command
short-summary: Delete a private cloud.
"""
helps['vmware private-cloud delete-identity-source'] = """
type: command
short-summary: Delete a vCenter Single Sign On Identity Source for a private cloud.
"""
helps['vmware private-cloud deleteidentitysource'] = """
type: command
short-summary: Delete a vCenter Single Sign On Identity Source for a private cloud.
"""
helps['vmware private-cloud list'] = """
type: command
short-summary: List the private clouds.
"""
helps['vmware private-cloud list-admin-credentials'] = """
type: command
short-summary: List the admin credentials for the private cloud.
"""
helps['vmware private-cloud listadmincredentials'] = """
type: command
short-summary: List the admin credentials for the private cloud.
"""
helps['vmware private-cloud show'] = """
type: command
short-summary: Show details of a private cloud.
"""
helps['vmware private-cloud update'] = """
type: command
short-summary: Update a private cloud.
"""
helps['vmware private-cloud rotate-vcenter-password'] = """
type: command
short-summary: Rotate the vCenter password.
examples:
- name: Rotate the vCenter password.
text: az vmware private-cloud rotate-vcenter-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware private-cloud rotate-nsxt-password'] = """
type: command
short-summary: Rotate the NSX-T Manager password.
examples:
- name: Rotate the NSX-T Manager password.
text: az vmware private-cloud rotate-nsxt-password --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware authorization create'] = """
type: command
short-summary: Create an authorization for an ExpressRoute Circuit in a private cloud.
"""
helps['vmware authorization list'] = """
type: command
short-summary: List authorizations for an ExpressRoute Circuit in a private cloud.
"""
helps['vmware authorization show'] = """
type: command
short-summary: Show details of an authorization for an ExpressRoute Circuit in a private cloud.
"""
helps['vmware authorization delete'] = """
type: command
short-summary: Delete an authorization for an ExpressRoute Circuit in a private cloud.
"""
helps['vmware hcx-enterprise-site create'] = """
type: command
short-summary: Create an HCX Enterprise Site in a private cloud.
"""
helps['vmware hcx-enterprise-site list'] = """
type: command
short-summary: List HCX Enterprise Sites in a private cloud.
"""
helps['vmware hcx-enterprise-site show'] = """
type: command
short-summary: Show details of an HCX Enterprise Site in a private cloud.
"""
helps['vmware hcx-enterprise-site delete'] = """
type: command
short-summary: Delete an HCX Enterprise Site in a private cloud.
"""
helps['vmware location checkquotaavailability'] = """
type: command
short-summary: Return quota for subscription by region.
"""
helps['vmware location check-quota-availability'] = """
type: command
short-summary: Return quota for subscription by region.
"""
helps['vmware location checktrialavailability'] = """
type: command
short-summary: Return trial status for subscription by region.
"""
helps['vmware location check-trial-availability'] = """
type: command
short-summary: Return trial status for subscription by region.
"""
helps['vmware datastore create'] = """
type: command
short-summary: Please use "netapp-volume create" or "disk-pool-volume create" instead.
"""
helps['vmware datastore netapp-volume'] = """
type: group
short-summary: Manage NetApp volume resource.
"""
helps['vmware datastore netapp-volume create'] = """
type: command
short-summary: Create a new Microsoft.NetApp provided NetApp volume in a private cloud cluster.
examples:
- name: Create a new Microsoft.NetApp provided NetApp volume based NFSv3 datastore.
text: az vmware datastore netapp-volume create --name ANFDatastore1 --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud --volume-id /subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/ResourceGroup1/providers/Microsoft.NetApp/netAppAccounts/NetAppAccount1/capacityPools/CapacityPool1/volumes/NFSVol1
"""
helps['vmware datastore disk-pool-volume'] = """
type: group
short-summary: Manage disk pool volume resource.
"""
helps['vmware datastore disk-pool-volume create'] = """
type: command
short-summary: Create a VMFS datastore in a private cloud cluster using Microsoft.StoragePool provided iSCSI target.
examples:
- name: Create a new Microsoft.StoragePool provided disk pool based iSCSI datastore.
text: az vmware datastore disk-pool-volume create --name iSCSIDatastore1 --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud --target-id /subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/ResourceGroup1/providers/Microsoft.StoragePool/diskPools/mpio-diskpool/iscsiTargets/mpio-iscsi-target --lun-name lun0
"""
helps['vmware datastore elastic-san-volume'] = """
type: group
short-summary: Manage Elastic SAN volume resource.
"""
helps['vmware datastore elastic-san-volume create'] = """
type: command
short-summary: Create an Elastic SAN volume in a private cloud cluster using Microsoft.ElasticSan provider.
examples:
- name: Create a new Microsoft.ElasticSan provided Elastic SAN volume based datastore.
text: az vmware datastore elastic-san-volume create --name ElasticSANDatastore --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud --elastic-san-volume elasticsan
"""
helps['vmware datastore pure-storage-volume'] = """
type: group
short-summary: Manage Pure Storage volume resource.
"""
helps['vmware datastore pure-storage-volume create'] = """
type: command
short-summary: Create a Pure Storage volume in a private cloud cluster using PureStorage.Block provider.
examples:
- name: Create a new PureStorage.Block provided Pure Storage volume based datastore.
text: az vmware datastore pure-storage-volume create --name PureStorageDatastore --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud --storage-pool-id "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/ResourceGroup1/providers/PureStorage.Block/storagePools/storagePool1" --size-gb 64
"""
helps['vmware datastore show'] = """
type: command
short-summary: Show details of a datastore in a private cloud cluster.
examples:
- name: Show the details of an iSCSI or NFS based datastore.
text: az vmware datastore show --name MyCloudSANDatastore1 --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud
"""
helps['vmware datastore list'] = """
type: command
short-summary: List datastores in a private cloud cluster.
examples:
- name: List all iSCSI or NFS based datastores under Cluster-1.
text: az vmware datastore list --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud
"""
helps['vmware datastore delete'] = """
type: command
short-summary: Delete a datastore in a private cloud cluster.
examples:
- name: Delete an iSCSI or NFS based datastore.
text: az vmware datastore delete --name MyCloudSANDatastore1 --resource-group MyResourceGroup --cluster Cluster-1 --private-cloud MyPrivateCloud
"""
helps['vmware addon list'] = """
type: command
short-summary: List addons in a private cloud.
examples:
- name: List addons in a private cloud.
text: az vmware addon list --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon vr create'] = """
type: command
short-summary: Create a vSphere Replication (VR) addon for a private cloud.
examples:
- name: Create a vSphere Replication (VR) addon.
text: az vmware addon vr create --resource-group MyResourceGroup --private-cloud MyPrivateCloud --vrs-count 1
"""
helps['vmware addon hcx create'] = """
type: command
short-summary: Create a HCX addon for a private cloud.
examples:
- name: Create a HCX addon.
text: az vmware addon hcx create --resource-group MyResourceGroup --private-cloud MyPrivateCloud --offer "VMware MaaS Cloud Provider (Enterprise)"
"""
helps['vmware addon srm create'] = """
type: command
short-summary: Create a Site Recovery Manager (SRM) addon for a private cloud.
examples:
- name: Create a Site Recovery Manager (SRM) addon.
text: az vmware addon srm create --resource-group MyResourceGroup --private-cloud MyPrivateCloud --license-key "41915-178A8-FF4A4-DB683-6D735"
"""
helps['vmware addon arc create'] = """
type: command
short-summary: Create an Arc addon for a private cloud.
examples:
- name: Create an Arc addon.
text: az vmware addon arc create --resource-group MyResourceGroup --private-cloud MyPrivateCloud --vcenter "00000000-0000-0000-0000-000000000000"
"""
helps['vmware addon vr show'] = """
type: command
short-summary: Show details of a vSphere Replication (VR) addon for a private cloud.
examples:
- name: Show details of a vSphere Replication (VR) addon.
text: az vmware addon vr show --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon hcx show'] = """
type: command
short-summary: Show details of a HCX addon for a private cloud.
examples:
- name: Show details of a HCX addon.
text: az vmware addon hcx show --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon srm show'] = """
type: command
short-summary: Show details of a Site Recovery Manager (SRM) addon for a private cloud.
examples:
- name: Show details of a Site Recovery Manager (SRM) addon.
text: az vmware addon srm show --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon arc show'] = """
type: command
short-summary: Show details of an Arc addon for a private cloud.
examples:
- name: Show details of an Arc addon.
text: az vmware addon arc show --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon vr update'] = """
type: command
short-summary: Update a vSphere Replication (VR) addon for a private cloud.
examples:
- name: Update a vSphere Replication (VR) addon.
text: az vmware addon vr update --resource-group MyResourceGroup --private-cloud MyPrivateCloud --vrs-count 1
"""
helps['vmware addon hcx update'] = """
type: command
short-summary: Update a HCX addon for a private cloud.
examples:
- name: Update a HCX addon.
text: az vmware addon hcx update --resource-group MyResourceGroup --private-cloud MyPrivateCloud --offer "VMware MaaS Cloud Provider (Enterprise)"
"""
helps['vmware addon srm update'] = """
type: command
short-summary: Update a Site Recovery Manager (SRM) addon for a private cloud.
examples:
- name: Update a Site Recovery Manager (SRM) addon.
text: az vmware addon srm update --resource-group MyResourceGroup --private-cloud MyPrivateCloud --license-key "41915-178A8-FF4A4-DB683-6D735"
"""
helps['vmware addon arc update'] = """
type: command
short-summary: Update an Arc addon for a private cloud.
examples:
- name: Update an Arc addon.
text: az vmware addon arc update --resource-group MyResourceGroup --private-cloud MyPrivateCloud --vcenter "00000000-0000-0000-0000-000000000000"
"""
helps['vmware addon vr delete'] = """
type: command
short-summary: Delete a vSphere Replication (VR) addon for a private cloud.
examples:
- name: Delete a vSphere Replication (VR) addon.
text: az vmware addon vr delete --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon hcx delete'] = """
type: command
short-summary: Delete a HCX addon for a private cloud.
examples:
- name: Delete a HCX addon.
text: az vmware addon hcx delete --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon srm delete'] = """
type: command
short-summary: Delete a Site Recovery Manager (SRM) addon for a private cloud.
examples:
- name: Delete a Site Recovery Manager (SRM) addon.
text: az vmware addon srm delete --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware addon arc delete'] = """
type: command
short-summary: Delete an Arc addon for a private cloud.
examples:
- name: Delete an Arc addon.
text: az vmware addon arc delete --resource-group MyResourceGroup --private-cloud MyPrivateCloud
"""
helps['vmware global-reach-connection'] = """
type: group
short-summary: Commands to manage global reach connections in a private cloud.
"""
helps['vmware global-reach-connection create'] = """
type: command
short-summary: Create a global reach connection in a private cloud.
"""
helps['vmware global-reach-connection list'] = """
type: command
short-summary: List global reach connections in a private cloud.
"""
helps['vmware global-reach-connection show'] = """
type: command
short-summary: Show details of a global reach connection in a private cloud.
"""
helps['vmware global-reach-connection delete'] = """
type: command
short-summary: Delete a global reach connection in a private cloud.
"""
helps['vmware cloud-link'] = """
type: group
short-summary: Commands to manage cloud links in a private cloud.
"""
helps['vmware cloud-link create'] = """
type: command
short-summary: Create or update a cloud link in a private cloud.
examples:
- name: Create a cloud link.
text: az vmware cloud-link create --resource-group group1 --private-cloud cloud1 --name cloudLink1 --linked-cloud "/subscriptions/12341234-1234-1234-1234-123412341234/resourceGroups/mygroup/providers/Microsoft.AVS/privateClouds/cloud2"
"""
helps['vmware cloud-link list'] = """
type: command
short-summary: List cloud links in a private cloud.
examples:
- name: List cloud links.
text: az vmware cloud-link list --resource-group group1 --private-cloud cloud1
"""
helps['vmware cloud-link show'] = """
type: command
short-summary: Show details of a cloud link in a private cloud.
examples:
- name: Show a cloud link.
text: az vmware cloud-link show --resource-group group1 --private-cloud cloud1 --name cloudLink1
"""
helps['vmware cloud-link delete'] = """
type: command
short-summary: Delete a cloud link in a private cloud.
examples:
- name: Delete a cloud link.
text: az vmware cloud-link delete --resource-group group1 --private-cloud cloud1 --name cloudLink1
"""
helps['vmware script-cmdlet'] = """
type: group
short-summary: Commands to list and show script cmdlet resources.
"""
helps['vmware script-cmdlet list'] = """
type: command
short-summary: List script cmdlet resources available for a private cloud to create a script execution resource on a private cloud.
examples:
- name: List script cmdlet resources.
text: az vmware script-cmdlet list --resource-group group1 --private-cloud cloud1 --script-package package1
"""
helps['vmware script-cmdlet show'] = """
type: command
short-summary: Get information about a script cmdlet resource in a specific package on a private cloud.
examples:
- name: Show a script cmdlet.
text: az vmware script-cmdlet show --resource-group group1 --private-cloud cloud1 --script-package package1 --name cmdlet1
"""
helps['vmware script-package'] = """
type: group
short-summary: Commands to list and show script packages available to run on the private cloud.
"""
helps['vmware script-package list'] = """
type: command
short-summary: List script packages available to run on the private cloud.
examples:
- name: List script packages.
text: az vmware script-package list --resource-group group1 --private-cloud cloud1
"""
helps['vmware script-package show'] = """
type: command
short-summary: Get a script package available to run on a private cloud.
examples:
- name: Show a script package.
text: az vmware script-package show --resource-group group1 --private-cloud cloud1 --name package1
"""
helps['vmware script-execution'] = """
type: group
short-summary: Commands to manage script executions in a private cloud.
"""
helps['vmware script-execution create'] = """
type: command
short-summary: Create or update a script execution in a private cloud.
examples:
- name: Create a script execution.
text: az vmware script-execution create --resource-group group1 --private-cloud cloud1 --name addSsoServer --script-cmdlet-id "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/scriptPackages/AVS.PowerCommands@1.0.0/scriptCmdlets/New-SsoExternalIdentitySource" --timeout P0Y0M0DT0H60M60S --retention P0Y0M60DT0H60M60S --parameter name=DomainName type=Value value=placeholderDomain.local --parameter name=BaseUserDN type=Value "value=DC=placeholder, DC=placeholder" --hidden-parameter name=Password type=SecureValue secureValue=PlaceholderPassword
"""
helps['vmware script-execution list'] = """
type: command
short-summary: List script executions in a private cloud.
examples:
- name: List script executions.
text: az vmware script-execution list --resource-group group1 --private-cloud cloud1
"""
helps['vmware script-execution show'] = """
type: command
short-summary: Get an script execution by name in a private cloud.
examples:
- name: Show a script execution.
text: az vmware script-execution show --resource-group group1 --private-cloud cloud1 --name addSsoServer
"""
helps['vmware script-execution delete'] = """
type: command
short-summary: Delete a script execution in a private cloud.
examples:
- name: Delete a script execution.
text: az vmware script-execution delete --resource-group group1 --private-cloud cloud1 --name addSsoServer
"""
helps['vmware workload-network'] = """
type: group
short-summary: Commands to manage workload-networks in a private cloud.
"""
helps['vmware workload-network dhcp'] = """
type: group
short-summary: Commands to manage a DHCP (Data Host Configuration Protocol) workload network.
"""
helps['vmware workload-network dhcp list'] = """
type: command
short-summary: List DHCP in a private cloud workload network.
examples:
- name: List DHCP in a workload network.
text: az vmware workload-network dhcp list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network dhcp show'] = """
type: command
short-summary: Get DHCP by ID in a private cloud workload network.
examples:
- name: Get DHCP by ID in a workload network.
text: az vmware workload-network dhcp show --resource-group group1 --private-cloud cloud1 --dhcp dhcp1
"""
helps['vmware workload-network dhcp relay'] = """
type: group
short-summary: Commands to manage a DHCP (Data Host Configuration Protocol) workload network.
"""
helps['vmware workload-network dhcp relay create'] = """
type: command
short-summary: Create DHCP by ID in a private cloud workload network.
examples:
- name: Create DHCP by ID in a workload network.
text: az vmware workload-network dhcp relay create --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-addresses 40.1.5.1/24
"""
helps['vmware workload-network dhcp relay delete'] = """
type: command
short-summary: Delete DHCP by ID in a private cloud workload network.
examples:
- name: Delete DHCP by ID in a workload network.
text: az vmware workload-network dhcp relay delete --resource-group group1 --private-cloud cloud1 --dhcp dhcp1
"""
helps['vmware workload-network dhcp relay update'] = """
type: command
short-summary: Update DHCP by ID in a private cloud workload network.
examples:
- name: Update DHCP by ID in a workload network.
text: az vmware workload-network dhcp relay update --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-addresses 40.1.5.1/24
"""
helps['vmware workload-network dhcp server'] = """
type: group
short-summary: Commands to manage a DHCP (Data Host Configuration Protocol) workload network.
"""
helps['vmware workload-network dhcp server create'] = """
type: command
short-summary: Create DHCP by ID in a private cloud workload network.
examples:
- name: Create DHCP by ID in a workload network.
text: az vmware workload-network dhcp server create --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-address 40.1.5.1/24 --lease-time 86400
"""
helps['vmware workload-network dhcp server delete'] = """
type: command
short-summary: Delete DHCP by ID in a private cloud workload network.
examples:
- name: Delete DHCP by ID in a workload network.
text: az vmware workload-network dhcp server delete --resource-group group1 --private-cloud cloud1 --dhcp dhcp1
"""
helps['vmware workload-network dhcp server update'] = """
type: command
short-summary: Update DHCP by ID in a private cloud workload network.
examples:
- name: Update DHCP by ID in a workload network.
text: az vmware workload-network dhcp server update --resource-group group1 --private-cloud cloud1 --dhcp dhcp1 --display-name dhcpConfigurations1 --revision 1 --server-address 40.1.5.1/24 --lease-time 86400
"""
helps['vmware workload-network dns-service'] = """
type: group
short-summary: Commands to manage a DNS Service workload network.
"""
helps['vmware workload-network dns-service list'] = """
type: command
short-summary: List of DNS services in a private cloud workload network.
examples:
- name: List of DNS services in a workload network.
text: az vmware workload-network dns-service list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network dns-service show'] = """
type: command
short-summary: Get a DNS service by ID in a private cloud workload network.
examples:
- name: Get a DNS service by ID in a workload network.
text: az vmware workload-network dns-service show --resource-group group1 --private-cloud cloud1 --dns-service dnsService1
"""
helps['vmware workload-network dns-service create'] = """
type: command
short-summary: Create a DNS service by ID in a private cloud workload network.
examples:
- name: Create a DNS service by ID in a workload network.
text: az vmware workload-network dns-service create --resource-group group1 --private-cloud cloud1 --dns-service dnsService1 --display-name dnsService1 --dns-service-ip 5.5.5.5 --default-dns-zone defaultDnsZone1 --fqdn-zones fqdnZone1 --log-level INFO --revision 1
"""
helps['vmware workload-network dns-service update'] = """
type: command
short-summary: Update a DNS service by ID in a private cloud workload network.
examples:
- name: Update a DNS service by ID in a workload network.
text: az vmware workload-network dns-service update --resource-group group1 --private-cloud cloud1 --dns-service dnsService1 --display-name dnsService1 --dns-service-ip 5.5.5.5 --default-dns-zone defaultDnsZone1 --fqdn-zones fqdnZone1 --log-level INFO --revision 1
"""
helps['vmware workload-network dns-service delete'] = """
type: command
short-summary: Delete a DNS service by ID in a private cloud workload network.
examples:
- name: Delete a DNS service by ID in a workload network.
text: az vmware workload-network dns-service delete --resource-group group1 --private-cloud cloud1 --dns-service dnsService1
"""
helps['vmware workload-network dns-zone'] = """
type: group
short-summary: Commands to manage a DNS Zone workload network.
"""
helps['vmware workload-network dns-zone list'] = """
type: command
short-summary: List of DNS zones in a private cloud workload network.
examples:
- name: List of DNS zones in a workload network.
text: az vmware workload-network dns-zone list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network dns-zone show'] = """
type: command
short-summary: Get a DNS zone by ID in a private cloud workload network.
examples:
- name: Get a DNS zone by ID in a workload network.
text: az vmware workload-network dns-zone show --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1
"""
helps['vmware workload-network dns-zone create'] = """
type: command
short-summary: Create a DNS zone by ID in a private cloud workload network.
examples:
- name: Create a DNS zone by ID in a workload network.
text: az vmware workload-network dns-zone create --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1 --display-name dnsZone1 --domain domain1 --dns-server-ips 1.1.1.1 --source-ip 8.8.8.8 --dns-services 1 --revision 1
"""
helps['vmware workload-network dns-zone update'] = """
type: command
short-summary: Update a DNS zone by ID in a private cloud workload network.
examples:
- name: Update a DNS zone by ID in a workload network.
text: az vmware workload-network dns-zone update --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1 --display-name dnsZone1 --domain domain1 --dns-server-ips 1.1.1.1 --source-ip 8.8.8.8 --dns-services 1 --revision 1
"""
helps['vmware workload-network dns-zone delete'] = """
type: command
short-summary: Delete a DNS zone by ID in a private cloud workload network.
examples:
- name: Delete a DNS zone by ID in a workload network.
text: az vmware workload-network dns-zone delete --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1
"""
helps['vmware workload-network port-mirroring'] = """
type: group
short-summary: Commands to manage a Port Mirroring workload network.
"""
helps['vmware workload-network port-mirroring list'] = """
type: command
short-summary: List of port mirroring profiles in a private cloud workload network.
examples:
- name: List of port mirroring profiles in a workload network.
text: az vmware workload-network port-mirroring list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network port-mirroring show'] = """
type: command
short-summary: Get a port mirroring profile by ID in a private cloud workload network.
examples:
- name: Get a port mirroring profile by ID in a workload network.
text: az vmware workload-network port-mirroring show --resource-group group1 --private-cloud cloud1 --port-mirroring portMirroring1
"""
helps['vmware workload-network port-mirroring create'] = """
type: command
short-summary: Create a port mirroring profile by ID in a private cloud workload network.
examples:
- name: Create a port mirroring profile by ID in a workload network.
text: az vmware workload-network port-mirroring create --resource-group group1 --private-cloud cloud1 --port-mirroring portMirroring1 --display-name portMirroring1 --direction BIDIRECTIONAL --source vmGroup1 --destination vmGroup2 --revision 1
"""
helps['vmware workload-network port-mirroring update'] = """
type: command
short-summary: Update a port mirroring profile by ID in a private cloud workload network.
examples:
- name: Update a port mirroring profile by ID in a workload network.
text: az vmware workload-network port-mirroring update --resource-group group1 --private-cloud cloud1 --port-mirroring portMirroring1 --display-name portMirroring1 --direction BIDIRECTIONAL --source vmGroup1 --destination vmGroup2 --revision 1
"""
helps['vmware workload-network port-mirroring delete'] = """
type: command
short-summary: Delete a port mirroring profile by ID in a private cloud workload network.
examples:
- name: Delete a port mirroring profile by ID in a workload network.
text: az vmware workload-network port-mirroring delete --resource-group group1 --private-cloud cloud1 --port-mirroring portMirroring1
"""
helps['vmware workload-network segment'] = """
type: group
short-summary: Commands to manage a Segment workload network.
"""
helps['vmware workload-network segment list'] = """
type: command
short-summary: List of segments in a private cloud workload network.
examples:
- name: List of segments in a workload network.
text: az vmware workload-network segment list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network segment show'] = """
type: command
short-summary: Get a segment by ID in a private cloud workload network.
examples:
- name: Get a segment by ID in a workload network.
text: az vmware workload-network segment show --resource-group group1 --private-cloud cloud1 --segment segment1
"""
helps['vmware workload-network segment create'] = """
type: command
short-summary: Create a segment by ID in a private cloud workload network.
examples:
- name: Create a segment by ID in a workload network.
text: az vmware workload-network segment create --resource-group group1 --private-cloud cloud1 --segment segment1 --display-name segment1 --connected-gateway /infra/tier-1s/gateway --revision 1 --dhcp-ranges 40.20.0.0 40.20.0.1 --gateway-address 40.20.20.20/16
"""
helps['vmware workload-network segment update'] = """
type: command
short-summary: Update a segment by ID in a private cloud workload network.
examples:
- name: Update a segment by ID in a workload network.
text: az vmware workload-network segment update --resource-group group1 --private-cloud cloud1 --segment segment1 --display-name segment1 --connected-gateway /infra/tier-1s/gateway --revision 1 --dhcp-ranges 40.20.0.0 40.20.0.1 --gateway-address 40.20.20.20/16
"""
helps['vmware workload-network segment delete'] = """
type: command
short-summary: Delete a segment by ID in a private cloud workload network.
examples:
- name: Delete a segment by ID in a workload network.
text: az vmware workload-network segment delete --resource-group group1 --private-cloud cloud1 --segment segment1
"""
helps['vmware workload-network public-ip'] = """
type: group
short-summary: Commands to manage a Public-IP workload network.
"""
helps['vmware workload-network public-ip list'] = """
type: command
short-summary: List of Public IP Blocks in a private cloud workload network.
examples:
- name: List of Public IP Blocks in a workload network.
text: az vmware workload-network public-ip list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network public-ip show'] = """
type: command
short-summary: Get a Public IP Block by ID in a private cloud workload network.
examples:
- name: Get a Public IP Block by ID in a workload network.
text: az vmware workload-network public-ip show --resource-group group1 --private-cloud cloud1 --public-ip publicIP1
"""
helps['vmware workload-network public-ip create'] = """
type: command
short-summary: Create a Public IP Block by ID in a private cloud workload network.
examples:
- name: Create a Public IP Block by ID in a workload network.
text: az vmware workload-network public-ip create --resource-group group1 --private-cloud cloud1 --public-ip publicIP1 --display-name publicIP1 --number-of-public-ips 32
"""
helps['vmware workload-network public-ip delete'] = """
type: command
short-summary: Delete a Public IP Block by ID in a private cloud workload network.
examples:
- name: Delete a Public IP Block by ID in a workload network.
text: az vmware workload-network public-ip delete --resource-group group1 --private-cloud cloud1 --public-ip publicIP1
"""
helps['vmware workload-network vm-group'] = """
type: group
short-summary: Commands to manage a VM Group workload network.
"""
helps['vmware workload-network vm-group list'] = """
type: command
short-summary: List of VM Groups in a private cloud workload network.
examples:
- name: List of VM Groups in a workload network.
text: az vmware workload-network vm-group list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network vm-group show'] = """
type: command
short-summary: Get a VM Group by ID in a private cloud workload network.
examples:
- name: Get a VM Group by ID in a workload network.
text: az vmware workload-network vm-group show --resource-group group1 --private-cloud cloud1 --vm-group vmGroup1
"""
helps['vmware workload-network vm-group create'] = """
type: command
short-summary: Create a VM Group by ID in a private cloud workload network.
examples:
- name: Create a VM Group by ID in a workload network.
text: az vmware workload-network vm-group create --resource-group group1 --private-cloud cloud1 --vm-group vmGroup1 --display-name vmGroup1 --members 564d43da-fefc-2a3b-1d92-42855622fa50 --revision 1
"""
helps['vmware workload-network vm-group update'] = """
type: command
short-summary: Update a VM Group by ID in a private cloud workload network.
examples:
- name: Update a VM Group by ID in a workload network.
text: az vmware workload-network vm-group update --resource-group group1 --private-cloud cloud1 --vm-group vmGroup1 --display-name vmGroup1 --members 564d43da-fefc-2a3b-1d92-42855622fa50 --revision 1
"""
helps['vmware workload-network vm-group delete'] = """
type: command
short-summary: Delete a VM Group by ID in a private cloud workload network.
examples:
- name: Delete a VM Group by ID in a private cloud workload network.
text: az vmware workload-network vm-group delete --resource-group group1 --private-cloud cloud1 --vm-group vmGroup1
"""
helps['vmware workload-network vm'] = """
type: group
short-summary: Commands to manage a Virtual Machine workload network.
"""
helps['vmware workload-network vm list'] = """
type: command
short-summary: List of Virtual Machines in a private cloud workload network.
examples:
- name: List of Virtual Machines in a workload network.
text: az vmware workload-network vm list --resource-group group1 --private-cloud cloud1
"""
helps['vmware workload-network vm show'] = """
type: command
short-summary: Get a Virtual Machines by ID in a private cloud workload network.
examples:
- name: Get a Virtual Machines by ID in a workload network.
text: az vmware workload-network vm show --resource-group group1 --private-cloud cloud1 --virtual-machine vm1
"""
helps['vmware workload-network gateway'] = """
type: group
short-summary: Commands to manage a Gateway workload network.
"""