blob: 5ba81d62ddcafbe24bff752a10422b5e69cf56f7 [file] [log] [blame]
yoshi-code-bota933dad2021-07-06 00:26:24 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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_v1alpha1.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v1alpha1.projects.html">projects</a> . <a href="baremetalsolution_v1alpha1.projects.locations.html">locations</a> . <a href="baremetalsolution_v1alpha1.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="#disableInteractiveSerialConsole">disableInteractiveSerialConsole(instance, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Disable the interactive serial console feature on a specific machine.</p>
83<p class="toc_element">
84 <code><a href="#enableInteractiveSerialConsole">enableInteractiveSerialConsole(instance, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Enable the interactive serial console feature on a specific machine.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Get details for a specific named Instance.</p>
89<p class="toc_element">
90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91<p class="firstline">List Instances (physical servers).</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#readSerialPortOutput">readSerialPortOutput(instance, startByte=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Read the most recent serial port output from a machine.</p>
98<p class="toc_element">
99 <code><a href="#resetInstance">resetInstance(instance, body=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Perform an ungraceful, hard reset on a machine (equivalent to physically turning power off and then back on).</p>
101<h3>Method Details</h3>
102<div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
108 <code class="details" id="disableInteractiveSerialConsole">disableInteractiveSerialConsole(instance, body=None, x__xgafv=None)</code>
109 <pre>Disable the interactive serial console feature on a specific machine.
110
111Args:
112 instance: string, Required. Name of the instance to disable the interactive serial console feature on. (required)
113 body: object, The request body.
114 The object takes the form of:
115
116{ # Request for DisableInteractiveSerialConsole.
117}
118
119 x__xgafv: string, V1 error format.
120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
123
124Returns:
125 An object of the form:
126
127 { # Response for DisableInteractiveSerialConsole.
128}</pre>
129</div>
130
131<div class="method">
132 <code class="details" id="enableInteractiveSerialConsole">enableInteractiveSerialConsole(instance, body=None, x__xgafv=None)</code>
133 <pre>Enable the interactive serial console feature on a specific machine.
134
135Args:
136 instance: string, Required. Name of the instance to enable the interactive serial console feature on. (required)
137 body: object, The request body.
138 The object takes the form of:
139
140{ # Request for EnableInteractiveSerialConsole.
141}
142
143 x__xgafv: string, V1 error format.
144 Allowed values
145 1 - v1 error format
146 2 - v2 error format
147
148Returns:
149 An object of the form:
150
151 { # Response for EnableInteractiveSerialConsole.
152}</pre>
153</div>
154
155<div class="method">
156 <code class="details" id="get">get(name, x__xgafv=None)</code>
157 <pre>Get details for a specific named Instance.
158
159Args:
160 name: string, Required. The name of the Instance to retrieve. (required)
161 x__xgafv: string, V1 error format.
162 Allowed values
163 1 - v1 error format
164 2 - v2 error format
165
166Returns:
167 An object of the form:
168
169 { # An Instance.
170 &quot;hyperthreadingEnabled&quot;: True or False, # Is hyperthreading enabled for this instance?
171 &quot;luns&quot;: [ # The Luns attached to this instance
172 { # A storage Lun.
173 &quot;isBoot&quot;: True or False, # Whether this Lun is a boot Lun.
174 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The multiprotocol type of this Lun.
175 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Lun.
176 &quot;remoteVolume&quot;: { # Volume registered in the project. # The storage volume that this Lun is attached to.
177 &quot;autoGrownSizeGb&quot;: &quot;A String&quot;, # The size, in GB, that this Volume has expanded as a result of an auto grow policy.
178 &quot;currentSizeGb&quot;: &quot;A String&quot;, # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink.
179 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Volume.
180 &quot;remainingSpaceGb&quot;: &quot;A String&quot;, # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots.
181 &quot;requestedSizeGb&quot;: &quot;A String&quot;, # The requested size of this Volume, in GB.
182 &quot;snapshotReservedSpacePercent&quot;: 42, # The percent of space on this Volume reserved for snapshots.
183 &quot;snapshotReservedSpaceRemainingGb&quot;: &quot;A String&quot;, # The amount, in GB, of space available in this Volume&#x27;s reserved snapshot space.
184 &quot;snapshotReservedSpaceUsedPercent&quot;: 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume.
185 &quot;state&quot;: &quot;A String&quot;, # The state of this Volume.
186 &quot;type&quot;: &quot;A String&quot;, # The type of this Volume.
187 },
188 &quot;shareable&quot;: True or False, # Whether this Lun is allowed to be shared between multiple physical servers.
189 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this Lun, in gigabytes.
190 &quot;state&quot;: &quot;A String&quot;, # The state of this Lun.
191 },
192 ],
193 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Instance.
194 &quot;scheduledPowerResetTime&quot;: &quot;A String&quot;, # The scheduled power reset time.
195 &quot;sshEnabled&quot;: True or False, # Is SSH enabled for this instance?
196 &quot;state&quot;: &quot;A String&quot;, # The state of this Instance.
197}</pre>
198</div>
199
200<div class="method">
201 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
202 <pre>List Instances (physical servers).
203
204Args:
205 parent: string, Required. The location to list Instances in. (required)
206 pageSize: integer, The maximum number of items to return.
207 pageToken: string, The next_page_token value returned from a previous List request, if any.
208 x__xgafv: string, V1 error format.
209 Allowed values
210 1 - v1 error format
211 2 - v2 error format
212
213Returns:
214 An object of the form:
215
216 { # Response for ListInstances.
217 &quot;instances&quot;: [ # The Instances in this project.
218 { # An Instance.
219 &quot;hyperthreadingEnabled&quot;: True or False, # Is hyperthreading enabled for this instance?
220 &quot;luns&quot;: [ # The Luns attached to this instance
221 { # A storage Lun.
222 &quot;isBoot&quot;: True or False, # Whether this Lun is a boot Lun.
223 &quot;multiprotocolType&quot;: &quot;A String&quot;, # The multiprotocol type of this Lun.
224 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Lun.
225 &quot;remoteVolume&quot;: { # Volume registered in the project. # The storage volume that this Lun is attached to.
226 &quot;autoGrownSizeGb&quot;: &quot;A String&quot;, # The size, in GB, that this Volume has expanded as a result of an auto grow policy.
227 &quot;currentSizeGb&quot;: &quot;A String&quot;, # The current size of this Volume, in GB, including space reserved for snapshots. This size may be different than the requested size if the Volume has been configured with auto grow or auto shrink.
228 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Volume.
229 &quot;remainingSpaceGb&quot;: &quot;A String&quot;, # The space remaining in the Volume for new LUNs, in GB, excluding space reserved for snapshots.
230 &quot;requestedSizeGb&quot;: &quot;A String&quot;, # The requested size of this Volume, in GB.
231 &quot;snapshotReservedSpacePercent&quot;: 42, # The percent of space on this Volume reserved for snapshots.
232 &quot;snapshotReservedSpaceRemainingGb&quot;: &quot;A String&quot;, # The amount, in GB, of space available in this Volume&#x27;s reserved snapshot space.
233 &quot;snapshotReservedSpaceUsedPercent&quot;: 42, # The percent of reserved snapshot space on this Volume that is actually used by snapshot copies. This may be higher than 100% if snapshot copies are occupying more space than has been reserved on the Volume.
234 &quot;state&quot;: &quot;A String&quot;, # The state of this Volume.
235 &quot;type&quot;: &quot;A String&quot;, # The type of this Volume.
236 },
237 &quot;shareable&quot;: True or False, # Whether this Lun is allowed to be shared between multiple physical servers.
238 &quot;sizeGb&quot;: &quot;A String&quot;, # The size of this Lun, in gigabytes.
239 &quot;state&quot;: &quot;A String&quot;, # The state of this Lun.
240 },
241 ],
242 &quot;name&quot;: &quot;A String&quot;, # Output only. The name of this Instance.
243 &quot;scheduledPowerResetTime&quot;: &quot;A String&quot;, # The scheduled power reset time.
244 &quot;sshEnabled&quot;: True or False, # Is SSH enabled for this instance?
245 &quot;state&quot;: &quot;A String&quot;, # The state of this Instance.
246 },
247 ],
248 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
249}</pre>
250</div>
251
252<div class="method">
253 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
254 <pre>Retrieves the next page of results.
255
256Args:
257 previous_request: The request for the previous page. (required)
258 previous_response: The response from the request for the previous page. (required)
259
260Returns:
261 A request object that you can call &#x27;execute()&#x27; on to request the next
262 page. Returns None if there are no more items in the collection.
263 </pre>
264</div>
265
266<div class="method">
267 <code class="details" id="readSerialPortOutput">readSerialPortOutput(instance, startByte=None, x__xgafv=None)</code>
268 <pre>Read the most recent serial port output from a machine.
269
270Args:
271 instance: string, Required. Name of the instance to get serial port output of. (required)
272 startByte: string, Optional. The start byte of the serial port output to return.
273 x__xgafv: string, V1 error format.
274 Allowed values
275 1 - v1 error format
276 2 - v2 error format
277
278Returns:
279 An object of the form:
280
281 { # Response for ReadSerialPortOutput.
282 &quot;contents&quot;: &quot;A String&quot;, # The serial port output.
283 &quot;nextStartByte&quot;: &quot;A String&quot;, # The byte index to use in a subsequent call to ReadSerialPortOutput to get more output.
284 &quot;start&quot;: &quot;A String&quot;, # The start byte index of the included contents.
285}</pre>
286</div>
287
288<div class="method">
289 <code class="details" id="resetInstance">resetInstance(instance, body=None, x__xgafv=None)</code>
290 <pre>Perform an ungraceful, hard reset on a machine (equivalent to physically turning power off and then back on).
291
292Args:
293 instance: string, Required. Name of the instance to reset. (required)
294 body: object, The request body.
295 The object takes the form of:
296
297{ # Request for ResetInstance.
298}
299
300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
304
305Returns:
306 An object of the form:
307
308 { # Response for ResetInstance.
309}</pre>
310</div>
311
312</body></html>