1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="baremetalsolution_v1alpha1.html">Bare Metal Solution API</a> . <a href="baremetalsolution_v1alpha1.projects.html">projects</a> . <a href="baremetalsolution_v1alpha1.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Submit a provisiong configuration for a given project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</code>
<pre>Submit a provisiong configuration for a given project.
Args:
project: string, Required. The target project of the provisioning request. (required)
location: string, Required. The target location of the provisioning request. (required)
body: object, The request body.
The object takes the form of:
{ # Request for SubmitProvisioningConfig.
"email": "A String", # Optional. Email provided to send a confirmation with provisioning config to.
"provisioningConfig": { # An provisioning configuration. # Required. The ProvisioningConfig to submit.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"clientNetwork": { # A network. # Client network address.
"address": "A String", # IP address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.
"networkId": "A String", # Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type.
"location": "A String", # Location where to deploy the instance.
"osImage": "A String", # OS image to initialize the instance.
"privateNetwork": { # A network. # Private network address, if any.
"address": "A String", # IP address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.
"networkId": "A String", # Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.
},
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
},
],
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"location": "A String", # Location where to deploy the network.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
},
],
"ticketId": "A String", # A reference to track the request.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"location": "A String", # Location where to deploy the volume.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing.
"permissions": "A String", # Export permissions.
},
],
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
},
],
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An provisioning configuration.
"instances": [ # Instances to be created.
{ # Configuration parameters for a new instance.
"clientNetwork": { # A network. # Client network address.
"address": "A String", # IP address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.
"networkId": "A String", # Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.
},
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
"instanceType": "A String", # Instance type.
"location": "A String", # Location where to deploy the instance.
"osImage": "A String", # OS image to initialize the instance.
"privateNetwork": { # A network. # Private network address, if any.
"address": "A String", # IP address to be assigned to the server.
"existingNetworkId": "A String", # Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.
"networkId": "A String", # Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.
},
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
},
],
"networks": [ # Networks to be created.
{ # Configuration parameters for a new network.
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT.
"cidr": "A String", # CIDR range of the network.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"location": "A String", # Location where to deploy the network.
"serviceCidr": "A String", # Service CIDR, if any.
"type": "A String", # The type of this network.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
{ # A GCP vlan attachment.
"id": "A String", # Identifier of the VLAN attachment.
"pairingKey": "A String", # Attachment pairing key.
},
],
},
],
"ticketId": "A String", # A reference to track the request.
"volumes": [ # Volumes to be created.
{ # Configuration parameters for a new volume.
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request.
"location": "A String", # Location where to deploy the volume.
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
{ # A LUN range.
"quantity": 42, # Number of LUNs to create.
"sizeGb": 42, # The requested size of each LUN, in GB.
},
],
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
"A String",
],
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
{ # A NFS export entry.
"allowDev": True or False, # Allow dev.
"allowSuid": True or False, # Allow the setuid flag.
"cidr": "A String", # A CIDR range.
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
"networkId": "A String", # Network to use to publish the export.
"noRootSquash": True or False, # Disable root squashing.
"permissions": "A String", # Export permissions.
},
],
"protocol": "A String", # Volume protocol.
"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
"snapshotsEnabled": True or False, # Whether snapshots should be enabled.
"type": "A String", # The type of this Volume.
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
},
],
}</pre>
</div>
</body></html>
|
