Debian Codegraph @

docs/dyn/baremetalsolution_v1alpha1.projects.locations.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_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>
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="#submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Submit a provisiong configuration for a given project.</p>
83 <h3>Method Details</h3>
84 <div class="method">
85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87 </div>
88
89 <div class="method">
90 <code class="details" id="submitProvisioningConfig">submitProvisioningConfig(project, location, body=None, x__xgafv=None)</code>
91 <pre>Submit a provisiong configuration for a given project.
92
93 Args:
94 project: string, Required. The target project of the provisioning request. (required)
95 location: string, Required. The target location of the provisioning request. (required)
96 body: object, The request body.
97 The object takes the form of:
98
99 { # Request for SubmitProvisioningConfig.
100 &quot;email&quot;: &quot;A String&quot;, # Optional. Email provided to send a confirmation with provisioning config to.
101 &quot;provisioningConfig&quot;: { # An provisioning configuration. # Required. The ProvisioningConfig to submit.
102 &quot;instances&quot;: [ # Instances to be created.
103 { # Configuration parameters for a new instance.
104 &quot;clientNetwork&quot;: { # A network. # Client network address.
105 &quot;address&quot;: &quot;A String&quot;, # IP address to be assigned to the server.
106 &quot;existingNetworkId&quot;: &quot;A String&quot;, # 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.
107 &quot;networkId&quot;: &quot;A String&quot;, # 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.
108 },
109 &quot;hyperthreading&quot;: True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
110 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
111 &quot;instanceType&quot;: &quot;A String&quot;, # Instance type.
112 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the instance.
113 &quot;osImage&quot;: &quot;A String&quot;, # OS image to initialize the instance.
114 &quot;privateNetwork&quot;: { # A network. # Private network address, if any.
115 &quot;address&quot;: &quot;A String&quot;, # IP address to be assigned to the server.
116 &quot;existingNetworkId&quot;: &quot;A String&quot;, # 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.
117 &quot;networkId&quot;: &quot;A String&quot;, # 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.
118 },
119 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
120 },
121 ],
122 &quot;networks&quot;: [ # Networks to be created.
123 { # Configuration parameters for a new network.
124 &quot;bandwidth&quot;: &quot;A String&quot;, # Interconnect bandwidth. Set only when type is CLIENT.
125 &quot;cidr&quot;: &quot;A String&quot;, # CIDR range of the network.
126 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to identify a volume within an ProvisioningConfig request.
127 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the network.
128 &quot;serviceCidr&quot;: &quot;A String&quot;, # Service CIDR, if any.
129 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
130 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
131 &quot;vlanAttachments&quot;: [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
132 { # A GCP vlan attachment.
133 &quot;id&quot;: &quot;A String&quot;, # Identifier of the VLAN attachment.
134 &quot;pairingKey&quot;: &quot;A String&quot;, # Attachment pairing key.
135 },
136 ],
137 },
138 ],
139 &quot;ticketId&quot;: &quot;A String&quot;, # A reference to track the request.
140 &quot;volumes&quot;: [ # Volumes to be created.
141 { # Configuration parameters for a new volume.
142 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to identify a volume within an ProvisioningConfig request.
143 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the volume.
144 &quot;lunRanges&quot;: [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
145 { # A LUN range.
146 &quot;quantity&quot;: 42, # Number of LUNs to create.
147 &quot;sizeGb&quot;: 42, # The requested size of each LUN, in GB.
148 },
149 ],
150 &quot;machineIds&quot;: [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
151 &quot;A String&quot;,
152 ],
153 &quot;nfsExports&quot;: [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
154 { # A NFS export entry.
155 &quot;allowDev&quot;: True or False, # Allow dev.
156 &quot;allowSuid&quot;: True or False, # Allow the setuid flag.
157 &quot;cidr&quot;: &quot;A String&quot;, # A CIDR range.
158 &quot;machineId&quot;: &quot;A String&quot;, # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
159 &quot;networkId&quot;: &quot;A String&quot;, # Network to use to publish the export.
160 &quot;noRootSquash&quot;: True or False, # Disable root squashing.
161 &quot;permissions&quot;: &quot;A String&quot;, # Export permissions.
162 },
163 ],
164 &quot;protocol&quot;: &quot;A String&quot;, # Volume protocol.
165 &quot;sizeGb&quot;: 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
166 &quot;snapshotsEnabled&quot;: True or False, # Whether snapshots should be enabled.
167 &quot;type&quot;: &quot;A String&quot;, # The type of this Volume.
168 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
169 },
170 ],
171 },
172 }
173
174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179 Returns:
180 An object of the form:
181
182 { # An provisioning configuration.
183 &quot;instances&quot;: [ # Instances to be created.
184 { # Configuration parameters for a new instance.
185 &quot;clientNetwork&quot;: { # A network. # Client network address.
186 &quot;address&quot;: &quot;A String&quot;, # IP address to be assigned to the server.
187 &quot;existingNetworkId&quot;: &quot;A String&quot;, # 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.
188 &quot;networkId&quot;: &quot;A String&quot;, # 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.
189 },
190 &quot;hyperthreading&quot;: True or False, # Whether the instance should be provisioned with Hyperthreading enabled.
191 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to idenfity an instance within an ProvisioningConfig request.
192 &quot;instanceType&quot;: &quot;A String&quot;, # Instance type.
193 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the instance.
194 &quot;osImage&quot;: &quot;A String&quot;, # OS image to initialize the instance.
195 &quot;privateNetwork&quot;: { # A network. # Private network address, if any.
196 &quot;address&quot;: &quot;A String&quot;, # IP address to be assigned to the server.
197 &quot;existingNetworkId&quot;: &quot;A String&quot;, # 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.
198 &quot;networkId&quot;: &quot;A String&quot;, # 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.
199 },
200 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
201 },
202 ],
203 &quot;networks&quot;: [ # Networks to be created.
204 { # Configuration parameters for a new network.
205 &quot;bandwidth&quot;: &quot;A String&quot;, # Interconnect bandwidth. Set only when type is CLIENT.
206 &quot;cidr&quot;: &quot;A String&quot;, # CIDR range of the network.
207 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to identify a volume within an ProvisioningConfig request.
208 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the network.
209 &quot;serviceCidr&quot;: &quot;A String&quot;, # Service CIDR, if any.
210 &quot;type&quot;: &quot;A String&quot;, # The type of this network.
211 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
212 &quot;vlanAttachments&quot;: [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).
213 { # A GCP vlan attachment.
214 &quot;id&quot;: &quot;A String&quot;, # Identifier of the VLAN attachment.
215 &quot;pairingKey&quot;: &quot;A String&quot;, # Attachment pairing key.
216 },
217 ],
218 },
219 ],
220 &quot;ticketId&quot;: &quot;A String&quot;, # A reference to track the request.
221 &quot;volumes&quot;: [ # Volumes to be created.
222 { # Configuration parameters for a new volume.
223 &quot;id&quot;: &quot;A String&quot;, # A transient unique identifier to identify a volume within an ProvisioningConfig request.
224 &quot;location&quot;: &quot;A String&quot;, # Location where to deploy the volume.
225 &quot;lunRanges&quot;: [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC.
226 { # A LUN range.
227 &quot;quantity&quot;: 42, # Number of LUNs to create.
228 &quot;sizeGb&quot;: 42, # The requested size of each LUN, in GB.
229 },
230 ],
231 &quot;machineIds&quot;: [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC.
232 &quot;A String&quot;,
233 ],
234 &quot;nfsExports&quot;: [ # NFS exports. Set only when protocol is PROTOCOL_NFS.
235 { # A NFS export entry.
236 &quot;allowDev&quot;: True or False, # Allow dev.
237 &quot;allowSuid&quot;: True or False, # Allow the setuid flag.
238 &quot;cidr&quot;: &quot;A String&quot;, # A CIDR range.
239 &quot;machineId&quot;: &quot;A String&quot;, # Either a single machine, identified by an ID, or a comma-separated list of machine IDs.
240 &quot;networkId&quot;: &quot;A String&quot;, # Network to use to publish the export.
241 &quot;noRootSquash&quot;: True or False, # Disable root squashing.
242 &quot;permissions&quot;: &quot;A String&quot;, # Export permissions.
243 },
244 ],
245 &quot;protocol&quot;: &quot;A String&quot;, # Volume protocol.
246 &quot;sizeGb&quot;: 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field.
247 &quot;snapshotsEnabled&quot;: True or False, # Whether snapshots should be enabled.
248 &quot;type&quot;: &quot;A String&quot;, # The type of this Volume.
249 &quot;userNote&quot;: &quot;A String&quot;, # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617).
250 },
251 ],
252 }</pre>
253 </div>
254
255 </body></html>