/
baremetalsolution_v2.projects.locations.instances.html
1043 lines (968 loc) 路 84.1 KB
/
baremetalsolution_v2.projects.locations.instances.html
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
<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.instances.html">instances</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, x__xgafv=None)</a></code></p>
<p class="firstline">Create an Instance.</p>
<p class="toc_element">
<code><a href="#detachLun">detachLun(instance, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Detach LUN from Instance.</p>
<p class="toc_element">
<code><a href="#disableInteractiveSerialConsole">disableInteractiveSerialConsole(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Disable the interactive serial console feature on an instance.</p>
<p class="toc_element">
<code><a href="#enableInteractiveSerialConsole">enableInteractiveSerialConsole(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Enable the interactive serial console feature on an instance.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get details about a single server.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List servers in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update details of a single server.</p>
<p class="toc_element">
<code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.</p>
<p class="toc_element">
<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Starts a server that was shutdown.</p>
<p class="toc_element">
<code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Stop a running server.</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, x__xgafv=None)</code>
<pre>Create an Instance.
Args:
parent: string, Required. The parent project and location. (required)
body: object, The request body.
The object takes the form of:
{ # A server.
"createTime": "A String", # Output only. Create a time stamp.
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
"id": "A String", # Output only. An identifier for the `Instance`, generated by the backend.
"interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
{ # 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.
},
],
"loginInfo": "A String", # Output only. Text field about info for logging in.
"luns": [ # Immutable. List of LUNs associated with this server.
{ # A storage volume logical unit number (LUN).
"bootLun": True or False, # Display if this LUN is a boot LUN.
"id": "A String", # An identifier for the LUN, generated by the backend.
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
"name": "A String", # Output only. The name of the LUN.
"shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
"sizeGb": "A String", # The size of this LUN, in gigabytes.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this LUN.
"storageVolume": "A String", # Display the storage volume for this LUN.
"wwid": "A String", # The WWID for this LUN.
},
],
"machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
"networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
"networks": [ # Output only. List of networks associated with this server.
{ # A Network.
"cidr": "A String", # The cidr of the Network.
"gatewayIp": "A String", # Output only. Gateway ip address.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address configured.
"jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"macAddress": [ # List of physical interfaces.
"A String",
],
"mountPoints": [ # Input only. List of mount points to attach the network to.
{ # Mount point for a network.
"defaultGateway": True or False, # Network should be a default gateway.
"instance": "A String", # Instance to attach network to.
"ipAddress": "A String", # Ip address of the server.
"logicalInterface": "A String", # Logical interface to detach from.
},
],
"name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
"pod": "A String", # Output only. Pod name.
"reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
{ # A reservation of one or more addresses in a network.
"endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
"note": "A String", # A note about this reservation, intended for human consumption.
"startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
},
],
"servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
"state": "A String", # The Network state.
"type": "A String", # The type of this network.
"vlanId": "A String", # The vlan id of the Network.
"vrf": { # A network VRF. # The vrf for the Network.
"name": "A String", # The name of the VRF.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"state": "A String", # The possible state of VRF.
"vlanAttachments": [ # The list of VLAN attachments for the VRF.
{ # VLAN attachment details.
"id": "A String", # Immutable. The identifier of the attachment within vrf.
"pairingKey": "A String", # Input only. Pairing key.
"peerIp": "A String", # The peer IP of the attachment.
"peerVlanId": "A String", # The peer vlan ID of the attachment.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"routerIp": "A String", # The router IP of the attachment.
},
],
},
},
],
"osImage": "A String", # The OS image currently installed on the server.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. Update a time stamp.
"volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
{ # A storage volume.
"autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
"bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
"currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
"emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
"id": "A String", # An identifier for the `Volume`, generated by the backend.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB.
"name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
"notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
"originallyRequestedSizeGib": "A String", # Originally requested size, in GiB.
"performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED.
"pod": "A String", # Immutable. Pod name.
"protocol": "A String", # Output only. Storage protocol for the Volume.
"remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
"requestedSizeGib": "A String", # The requested size of this storage volume, in GiB.
"snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full.
"snapshotEnabled": True or False, # Whether snapshots are enabled.
"snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
"reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB.
"reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.
"reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space.
"reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
},
"snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this volume.
"workloadProfile": "A String", # The workload profile for the volume.
},
],
"workloadProfile": "A String", # The workload profile for the instance.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="detachLun">detachLun(instance, body=None, x__xgafv=None)</code>
<pre>Detach LUN from Instance.
Args:
instance: string, Required. Name of the instance. (required)
body: object, The request body.
The object takes the form of:
{ # Message for detach specific LUN from an Instance.
"lun": "A String", # Required. Name of the Lun to detach.
"skipReboot": True or False, # If true, performs lun unmapping without instance reboot.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="disableInteractiveSerialConsole">disableInteractiveSerialConsole(name, body=None, x__xgafv=None)</code>
<pre>Disable the interactive serial console feature on an instance.
Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:
{ # Message for disabling the interactive serial console on an instance.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="enableInteractiveSerialConsole">enableInteractiveSerialConsole(name, body=None, x__xgafv=None)</code>
<pre>Enable the interactive serial console feature on an instance.
Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:
{ # Message for enabling the interactive serial console on an instance.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get details about a single server.
Args:
name: string, Required. Name of the resource. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A server.
"createTime": "A String", # Output only. Create a time stamp.
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
"id": "A String", # Output only. An identifier for the `Instance`, generated by the backend.
"interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
{ # 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.
},
],
"loginInfo": "A String", # Output only. Text field about info for logging in.
"luns": [ # Immutable. List of LUNs associated with this server.
{ # A storage volume logical unit number (LUN).
"bootLun": True or False, # Display if this LUN is a boot LUN.
"id": "A String", # An identifier for the LUN, generated by the backend.
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
"name": "A String", # Output only. The name of the LUN.
"shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
"sizeGb": "A String", # The size of this LUN, in gigabytes.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this LUN.
"storageVolume": "A String", # Display the storage volume for this LUN.
"wwid": "A String", # The WWID for this LUN.
},
],
"machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
"networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
"networks": [ # Output only. List of networks associated with this server.
{ # A Network.
"cidr": "A String", # The cidr of the Network.
"gatewayIp": "A String", # Output only. Gateway ip address.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address configured.
"jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"macAddress": [ # List of physical interfaces.
"A String",
],
"mountPoints": [ # Input only. List of mount points to attach the network to.
{ # Mount point for a network.
"defaultGateway": True or False, # Network should be a default gateway.
"instance": "A String", # Instance to attach network to.
"ipAddress": "A String", # Ip address of the server.
"logicalInterface": "A String", # Logical interface to detach from.
},
],
"name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
"pod": "A String", # Output only. Pod name.
"reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
{ # A reservation of one or more addresses in a network.
"endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
"note": "A String", # A note about this reservation, intended for human consumption.
"startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
},
],
"servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
"state": "A String", # The Network state.
"type": "A String", # The type of this network.
"vlanId": "A String", # The vlan id of the Network.
"vrf": { # A network VRF. # The vrf for the Network.
"name": "A String", # The name of the VRF.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"state": "A String", # The possible state of VRF.
"vlanAttachments": [ # The list of VLAN attachments for the VRF.
{ # VLAN attachment details.
"id": "A String", # Immutable. The identifier of the attachment within vrf.
"pairingKey": "A String", # Input only. Pairing key.
"peerIp": "A String", # The peer IP of the attachment.
"peerVlanId": "A String", # The peer vlan ID of the attachment.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"routerIp": "A String", # The router IP of the attachment.
},
],
},
},
],
"osImage": "A String", # The OS image currently installed on the server.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. Update a time stamp.
"volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
{ # A storage volume.
"autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
"bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
"currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
"emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
"id": "A String", # An identifier for the `Volume`, generated by the backend.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB.
"name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
"notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
"originallyRequestedSizeGib": "A String", # Originally requested size, in GiB.
"performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED.
"pod": "A String", # Immutable. Pod name.
"protocol": "A String", # Output only. Storage protocol for the Volume.
"remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
"requestedSizeGib": "A String", # The requested size of this storage volume, in GiB.
"snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full.
"snapshotEnabled": True or False, # Whether snapshots are enabled.
"snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
"reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB.
"reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.
"reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space.
"reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
},
"snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this volume.
"workloadProfile": "A String", # The workload profile for the volume.
},
],
"workloadProfile": "A String", # The workload profile for the instance.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List servers in a given project and location.
Args:
parent: string, Required. Parent value for ListInstancesRequest. (required)
filter: string, List filter.
pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
pageToken: string, A token identifying a page of results from the server.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the list of servers.
"instances": [ # The list of servers.
{ # A server.
"createTime": "A String", # Output only. Create a time stamp.
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
"id": "A String", # Output only. An identifier for the `Instance`, generated by the backend.
"interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
{ # 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.
},
],
"loginInfo": "A String", # Output only. Text field about info for logging in.
"luns": [ # Immutable. List of LUNs associated with this server.
{ # A storage volume logical unit number (LUN).
"bootLun": True or False, # Display if this LUN is a boot LUN.
"id": "A String", # An identifier for the LUN, generated by the backend.
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
"name": "A String", # Output only. The name of the LUN.
"shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
"sizeGb": "A String", # The size of this LUN, in gigabytes.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this LUN.
"storageVolume": "A String", # Display the storage volume for this LUN.
"wwid": "A String", # The WWID for this LUN.
},
],
"machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
"networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
"networks": [ # Output only. List of networks associated with this server.
{ # A Network.
"cidr": "A String", # The cidr of the Network.
"gatewayIp": "A String", # Output only. Gateway ip address.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address configured.
"jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"macAddress": [ # List of physical interfaces.
"A String",
],
"mountPoints": [ # Input only. List of mount points to attach the network to.
{ # Mount point for a network.
"defaultGateway": True or False, # Network should be a default gateway.
"instance": "A String", # Instance to attach network to.
"ipAddress": "A String", # Ip address of the server.
"logicalInterface": "A String", # Logical interface to detach from.
},
],
"name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
"pod": "A String", # Output only. Pod name.
"reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
{ # A reservation of one or more addresses in a network.
"endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
"note": "A String", # A note about this reservation, intended for human consumption.
"startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
},
],
"servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
"state": "A String", # The Network state.
"type": "A String", # The type of this network.
"vlanId": "A String", # The vlan id of the Network.
"vrf": { # A network VRF. # The vrf for the Network.
"name": "A String", # The name of the VRF.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"state": "A String", # The possible state of VRF.
"vlanAttachments": [ # The list of VLAN attachments for the VRF.
{ # VLAN attachment details.
"id": "A String", # Immutable. The identifier of the attachment within vrf.
"pairingKey": "A String", # Input only. Pairing key.
"peerIp": "A String", # The peer IP of the attachment.
"peerVlanId": "A String", # The peer vlan ID of the attachment.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"routerIp": "A String", # The router IP of the attachment.
},
],
},
},
],
"osImage": "A String", # The OS image currently installed on the server.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. Update a time stamp.
"volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
{ # A storage volume.
"autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
"bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
"currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
"emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
"id": "A String", # An identifier for the `Volume`, generated by the backend.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB.
"name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
"notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
"originallyRequestedSizeGib": "A String", # Originally requested size, in GiB.
"performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED.
"pod": "A String", # Immutable. Pod name.
"protocol": "A String", # Output only. Storage protocol for the Volume.
"remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
"requestedSizeGib": "A String", # The requested size of this storage volume, in GiB.
"snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full.
"snapshotEnabled": True or False, # Whether snapshots are enabled.
"snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
"reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB.
"reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.
"reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space.
"reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
},
"snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this volume.
"workloadProfile": "A String", # The workload profile for the volume.
},
],
"workloadProfile": "A String", # The workload profile for the instance.
},
],
"nextPageToken": "A String", # A token identifying a page of results from the server.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update details of a single server.
Args:
name: string, Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` (required)
body: object, The request body.
The object takes the form of:
{ # A server.
"createTime": "A String", # Output only. Create a time stamp.
"hyperthreadingEnabled": True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
"id": "A String", # Output only. An identifier for the `Instance`, generated by the backend.
"interactiveSerialConsoleEnabled": True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"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. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled.
{ # 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.
},
],
"loginInfo": "A String", # Output only. Text field about info for logging in.
"luns": [ # Immutable. List of LUNs associated with this server.
{ # A storage volume logical unit number (LUN).
"bootLun": True or False, # Display if this LUN is a boot LUN.
"id": "A String", # An identifier for the LUN, generated by the backend.
"multiprotocolType": "A String", # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
"name": "A String", # Output only. The name of the LUN.
"shareable": True or False, # Display if this LUN can be shared between multiple physical servers.
"sizeGb": "A String", # The size of this LUN, in gigabytes.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this LUN.
"storageVolume": "A String", # Display the storage volume for this LUN.
"wwid": "A String", # The WWID for this LUN.
},
],
"machineType": "A String", # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
"name": "A String", # Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}`
"networkTemplate": "A String", # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic".
"networks": [ # Output only. List of networks associated with this server.
{ # A Network.
"cidr": "A String", # The cidr of the Network.
"gatewayIp": "A String", # Output only. Gateway ip address.
"id": "A String", # An identifier for the `Network`, generated by the backend.
"ipAddress": "A String", # IP address configured.
"jumboFramesEnabled": True or False, # Whether network uses standard frames or jumbo ones.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"macAddress": [ # List of physical interfaces.
"A String",
],
"mountPoints": [ # Input only. List of mount points to attach the network to.
{ # Mount point for a network.
"defaultGateway": True or False, # Network should be a default gateway.
"instance": "A String", # Instance to attach network to.
"ipAddress": "A String", # Ip address of the server.
"logicalInterface": "A String", # Logical interface to detach from.
},
],
"name": "A String", # Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}`
"pod": "A String", # Output only. Pod name.
"reservations": [ # List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server.
{ # A reservation of one or more addresses in a network.
"endAddress": "A String", # The last address of this reservation block, inclusive. I.e., for cases when reservations are only single addresses, end_address and start_address will be the same. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
"note": "A String", # A note about this reservation, intended for human consumption.
"startAddress": "A String", # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
},
],
"servicesCidr": "A String", # IP range for reserved for services (e.g. NFS).
"state": "A String", # The Network state.
"type": "A String", # The type of this network.
"vlanId": "A String", # The vlan id of the Network.
"vrf": { # A network VRF. # The vrf for the Network.
"name": "A String", # The name of the VRF.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VRF. The value is only meaningful when all the vlan attachments have the same QoS. This field should not be used for new integrations, use vlan attachment level qos instead. The field is left for backward-compatibility.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"state": "A String", # The possible state of VRF.
"vlanAttachments": [ # The list of VLAN attachments for the VRF.
{ # VLAN attachment details.
"id": "A String", # Immutable. The identifier of the attachment within vrf.
"pairingKey": "A String", # Input only. Pairing key.
"peerIp": "A String", # The peer IP of the attachment.
"peerVlanId": "A String", # The peer vlan ID of the attachment.
"qosPolicy": { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
"bandwidthGbps": 3.14, # The bandwidth permitted by the QOS policy, in gbps.
},
"routerIp": "A String", # The router IP of the attachment.
},
],
},
},
],
"osImage": "A String", # The OS image currently installed on the server.
"pod": "A String", # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only.
"state": "A String", # Output only. The state of the server.
"updateTime": "A String", # Output only. Update a time stamp.
"volumes": [ # Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses.
{ # A storage volume.
"autoGrownSizeGib": "A String", # The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0.
"bootVolume": True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
"currentSizeGib": "A String", # The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink.
"emergencySizeGib": "A String", # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
"id": "A String", # An identifier for the `Volume`, generated by the backend.
"labels": { # Labels as key value pairs.
"a_key": "A String",
},
"maxSizeGib": "A String", # Maximum size volume can be expanded to in case of evergency, in GiB.
"name": "A String", # Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}`
"notes": "A String", # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
"originallyRequestedSizeGib": "A String", # Originally requested size, in GiB.
"performanceTier": "A String", # Immutable. Performance tier of the Volume. Default is SHARED.
"pod": "A String", # Immutable. Pod name.
"protocol": "A String", # Output only. Storage protocol for the Volume.
"remainingSpaceGib": "A String", # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
"requestedSizeGib": "A String", # The requested size of this storage volume, in GiB.
"snapshotAutoDeleteBehavior": "A String", # The behavior to use when snapshot reserved space is full.
"snapshotEnabled": True or False, # Whether snapshots are enabled.
"snapshotReservationDetail": { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
"reservedSpaceGib": "A String", # The space on this storage volume reserved for snapshots, shown in GiB.
"reservedSpacePercent": 42, # Percent of the total Volume size reserved for snapshot copies. Enabling snapshots requires reserving 20% or more of the storage volume space for snapshots. Maximum reserved space for snapshots is 40%. Setting this field will effectively set snapshot_enabled to true.
"reservedSpaceRemainingGib": "A String", # The amount, in GiB, of available space in this storage volume's reserved snapshot space.
"reservedSpaceUsedPercent": 42, # The percent of snapshot space on this storage volume actually being used by the snapshot copies. This value might be higher than 100% if the snapshot copies have overflowed into the data portion of the storage volume.
},
"snapshotSchedulePolicy": "A String", # The name of the snapshot schedule policy in use for this volume, if any.
"state": "A String", # The state of this storage volume.
"storageType": "A String", # The storage type for this volume.
"workloadProfile": "A String", # The workload profile for the volume.
},
],
"workloadProfile": "A String", # The workload profile for the instance.
}
updateMask: string, The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
<pre>Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:
{ # Message requesting to reset a server.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
<pre>Starts a server that was shutdown.
Args:
name: string, Required. Name of the resource. (required)
body: object, The request body.
The object takes the form of:
{ # Message requesting to start a server.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>