1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. getHardwareReservation

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

equinix-metal.getHardwareReservation

Explore with Pulumi AI

equinix-metal logo

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

    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.

    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>
    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]
    func GetHardwareReservation(ctx *Context, args *GetHardwareReservationArgs, opts ...InvokeOption) (*GetHardwareReservationResult, error)
    func GetHardwareReservationOutput(ctx *Context, args *GetHardwareReservationOutputArgs, opts ...InvokeOption) GetHardwareReservationResultOutput

    > 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)
    }
    public static CompletableFuture<GetHardwareReservationResult> getHardwareReservation(GetHardwareReservationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: equinix-metal:index/getHardwareReservation:getHardwareReservation
      arguments:
        # arguments dictionary

    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

    Plan type for the reservation

    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

    Plan type for the reservation

    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

    Plan type for the reservation

    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

    Plan type for the reservation

    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

    Plan type for the reservation

    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

    Plan type for the reservation

    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 Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the metal Terraform Provider.

    equinix-metal logo

    This package is deprecated. We recommend using the new Equinix package.

    Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED