Debian Codegraph @

docs/dyn/baremetalsolution_v2.projects.locations.instances.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#detachLun">detachLun(instance, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Detach LUN from Instance.</p>
83 <p class="toc_element">
84 <code><a href="#disableHyperthreading">disableHyperthreading(name, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Perform disable hyperthreading operation on a single server.</p>
86 <p class="toc_element">
87 <code><a href="#disableInteractiveSerialConsole">disableInteractiveSerialConsole(name, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Disable the interactive serial console feature on an instance.</p>
89 <p class="toc_element">
90 <code><a href="#enableHyperthreading">enableHyperthreading(name, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Perform enable hyperthreading operation on a single server.</p>
92 <p class="toc_element">
93 <code><a href="#enableInteractiveSerialConsole">enableInteractiveSerialConsole(name, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Enable the interactive serial console feature on an instance.</p>
95 <p class="toc_element">
96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97 <p class="firstline">Get details about a single server.</p>
98 <p class="toc_element">
99 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">List servers in a given project and location.</p>
101 <p class="toc_element">
102 <code><a href="#list_next">list_next()</a></code></p>
103 <p class="firstline">Retrieves the next page of results.</p>
104 <p class="toc_element">
105 <code><a href="#loadAuthInfo">loadAuthInfo(name, x__xgafv=None)</a></code></p>
106 <p class="firstline">Load auth info for a server.</p>
107 <p class="toc_element">
108 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
109 <p class="firstline">Update details of a single server.</p>
110 <p class="toc_element">
111 <code><a href="#reimage">reimage(name, body=None, x__xgafv=None)</a></code></p>
112 <p class="firstline">Perform reimage operation on a single server.</p>
113 <p class="toc_element">
114 <code><a href="#rename">rename(name, body=None, x__xgafv=None)</a></code></p>
115 <p class="firstline">RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.</p>
116 <p class="toc_element">
117 <code><a href="#reset">reset(name, body=None, x__xgafv=None)</a></code></p>
118 <p class="firstline">Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.</p>
119 <p class="toc_element">
120 <code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>
121 <p class="firstline">Starts a server that was shutdown.</p>
122 <p class="toc_element">
123 <code><a href="#stop">stop(name, body=None, x__xgafv=None)</a></code></p>
124 <p class="firstline">Stop a running server.</p>
125 <h3>Method Details</h3>
126 <div class="method">
127 <code class="details" id="close">close()</code>
128 <pre>Close httplib2 connections.</pre>
129 </div>
130
131 <div class="method">
132 <code class="details" id="detachLun">detachLun(instance, body=None, x__xgafv=None)</code>
133 <pre>Detach LUN from Instance.
134
135 Args:
136 instance: string, Required. Name of the instance. (required)
137 body: object, The request body.
138 The object takes the form of:
139
140 { # Message for detach specific LUN from an Instance.
141 &quot;lun&quot;: &quot;A String&quot;, # Required. Name of the Lun to detach.
142 &quot;skipReboot&quot;: True or False, # If true, performs lun unmapping without instance reboot.
143 }
144
145 x__xgafv: string, V1 error format.
146 Allowed values
147 1 - v1 error format
148 2 - v2 error format
149
150 Returns:
151 An object of the form:
152
153 { # This resource represents a long-running operation that is the result of a network API call.
154 &quot;done&quot;: 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.
155 &quot;error&quot;: { # 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.
156 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
157 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
158 {
159 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
160 },
161 ],
162 &quot;message&quot;: &quot;A String&quot;, # 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.
163 },
164 &quot;metadata&quot;: { # 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.
165 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
166 },
167 &quot;name&quot;: &quot;A String&quot;, # 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}`.
168 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
169 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
170 },
171 }</pre>
172 </div>
173
174 <div class="method">
175 <code class="details" id="disableHyperthreading">disableHyperthreading(name, body=None, x__xgafv=None)</code>
176 <pre>Perform disable hyperthreading operation on a single server.
177
178 Args:
179 name: string, Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} (required)
180 body: object, The request body.
181 The object takes the form of:
182
183 { # Message requesting to perform disable hyperthreading operation on a server.
184 }
185
186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191 Returns:
192 An object of the form:
193
194 { # This resource represents a long-running operation that is the result of a network API call.
195 &quot;done&quot;: 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.
196 &quot;error&quot;: { # 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.
197 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
198 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
199 {
200 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
201 },
202 ],
203 &quot;message&quot;: &quot;A String&quot;, # 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.
204 },
205 &quot;metadata&quot;: { # 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.
206 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
207 },
208 &quot;name&quot;: &quot;A String&quot;, # 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}`.
209 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
210 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
211 },
212 }</pre>
213 </div>
214
215 <div class="method">
216 <code class="details" id="disableInteractiveSerialConsole">disableInteractiveSerialConsole(name, body=None, x__xgafv=None)</code>
217 <pre>Disable the interactive serial console feature on an instance.
218
219 Args:
220 name: string, Required. Name of the resource. (required)
221 body: object, The request body.
222 The object takes the form of:
223
224 { # Message for disabling the interactive serial console on an instance.
225 }
226
227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
231
232 Returns:
233 An object of the form:
234
235 { # This resource represents a long-running operation that is the result of a network API call.
236 &quot;done&quot;: 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.
237 &quot;error&quot;: { # 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.
238 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
239 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
240 {
241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
242 },
243 ],
244 &quot;message&quot;: &quot;A String&quot;, # 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.
245 },
246 &quot;metadata&quot;: { # 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.
247 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
248 },
249 &quot;name&quot;: &quot;A String&quot;, # 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}`.
250 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
251 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
252 },
253 }</pre>
254 </div>
255
256 <div class="method">
257 <code class="details" id="enableHyperthreading">enableHyperthreading(name, body=None, x__xgafv=None)</code>
258 <pre>Perform enable hyperthreading operation on a single server.
259
260 Args:
261 name: string, Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} (required)
262 body: object, The request body.
263 The object takes the form of:
264
265 { # Message requesting to perform enable hyperthreading operation on a server.
266 }
267
268 x__xgafv: string, V1 error format.
269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
272
273 Returns:
274 An object of the form:
275
276 { # This resource represents a long-running operation that is the result of a network API call.
277 &quot;done&quot;: 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.
278 &quot;error&quot;: { # 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.
279 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
280 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
281 {
282 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
283 },
284 ],
285 &quot;message&quot;: &quot;A String&quot;, # 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.
286 },
287 &quot;metadata&quot;: { # 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.
288 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
289 },
290 &quot;name&quot;: &quot;A String&quot;, # 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}`.
291 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
292 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
293 },
294 }</pre>
295 </div>
296
297 <div class="method">
298 <code class="details" id="enableInteractiveSerialConsole">enableInteractiveSerialConsole(name, body=None, x__xgafv=None)</code>
299 <pre>Enable the interactive serial console feature on an instance.
300
301 Args:
302 name: string, Required. Name of the resource. (required)
303 body: object, The request body.
304 The object takes the form of:
305
306 { # Message for enabling the interactive serial console on an instance.
307 }
308
309 x__xgafv: string, V1 error format.
310 Allowed values
311 1 - v1 error format
312 2 - v2 error format
313
314 Returns:
315 An object of the form:
316
317 { # This resource represents a long-running operation that is the result of a network API call.
318 &quot;done&quot;: 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.
319 &quot;error&quot;: { # 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.
320 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
321 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
322 {
323 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
324 },
325 ],
326 &quot;message&quot;: &quot;A String&quot;, # 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.
327 },
328 &quot;metadata&quot;: { # 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.
329 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
330 },
331 &quot;name&quot;: &quot;A String&quot;, # 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}`.
332 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
333 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
334 },
335 }</pre>
336 </div>
337
338 <div class="method">
339 <code class="details" id="get">get(name, x__xgafv=None)</code>
340 <pre>Get details about a single server.
341
342 Args:
343 name: string, Required. Name of the resource. (required)
344 x__xgafv: string, V1 error format.
345 Allowed values
346 1 - v1 error format
347 2 - v2 error format
348
349 Returns:
350 An object of the form:
351
352 { # A server.
353 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create a time stamp.
354 &quot;firmwareVersion&quot;: &quot;A String&quot;, # Output only. The firmware version for the instance.
355 &quot;hyperthreadingEnabled&quot;: True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
356 &quot;id&quot;: &quot;A String&quot;, # Output only. An identifier for the `Instance`, generated by the backend.
357 &quot;interactiveSerialConsoleEnabled&quot;: True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
358 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
359 &quot;labels&quot;: { # Labels as key value pairs.
360 &quot;a_key&quot;: &quot;A String&quot;,
361 },
362 &quot;logicalInterfaces&quot;: [ # 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.
363 { # 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.
364 &quot;interfaceIndex&quot;: 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.
365 &quot;logicalNetworkInterfaces&quot;: [ # List of logical network interfaces within a logical interface.
366 { # Each logical network interface is effectively a network and IP pair.
367 &quot;defaultGateway&quot;: True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
368 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
369 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address in the network
370 &quot;network&quot;: &quot;A String&quot;, # Name of the network
371 &quot;networkType&quot;: &quot;A String&quot;, # Type of network.
372 },
373 ],
374 &quot;name&quot;: &quot;A String&quot;, # Interface name. This is of syntax or and forms part of the network template name.
375 },
376 ],
377 &quot;loginInfo&quot;: &quot;A String&quot;, # Output only. Text field about info for logging in.
378 &quot;luns&quot;: [ # Immutable. List of LUNs associated with this server.
379 { # A storage volume logical unit number (LUN).
380 &quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
381 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
382 &quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
383 &quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
384 &quot;A String&quot;,
385 ],
386 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
387 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
388 &quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
389 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
390 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
391 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
392 &quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
393 &quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
394 },
395 ],
396 &quot;machineType&quot;: &quot;A String&quot;, # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
397 &quot;name&quot;: &quot;A String&quot;, # 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}`
398 &quot;networkTemplate&quot;: &quot;A String&quot;, # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of &quot;bond&quot; or &quot;nic&quot;.
399 &quot;networks&quot;: [ # Output only. List of networks associated with this server.
400 { # A Network.
401 &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
402 &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
403 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
404 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
405 &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
406 &quot;labels&quot;: { # Labels as key value pairs.
407 &quot;a_key&quot;: &quot;A String&quot;,
408 },
409 &quot;macAddress&quot;: [ # List of physical interfaces.
410 &quot;A String&quot;,
411 ],
412 &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
413 { # Mount point for a network.
414 &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
415 &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
416 &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
417 &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
418 },
419 ],
420 &quot;name&quot;: &quot;A String&quot;, # 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}`
421 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
422 &quot;reservations&quot;: [ # 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.
423 { # A reservation of one or more addresses in a network.
424 &quot;endAddress&quot;: &quot;A String&quot;, # 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.
425 &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
426 &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
427 },
428 ],
429 &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
430 &quot;state&quot;: &quot;A String&quot;, # The Network state.
431 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
432 &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
433 &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
434 &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
435 &quot;qosPolicy&quot;: { # 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.
436 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
437 },
438 &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
439 &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
440 { # VLAN attachment details.
441 &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
442 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
443 &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
444 &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
445 &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
446 &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
447 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
448 },
449 &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
450 },
451 ],
452 },
453 &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
454 },
455 ],
456 &quot;osImage&quot;: &quot;A String&quot;, # The OS image currently installed on the server.
457 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
458 &quot;sshKeys&quot;: [ # Optional. List of SSH Keys used during instance provisioning.
459 &quot;A String&quot;,
460 ],
461 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the server.
462 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update a time stamp.
463 &quot;volumes&quot;: [ # Input only. List of Volumes to attach to this Instance on creation. This field won&#x27;t be populated in Get/List responses.
464 { # A storage volume.
465 &quot;attached&quot;: True or False, # Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.
466 &quot;autoGrownSizeGib&quot;: &quot;A String&quot;, # 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.
467 &quot;bootVolume&quot;: True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
468 &quot;currentSizeGib&quot;: &quot;A String&quot;, # 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.
469 &quot;emergencySizeGib&quot;: &quot;A String&quot;, # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
470 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
471 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Volume`, generated by the backend.
472 &quot;instances&quot;: [ # Output only. Instances this Volume is attached to. This field is set only in Get requests.
473 &quot;A String&quot;,
474 ],
475 &quot;labels&quot;: { # Labels as key value pairs.
476 &quot;a_key&quot;: &quot;A String&quot;,
477 },
478 &quot;maxSizeGib&quot;: &quot;A String&quot;, # Maximum size volume can be expanded to in case of evergency, in GiB.
479 &quot;name&quot;: &quot;A String&quot;, # 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}`
480 &quot;notes&quot;: &quot;A String&quot;, # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
481 &quot;originallyRequestedSizeGib&quot;: &quot;A String&quot;, # Originally requested size, in GiB.
482 &quot;performanceTier&quot;: &quot;A String&quot;, # Immutable. Performance tier of the Volume. Default is SHARED.
483 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
484 &quot;protocol&quot;: &quot;A String&quot;, # Output only. Storage protocol for the Volume.
485 &quot;remainingSpaceGib&quot;: &quot;A String&quot;, # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
486 &quot;requestedSizeGib&quot;: &quot;A String&quot;, # The requested size of this storage volume, in GiB.
487 &quot;snapshotAutoDeleteBehavior&quot;: &quot;A String&quot;, # The behavior to use when snapshot reserved space is full.
488 &quot;snapshotEnabled&quot;: True or False, # Whether snapshots are enabled.
489 &quot;snapshotReservationDetail&quot;: { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
490 &quot;reservedSpaceGib&quot;: &quot;A String&quot;, # The space on this storage volume reserved for snapshots, shown in GiB.
491 &quot;reservedSpacePercent&quot;: 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.
492 &quot;reservedSpaceRemainingGib&quot;: &quot;A String&quot;, # The amount, in GiB, of available space in this storage volume&#x27;s reserved snapshot space.
493 &quot;reservedSpaceUsedPercent&quot;: 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.
494 },
495 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
496 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this volume.
497 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the volume.
498 },
499 ],
500 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the instance.
501 }</pre>
502 </div>
503
504 <div class="method">
505 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
506 <pre>List servers in a given project and location.
507
508 Args:
509 parent: string, Required. Parent value for ListInstancesRequest. (required)
510 filter: string, List filter.
511 pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
512 pageToken: string, A token identifying a page of results from the server.
513 x__xgafv: string, V1 error format.
514 Allowed values
515 1 - v1 error format
516 2 - v2 error format
517
518 Returns:
519 An object of the form:
520
521 { # Response message for the list of servers.
522 &quot;instances&quot;: [ # The list of servers.
523 { # A server.
524 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create a time stamp.
525 &quot;firmwareVersion&quot;: &quot;A String&quot;, # Output only. The firmware version for the instance.
526 &quot;hyperthreadingEnabled&quot;: True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
527 &quot;id&quot;: &quot;A String&quot;, # Output only. An identifier for the `Instance`, generated by the backend.
528 &quot;interactiveSerialConsoleEnabled&quot;: True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
529 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
530 &quot;labels&quot;: { # Labels as key value pairs.
531 &quot;a_key&quot;: &quot;A String&quot;,
532 },
533 &quot;logicalInterfaces&quot;: [ # 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.
534 { # 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.
535 &quot;interfaceIndex&quot;: 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.
536 &quot;logicalNetworkInterfaces&quot;: [ # List of logical network interfaces within a logical interface.
537 { # Each logical network interface is effectively a network and IP pair.
538 &quot;defaultGateway&quot;: True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
539 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
540 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address in the network
541 &quot;network&quot;: &quot;A String&quot;, # Name of the network
542 &quot;networkType&quot;: &quot;A String&quot;, # Type of network.
543 },
544 ],
545 &quot;name&quot;: &quot;A String&quot;, # Interface name. This is of syntax or and forms part of the network template name.
546 },
547 ],
548 &quot;loginInfo&quot;: &quot;A String&quot;, # Output only. Text field about info for logging in.
549 &quot;luns&quot;: [ # Immutable. List of LUNs associated with this server.
550 { # A storage volume logical unit number (LUN).
551 &quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
552 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
553 &quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
554 &quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
555 &quot;A String&quot;,
556 ],
557 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
558 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
559 &quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
560 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
561 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
562 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
563 &quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
564 &quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
565 },
566 ],
567 &quot;machineType&quot;: &quot;A String&quot;, # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
568 &quot;name&quot;: &quot;A String&quot;, # 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}`
569 &quot;networkTemplate&quot;: &quot;A String&quot;, # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of &quot;bond&quot; or &quot;nic&quot;.
570 &quot;networks&quot;: [ # Output only. List of networks associated with this server.
571 { # A Network.
572 &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
573 &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
574 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
575 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
576 &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
577 &quot;labels&quot;: { # Labels as key value pairs.
578 &quot;a_key&quot;: &quot;A String&quot;,
579 },
580 &quot;macAddress&quot;: [ # List of physical interfaces.
581 &quot;A String&quot;,
582 ],
583 &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
584 { # Mount point for a network.
585 &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
586 &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
587 &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
588 &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
589 },
590 ],
591 &quot;name&quot;: &quot;A String&quot;, # 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}`
592 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
593 &quot;reservations&quot;: [ # 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.
594 { # A reservation of one or more addresses in a network.
595 &quot;endAddress&quot;: &quot;A String&quot;, # 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.
596 &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
597 &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
598 },
599 ],
600 &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
601 &quot;state&quot;: &quot;A String&quot;, # The Network state.
602 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
603 &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
604 &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
605 &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
606 &quot;qosPolicy&quot;: { # 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.
607 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
608 },
609 &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
610 &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
611 { # VLAN attachment details.
612 &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
613 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
614 &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
615 &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
616 &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
617 &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
618 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
619 },
620 &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
621 },
622 ],
623 },
624 &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
625 },
626 ],
627 &quot;osImage&quot;: &quot;A String&quot;, # The OS image currently installed on the server.
628 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
629 &quot;sshKeys&quot;: [ # Optional. List of SSH Keys used during instance provisioning.
630 &quot;A String&quot;,
631 ],
632 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the server.
633 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update a time stamp.
634 &quot;volumes&quot;: [ # Input only. List of Volumes to attach to this Instance on creation. This field won&#x27;t be populated in Get/List responses.
635 { # A storage volume.
636 &quot;attached&quot;: True or False, # Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.
637 &quot;autoGrownSizeGib&quot;: &quot;A String&quot;, # 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.
638 &quot;bootVolume&quot;: True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
639 &quot;currentSizeGib&quot;: &quot;A String&quot;, # 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.
640 &quot;emergencySizeGib&quot;: &quot;A String&quot;, # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
641 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
642 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Volume`, generated by the backend.
643 &quot;instances&quot;: [ # Output only. Instances this Volume is attached to. This field is set only in Get requests.
644 &quot;A String&quot;,
645 ],
646 &quot;labels&quot;: { # Labels as key value pairs.
647 &quot;a_key&quot;: &quot;A String&quot;,
648 },
649 &quot;maxSizeGib&quot;: &quot;A String&quot;, # Maximum size volume can be expanded to in case of evergency, in GiB.
650 &quot;name&quot;: &quot;A String&quot;, # 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}`
651 &quot;notes&quot;: &quot;A String&quot;, # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
652 &quot;originallyRequestedSizeGib&quot;: &quot;A String&quot;, # Originally requested size, in GiB.
653 &quot;performanceTier&quot;: &quot;A String&quot;, # Immutable. Performance tier of the Volume. Default is SHARED.
654 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
655 &quot;protocol&quot;: &quot;A String&quot;, # Output only. Storage protocol for the Volume.
656 &quot;remainingSpaceGib&quot;: &quot;A String&quot;, # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
657 &quot;requestedSizeGib&quot;: &quot;A String&quot;, # The requested size of this storage volume, in GiB.
658 &quot;snapshotAutoDeleteBehavior&quot;: &quot;A String&quot;, # The behavior to use when snapshot reserved space is full.
659 &quot;snapshotEnabled&quot;: True or False, # Whether snapshots are enabled.
660 &quot;snapshotReservationDetail&quot;: { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
661 &quot;reservedSpaceGib&quot;: &quot;A String&quot;, # The space on this storage volume reserved for snapshots, shown in GiB.
662 &quot;reservedSpacePercent&quot;: 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.
663 &quot;reservedSpaceRemainingGib&quot;: &quot;A String&quot;, # The amount, in GiB, of available space in this storage volume&#x27;s reserved snapshot space.
664 &quot;reservedSpaceUsedPercent&quot;: 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.
665 },
666 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
667 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this volume.
668 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the volume.
669 },
670 ],
671 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the instance.
672 },
673 ],
674 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results from the server.
675 &quot;unreachable&quot;: [ # Locations that could not be reached.
676 &quot;A String&quot;,
677 ],
678 }</pre>
679 </div>
680
681 <div class="method">
682 <code class="details" id="list_next">list_next()</code>
683 <pre>Retrieves the next page of results.
684
685 Args:
686 previous_request: The request for the previous page. (required)
687 previous_response: The response from the request for the previous page. (required)
688
689 Returns:
690 A request object that you can call &#x27;execute()&#x27; on to request the next
691 page. Returns None if there are no more items in the collection.
692 </pre>
693 </div>
694
695 <div class="method">
696 <code class="details" id="loadAuthInfo">loadAuthInfo(name, x__xgafv=None)</code>
697 <pre>Load auth info for a server.
698
699 Args:
700 name: string, Required. Name of the server. (required)
701 x__xgafv: string, V1 error format.
702 Allowed values
703 1 - v1 error format
704 2 - v2 error format
705
706 Returns:
707 An object of the form:
708
709 { # Response for LoadInstanceAuthInfo.
710 &quot;sshKeys&quot;: [ # List of ssh keys.
711 { # An SSH key, used for authorizing with the interactive serial console feature.
712 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this SSH key. Currently, the only valid value for the location is &quot;global&quot;.
713 &quot;publicKey&quot;: &quot;A String&quot;, # The public SSH key. This must be in OpenSSH .authorized_keys format.
714 },
715 ],
716 &quot;userAccounts&quot;: { # Map of username to the user account info.
717 &quot;a_key&quot;: { # User account provisioned for the customer.
718 &quot;encryptedPassword&quot;: &quot;A String&quot;, # Encrypted initial password value.
719 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # KMS CryptoKey Version used to encrypt the password.
720 },
721 },
722 }</pre>
723 </div>
724
725 <div class="method">
726 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
727 <pre>Update details of a single server.
728
729 Args:
730 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)
731 body: object, The request body.
732 The object takes the form of:
733
734 { # A server.
735 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create a time stamp.
736 &quot;firmwareVersion&quot;: &quot;A String&quot;, # Output only. The firmware version for the instance.
737 &quot;hyperthreadingEnabled&quot;: True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
738 &quot;id&quot;: &quot;A String&quot;, # Output only. An identifier for the `Instance`, generated by the backend.
739 &quot;interactiveSerialConsoleEnabled&quot;: True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
740 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
741 &quot;labels&quot;: { # Labels as key value pairs.
742 &quot;a_key&quot;: &quot;A String&quot;,
743 },
744 &quot;logicalInterfaces&quot;: [ # 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.
745 { # 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.
746 &quot;interfaceIndex&quot;: 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.
747 &quot;logicalNetworkInterfaces&quot;: [ # List of logical network interfaces within a logical interface.
748 { # Each logical network interface is effectively a network and IP pair.
749 &quot;defaultGateway&quot;: True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
750 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
751 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address in the network
752 &quot;network&quot;: &quot;A String&quot;, # Name of the network
753 &quot;networkType&quot;: &quot;A String&quot;, # Type of network.
754 },
755 ],
756 &quot;name&quot;: &quot;A String&quot;, # Interface name. This is of syntax or and forms part of the network template name.
757 },
758 ],
759 &quot;loginInfo&quot;: &quot;A String&quot;, # Output only. Text field about info for logging in.
760 &quot;luns&quot;: [ # Immutable. List of LUNs associated with this server.
761 { # A storage volume logical unit number (LUN).
762 &quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
763 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
764 &quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
765 &quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
766 &quot;A String&quot;,
767 ],
768 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
769 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
770 &quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
771 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
772 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
773 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
774 &quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
775 &quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
776 },
777 ],
778 &quot;machineType&quot;: &quot;A String&quot;, # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
779 &quot;name&quot;: &quot;A String&quot;, # 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}`
780 &quot;networkTemplate&quot;: &quot;A String&quot;, # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of &quot;bond&quot; or &quot;nic&quot;.
781 &quot;networks&quot;: [ # Output only. List of networks associated with this server.
782 { # A Network.
783 &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
784 &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
785 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
786 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
787 &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
788 &quot;labels&quot;: { # Labels as key value pairs.
789 &quot;a_key&quot;: &quot;A String&quot;,
790 },
791 &quot;macAddress&quot;: [ # List of physical interfaces.
792 &quot;A String&quot;,
793 ],
794 &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
795 { # Mount point for a network.
796 &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
797 &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
798 &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
799 &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
800 },
801 ],
802 &quot;name&quot;: &quot;A String&quot;, # 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}`
803 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
804 &quot;reservations&quot;: [ # 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.
805 { # A reservation of one or more addresses in a network.
806 &quot;endAddress&quot;: &quot;A String&quot;, # 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.
807 &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
808 &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
809 },
810 ],
811 &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
812 &quot;state&quot;: &quot;A String&quot;, # The Network state.
813 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
814 &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
815 &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
816 &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
817 &quot;qosPolicy&quot;: { # 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.
818 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
819 },
820 &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
821 &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
822 { # VLAN attachment details.
823 &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
824 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
825 &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
826 &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
827 &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
828 &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
829 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
830 },
831 &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
832 },
833 ],
834 },
835 &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
836 },
837 ],
838 &quot;osImage&quot;: &quot;A String&quot;, # The OS image currently installed on the server.
839 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
840 &quot;sshKeys&quot;: [ # Optional. List of SSH Keys used during instance provisioning.
841 &quot;A String&quot;,
842 ],
843 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the server.
844 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update a time stamp.
845 &quot;volumes&quot;: [ # Input only. List of Volumes to attach to this Instance on creation. This field won&#x27;t be populated in Get/List responses.
846 { # A storage volume.
847 &quot;attached&quot;: True or False, # Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.
848 &quot;autoGrownSizeGib&quot;: &quot;A String&quot;, # 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.
849 &quot;bootVolume&quot;: True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
850 &quot;currentSizeGib&quot;: &quot;A String&quot;, # 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.
851 &quot;emergencySizeGib&quot;: &quot;A String&quot;, # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
852 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
853 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Volume`, generated by the backend.
854 &quot;instances&quot;: [ # Output only. Instances this Volume is attached to. This field is set only in Get requests.
855 &quot;A String&quot;,
856 ],
857 &quot;labels&quot;: { # Labels as key value pairs.
858 &quot;a_key&quot;: &quot;A String&quot;,
859 },
860 &quot;maxSizeGib&quot;: &quot;A String&quot;, # Maximum size volume can be expanded to in case of evergency, in GiB.
861 &quot;name&quot;: &quot;A String&quot;, # 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}`
862 &quot;notes&quot;: &quot;A String&quot;, # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
863 &quot;originallyRequestedSizeGib&quot;: &quot;A String&quot;, # Originally requested size, in GiB.
864 &quot;performanceTier&quot;: &quot;A String&quot;, # Immutable. Performance tier of the Volume. Default is SHARED.
865 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
866 &quot;protocol&quot;: &quot;A String&quot;, # Output only. Storage protocol for the Volume.
867 &quot;remainingSpaceGib&quot;: &quot;A String&quot;, # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
868 &quot;requestedSizeGib&quot;: &quot;A String&quot;, # The requested size of this storage volume, in GiB.
869 &quot;snapshotAutoDeleteBehavior&quot;: &quot;A String&quot;, # The behavior to use when snapshot reserved space is full.
870 &quot;snapshotEnabled&quot;: True or False, # Whether snapshots are enabled.
871 &quot;snapshotReservationDetail&quot;: { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
872 &quot;reservedSpaceGib&quot;: &quot;A String&quot;, # The space on this storage volume reserved for snapshots, shown in GiB.
873 &quot;reservedSpacePercent&quot;: 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.
874 &quot;reservedSpaceRemainingGib&quot;: &quot;A String&quot;, # The amount, in GiB, of available space in this storage volume&#x27;s reserved snapshot space.
875 &quot;reservedSpaceUsedPercent&quot;: 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.
876 },
877 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
878 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this volume.
879 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the volume.
880 },
881 ],
882 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the instance.
883 }
884
885 updateMask: string, The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image` `ssh_keys` `kms_key_version`
886 x__xgafv: string, V1 error format.
887 Allowed values
888 1 - v1 error format
889 2 - v2 error format
890
891 Returns:
892 An object of the form:
893
894 { # This resource represents a long-running operation that is the result of a network API call.
895 &quot;done&quot;: 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.
896 &quot;error&quot;: { # 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.
897 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
898 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
899 {
900 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
901 },
902 ],
903 &quot;message&quot;: &quot;A String&quot;, # 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.
904 },
905 &quot;metadata&quot;: { # 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.
906 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
907 },
908 &quot;name&quot;: &quot;A String&quot;, # 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}`.
909 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
910 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
911 },
912 }</pre>
913 </div>
914
915 <div class="method">
916 <code class="details" id="reimage">reimage(name, body=None, x__xgafv=None)</code>
917 <pre>Perform reimage operation on a single server.
918
919 Args:
920 name: string, Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} (required)
921 body: object, The request body.
922 The object takes the form of:
923
924 { # Message requesting to perform reimage operation on a server.
925 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
926 &quot;osImage&quot;: &quot;A String&quot;, # Required. The OS image code of the image which will be used in the reimage operation.
927 &quot;sshKeys&quot;: [ # Optional. List of SSH Keys used during reimaging an instance.
928 &quot;A String&quot;,
929 ],
930 }
931
932 x__xgafv: string, V1 error format.
933 Allowed values
934 1 - v1 error format
935 2 - v2 error format
936
937 Returns:
938 An object of the form:
939
940 { # This resource represents a long-running operation that is the result of a network API call.
941 &quot;done&quot;: 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.
942 &quot;error&quot;: { # 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.
943 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
944 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
945 {
946 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
947 },
948 ],
949 &quot;message&quot;: &quot;A String&quot;, # 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.
950 },
951 &quot;metadata&quot;: { # 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.
952 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
953 },
954 &quot;name&quot;: &quot;A String&quot;, # 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}`.
955 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
956 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
957 },
958 }</pre>
959 </div>
960
961 <div class="method">
962 <code class="details" id="rename">rename(name, body=None, x__xgafv=None)</code>
963 <pre>RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.
964
965 Args:
966 name: string, Required. The `name` field is used to identify the instance. Format: projects/{project}/locations/{location}/instances/{instance} (required)
967 body: object, The request body.
968 The object takes the form of:
969
970 { # Message requesting rename of a server.
971 &quot;newInstanceId&quot;: &quot;A String&quot;, # Required. The new `id` of the instance.
972 }
973
974 x__xgafv: string, V1 error format.
975 Allowed values
976 1 - v1 error format
977 2 - v2 error format
978
979 Returns:
980 An object of the form:
981
982 { # A server.
983 &quot;createTime&quot;: &quot;A String&quot;, # Output only. Create a time stamp.
984 &quot;firmwareVersion&quot;: &quot;A String&quot;, # Output only. The firmware version for the instance.
985 &quot;hyperthreadingEnabled&quot;: True or False, # True if you enable hyperthreading for the server, otherwise false. The default value is false.
986 &quot;id&quot;: &quot;A String&quot;, # Output only. An identifier for the `Instance`, generated by the backend.
987 &quot;interactiveSerialConsoleEnabled&quot;: True or False, # Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false.
988 &quot;kmsKeyVersion&quot;: &quot;A String&quot;, # Optional. Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. Format is `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}`.
989 &quot;labels&quot;: { # Labels as key value pairs.
990 &quot;a_key&quot;: &quot;A String&quot;,
991 },
992 &quot;logicalInterfaces&quot;: [ # 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.
993 { # 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.
994 &quot;interfaceIndex&quot;: 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.
995 &quot;logicalNetworkInterfaces&quot;: [ # List of logical network interfaces within a logical interface.
996 { # Each logical network interface is effectively a network and IP pair.
997 &quot;defaultGateway&quot;: True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance.
998 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
999 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address in the network
1000 &quot;network&quot;: &quot;A String&quot;, # Name of the network
1001 &quot;networkType&quot;: &quot;A String&quot;, # Type of network.
1002 },
1003 ],
1004 &quot;name&quot;: &quot;A String&quot;, # Interface name. This is of syntax or and forms part of the network template name.
1005 },
1006 ],
1007 &quot;loginInfo&quot;: &quot;A String&quot;, # Output only. Text field about info for logging in.
1008 &quot;luns&quot;: [ # Immutable. List of LUNs associated with this server.
1009 { # A storage volume logical unit number (LUN).
1010 &quot;bootLun&quot;: True or False, # Display if this LUN is a boot LUN.
1011 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state.
1012 &quot;id&quot;: &quot;A String&quot;, # An identifier for the LUN, generated by the backend.
1013 &quot;instances&quot;: [ # Output only. Instances this Lun is attached to.
1014 &quot;A String&quot;,
1015 ],
1016 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system.
1017 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of the LUN.
1018 &quot;shareable&quot;: True or False, # Display if this LUN can be shared between multiple physical servers.
1019 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this LUN, in GiB.
1020 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
1021 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this LUN.
1022 &quot;storageVolume&quot;: &quot;A String&quot;, # Display the storage volume for this LUN.
1023 &quot;wwid&quot;: &quot;A String&quot;, # The WWID for this LUN.
1024 },
1025 ],
1026 &quot;machineType&quot;: &quot;A String&quot;, # Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
1027 &quot;name&quot;: &quot;A String&quot;, # 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}`
1028 &quot;networkTemplate&quot;: &quot;A String&quot;, # Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of &quot;bond&quot; or &quot;nic&quot;.
1029 &quot;networks&quot;: [ # Output only. List of networks associated with this server.
1030 { # A Network.
1031 &quot;cidr&quot;: &quot;A String&quot;, # The cidr of the Network.
1032 &quot;gatewayIp&quot;: &quot;A String&quot;, # Output only. Gateway ip address.
1033 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Network`, generated by the backend.
1034 &quot;ipAddress&quot;: &quot;A String&quot;, # IP address configured.
1035 &quot;jumboFramesEnabled&quot;: True or False, # Whether network uses standard frames or jumbo ones.
1036 &quot;labels&quot;: { # Labels as key value pairs.
1037 &quot;a_key&quot;: &quot;A String&quot;,
1038 },
1039 &quot;macAddress&quot;: [ # List of physical interfaces.
1040 &quot;A String&quot;,
1041 ],
1042 &quot;mountPoints&quot;: [ # Input only. List of mount points to attach the network to.
1043 { # Mount point for a network.
1044 &quot;defaultGateway&quot;: True or False, # Network should be a default gateway.
1045 &quot;instance&quot;: &quot;A String&quot;, # Instance to attach network to.
1046 &quot;ipAddress&quot;: &quot;A String&quot;, # Ip address of the server.
1047 &quot;logicalInterface&quot;: &quot;A String&quot;, # Logical interface to detach from.
1048 },
1049 ],
1050 &quot;name&quot;: &quot;A String&quot;, # 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}`
1051 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Network can only be connected to the assets (instances, nfsshares) allocated in the same pod.
1052 &quot;reservations&quot;: [ # 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.
1053 { # A reservation of one or more addresses in a network.
1054 &quot;endAddress&quot;: &quot;A String&quot;, # 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.
1055 &quot;note&quot;: &quot;A String&quot;, # A note about this reservation, intended for human consumption.
1056 &quot;startAddress&quot;: &quot;A String&quot;, # The first address of this reservation block. Must be specified as a single IPv4 address, e.g. 10.1.2.2.
1057 },
1058 ],
1059 &quot;servicesCidr&quot;: &quot;A String&quot;, # IP range for reserved for services (e.g. NFS).
1060 &quot;state&quot;: &quot;A String&quot;, # The Network state.
1061 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
1062 &quot;vlanId&quot;: &quot;A String&quot;, # The vlan id of the Network.
1063 &quot;vrf&quot;: { # A network VRF. # The Vrf for the Network. Use this only if a new Vrf needs to be created.
1064 &quot;name&quot;: &quot;A String&quot;, # The name of the VRF.
1065 &quot;qosPolicy&quot;: { # 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.
1066 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
1067 },
1068 &quot;state&quot;: &quot;A String&quot;, # The possible state of VRF.
1069 &quot;vlanAttachments&quot;: [ # The list of VLAN attachments for the VRF.
1070 { # VLAN attachment details.
1071 &quot;id&quot;: &quot;A String&quot;, # Immutable. The identifier of the attachment within vrf.
1072 &quot;interconnectAttachment&quot;: &quot;A String&quot;, # Optional. The name of the vlan attachment within vrf. This is of the form projects/{project_number}/regions/{region}/interconnectAttachments/{interconnect_attachment}
1073 &quot;pairingKey&quot;: &quot;A String&quot;, # Input only. Pairing key.
1074 &quot;peerIp&quot;: &quot;A String&quot;, # The peer IP of the attachment.
1075 &quot;peerVlanId&quot;: &quot;A String&quot;, # The peer vlan ID of the attachment.
1076 &quot;qosPolicy&quot;: { # QOS policy parameters. # The QOS policy applied to this VLAN attachment. This value should be preferred to using qos at vrf level.
1077 &quot;bandwidthGbps&quot;: 3.14, # The bandwidth permitted by the QOS policy, in gbps.
1078 },
1079 &quot;routerIp&quot;: &quot;A String&quot;, # The router IP of the attachment.
1080 },
1081 ],
1082 },
1083 &quot;vrfAttachment&quot;: &quot;A String&quot;, # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`.
1084 },
1085 ],
1086 &quot;osImage&quot;: &quot;A String&quot;, # The OS image currently installed on the server.
1087 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Instance can only be connected to the assets (networks, volumes) allocated in the same pod.
1088 &quot;sshKeys&quot;: [ # Optional. List of SSH Keys used during instance provisioning.
1089 &quot;A String&quot;,
1090 ],
1091 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the server.
1092 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Update a time stamp.
1093 &quot;volumes&quot;: [ # Input only. List of Volumes to attach to this Instance on creation. This field won&#x27;t be populated in Get/List responses.
1094 { # A storage volume.
1095 &quot;attached&quot;: True or False, # Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well.
1096 &quot;autoGrownSizeGib&quot;: &quot;A String&quot;, # 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.
1097 &quot;bootVolume&quot;: True or False, # Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN.
1098 &quot;currentSizeGib&quot;: &quot;A String&quot;, # 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.
1099 &quot;emergencySizeGib&quot;: &quot;A String&quot;, # Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value.
1100 &quot;expireTime&quot;: &quot;A String&quot;, # Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state.
1101 &quot;id&quot;: &quot;A String&quot;, # An identifier for the `Volume`, generated by the backend.
1102 &quot;instances&quot;: [ # Output only. Instances this Volume is attached to. This field is set only in Get requests.
1103 &quot;A String&quot;,
1104 ],
1105 &quot;labels&quot;: { # Labels as key value pairs.
1106 &quot;a_key&quot;: &quot;A String&quot;,
1107 },
1108 &quot;maxSizeGib&quot;: &quot;A String&quot;, # Maximum size volume can be expanded to in case of evergency, in GiB.
1109 &quot;name&quot;: &quot;A String&quot;, # 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}`
1110 &quot;notes&quot;: &quot;A String&quot;, # Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention.
1111 &quot;originallyRequestedSizeGib&quot;: &quot;A String&quot;, # Originally requested size, in GiB.
1112 &quot;performanceTier&quot;: &quot;A String&quot;, # Immutable. Performance tier of the Volume. Default is SHARED.
1113 &quot;pod&quot;: &quot;A String&quot;, # Immutable. Pod name. Pod is an independent part of infrastructure. Volume can only be connected to the instances allocated in the same pod.
1114 &quot;protocol&quot;: &quot;A String&quot;, # Output only. Storage protocol for the Volume.
1115 &quot;remainingSpaceGib&quot;: &quot;A String&quot;, # The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots.
1116 &quot;requestedSizeGib&quot;: &quot;A String&quot;, # The requested size of this storage volume, in GiB.
1117 &quot;snapshotAutoDeleteBehavior&quot;: &quot;A String&quot;, # The behavior to use when snapshot reserved space is full.
1118 &quot;snapshotEnabled&quot;: True or False, # Whether snapshots are enabled.
1119 &quot;snapshotReservationDetail&quot;: { # Details about snapshot space reservation and usage on the storage volume. # Details about snapshot space reservation and usage on the storage volume.
1120 &quot;reservedSpaceGib&quot;: &quot;A String&quot;, # The space on this storage volume reserved for snapshots, shown in GiB.
1121 &quot;reservedSpacePercent&quot;: 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.
1122 &quot;reservedSpaceRemainingGib&quot;: &quot;A String&quot;, # The amount, in GiB, of available space in this storage volume&#x27;s reserved snapshot space.
1123 &quot;reservedSpaceUsedPercent&quot;: 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.
1124 },
1125 &quot;state&quot;: &quot;A String&quot;, # The state of this storage volume.
1126 &quot;storageType&quot;: &quot;A String&quot;, # The storage type for this volume.
1127 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the volume.
1128 },
1129 ],
1130 &quot;workloadProfile&quot;: &quot;A String&quot;, # The workload profile for the instance.
1131 }</pre>
1132 </div>
1133
1134 <div class="method">
1135 <code class="details" id="reset">reset(name, body=None, x__xgafv=None)</code>
1136 <pre>Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.
1137
1138 Args:
1139 name: string, Required. Name of the resource. (required)
1140 body: object, The request body.
1141 The object takes the form of:
1142
1143 { # Message requesting to reset a server.
1144 }
1145
1146 x__xgafv: string, V1 error format.
1147 Allowed values
1148 1 - v1 error format
1149 2 - v2 error format
1150
1151 Returns:
1152 An object of the form:
1153
1154 { # This resource represents a long-running operation that is the result of a network API call.
1155 &quot;done&quot;: 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.
1156 &quot;error&quot;: { # 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.
1157 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1158 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1159 {
1160 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1161 },
1162 ],
1163 &quot;message&quot;: &quot;A String&quot;, # 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.
1164 },
1165 &quot;metadata&quot;: { # 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.
1166 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1167 },
1168 &quot;name&quot;: &quot;A String&quot;, # 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}`.
1169 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
1170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1171 },
1172 }</pre>
1173 </div>
1174
1175 <div class="method">
1176 <code class="details" id="start">start(name, body=None, x__xgafv=None)</code>
1177 <pre>Starts a server that was shutdown.
1178
1179 Args:
1180 name: string, Required. Name of the resource. (required)
1181 body: object, The request body.
1182 The object takes the form of:
1183
1184 { # Message requesting to start a server.
1185 }
1186
1187 x__xgafv: string, V1 error format.
1188 Allowed values
1189 1 - v1 error format
1190 2 - v2 error format
1191
1192 Returns:
1193 An object of the form:
1194
1195 { # This resource represents a long-running operation that is the result of a network API call.
1196 &quot;done&quot;: 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.
1197 &quot;error&quot;: { # 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.
1198 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1199 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1200 {
1201 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1202 },
1203 ],
1204 &quot;message&quot;: &quot;A String&quot;, # 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.
1205 },
1206 &quot;metadata&quot;: { # 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.
1207 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1208 },
1209 &quot;name&quot;: &quot;A String&quot;, # 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}`.
1210 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
1211 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1212 },
1213 }</pre>
1214 </div>
1215
1216 <div class="method">
1217 <code class="details" id="stop">stop(name, body=None, x__xgafv=None)</code>
1218 <pre>Stop a running server.
1219
1220 Args:
1221 name: string, Required. Name of the resource. (required)
1222 body: object, The request body.
1223 The object takes the form of:
1224
1225 { # Message requesting to stop a server.
1226 }
1227
1228 x__xgafv: string, V1 error format.
1229 Allowed values
1230 1 - v1 error format
1231 2 - v2 error format
1232
1233 Returns:
1234 An object of the form:
1235
1236 { # This resource represents a long-running operation that is the result of a network API call.
1237 &quot;done&quot;: 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.
1238 &quot;error&quot;: { # 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.
1239 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1240 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1241 {
1242 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1243 },
1244 ],
1245 &quot;message&quot;: &quot;A String&quot;, # 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.
1246 },
1247 &quot;metadata&quot;: { # 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.
1248 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1249 },
1250 &quot;name&quot;: &quot;A String&quot;, # 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}`.
1251 &quot;response&quot;: { # The normal, successful response of the operation. 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`.
1252 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1253 },
1254 }</pre>
1255 </div>
1256
1257 </body></html>