1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. getHardwareReservation
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

equinix.metal.getHardwareReservation

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

Use this data source to retrieve a hardware reservation resource from Equinix Metal.

You can look up hardware reservation by its ID or by ID of device which occupies it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@pulumi/equinix";

const example = equinix.metal.getHardwareReservation({
    id: "4347e805-eb46-4699-9eb9-5c116e6a0172",
});
const exampleByDeviceId = equinix.metal.getHardwareReservation({
    deviceId: "ff85aa58-c106-4624-8f1c-7c64554047ea",
});
Copy
import pulumi
import pulumi_equinix as equinix

example = equinix.metal.get_hardware_reservation(id="4347e805-eb46-4699-9eb9-5c116e6a0172")
example_by_device_id = equinix.metal.get_hardware_reservation(device_id="ff85aa58-c106-4624-8f1c-7c64554047ea")
Copy
package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := metal.GetHardwareReservation(ctx, &metal.GetHardwareReservationArgs{
			Id: pulumi.StringRef("4347e805-eb46-4699-9eb9-5c116e6a0172"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = metal.GetHardwareReservation(ctx, &metal.GetHardwareReservationArgs{
			DeviceId: pulumi.StringRef("ff85aa58-c106-4624-8f1c-7c64554047ea"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var example = Equinix.Metal.GetHardwareReservation.Invoke(new()
    {
        Id = "4347e805-eb46-4699-9eb9-5c116e6a0172",
    });

    var exampleByDeviceId = Equinix.Metal.GetHardwareReservation.Invoke(new()
    {
        DeviceId = "ff85aa58-c106-4624-8f1c-7c64554047ea",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.metal.MetalFunctions;
import com.pulumi.equinix.metal.inputs.GetHardwareReservationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = MetalFunctions.getHardwareReservation(GetHardwareReservationArgs.builder()
            .id("4347e805-eb46-4699-9eb9-5c116e6a0172")
            .build());

        final var exampleByDeviceId = MetalFunctions.getHardwareReservation(GetHardwareReservationArgs.builder()
            .deviceId("ff85aa58-c106-4624-8f1c-7c64554047ea")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      Function: equinix:metal:getHardwareReservation
      Arguments:
        id: 4347e805-eb46-4699-9eb9-5c116e6a0172
  exampleByDeviceId:
    fn::invoke:
      Function: equinix:metal:getHardwareReservation
      Arguments:
        deviceId: ff85aa58-c106-4624-8f1c-7c64554047ea
Copy

Using getHardwareReservation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHardwareReservation(args: GetHardwareReservationArgs, opts?: InvokeOptions): Promise<GetHardwareReservationResult>
function getHardwareReservationOutput(args: GetHardwareReservationOutputArgs, opts?: InvokeOptions): Output<GetHardwareReservationResult>
Copy
def get_hardware_reservation(device_id: Optional[str] = None,
                             id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetHardwareReservationResult
def get_hardware_reservation_output(device_id: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetHardwareReservationResult]
Copy
func GetHardwareReservation(ctx *Context, args *GetHardwareReservationArgs, opts ...InvokeOption) (*GetHardwareReservationResult, error)
func GetHardwareReservationOutput(ctx *Context, args *GetHardwareReservationOutputArgs, opts ...InvokeOption) GetHardwareReservationResultOutput
Copy

> Note: This function is named GetHardwareReservation in the Go SDK.

public static class GetHardwareReservation 
{
    public static Task<GetHardwareReservationResult> InvokeAsync(GetHardwareReservationArgs args, InvokeOptions? opts = null)
    public static Output<GetHardwareReservationResult> Invoke(GetHardwareReservationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetHardwareReservationResult> getHardwareReservation(GetHardwareReservationArgs args, InvokeOptions options)
public static Output<GetHardwareReservationResult> getHardwareReservation(GetHardwareReservationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: equinix:metal/getHardwareReservation:getHardwareReservation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceId string
UUID of device occupying the reservation.
Id string
ID of the hardware reservation.
DeviceId string
UUID of device occupying the reservation.
Id string
ID of the hardware reservation.
deviceId String
UUID of device occupying the reservation.
id String
ID of the hardware reservation.
deviceId string
UUID of device occupying the reservation.
id string
ID of the hardware reservation.
device_id str
UUID of device occupying the reservation.
id str
ID of the hardware reservation.
deviceId String
UUID of device occupying the reservation.
id String
ID of the hardware reservation.

getHardwareReservation Result

The following output properties are available:

DeviceId string
UUID of device occupying the reservation.
Facility string
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

Id string
ID of the hardware reservation to look up.
Plan string
Plan type for the reservation.
ProjectId string
UUID of project this reservation is scoped to.
Provisionable bool
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
ShortId string
Reservation short ID.
Spare bool
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
SwitchUuid string
Switch short ID, can be used to determine if two devices are connected to the same switch.
DeviceId string
UUID of device occupying the reservation.
Facility string
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

Id string
ID of the hardware reservation to look up.
Plan string
Plan type for the reservation.
ProjectId string
UUID of project this reservation is scoped to.
Provisionable bool
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
ShortId string
Reservation short ID.
Spare bool
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
SwitchUuid string
Switch short ID, can be used to determine if two devices are connected to the same switch.
deviceId String
UUID of device occupying the reservation.
facility String
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

id String
ID of the hardware reservation to look up.
plan String
Plan type for the reservation.
projectId String
UUID of project this reservation is scoped to.
provisionable Boolean
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
shortId String
Reservation short ID.
spare Boolean
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
switchUuid String
Switch short ID, can be used to determine if two devices are connected to the same switch.
deviceId string
UUID of device occupying the reservation.
facility string
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

id string
ID of the hardware reservation to look up.
plan string
Plan type for the reservation.
projectId string
UUID of project this reservation is scoped to.
provisionable boolean
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
shortId string
Reservation short ID.
spare boolean
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
switchUuid string
Switch short ID, can be used to determine if two devices are connected to the same switch.
device_id str
UUID of device occupying the reservation.
facility str
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

id str
ID of the hardware reservation to look up.
plan str
Plan type for the reservation.
project_id str
UUID of project this reservation is scoped to.
provisionable bool
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
short_id str
Reservation short ID.
spare bool
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
switch_uuid str
Switch short ID, can be used to determine if two devices are connected to the same switch.
deviceId String
UUID of device occupying the reservation.
facility String
(Deprecated) Facility for the reservation. Use metro instead; read the facility to metro migration guide

Deprecated: Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices

id String
ID of the hardware reservation to look up.
plan String
Plan type for the reservation.
projectId String
UUID of project this reservation is scoped to.
provisionable Boolean
Flag indicating whether the reserved server is provisionable or not. Spare devices can't be provisioned unless they are activated first.
shortId String
Reservation short ID.
spare Boolean
Flag indicating whether the Hardware Reservation is a spare. Spare Hardware Reservations are used when a Hardware Reservations requires service from Metal Equinix.
switchUuid String
Switch short ID, can be used to determine if two devices are connected to the same switch.

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.
Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix