# REST Resource: projects.locations.hardware

- [Resource: Hardware](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Hardware)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Hardware.SCHEMA_REPRESENTATION)
- [State](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#State)
- [HardwarePhysicalInfo](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwarePhysicalInfo)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwarePhysicalInfo.SCHEMA_REPRESENTATION)
- [PowerReceptacleType](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#PowerReceptacleType)
- [NetworkUplinkType](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#NetworkUplinkType)
- [Voltage](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Voltage)
- [Amperes](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Amperes)
- [HardwareInstallationInfo](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwareInstallationInfo)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwareInstallationInfo.SCHEMA_REPRESENTATION)
- [Dimensions](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Dimensions)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Dimensions.SCHEMA_REPRESENTATION)
- [RackType](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#RackType)
- [MachineInfo](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MachineInfo)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MachineInfo.SCHEMA_REPRESENTATION)
- [MacAddress](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MacAddress)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MacAddress.SCHEMA_REPRESENTATION)
- [AddressType](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#AddressType)
- [DiskInfo](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#DiskInfo)
  - [JSON representation](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#DiskInfo.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#METHODS_SUMMARY)

## Resource: Hardware

An instance of hardware installed at a site.

| JSON representation |
|---|
| ``` { "name": string, "displayName": string, "createTime": string, "updateTime": string, "labels": { string: string, ... }, "order": string, "hardwareGroup": string, "site": string, "state": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#State`), "ciqUri": string, "config": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/HardwareConfig`) }, "estimatedInstallationDate": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`) }, "physicalInfo": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwarePhysicalInfo`) }, "installationInfo": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwareInstallationInfo`) }, "zone": string, "requestedInstallationDate": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`) }, "actualInstallationDate": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`) }, "machineInfos": [ { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MachineInfo`) } ], "estimatedDeliveryDate": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` Identifier. Name of this hardware. Format: `projects/{project}/locations/{location}/hardware/{hardware}` |
| `displayName` | `string` Optional. Display name for this hardware. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Time when this hardware was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Time when this hardware was last updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `labels` | `map (key: string, value: string)` Optional. Labels associated with this hardware as key value pairs. For more information about labels, see [Create and manage labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). An object containing a list of `"key": value` pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. |
| `order` | `string` Required. Name of the order that this hardware belongs to. Format: `projects/{project}/locations/{location}/orders/{order}` |
| `hardwareGroup` | `string` Output only. Name for the hardware group that this hardware belongs to. Format: `projects/{project}/locations/{location}/orders/{order}/hardwareGroups/{hardwareGroup}` |
| `site` | `string` Required. Name for the site that this hardware belongs to. Format: `projects/{project}/locations/{location}/sites/{site}` |
| `state` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#State`)`` Output only. Current state for this hardware. |
| `ciqUri` | `string` Output only. Link to the Customer Intake Questionnaire (CIQ) sheet for this Hardware. |
| `config` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/HardwareConfig`)`` Required. Configuration for this hardware. |
| `estimatedInstallationDate` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`)`` Output only. Estimated installation date for this hardware. |
| `physicalInfo` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwarePhysicalInfo`)`` Optional. Physical properties of this hardware. |
| `installationInfo` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#HardwareInstallationInfo`)`` Optional. Information for installation of this hardware. |
| `zone` | `string` Required. Name for the zone that this hardware belongs to. Format: `projects/{project}/locations/{location}/zones/{zone}` |
| `requestedInstallationDate (deprecated)` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`)`` > [!WARNING] > This item is deprecated! Optional. Deprecated: The requested installation date has been moved to the Order resource. Use `customerRequestedInstallationDate` on the Order resource instead. |
| `actualInstallationDate` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`)`` Output only. Actual installation date for this hardware. Filled in by Google. |
| `machineInfos[]` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MachineInfo`)`` Output only. Per machine asset information needed for turnup. |
| `estimatedDeliveryDate` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/Date`)`` Output only. The estimated delivery date of the hardware. |

## State

Valid states for hardware.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | State of the Hardware is unspecified. |
| `ADDITIONAL_INFO_NEEDED` | More information is required from the customer to make progress. |
| `BUILDING` | Google has initiated building hardware for this Hardware. |
| `SHIPPING` | The hardware has been built and is being shipped. |
| `INSTALLING` | The hardware is being installed. |
| `INSTALLED` | The hardware has been installed. |
| `FAILED` | An error occurred and customer intervention is required. |

## HardwarePhysicalInfo

Physical properties of a hardware.

| JSON representation |
|---|
| ``` { "powerReceptacle": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#PowerReceptacleType`), "networkUplink": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#NetworkUplinkType`), "voltage": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Voltage`), "amperes": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Amperes`) } ``` |

| Fields ||
|---|---|
| `powerReceptacle` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#PowerReceptacleType`)`` Required. The power receptacle type. |
| `networkUplink` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#NetworkUplinkType`)`` Required. Type of the uplink network connection. |
| `voltage` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Voltage`)`` Required. Voltage of the power supply. |
| `amperes` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Amperes`)`` Required. Amperes of the power supply. |

## PowerReceptacleType

Valid power receptacle types.

| Enums ||
|---|---|
| `POWER_RECEPTACLE_TYPE_UNSPECIFIED` | Facility plug type is unspecified. |
| `NEMA_5_15` | NEMA 5-15. |
| `C_13` | C13. |
| `STANDARD_EU` | Deprecated: Please use TYPE_G_BS1363, CEE_7_3, CEE_7_5 or TYPE_F instead. > [!WARNING] > This item is deprecated! |
| `TYPE_G_BS1363` | Type G / BS1363. |
| `CEE_7_3` | C 7/3. |
| `CEE_7_5` | C 7/5. |
| `TYPE_F` | Type F. |

## NetworkUplinkType

Valid network uplink types.

| Enums ||
|---|---|
| `NETWORK_UPLINK_TYPE_UNSPECIFIED` | Network uplink type is unspecified. |
| `RJ_45` | RJ-45. |

## Voltage

Valid voltage values.

| Enums ||
|---|---|
| `VOLTAGE_UNSPECIFIED` | Voltage is unspecified. |
| `VOLTAGE_110` | 120V. |
| `VOLTAGE_220` | 220V. |

## Amperes

Valid amperes values.

| Enums ||
|---|---|
| `AMPERES_UNSPECIFIED` | Amperes is unspecified. |
| `AMPERES_15` | 15A. |

## HardwareInstallationInfo

Information for installation of a Hardware.

| JSON representation |
|---|
| ``` { "rackLocation": string, "powerDistanceMeters": integer, "switchDistanceMeters": integer, "rackUnitDimensions": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Dimensions`) }, "rackSpace": { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/RackSpace`) }, "rackType": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#RackType`) } ``` |

| Fields ||
|---|---|
| `rackLocation` | `string` Required. Location of the rack in the site e.g. Floor 2, Room 201, Row 7, Rack 3. |
| `powerDistanceMeters` | `integer` Required. Distance from the power outlet in meters. |
| `switchDistanceMeters` | `integer` Required. Distance from the network switch in meters. |
| `rackUnitDimensions` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#Dimensions`)`` Required. Dimensions of the rack unit. |
| `rackSpace` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/RackSpace`)`` Required. Rack space allocated for the hardware. |
| `rackType` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#RackType`)`` Required. Type of the rack. |

## Dimensions

Represents the dimensions of an object.

| JSON representation |
|---|
| ``` { "widthInches": number, "heightInches": number, "depthInches": number } ``` |

| Fields ||
|---|---|
| `widthInches` | `number` Required. Width in inches. |
| `heightInches` | `number` Required. Height in inches. |
| `depthInches` | `number` Required. Depth in inches. |

## RackType

Valid rack types.

| Enums ||
|---|---|
| `RACK_TYPE_UNSPECIFIED` | Rack type is unspecified. |
| `TWO_POST` | Two post rack. |
| `FOUR_POST` | Four post rack. |

## MachineInfo

Information about individual machines vendors will provide during turnup.

| JSON representation |
|---|
| ``` { "serviceTag": string, "macAddresses": [ { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MacAddress`) } ], "name": string, "diskInfos": [ { object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#DiskInfo`) } ] } ``` |

| Fields ||
|---|---|
| `serviceTag` | `string` Output only. Machine service tag. |
| `macAddresses[]` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#MacAddress`)`` Output only. Each associated MAC address. |
| `name` | `string` Output only. Machine name. |
| `diskInfos[]` | ``object (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#DiskInfo`)`` Output only. Information for each disk installed. |

## MacAddress

Message to describe the MAC address of a machine.

| JSON representation |
|---|
| ``` { "address": string, "type": enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#AddressType`), "ipv4Address": string } ``` |

| Fields ||
|---|---|
| `address` | `string` Output only. Address string. |
| `type` | ``enum (`https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware#AddressType`)`` Output only. Address type for this MAC address. |
| `ipv4Address` | `string` Output only. Static IP address (if used) that is associated with the MAC address. Only applicable for VIRTUAL MAC address type. |

## AddressType

Enum for the different types of MAC address.

| Enums ||
|---|---|
| `ADDRESS_TYPE_UNSPECIFIED` | Unspecified address type. |
| `NIC` | Address of a network interface card. |
| `BMC` | Address of a baseboard management controller. |
| `VIRTUAL` | Address of a virtual interface. |

## DiskInfo

Information about individual disks on a machine.

| JSON representation |
|---|
| ``` { "manufacturer": string, "slot": integer, "serialNumber": string, "psid": string, "partNumber": string, "modelNumber": string } ``` |

| Fields ||
|---|---|
| `manufacturer` | `string` Output only. Disk manufacturer. |
| `slot` | `integer` Output only. Disk slot number. |
| `serialNumber` | `string` Output only. Disk serial number. |
| `psid` | `string` Output only. Disk PSID. |
| `partNumber` | `string` Output only. Disk part number. |
| `modelNumber` | `string` Output only. Disk model number. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware/create` | Creates new hardware in a given project and location. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware/delete` | Deletes hardware. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware/get` | Gets hardware details. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware/list` | Lists hardware in a given project and location. |
| ### `https://docs.cloud.google.com/distributed-cloud/connected/1.11.0/docs/reference/hardware/rest/v1alpha/projects.locations.hardware/patch` | Updates hardware parameters. |