getBareMetalServer

Vultr v2.27.1, Sep 30 25

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Viewing docs for Vultr v2.27.1
published on Tuesday, Sep 30, 2025 by dirien

Schema (JSON)

dirien/pulumi-vultr

Example Usage

Get the information for a server by label:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myServer = vultr.getBareMetalServer({
    filters: [{
        name: "label",
        values: ["my-server-label"],
    }],
});

import pulumi
import pulumi_vultr as vultr

my_server = vultr.get_bare_metal_server(filters=[{
    "name": "label",
    "values": ["my-server-label"],
}])

package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.LookupBareMetalServer(ctx, &vultr.LookupBareMetalServerArgs{
			Filters: []vultr.GetBareMetalServerFilter{
				{
					Name: "label",
					Values: []string{
						"my-server-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = Pulumi.Vultr;

return await Deployment.RunAsync(() => 
{
    var myServer = Vultr.GetBareMetalServer.Invoke(new()
    {
        Filters = new[]
        {
            new Vultr.Inputs.GetBareMetalServerFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-server-label",
                },
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.VultrFunctions;
import com.pulumi.vultr.inputs.GetBareMetalServerArgs;
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 myServer = VultrFunctions.getBareMetalServer(GetBareMetalServerArgs.builder()
            .filters(GetBareMetalServerFilterArgs.builder()
                .name("label")
                .values("my-server-label")
                .build())
            .build());

    }
}

variables:
  myServer:
    fn::invoke:
      function: vultr:getBareMetalServer
      arguments:
        filters:
          - name: label
            values:
              - my-server-label

Using getBareMetalServer

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 getBareMetalServer(args: GetBareMetalServerArgs, opts?: InvokeOptions): Promise<GetBareMetalServerResult>
function getBareMetalServerOutput(args: GetBareMetalServerOutputArgs, opts?: InvokeOptions): Output<GetBareMetalServerResult>

def get_bare_metal_server(filters: Optional[Sequence[GetBareMetalServerFilter]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetBareMetalServerResult
def get_bare_metal_server_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBareMetalServerFilterArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetBareMetalServerResult]

func LookupBareMetalServer(ctx *Context, args *LookupBareMetalServerArgs, opts ...InvokeOption) (*LookupBareMetalServerResult, error)
func LookupBareMetalServerOutput(ctx *Context, args *LookupBareMetalServerOutputArgs, opts ...InvokeOption) LookupBareMetalServerResultOutput

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

public static class GetBareMetalServer 
{
    public static Task<GetBareMetalServerResult> InvokeAsync(GetBareMetalServerArgs args, InvokeOptions? opts = null)
    public static Output<GetBareMetalServerResult> Invoke(GetBareMetalServerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBareMetalServerResult> getBareMetalServer(GetBareMetalServerArgs args, InvokeOptions options)
public static Output<GetBareMetalServerResult> getBareMetalServer(GetBareMetalServerArgs args, InvokeOptions options)

fn::invoke:
  function: vultr:index/getBareMetalServer:getBareMetalServer
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<ediri.Vultr.Inputs.GetBareMetalServerFilter>: Query parameters for finding servers.

Filters []GetBareMetalServerFilter: Query parameters for finding servers.

filters List<GetBareMetalServerFilter>: Query parameters for finding servers.

filters GetBareMetalServerFilter[]: Query parameters for finding servers.

filters Sequence[GetBareMetalServerFilter]: Query parameters for finding servers.

filters List<Property Map>: Query parameters for finding servers.