| 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.provisioningConfigs.html">provisioningConfigs</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="#create">create(parent, body=None, email=None, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Create new ProvisioningConfig.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Get ProvisioningConfig by name.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#patch">patch(name, body=None, email=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 88 |
<p class="firstline">Update existing ProvisioningConfig.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#submit">submit(parent, body=None, x__xgafv=None)</a></code></p> |
| 91 |
<p class="firstline">Submit a provisioning configuration for a given project.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="create">create(parent, body=None, email=None, x__xgafv=None)</code> |
| 100 |
<pre>Create new ProvisioningConfig. |
| 101 |
|
| 102 |
Args: |
| 103 |
parent: string, Required. The parent project and location containing the ProvisioningConfig. (required) |
| 104 |
body: object, The request body. |
| 105 |
The object takes the form of: |
| 106 |
|
| 107 |
{ # A provisioning configuration. |
| 108 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 109 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 110 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 111 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 112 |
"instances": [ # Instances to be created. |
| 113 |
{ # Configuration parameters for a new instance. |
| 114 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 115 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 116 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 117 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 118 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 119 |
}, |
| 120 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 121 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 122 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 123 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 124 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 125 |
{ # 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. |
| 126 |
"interfaceIndex": 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. |
| 127 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 128 |
{ # Each logical network interface is effectively a network and IP pair. |
| 129 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 130 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 131 |
"ipAddress": "A String", # IP address in the network |
| 132 |
"network": "A String", # Name of the network |
| 133 |
"networkType": "A String", # Type of network. |
| 134 |
}, |
| 135 |
], |
| 136 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 137 |
}, |
| 138 |
], |
| 139 |
"name": "A String", # The name of the instance config. |
| 140 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 141 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 142 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 143 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 144 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 145 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 146 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 147 |
}, |
| 148 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 149 |
"A String", |
| 150 |
], |
| 151 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 152 |
}, |
| 153 |
], |
| 154 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 155 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 156 |
"networks": [ # Networks to be created. |
| 157 |
{ # Configuration parameters for a new network. |
| 158 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 159 |
"cidr": "A String", # CIDR range of the network. |
| 160 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 161 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 162 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 163 |
"name": "A String", # Output only. The name of the network config. |
| 164 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 165 |
"type": "A String", # The type of this network, either Client or Private. |
| 166 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 167 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 168 |
{ # A GCP vlan attachment. |
| 169 |
"id": "A String", # Identifier of the VLAN attachment. |
| 170 |
"pairingKey": "A String", # Attachment pairing key. |
| 171 |
}, |
| 172 |
], |
| 173 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 174 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 175 |
}, |
| 176 |
], |
| 177 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 178 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 179 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 180 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 181 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 182 |
"volumes": [ # Volumes to be created. |
| 183 |
{ # Configuration parameters for a new volume. |
| 184 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 185 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 186 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 187 |
{ # A LUN(Logical Unit Number) range. |
| 188 |
"quantity": 42, # Number of LUNs to create. |
| 189 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 190 |
}, |
| 191 |
], |
| 192 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 193 |
"A String", |
| 194 |
], |
| 195 |
"name": "A String", # Output only. The name of the volume config. |
| 196 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 197 |
{ # A NFS export entry. |
| 198 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 199 |
"allowSuid": True or False, # Allow the setuid flag. |
| 200 |
"cidr": "A String", # A CIDR range. |
| 201 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 202 |
"networkId": "A String", # Network to use to publish the export. |
| 203 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 204 |
"permissions": "A String", # Export permissions. |
| 205 |
}, |
| 206 |
], |
| 207 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 208 |
"protocol": "A String", # Volume protocol. |
| 209 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 210 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 211 |
"type": "A String", # The type of this Volume. |
| 212 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 213 |
}, |
| 214 |
], |
| 215 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 216 |
} |
| 217 |
|
| 218 |
email: string, Optional. Email provided to send a confirmation with provisioning config to. |
| 219 |
x__xgafv: string, V1 error format. |
| 220 |
Allowed values |
| 221 |
1 - v1 error format |
| 222 |
2 - v2 error format |
| 223 |
|
| 224 |
Returns: |
| 225 |
An object of the form: |
| 226 |
|
| 227 |
{ # A provisioning configuration. |
| 228 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 229 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 230 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 231 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 232 |
"instances": [ # Instances to be created. |
| 233 |
{ # Configuration parameters for a new instance. |
| 234 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 235 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 236 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 237 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 238 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 239 |
}, |
| 240 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 241 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 242 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 243 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 244 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 245 |
{ # 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. |
| 246 |
"interfaceIndex": 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. |
| 247 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 248 |
{ # Each logical network interface is effectively a network and IP pair. |
| 249 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 250 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 251 |
"ipAddress": "A String", # IP address in the network |
| 252 |
"network": "A String", # Name of the network |
| 253 |
"networkType": "A String", # Type of network. |
| 254 |
}, |
| 255 |
], |
| 256 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 257 |
}, |
| 258 |
], |
| 259 |
"name": "A String", # The name of the instance config. |
| 260 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 261 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 262 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 263 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 264 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 265 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 266 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 267 |
}, |
| 268 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 269 |
"A String", |
| 270 |
], |
| 271 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 272 |
}, |
| 273 |
], |
| 274 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 275 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 276 |
"networks": [ # Networks to be created. |
| 277 |
{ # Configuration parameters for a new network. |
| 278 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 279 |
"cidr": "A String", # CIDR range of the network. |
| 280 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 281 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 282 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 283 |
"name": "A String", # Output only. The name of the network config. |
| 284 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 285 |
"type": "A String", # The type of this network, either Client or Private. |
| 286 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 287 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 288 |
{ # A GCP vlan attachment. |
| 289 |
"id": "A String", # Identifier of the VLAN attachment. |
| 290 |
"pairingKey": "A String", # Attachment pairing key. |
| 291 |
}, |
| 292 |
], |
| 293 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 294 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 295 |
}, |
| 296 |
], |
| 297 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 298 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 299 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 300 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 301 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 302 |
"volumes": [ # Volumes to be created. |
| 303 |
{ # Configuration parameters for a new volume. |
| 304 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 305 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 306 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 307 |
{ # A LUN(Logical Unit Number) range. |
| 308 |
"quantity": 42, # Number of LUNs to create. |
| 309 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 310 |
}, |
| 311 |
], |
| 312 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 313 |
"A String", |
| 314 |
], |
| 315 |
"name": "A String", # Output only. The name of the volume config. |
| 316 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 317 |
{ # A NFS export entry. |
| 318 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 319 |
"allowSuid": True or False, # Allow the setuid flag. |
| 320 |
"cidr": "A String", # A CIDR range. |
| 321 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 322 |
"networkId": "A String", # Network to use to publish the export. |
| 323 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 324 |
"permissions": "A String", # Export permissions. |
| 325 |
}, |
| 326 |
], |
| 327 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 328 |
"protocol": "A String", # Volume protocol. |
| 329 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 330 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 331 |
"type": "A String", # The type of this Volume. |
| 332 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 333 |
}, |
| 334 |
], |
| 335 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 336 |
}</pre> |
| 337 |
</div> |
| 338 |
|
| 339 |
<div class="method"> |
| 340 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 341 |
<pre>Get ProvisioningConfig by name. |
| 342 |
|
| 343 |
Args: |
| 344 |
name: string, Required. Name of the ProvisioningConfig. (required) |
| 345 |
x__xgafv: string, V1 error format. |
| 346 |
Allowed values |
| 347 |
1 - v1 error format |
| 348 |
2 - v2 error format |
| 349 |
|
| 350 |
Returns: |
| 351 |
An object of the form: |
| 352 |
|
| 353 |
{ # A provisioning configuration. |
| 354 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 355 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 356 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 357 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 358 |
"instances": [ # Instances to be created. |
| 359 |
{ # Configuration parameters for a new instance. |
| 360 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 361 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 362 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 363 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 364 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 365 |
}, |
| 366 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 367 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 368 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 369 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 370 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 371 |
{ # 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. |
| 372 |
"interfaceIndex": 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. |
| 373 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 374 |
{ # Each logical network interface is effectively a network and IP pair. |
| 375 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 376 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 377 |
"ipAddress": "A String", # IP address in the network |
| 378 |
"network": "A String", # Name of the network |
| 379 |
"networkType": "A String", # Type of network. |
| 380 |
}, |
| 381 |
], |
| 382 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 383 |
}, |
| 384 |
], |
| 385 |
"name": "A String", # The name of the instance config. |
| 386 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 387 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 388 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 389 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 390 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 391 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 392 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 393 |
}, |
| 394 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 395 |
"A String", |
| 396 |
], |
| 397 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 398 |
}, |
| 399 |
], |
| 400 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 401 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 402 |
"networks": [ # Networks to be created. |
| 403 |
{ # Configuration parameters for a new network. |
| 404 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 405 |
"cidr": "A String", # CIDR range of the network. |
| 406 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 407 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 408 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 409 |
"name": "A String", # Output only. The name of the network config. |
| 410 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 411 |
"type": "A String", # The type of this network, either Client or Private. |
| 412 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 413 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 414 |
{ # A GCP vlan attachment. |
| 415 |
"id": "A String", # Identifier of the VLAN attachment. |
| 416 |
"pairingKey": "A String", # Attachment pairing key. |
| 417 |
}, |
| 418 |
], |
| 419 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 420 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 421 |
}, |
| 422 |
], |
| 423 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 424 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 425 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 426 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 427 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 428 |
"volumes": [ # Volumes to be created. |
| 429 |
{ # Configuration parameters for a new volume. |
| 430 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 431 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 432 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 433 |
{ # A LUN(Logical Unit Number) range. |
| 434 |
"quantity": 42, # Number of LUNs to create. |
| 435 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 436 |
}, |
| 437 |
], |
| 438 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 439 |
"A String", |
| 440 |
], |
| 441 |
"name": "A String", # Output only. The name of the volume config. |
| 442 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 443 |
{ # A NFS export entry. |
| 444 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 445 |
"allowSuid": True or False, # Allow the setuid flag. |
| 446 |
"cidr": "A String", # A CIDR range. |
| 447 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 448 |
"networkId": "A String", # Network to use to publish the export. |
| 449 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 450 |
"permissions": "A String", # Export permissions. |
| 451 |
}, |
| 452 |
], |
| 453 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 454 |
"protocol": "A String", # Volume protocol. |
| 455 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 456 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 457 |
"type": "A String", # The type of this Volume. |
| 458 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 459 |
}, |
| 460 |
], |
| 461 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 462 |
}</pre> |
| 463 |
</div> |
| 464 |
|
| 465 |
<div class="method"> |
| 466 |
<code class="details" id="patch">patch(name, body=None, email=None, updateMask=None, x__xgafv=None)</code> |
| 467 |
<pre>Update existing ProvisioningConfig. |
| 468 |
|
| 469 |
Args: |
| 470 |
name: string, Output only. The system-generated name of the provisioning config. This follows the UUID format. (required) |
| 471 |
body: object, The request body. |
| 472 |
The object takes the form of: |
| 473 |
|
| 474 |
{ # A provisioning configuration. |
| 475 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 476 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 477 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 478 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 479 |
"instances": [ # Instances to be created. |
| 480 |
{ # Configuration parameters for a new instance. |
| 481 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 482 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 483 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 484 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 485 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 486 |
}, |
| 487 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 488 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 489 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 490 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 491 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 492 |
{ # 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. |
| 493 |
"interfaceIndex": 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. |
| 494 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 495 |
{ # Each logical network interface is effectively a network and IP pair. |
| 496 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 497 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 498 |
"ipAddress": "A String", # IP address in the network |
| 499 |
"network": "A String", # Name of the network |
| 500 |
"networkType": "A String", # Type of network. |
| 501 |
}, |
| 502 |
], |
| 503 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 504 |
}, |
| 505 |
], |
| 506 |
"name": "A String", # The name of the instance config. |
| 507 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 508 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 509 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 510 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 511 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 512 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 513 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 514 |
}, |
| 515 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 516 |
"A String", |
| 517 |
], |
| 518 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 519 |
}, |
| 520 |
], |
| 521 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 522 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 523 |
"networks": [ # Networks to be created. |
| 524 |
{ # Configuration parameters for a new network. |
| 525 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 526 |
"cidr": "A String", # CIDR range of the network. |
| 527 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 528 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 529 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 530 |
"name": "A String", # Output only. The name of the network config. |
| 531 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 532 |
"type": "A String", # The type of this network, either Client or Private. |
| 533 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 534 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 535 |
{ # A GCP vlan attachment. |
| 536 |
"id": "A String", # Identifier of the VLAN attachment. |
| 537 |
"pairingKey": "A String", # Attachment pairing key. |
| 538 |
}, |
| 539 |
], |
| 540 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 541 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 542 |
}, |
| 543 |
], |
| 544 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 545 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 546 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 547 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 548 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 549 |
"volumes": [ # Volumes to be created. |
| 550 |
{ # Configuration parameters for a new volume. |
| 551 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 552 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 553 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 554 |
{ # A LUN(Logical Unit Number) range. |
| 555 |
"quantity": 42, # Number of LUNs to create. |
| 556 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 557 |
}, |
| 558 |
], |
| 559 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 560 |
"A String", |
| 561 |
], |
| 562 |
"name": "A String", # Output only. The name of the volume config. |
| 563 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 564 |
{ # A NFS export entry. |
| 565 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 566 |
"allowSuid": True or False, # Allow the setuid flag. |
| 567 |
"cidr": "A String", # A CIDR range. |
| 568 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 569 |
"networkId": "A String", # Network to use to publish the export. |
| 570 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 571 |
"permissions": "A String", # Export permissions. |
| 572 |
}, |
| 573 |
], |
| 574 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 575 |
"protocol": "A String", # Volume protocol. |
| 576 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 577 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 578 |
"type": "A String", # The type of this Volume. |
| 579 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 580 |
}, |
| 581 |
], |
| 582 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 583 |
} |
| 584 |
|
| 585 |
email: string, Optional. Email provided to send a confirmation with provisioning config to. |
| 586 |
updateMask: string, Required. The list of fields to update. |
| 587 |
x__xgafv: string, V1 error format. |
| 588 |
Allowed values |
| 589 |
1 - v1 error format |
| 590 |
2 - v2 error format |
| 591 |
|
| 592 |
Returns: |
| 593 |
An object of the form: |
| 594 |
|
| 595 |
{ # A provisioning configuration. |
| 596 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 597 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 598 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 599 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 600 |
"instances": [ # Instances to be created. |
| 601 |
{ # Configuration parameters for a new instance. |
| 602 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 603 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 604 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 605 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 606 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 607 |
}, |
| 608 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 609 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 610 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 611 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 612 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 613 |
{ # 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. |
| 614 |
"interfaceIndex": 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. |
| 615 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 616 |
{ # Each logical network interface is effectively a network and IP pair. |
| 617 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 618 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 619 |
"ipAddress": "A String", # IP address in the network |
| 620 |
"network": "A String", # Name of the network |
| 621 |
"networkType": "A String", # Type of network. |
| 622 |
}, |
| 623 |
], |
| 624 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 625 |
}, |
| 626 |
], |
| 627 |
"name": "A String", # The name of the instance config. |
| 628 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 629 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 630 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 631 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 632 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 633 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 634 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 635 |
}, |
| 636 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 637 |
"A String", |
| 638 |
], |
| 639 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 640 |
}, |
| 641 |
], |
| 642 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 643 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 644 |
"networks": [ # Networks to be created. |
| 645 |
{ # Configuration parameters for a new network. |
| 646 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 647 |
"cidr": "A String", # CIDR range of the network. |
| 648 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 649 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 650 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 651 |
"name": "A String", # Output only. The name of the network config. |
| 652 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 653 |
"type": "A String", # The type of this network, either Client or Private. |
| 654 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 655 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 656 |
{ # A GCP vlan attachment. |
| 657 |
"id": "A String", # Identifier of the VLAN attachment. |
| 658 |
"pairingKey": "A String", # Attachment pairing key. |
| 659 |
}, |
| 660 |
], |
| 661 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 662 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 663 |
}, |
| 664 |
], |
| 665 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 666 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 667 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 668 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 669 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 670 |
"volumes": [ # Volumes to be created. |
| 671 |
{ # Configuration parameters for a new volume. |
| 672 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 673 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 674 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 675 |
{ # A LUN(Logical Unit Number) range. |
| 676 |
"quantity": 42, # Number of LUNs to create. |
| 677 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 678 |
}, |
| 679 |
], |
| 680 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 681 |
"A String", |
| 682 |
], |
| 683 |
"name": "A String", # Output only. The name of the volume config. |
| 684 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 685 |
{ # A NFS export entry. |
| 686 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 687 |
"allowSuid": True or False, # Allow the setuid flag. |
| 688 |
"cidr": "A String", # A CIDR range. |
| 689 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 690 |
"networkId": "A String", # Network to use to publish the export. |
| 691 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 692 |
"permissions": "A String", # Export permissions. |
| 693 |
}, |
| 694 |
], |
| 695 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 696 |
"protocol": "A String", # Volume protocol. |
| 697 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 698 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 699 |
"type": "A String", # The type of this Volume. |
| 700 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 701 |
}, |
| 702 |
], |
| 703 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 704 |
}</pre> |
| 705 |
</div> |
| 706 |
|
| 707 |
<div class="method"> |
| 708 |
<code class="details" id="submit">submit(parent, body=None, x__xgafv=None)</code> |
| 709 |
<pre>Submit a provisioning configuration for a given project. |
| 710 |
|
| 711 |
Args: |
| 712 |
parent: string, Required. The parent project and location containing the ProvisioningConfig. (required) |
| 713 |
body: object, The request body. |
| 714 |
The object takes the form of: |
| 715 |
|
| 716 |
{ # Request for SubmitProvisioningConfig. |
| 717 |
"email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| 718 |
"provisioningConfig": { # A provisioning configuration. # Required. The ProvisioningConfig to create. |
| 719 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 720 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 721 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 722 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 723 |
"instances": [ # Instances to be created. |
| 724 |
{ # Configuration parameters for a new instance. |
| 725 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 726 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 727 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 728 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 729 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 730 |
}, |
| 731 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 732 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 733 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 734 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 735 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 736 |
{ # 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. |
| 737 |
"interfaceIndex": 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. |
| 738 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 739 |
{ # Each logical network interface is effectively a network and IP pair. |
| 740 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 741 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 742 |
"ipAddress": "A String", # IP address in the network |
| 743 |
"network": "A String", # Name of the network |
| 744 |
"networkType": "A String", # Type of network. |
| 745 |
}, |
| 746 |
], |
| 747 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 748 |
}, |
| 749 |
], |
| 750 |
"name": "A String", # The name of the instance config. |
| 751 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 752 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 753 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 754 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 755 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 756 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 757 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 758 |
}, |
| 759 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 760 |
"A String", |
| 761 |
], |
| 762 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 763 |
}, |
| 764 |
], |
| 765 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 766 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 767 |
"networks": [ # Networks to be created. |
| 768 |
{ # Configuration parameters for a new network. |
| 769 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 770 |
"cidr": "A String", # CIDR range of the network. |
| 771 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 772 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 773 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 774 |
"name": "A String", # Output only. The name of the network config. |
| 775 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 776 |
"type": "A String", # The type of this network, either Client or Private. |
| 777 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 778 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 779 |
{ # A GCP vlan attachment. |
| 780 |
"id": "A String", # Identifier of the VLAN attachment. |
| 781 |
"pairingKey": "A String", # Attachment pairing key. |
| 782 |
}, |
| 783 |
], |
| 784 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 785 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 786 |
}, |
| 787 |
], |
| 788 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 789 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 790 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 791 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 792 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 793 |
"volumes": [ # Volumes to be created. |
| 794 |
{ # Configuration parameters for a new volume. |
| 795 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 796 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 797 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 798 |
{ # A LUN(Logical Unit Number) range. |
| 799 |
"quantity": 42, # Number of LUNs to create. |
| 800 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 801 |
}, |
| 802 |
], |
| 803 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 804 |
"A String", |
| 805 |
], |
| 806 |
"name": "A String", # Output only. The name of the volume config. |
| 807 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 808 |
{ # A NFS export entry. |
| 809 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 810 |
"allowSuid": True or False, # Allow the setuid flag. |
| 811 |
"cidr": "A String", # A CIDR range. |
| 812 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 813 |
"networkId": "A String", # Network to use to publish the export. |
| 814 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 815 |
"permissions": "A String", # Export permissions. |
| 816 |
}, |
| 817 |
], |
| 818 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 819 |
"protocol": "A String", # Volume protocol. |
| 820 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 821 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 822 |
"type": "A String", # The type of this Volume. |
| 823 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 824 |
}, |
| 825 |
], |
| 826 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 827 |
}, |
| 828 |
} |
| 829 |
|
| 830 |
x__xgafv: string, V1 error format. |
| 831 |
Allowed values |
| 832 |
1 - v1 error format |
| 833 |
2 - v2 error format |
| 834 |
|
| 835 |
Returns: |
| 836 |
An object of the form: |
| 837 |
|
| 838 |
{ # Response for SubmitProvisioningConfig. |
| 839 |
"provisioningConfig": { # A provisioning configuration. # The submitted provisioning config. |
| 840 |
"cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| 841 |
"customId": "A String", # Optional. The user-defined identifier of the provisioning config. |
| 842 |
"email": "A String", # Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. |
| 843 |
"handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| 844 |
"instances": [ # Instances to be created. |
| 845 |
{ # Configuration parameters for a new instance. |
| 846 |
"accountNetworksEnabled": True or False, # If true networks can be from different projects of the same vendor account. |
| 847 |
"clientNetwork": { # A network. # Client network address. Filled if InstanceConfig.multivlan_config is false. |
| 848 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 849 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 850 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 851 |
}, |
| 852 |
"hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| 853 |
"id": "A String", # A transient unique identifier to identify an instance within an ProvisioningConfig request. |
| 854 |
"instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 855 |
"kmsKeyVersion": "A String", # Name of the KMS crypto key version used to encrypt the initial passwords. The key has to have ASYMMETRIC_DECRYPT purpose. |
| 856 |
"logicalInterfaces": [ # 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. Filled if InstanceConfig.multivlan_config is true. |
| 857 |
{ # 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. |
| 858 |
"interfaceIndex": 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. |
| 859 |
"logicalNetworkInterfaces": [ # List of logical network interfaces within a logical interface. |
| 860 |
{ # Each logical network interface is effectively a network and IP pair. |
| 861 |
"defaultGateway": True or False, # Whether this interface is the default gateway for the instance. Only one interface can be the default gateway for the instance. |
| 862 |
"id": "A String", # An identifier for the `Network`, generated by the backend. |
| 863 |
"ipAddress": "A String", # IP address in the network |
| 864 |
"network": "A String", # Name of the network |
| 865 |
"networkType": "A String", # Type of network. |
| 866 |
}, |
| 867 |
], |
| 868 |
"name": "A String", # Interface name. This is of syntax or and forms part of the network template name. |
| 869 |
}, |
| 870 |
], |
| 871 |
"name": "A String", # The name of the instance config. |
| 872 |
"networkConfig": "A String", # The type of network configuration on the instance. |
| 873 |
"networkTemplate": "A String", # Server network template name. Filled if InstanceConfig.multivlan_config is true. |
| 874 |
"osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| 875 |
"privateNetwork": { # A network. # Private network address, if any. Filled if InstanceConfig.multivlan_config is false. |
| 876 |
"address": "A String", # IPv4 address to be assigned to the server. |
| 877 |
"existingNetworkId": "A String", # Name of the existing network to use. |
| 878 |
"networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| 879 |
}, |
| 880 |
"sshKeyNames": [ # Optional. List of names of ssh keys used to provision the instance. |
| 881 |
"A String", |
| 882 |
], |
| 883 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 884 |
}, |
| 885 |
], |
| 886 |
"location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| 887 |
"name": "A String", # Output only. The system-generated name of the provisioning config. This follows the UUID format. |
| 888 |
"networks": [ # Networks to be created. |
| 889 |
{ # Configuration parameters for a new network. |
| 890 |
"bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| 891 |
"cidr": "A String", # CIDR range of the network. |
| 892 |
"gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 893 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 894 |
"jumboFramesEnabled": True or False, # The JumboFramesEnabled option for customer to set. |
| 895 |
"name": "A String", # Output only. The name of the network config. |
| 896 |
"serviceCidr": "A String", # Service CIDR, if any. |
| 897 |
"type": "A String", # The type of this network, either Client or Private. |
| 898 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 899 |
"vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf |
| 900 |
{ # A GCP vlan attachment. |
| 901 |
"id": "A String", # Identifier of the VLAN attachment. |
| 902 |
"pairingKey": "A String", # Attachment pairing key. |
| 903 |
}, |
| 904 |
], |
| 905 |
"vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| 906 |
"vrf": "A String", # Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty. |
| 907 |
}, |
| 908 |
], |
| 909 |
"pod": "A String", # Optional. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes, nfsshares) allocated in the same pod only. |
| 910 |
"state": "A String", # Output only. State of ProvisioningConfig. |
| 911 |
"statusMessage": "A String", # Optional status messages associated with the FAILED state. |
| 912 |
"ticketId": "A String", # A generated ticket id to track provisioning request. |
| 913 |
"updateTime": "A String", # Output only. Last update timestamp. |
| 914 |
"volumes": [ # Volumes to be created. |
| 915 |
{ # Configuration parameters for a new volume. |
| 916 |
"gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| 917 |
"id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| 918 |
"lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| 919 |
{ # A LUN(Logical Unit Number) range. |
| 920 |
"quantity": 42, # Number of LUNs to create. |
| 921 |
"sizeGb": 42, # The requested size of each LUN, in GB. |
| 922 |
}, |
| 923 |
], |
| 924 |
"machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| 925 |
"A String", |
| 926 |
], |
| 927 |
"name": "A String", # Output only. The name of the volume config. |
| 928 |
"nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| 929 |
{ # A NFS export entry. |
| 930 |
"allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| 931 |
"allowSuid": True or False, # Allow the setuid flag. |
| 932 |
"cidr": "A String", # A CIDR range. |
| 933 |
"machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| 934 |
"networkId": "A String", # Network to use to publish the export. |
| 935 |
"noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| 936 |
"permissions": "A String", # Export permissions. |
| 937 |
}, |
| 938 |
], |
| 939 |
"performanceTier": "A String", # Performance tier of the Volume. Default is SHARED. |
| 940 |
"protocol": "A String", # Volume protocol. |
| 941 |
"sizeGb": 42, # The requested size of this volume, in GB. |
| 942 |
"snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| 943 |
"type": "A String", # The type of this Volume. |
| 944 |
"userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| 945 |
}, |
| 946 |
], |
| 947 |
"vpcScEnabled": True or False, # If true, VPC SC is enabled for the cluster. |
| 948 |
}, |
| 949 |
}</pre> |
| 950 |
</div> |
| 951 |
|
| 952 |
</body></html> |