| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="baremetalsolution_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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create new ProvisioningConfig.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get ProvisioningConfig by name.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update existing ProvisioningConfig.</p> |
| <p class="toc_element"> |
| <code><a href="#submit">submit(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Submit a provisiong configuration for a given project.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Create new ProvisioningConfig. |
| |
| Args: |
| parent: string, Required. The parent project and location containing the ProvisioningConfig. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A provisioning configuration. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A provisioning configuration. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Get ProvisioningConfig by name. |
| |
| Args: |
| name: string, Required. Name of the ProvisioningConfig. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A provisioning configuration. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update existing ProvisioningConfig. |
| |
| Args: |
| name: string, Output only. The name of the provisioning config. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A provisioning configuration. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| } |
| |
| updateMask: string, Required. The list of fields to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A provisioning configuration. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="submit">submit(parent, body=None, x__xgafv=None)</code> |
| <pre>Submit a provisiong configuration for a given project. |
| |
| Args: |
| parent: string, Required. The parent project and location containing the ProvisioningConfig. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request for SubmitProvisioningConfig. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "provisioningConfig": { # A provisioning configuration. # Required. The ProvisioningConfig to create. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for SubmitProvisioningConfig. |
| "provisioningConfig": { # A provisioning configuration. # The submitted provisioning config. |
| "cloudConsoleUri": "A String", # Output only. URI to Cloud Console UI view of this provisioning config. |
| "email": "A String", # Optional. Email provided to send a confirmation with provisioning config to. |
| "handoverServiceAccount": "A String", # A service account to enable customers to access instance credentials upon handover. |
| "instances": [ # Instances to be created. |
| { # Configuration parameters for a new instance. |
| "clientNetwork": { # A network. # Client network address. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "hyperthreading": True or False, # Whether the instance should be provisioned with Hyperthreading enabled. |
| "id": "A String", # A transient unique identifier to idenfity an instance within an ProvisioningConfig request. |
| "instanceType": "A String", # Instance type. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "name": "A String", # Output only. The name of the instance config. |
| "osImage": "A String", # OS image to initialize the instance. [Available images](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) |
| "privateNetwork": { # A network. # Private network address, if any. |
| "address": "A String", # IPv4 address to be assigned to the server. |
| "existingNetworkId": "A String", # Name of the existing network to use. |
| "networkId": "A String", # Id of the network to use, within the same ProvisioningConfig request. |
| }, |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team . |
| }, |
| ], |
| "location": "A String", # Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. |
| "name": "A String", # Output only. The name of the provisioning config. |
| "networks": [ # Networks to be created. |
| { # Configuration parameters for a new network. |
| "bandwidth": "A String", # Interconnect bandwidth. Set only when type is CLIENT. |
| "cidr": "A String", # CIDR range of the network. |
| "gcpService": "A String", # The GCP service of the network. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "name": "A String", # Output only. The name of the network config. |
| "serviceCidr": "A String", # Service CIDR, if any. |
| "type": "A String", # The type of this network, either Client or Private. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| "vlanAttachments": [ # List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). |
| { # A GCP vlan attachment. |
| "id": "A String", # Identifier of the VLAN attachment. |
| "pairingKey": "A String", # Attachment pairing key. |
| }, |
| ], |
| "vlanSameProject": True or False, # Whether the VLAN attachment pair is located in the same project. |
| }, |
| ], |
| "state": "A String", # Output only. State of ProvisioningConfig. |
| "ticketId": "A String", # A generated buganizer id to track provisioning request. |
| "updateTime": "A String", # Output only. Last update timestamp. |
| "volumes": [ # Volumes to be created. |
| { # Configuration parameters for a new volume. |
| "gcpService": "A String", # The GCP service of the storage volume. Available gcp_service are in https://cloud.google.com/bare-metal/docs/bms-planning. |
| "id": "A String", # A transient unique identifier to identify a volume within an ProvisioningConfig request. |
| "lunRanges": [ # LUN ranges to be configured. Set only when protocol is PROTOCOL_FC. |
| { # A LUN(Logical Unit Number) range. |
| "quantity": 42, # Number of LUNs to create. |
| "sizeGb": 42, # The requested size of each LUN, in GB. |
| }, |
| ], |
| "machineIds": [ # Machine ids connected to this volume. Set only when protocol is PROTOCOL_FC. |
| "A String", |
| ], |
| "name": "A String", # Output only. The name of the volume config. |
| "nfsExports": [ # NFS exports. Set only when protocol is PROTOCOL_NFS. |
| { # A NFS export entry. |
| "allowDev": True or False, # Allow dev flag in NfsShare AllowedClientsRequest. |
| "allowSuid": True or False, # Allow the setuid flag. |
| "cidr": "A String", # A CIDR range. |
| "machineId": "A String", # Either a single machine, identified by an ID, or a comma-separated list of machine IDs. |
| "networkId": "A String", # Network to use to publish the export. |
| "noRootSquash": True or False, # Disable root squashing, which is a feature of NFS. Root squash is a special mapping of the remote superuser (root) identity when using identity authentication. |
| "permissions": "A String", # Export permissions. |
| }, |
| ], |
| "protocol": "A String", # Volume protocol. |
| "sizeGb": 42, # The requested size of this volume, in GB. |
| "snapshotsEnabled": True or False, # Whether snapshots should be enabled. |
| "type": "A String", # The type of this Volume. |
| "userNote": "A String", # User note field, it can be used by customers to add additional information for the BMS Ops team (b/194021617). |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
