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
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="baremetalsolution_v2.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v2.projects.html">projects</a> . <a href="baremetalsolution_v2.projects.locations.html">locations</a> . <a href="baremetalsolution_v2.projects.locations.provisioningConfigs.html">provisioningConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, email=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create new ProvisioningConfig.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get ProvisioningConfig by name.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, email=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update existing ProvisioningConfig.</p>
<p class="toc_element">
<code><a href="#submit">submit(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submit a provisioning configuration for a given project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, email=None, x__xgafv=None)</code>
<pre>Create new ProvisioningConfig.
Args:
parent: string, Required. The parent project and location containing the ProvisioningConfig. (required)
body: object, The request body.
The object takes the form of:
{ # A provisioning configuration.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
}
email: string, Optional. Email provided to send a confirmation with provisioning config to.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A provisioning configuration.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get ProvisioningConfig by name.
Args:
name: string, Required. Name of the ProvisioningConfig. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A provisioning configuration.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, email=None, updateMask=None, x__xgafv=None)</code>
<pre>Update existing ProvisioningConfig.
Args:
name: string, Output only. The system-generated name of the provisioning config. This follows the UUID format. (required)
body: object, The request body.
The object takes the form of:
{ # A provisioning configuration.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
}
email: string, Optional. Email provided to send a confirmation with provisioning config to.
updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A provisioning configuration.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
}</pre>
</div>
<div class="method">
<code class="details" id="submit">submit(parent, body=None, x__xgafv=None)</code>
<pre>Submit a provisioning configuration for a given project.
Args:
parent: string, Required. The parent project and location containing the ProvisioningConfig. (required)
body: object, The request body.
The object takes the form of:
{ # Request for SubmitProvisioningConfig.
"email": "A String", # Optional. Email provided to send a confirmation with provisioning config to.
"provisioningConfig": { # A provisioning configuration. # Required. The ProvisioningConfig to create.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for SubmitProvisioningConfig.
"provisioningConfig": { # A provisioning configuration. # The submitted provisioning config.
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config.
"customId": "A String", # Optional. The user-defined identifier of the provisioning config.
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages.
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account.
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose.
"logicalInterfaces": [ # List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. Filled if InstanceConfig.multivlan_config is true.
{ # Each logical interface represents a logical abstraction of the underlying physical interface (for eg. bond, nic) of the instance. Each logical interface can effectively map to multiple network-IP pairs and still be mapped to one underlying physical interface.
"interfaceIndex": 42, # The index of the logical interface mapping to the index of the hardware bond or nic on the chosen network template. This field is deprecated.
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface.
{ # Each logical network interface is effectively a network and IP pair.
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address in the network
"network": "A String", # Name of the network
"networkType": "A String", # Type of network.
},
],
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name.
},
],
"name": "A String", # The name of the instance config.
"networkConfig": "A String", # The type of network configuration on the instance.
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true.
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false.
"address": "A String", # IPv4 address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use.
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request.
},
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance.
"A String",
],
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period.
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format.
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set.
"name": "A String", # Output only. The name of the network config.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network, either Client or Private.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project.
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.
},
],
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only.
"state": "A String", # Output only. State of ProvisioningConfig.
"statusMessage": "A String", # Optional status messages associated with the FAILED state.
"ticketId": "A String", # A generated ticket id to track provisioning request.
"updateTime": "A String", # Output only. Last update timestamp.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN(Logical Unit Number) range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"name": "A String", # Output only. The name of the volume config.
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication.
"permissions": "A String", # Export permissions.
},
],
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED.
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team .
},
],
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster.
},
}</pre>
</div>
</body></html>
|
