| 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 |
"email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| 101 |
"provisioningConfig": { # An provisioning configuration. # Required. The ProvisioningConfig to submit. |
| 102 |
"instances": [ # Instances to be created. |
| 103 |
{ # Configuration parameters for a new instance. |
| 104 |
"clientNetwork": { # A network. # Client network address. |
| 105 |
"address": "A String", # IP address to be assigned to the server. |
| 106 |
"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. |
| 107 |
"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. |
| 108 |
}, |
| 109 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 110 |
"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| 111 |
"instanceType": "A String", # Instance type. |
| 112 |
"location": "A String", # Location where to deploy the instance. |
| 113 |
"osImage": "A String", # OS image to initialize the instance. |
| 114 |
"privateNetwork": { # A network. # Private network address, if any. |
| 115 |
"address": "A String", # IP address to be assigned to the server. |
| 116 |
"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. |
| 117 |
"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. |
| 118 |
}, |
| 119 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| 120 |
}, |
| 121 |
], |
| 122 |
"networks": [ # Networks to be created. |
| 123 |
{ # Configuration parameters for a new network. |
| 124 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 125 |
"cidr": "A String", # CIDR range of the network. |
| 126 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 127 |
"location": "A String", # Location where to deploy the network. |
| 128 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 129 |
"type": "A String", # The type of this network. |
| 130 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| 131 |
"vlanAttachments": [ # 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 |
"id": "A String", # Identifier of the VLAN attachment. |
| 134 |
"pairingKey": "A String", # Attachment pairing key. |
| 135 |
}, |
| 136 |
], |
| 137 |
}, |
| 138 |
], |
| 139 |
"ticketId": "A String", # A reference to track the request. |
| 140 |
"volumes": [ # Volumes to be created. |
| 141 |
{ # Configuration parameters for a new volume. |
| 142 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 143 |
"location": "A String", # Location where to deploy the volume. |
| 144 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 145 |
{ # A LUN range. |
| 146 |
"quantity": 42, # Number of LUNs to create. |
| 147 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 148 |
}, |
| 149 |
], |
| 150 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 151 |
"A String", |
| 152 |
], |
| 153 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 154 |
{ # A NFS export entry. |
| 155 |
"allowDev": True or False, # Allow dev. |
| 156 |
"allowSuid": True or False, # Allow the setuid flag. |
| 157 |
"cidr": "A String", # A CIDR range. |
| 158 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 159 |
"networkId": "A String", # Network to use to publish the export. |
| 160 |
"noRootSquash": True or False, # Disable root squashing. |
| 161 |
"permissions": "A String", # Export permissions. |
| 162 |
}, |
| 163 |
], |
| 164 |
"protocol": "A String", # Volume protocol. |
| 165 |
"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field. |
| 166 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 167 |
"type": "A String", # The type of this Volume. |
| 168 |
"userNote": "A String", # 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 |
"instances": [ # Instances to be created. |
| 184 |
{ # Configuration parameters for a new instance. |
| 185 |
"clientNetwork": { # A network. # Client network address. |
| 186 |
"address": "A String", # IP address to be assigned to the server. |
| 187 |
"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. |
| 188 |
"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. |
| 189 |
}, |
| 190 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 191 |
"id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| 192 |
"instanceType": "A String", # Instance type. |
| 193 |
"location": "A String", # Location where to deploy the instance. |
| 194 |
"osImage": "A String", # OS image to initialize the instance. |
| 195 |
"privateNetwork": { # A network. # Private network address, if any. |
| 196 |
"address": "A String", # IP address to be assigned to the server. |
| 197 |
"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. |
| 198 |
"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. |
| 199 |
}, |
| 200 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| 201 |
}, |
| 202 |
], |
| 203 |
"networks": [ # Networks to be created. |
| 204 |
{ # Configuration parameters for a new network. |
| 205 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 206 |
"cidr": "A String", # CIDR range of the network. |
| 207 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 208 |
"location": "A String", # Location where to deploy the network. |
| 209 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 210 |
"type": "A String", # The type of this network. |
| 211 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| 212 |
"vlanAttachments": [ # 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 |
"id": "A String", # Identifier of the VLAN attachment. |
| 215 |
"pairingKey": "A String", # Attachment pairing key. |
| 216 |
}, |
| 217 |
], |
| 218 |
}, |
| 219 |
], |
| 220 |
"ticketId": "A String", # A reference to track the request. |
| 221 |
"volumes": [ # Volumes to be created. |
| 222 |
{ # Configuration parameters for a new volume. |
| 223 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 224 |
"location": "A String", # Location where to deploy the volume. |
| 225 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 226 |
{ # A LUN range. |
| 227 |
"quantity": 42, # Number of LUNs to create. |
| 228 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 229 |
}, |
| 230 |
], |
| 231 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 232 |
"A String", |
| 233 |
], |
| 234 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 235 |
{ # A NFS export entry. |
| 236 |
"allowDev": True or False, # Allow dev. |
| 237 |
"allowSuid": True or False, # Allow the setuid flag. |
| 238 |
"cidr": "A String", # A CIDR range. |
| 239 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 240 |
"networkId": "A String", # Network to use to publish the export. |
| 241 |
"noRootSquash": True or False, # Disable root squashing. |
| 242 |
"permissions": "A String", # Export permissions. |
| 243 |
}, |
| 244 |
], |
| 245 |
"protocol": "A String", # Volume protocol. |
| 246 |
"sizeGb": 42, # The requested size of this volume, in GB. This will be updated in a later iteration with a generic size field. |
| 247 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 248 |
"type": "A String", # The type of this Volume. |
| 249 |
"userNote": "A String", # 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> |