Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vultr
  3. API Docs
  4. BareMetalServer
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

vultr.BareMetalServer

Explore with Pulumi AI

Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

Provides a Vultr bare metal server resource. This can be used to create, read, modify, and delete bare metal servers on your Vultr account.

Example Usage

Create a new bare metal server:

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

const myServer = new vultr.BareMetalServer("myServer", {
    osId: 1743,
    plan: "vbm-4c-32gb",
    region: "ewr",
});
Copy
import pulumi
import ediri_vultr as vultr

my_server = vultr.BareMetalServer("myServer",
    os_id=1743,
    plan="vbm-4c-32gb",
    region="ewr")
Copy
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.NewBareMetalServer(ctx, "myServer", &vultr.BareMetalServerArgs{
			OsId:   pulumi.Int(1743),
			Plan:   pulumi.String("vbm-4c-32gb"),
			Region: pulumi.String("ewr"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myServer = new Vultr.BareMetalServer("myServer", new()
    {
        OsId = 1743,
        Plan = "vbm-4c-32gb",
        Region = "ewr",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.BareMetalServer;
import com.pulumi.vultr.BareMetalServerArgs;
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) {
        var myServer = new BareMetalServer("myServer", BareMetalServerArgs.builder()
            .osId(1743)
            .plan("vbm-4c-32gb")
            .region("ewr")
            .build());

    }
}
Copy
resources:
  myServer:
    type: vultr:BareMetalServer
    properties:
      osId: 1743
      plan: vbm-4c-32gb
      region: ewr
Copy

Create a new bare metal server with options:

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

const myServer = new vultr.BareMetalServer("myServer", {
    activationEmail: false,
    enableIpv6: true,
    hostname: "my-server-hostname",
    label: "my-server-label",
    osId: 1743,
    plan: "vbm-4c-32gb",
    region: "ewr",
    tags: ["my-server-tag"],
    userData: "this is my user data",
});
Copy
import pulumi
import ediri_vultr as vultr

my_server = vultr.BareMetalServer("myServer",
    activation_email=False,
    enable_ipv6=True,
    hostname="my-server-hostname",
    label="my-server-label",
    os_id=1743,
    plan="vbm-4c-32gb",
    region="ewr",
    tags=["my-server-tag"],
    user_data="this is my user data")
Copy
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.NewBareMetalServer(ctx, "myServer", &vultr.BareMetalServerArgs{
			ActivationEmail: pulumi.Bool(false),
			EnableIpv6:      pulumi.Bool(true),
			Hostname:        pulumi.String("my-server-hostname"),
			Label:           pulumi.String("my-server-label"),
			OsId:            pulumi.Int(1743),
			Plan:            pulumi.String("vbm-4c-32gb"),
			Region:          pulumi.String("ewr"),
			Tags: pulumi.StringArray{
				pulumi.String("my-server-tag"),
			},
			UserData: pulumi.String("this is my user data"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myServer = new Vultr.BareMetalServer("myServer", new()
    {
        ActivationEmail = false,
        EnableIpv6 = true,
        Hostname = "my-server-hostname",
        Label = "my-server-label",
        OsId = 1743,
        Plan = "vbm-4c-32gb",
        Region = "ewr",
        Tags = new[]
        {
            "my-server-tag",
        },
        UserData = "this is my user data",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.BareMetalServer;
import com.pulumi.vultr.BareMetalServerArgs;
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) {
        var myServer = new BareMetalServer("myServer", BareMetalServerArgs.builder()
            .activationEmail(false)
            .enableIpv6(true)
            .hostname("my-server-hostname")
            .label("my-server-label")
            .osId(1743)
            .plan("vbm-4c-32gb")
            .region("ewr")
            .tags("my-server-tag")
            .userData("this is my user data")
            .build());

    }
}
Copy
resources:
  myServer:
    type: vultr:BareMetalServer
    properties:
      activationEmail: false
      enableIpv6: true
      hostname: my-server-hostname
      label: my-server-label
      osId: 1743
      plan: vbm-4c-32gb
      region: ewr
      tags:
        - my-server-tag
      userData: this is my user data
Copy

Create BareMetalServer Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BareMetalServer(name: string, args: BareMetalServerArgs, opts?: CustomResourceOptions);
@overload
def BareMetalServer(resource_name: str,
                    args: BareMetalServerArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def BareMetalServer(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    plan: Optional[str] = None,
                    region: Optional[str] = None,
                    image_id: Optional[str] = None,
                    app_id: Optional[int] = None,
                    hostname: Optional[str] = None,
                    activation_email: Optional[bool] = None,
                    label: Optional[str] = None,
                    mdisk_mode: Optional[str] = None,
                    os_id: Optional[int] = None,
                    persistent_pxe: Optional[bool] = None,
                    app_variables: Optional[Mapping[str, str]] = None,
                    enable_ipv6: Optional[bool] = None,
                    reserved_ipv4: Optional[str] = None,
                    script_id: Optional[str] = None,
                    snapshot_id: Optional[str] = None,
                    ssh_key_ids: Optional[Sequence[str]] = None,
                    tags: Optional[Sequence[str]] = None,
                    user_data: Optional[str] = None,
                    user_scheme: Optional[str] = None,
                    vpc2_ids: Optional[Sequence[str]] = None)
func NewBareMetalServer(ctx *Context, name string, args BareMetalServerArgs, opts ...ResourceOption) (*BareMetalServer, error)
public BareMetalServer(string name, BareMetalServerArgs args, CustomResourceOptions? opts = null)
public BareMetalServer(String name, BareMetalServerArgs args)
public BareMetalServer(String name, BareMetalServerArgs args, CustomResourceOptions options)

type: vultr:BareMetalServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BareMetalServerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BareMetalServerArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BareMetalServerArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BareMetalServerArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BareMetalServerArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var bareMetalServerResource = new Vultr.BareMetalServer("bareMetalServerResource", new()
{
    Plan = "string",
    Region = "string",
    ImageId = "string",
    AppId = 0,
    Hostname = "string",
    ActivationEmail = false,
    Label = "string",
    MdiskMode = "string",
    OsId = 0,
    PersistentPxe = false,
    AppVariables = 
    {
        { "string", "string" },
    },
    EnableIpv6 = false,
    ReservedIpv4 = "string",
    ScriptId = "string",
    SnapshotId = "string",
    SshKeyIds = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    UserData = "string",
    UserScheme = "string",
    Vpc2Ids = new[]
    {
        "string",
    },
});
Copy
example, err := vultr.NewBareMetalServer(ctx, "bareMetalServerResource", &vultr.BareMetalServerArgs{
	Plan:            pulumi.String("string"),
	Region:          pulumi.String("string"),
	ImageId:         pulumi.String("string"),
	AppId:           pulumi.Int(0),
	Hostname:        pulumi.String("string"),
	ActivationEmail: pulumi.Bool(false),
	Label:           pulumi.String("string"),
	MdiskMode:       pulumi.String("string"),
	OsId:            pulumi.Int(0),
	PersistentPxe:   pulumi.Bool(false),
	AppVariables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	EnableIpv6:   pulumi.Bool(false),
	ReservedIpv4: pulumi.String("string"),
	ScriptId:     pulumi.String("string"),
	SnapshotId:   pulumi.String("string"),
	SshKeyIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserData:   pulumi.String("string"),
	UserScheme: pulumi.String("string"),
	Vpc2Ids: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var bareMetalServerResource = new BareMetalServer("bareMetalServerResource", BareMetalServerArgs.builder()
    .plan("string")
    .region("string")
    .imageId("string")
    .appId(0)
    .hostname("string")
    .activationEmail(false)
    .label("string")
    .mdiskMode("string")
    .osId(0)
    .persistentPxe(false)
    .appVariables(Map.of("string", "string"))
    .enableIpv6(false)
    .reservedIpv4("string")
    .scriptId("string")
    .snapshotId("string")
    .sshKeyIds("string")
    .tags("string")
    .userData("string")
    .userScheme("string")
    .vpc2Ids("string")
    .build());
Copy
bare_metal_server_resource = vultr.BareMetalServer("bareMetalServerResource",
    plan="string",
    region="string",
    image_id="string",
    app_id=0,
    hostname="string",
    activation_email=False,
    label="string",
    mdisk_mode="string",
    os_id=0,
    persistent_pxe=False,
    app_variables={
        "string": "string",
    },
    enable_ipv6=False,
    reserved_ipv4="string",
    script_id="string",
    snapshot_id="string",
    ssh_key_ids=["string"],
    tags=["string"],
    user_data="string",
    user_scheme="string",
    vpc2_ids=["string"])
Copy
const bareMetalServerResource = new vultr.BareMetalServer("bareMetalServerResource", {
    plan: "string",
    region: "string",
    imageId: "string",
    appId: 0,
    hostname: "string",
    activationEmail: false,
    label: "string",
    mdiskMode: "string",
    osId: 0,
    persistentPxe: false,
    appVariables: {
        string: "string",
    },
    enableIpv6: false,
    reservedIpv4: "string",
    scriptId: "string",
    snapshotId: "string",
    sshKeyIds: ["string"],
    tags: ["string"],
    userData: "string",
    userScheme: "string",
    vpc2Ids: ["string"],
});
Copy
type: vultr:BareMetalServer
properties:
    activationEmail: false
    appId: 0
    appVariables:
        string: string
    enableIpv6: false
    hostname: string
    imageId: string
    label: string
    mdiskMode: string
    osId: 0
    persistentPxe: false
    plan: string
    region: string
    reservedIpv4: string
    scriptId: string
    snapshotId: string
    sshKeyIds:
        - string
    tags:
        - string
    userData: string
    userScheme: string
    vpc2Ids:
        - string
Copy

BareMetalServer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BareMetalServer resource accepts the following input properties:

Plan
This property is required.
Changes to this property will trigger replacement.
string
The ID of the plan that you want the server to subscribe to. See List Plans
Region
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region that the server is to be created in. See List Regions
ActivationEmail bool
Whether an activation email will be sent when the server is ready.
AppId int
The ID of the Vultr application to be installed on the server. See List Applications
AppVariables Changes to this property will trigger replacement. Dictionary<string, string>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
EnableIpv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
Hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
ImageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
Label string
A label for the server.
MdiskMode Changes to this property will trigger replacement. string
OsId int
The ID of the operating system to be installed on the server. See List OS
PersistentPxe Changes to this property will trigger replacement. bool
ReservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
ScriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
SnapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
SshKeyIds Changes to this property will trigger replacement. List<string>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
Tags List<string>
A list of tags to apply to the servier.
UserData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
UserScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
Vpc2Ids List<string>
A list of VPC 2.0 IDs to be attached to the server.
Plan
This property is required.
Changes to this property will trigger replacement.
string
The ID of the plan that you want the server to subscribe to. See List Plans
Region
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region that the server is to be created in. See List Regions
ActivationEmail bool
Whether an activation email will be sent when the server is ready.
AppId int
The ID of the Vultr application to be installed on the server. See List Applications
AppVariables Changes to this property will trigger replacement. map[string]string
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
EnableIpv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
Hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
ImageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
Label string
A label for the server.
MdiskMode Changes to this property will trigger replacement. string
OsId int
The ID of the operating system to be installed on the server. See List OS
PersistentPxe Changes to this property will trigger replacement. bool
ReservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
ScriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
SnapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
SshKeyIds Changes to this property will trigger replacement. []string
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
Tags []string
A list of tags to apply to the servier.
UserData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
UserScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
Vpc2Ids []string
A list of VPC 2.0 IDs to be attached to the server.
plan
This property is required.
Changes to this property will trigger replacement.
String
The ID of the plan that you want the server to subscribe to. See List Plans
region
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region that the server is to be created in. See List Regions
activationEmail Boolean
Whether an activation email will be sent when the server is ready.
appId Integer
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. Map<String,String>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
enableIpv6 Changes to this property will trigger replacement. Boolean
Whether the server has IPv6 networking activated.
hostname Changes to this property will trigger replacement. String
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. String
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label String
A label for the server.
mdiskMode Changes to this property will trigger replacement. String
osId Integer
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. Boolean
reservedIpv4 String
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. String
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. String
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. List<String>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
tags List<String>
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. String
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. String
The scheme used for the default user. Possible values are root or limited (linux servers only).
vpc2Ids List<String>
A list of VPC 2.0 IDs to be attached to the server.
plan
This property is required.
Changes to this property will trigger replacement.
string
The ID of the plan that you want the server to subscribe to. See List Plans
region
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region that the server is to be created in. See List Regions
activationEmail boolean
Whether an activation email will be sent when the server is ready.
appId number
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. {[key: string]: string}
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
enableIpv6 Changes to this property will trigger replacement. boolean
Whether the server has IPv6 networking activated.
hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label string
A label for the server.
mdiskMode Changes to this property will trigger replacement. string
osId number
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. boolean
reservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. string[]
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
tags string[]
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
vpc2Ids string[]
A list of VPC 2.0 IDs to be attached to the server.
plan
This property is required.
Changes to this property will trigger replacement.
str
The ID of the plan that you want the server to subscribe to. See List Plans
region
This property is required.
Changes to this property will trigger replacement.
str
The ID of the region that the server is to be created in. See List Regions
activation_email bool
Whether an activation email will be sent when the server is ready.
app_id int
The ID of the Vultr application to be installed on the server. See List Applications
app_variables Changes to this property will trigger replacement. Mapping[str, str]
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
enable_ipv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
hostname Changes to this property will trigger replacement. str
The hostname to assign to the server.
image_id Changes to this property will trigger replacement. str
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label str
A label for the server.
mdisk_mode Changes to this property will trigger replacement. str
os_id int
The ID of the operating system to be installed on the server. See List OS
persistent_pxe Changes to this property will trigger replacement. bool
reserved_ipv4 str
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
script_id Changes to this property will trigger replacement. str
The ID of the startup script you want added to the server.
snapshot_id Changes to this property will trigger replacement. str
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
ssh_key_ids Changes to this property will trigger replacement. Sequence[str]
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
tags Sequence[str]
A list of tags to apply to the servier.
user_data Changes to this property will trigger replacement. str
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
user_scheme Changes to this property will trigger replacement. str
The scheme used for the default user. Possible values are root or limited (linux servers only).
vpc2_ids Sequence[str]
A list of VPC 2.0 IDs to be attached to the server.
plan
This property is required.
Changes to this property will trigger replacement.
String
The ID of the plan that you want the server to subscribe to. See List Plans
region
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region that the server is to be created in. See List Regions
activationEmail Boolean
Whether an activation email will be sent when the server is ready.
appId Number
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. Map<String>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
enableIpv6 Changes to this property will trigger replacement. Boolean
Whether the server has IPv6 networking activated.
hostname Changes to this property will trigger replacement. String
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. String
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label String
A label for the server.
mdiskMode Changes to this property will trigger replacement. String
osId Number
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. Boolean
reservedIpv4 String
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. String
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. String
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. List<String>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
tags List<String>
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. String
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. String
The scheme used for the default user. Possible values are root or limited (linux servers only).
vpc2Ids List<String>
A list of VPC 2.0 IDs to be attached to the server.

Outputs

All input properties are implicitly available as output properties. Additionally, the BareMetalServer resource produces the following output properties:

CpuCount int
The number of CPUs available on the server.
DateCreated string
The date the server was added to your Vultr account.
DefaultPassword string
The server's default password.
Disk string
The description of the disk(s) on the server.
GatewayV4 string
The server's IPv4 gateway.
Id string
The provider-assigned unique ID for this managed resource.
MacAddress int
The MAC address associated with the server.
MainIp string
The server's main IP address.
NetmaskV4 string
The server's IPv4 netmask.
Os string
The string description of the operating system installed on the server.
Ram string
The amount of memory available on the server in MB.
Status string
The status of the server's subscription.
V6MainIp string
The main IPv6 network address.
V6Network string
The IPv6 subnet.
V6NetworkSize int
The IPv6 network size in bits.
CpuCount int
The number of CPUs available on the server.
DateCreated string
The date the server was added to your Vultr account.
DefaultPassword string
The server's default password.
Disk string
The description of the disk(s) on the server.
GatewayV4 string
The server's IPv4 gateway.
Id string
The provider-assigned unique ID for this managed resource.
MacAddress int
The MAC address associated with the server.
MainIp string
The server's main IP address.
NetmaskV4 string
The server's IPv4 netmask.
Os string
The string description of the operating system installed on the server.
Ram string
The amount of memory available on the server in MB.
Status string
The status of the server's subscription.
V6MainIp string
The main IPv6 network address.
V6Network string
The IPv6 subnet.
V6NetworkSize int
The IPv6 network size in bits.
cpuCount Integer
The number of CPUs available on the server.
dateCreated String
The date the server was added to your Vultr account.
defaultPassword String
The server's default password.
disk String
The description of the disk(s) on the server.
gatewayV4 String
The server's IPv4 gateway.
id String
The provider-assigned unique ID for this managed resource.
macAddress Integer
The MAC address associated with the server.
mainIp String
The server's main IP address.
netmaskV4 String
The server's IPv4 netmask.
os String
The string description of the operating system installed on the server.
ram String
The amount of memory available on the server in MB.
status String
The status of the server's subscription.
v6MainIp String
The main IPv6 network address.
v6Network String
The IPv6 subnet.
v6NetworkSize Integer
The IPv6 network size in bits.
cpuCount number
The number of CPUs available on the server.
dateCreated string
The date the server was added to your Vultr account.
defaultPassword string
The server's default password.
disk string
The description of the disk(s) on the server.
gatewayV4 string
The server's IPv4 gateway.
id string
The provider-assigned unique ID for this managed resource.
macAddress number
The MAC address associated with the server.
mainIp string
The server's main IP address.
netmaskV4 string
The server's IPv4 netmask.
os string
The string description of the operating system installed on the server.
ram string
The amount of memory available on the server in MB.
status string
The status of the server's subscription.
v6MainIp string
The main IPv6 network address.
v6Network string
The IPv6 subnet.
v6NetworkSize number
The IPv6 network size in bits.
cpu_count int
The number of CPUs available on the server.
date_created str
The date the server was added to your Vultr account.
default_password str
The server's default password.
disk str
The description of the disk(s) on the server.
gateway_v4 str
The server's IPv4 gateway.
id str
The provider-assigned unique ID for this managed resource.
mac_address int
The MAC address associated with the server.
main_ip str
The server's main IP address.
netmask_v4 str
The server's IPv4 netmask.
os str
The string description of the operating system installed on the server.
ram str
The amount of memory available on the server in MB.
status str
The status of the server's subscription.
v6_main_ip str
The main IPv6 network address.
v6_network str
The IPv6 subnet.
v6_network_size int
The IPv6 network size in bits.
cpuCount Number
The number of CPUs available on the server.
dateCreated String
The date the server was added to your Vultr account.
defaultPassword String
The server's default password.
disk String
The description of the disk(s) on the server.
gatewayV4 String
The server's IPv4 gateway.
id String
The provider-assigned unique ID for this managed resource.
macAddress Number
The MAC address associated with the server.
mainIp String
The server's main IP address.
netmaskV4 String
The server's IPv4 netmask.
os String
The string description of the operating system installed on the server.
ram String
The amount of memory available on the server in MB.
status String
The status of the server's subscription.
v6MainIp String
The main IPv6 network address.
v6Network String
The IPv6 subnet.
v6NetworkSize Number
The IPv6 network size in bits.

Look up Existing BareMetalServer Resource

Get an existing BareMetalServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BareMetalServerState, opts?: CustomResourceOptions): BareMetalServer
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_email: Optional[bool] = None,
        app_id: Optional[int] = None,
        app_variables: Optional[Mapping[str, str]] = None,
        cpu_count: Optional[int] = None,
        date_created: Optional[str] = None,
        default_password: Optional[str] = None,
        disk: Optional[str] = None,
        enable_ipv6: Optional[bool] = None,
        gateway_v4: Optional[str] = None,
        hostname: Optional[str] = None,
        image_id: Optional[str] = None,
        label: Optional[str] = None,
        mac_address: Optional[int] = None,
        main_ip: Optional[str] = None,
        mdisk_mode: Optional[str] = None,
        netmask_v4: Optional[str] = None,
        os: Optional[str] = None,
        os_id: Optional[int] = None,
        persistent_pxe: Optional[bool] = None,
        plan: Optional[str] = None,
        ram: Optional[str] = None,
        region: Optional[str] = None,
        reserved_ipv4: Optional[str] = None,
        script_id: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        ssh_key_ids: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        user_data: Optional[str] = None,
        user_scheme: Optional[str] = None,
        v6_main_ip: Optional[str] = None,
        v6_network: Optional[str] = None,
        v6_network_size: Optional[int] = None,
        vpc2_ids: Optional[Sequence[str]] = None) -> BareMetalServer
func GetBareMetalServer(ctx *Context, name string, id IDInput, state *BareMetalServerState, opts ...ResourceOption) (*BareMetalServer, error)
public static BareMetalServer Get(string name, Input<string> id, BareMetalServerState? state, CustomResourceOptions? opts = null)
public static BareMetalServer get(String name, Output<String> id, BareMetalServerState state, CustomResourceOptions options)
resources:  _:    type: vultr:BareMetalServer    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActivationEmail bool
Whether an activation email will be sent when the server is ready.
AppId int
The ID of the Vultr application to be installed on the server. See List Applications
AppVariables Changes to this property will trigger replacement. Dictionary<string, string>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
CpuCount int
The number of CPUs available on the server.
DateCreated string
The date the server was added to your Vultr account.
DefaultPassword string
The server's default password.
Disk string
The description of the disk(s) on the server.
EnableIpv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
GatewayV4 string
The server's IPv4 gateway.
Hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
ImageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
Label string
A label for the server.
MacAddress int
The MAC address associated with the server.
MainIp string
The server's main IP address.
MdiskMode Changes to this property will trigger replacement. string
NetmaskV4 string
The server's IPv4 netmask.
Os string
The string description of the operating system installed on the server.
OsId int
The ID of the operating system to be installed on the server. See List OS
PersistentPxe Changes to this property will trigger replacement. bool
Plan Changes to this property will trigger replacement. string
The ID of the plan that you want the server to subscribe to. See List Plans
Ram string
The amount of memory available on the server in MB.
Region Changes to this property will trigger replacement. string
The ID of the region that the server is to be created in. See List Regions
ReservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
ScriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
SnapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
SshKeyIds Changes to this property will trigger replacement. List<string>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
Status string
The status of the server's subscription.
Tags List<string>
A list of tags to apply to the servier.
UserData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
UserScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
V6MainIp string
The main IPv6 network address.
V6Network string
The IPv6 subnet.
V6NetworkSize int
The IPv6 network size in bits.
Vpc2Ids List<string>
A list of VPC 2.0 IDs to be attached to the server.
ActivationEmail bool
Whether an activation email will be sent when the server is ready.
AppId int
The ID of the Vultr application to be installed on the server. See List Applications
AppVariables Changes to this property will trigger replacement. map[string]string
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
CpuCount int
The number of CPUs available on the server.
DateCreated string
The date the server was added to your Vultr account.
DefaultPassword string
The server's default password.
Disk string
The description of the disk(s) on the server.
EnableIpv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
GatewayV4 string
The server's IPv4 gateway.
Hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
ImageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
Label string
A label for the server.
MacAddress int
The MAC address associated with the server.
MainIp string
The server's main IP address.
MdiskMode Changes to this property will trigger replacement. string
NetmaskV4 string
The server's IPv4 netmask.
Os string
The string description of the operating system installed on the server.
OsId int
The ID of the operating system to be installed on the server. See List OS
PersistentPxe Changes to this property will trigger replacement. bool
Plan Changes to this property will trigger replacement. string
The ID of the plan that you want the server to subscribe to. See List Plans
Ram string
The amount of memory available on the server in MB.
Region Changes to this property will trigger replacement. string
The ID of the region that the server is to be created in. See List Regions
ReservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
ScriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
SnapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
SshKeyIds Changes to this property will trigger replacement. []string
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
Status string
The status of the server's subscription.
Tags []string
A list of tags to apply to the servier.
UserData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
UserScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
V6MainIp string
The main IPv6 network address.
V6Network string
The IPv6 subnet.
V6NetworkSize int
The IPv6 network size in bits.
Vpc2Ids []string
A list of VPC 2.0 IDs to be attached to the server.
activationEmail Boolean
Whether an activation email will be sent when the server is ready.
appId Integer
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. Map<String,String>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
cpuCount Integer
The number of CPUs available on the server.
dateCreated String
The date the server was added to your Vultr account.
defaultPassword String
The server's default password.
disk String
The description of the disk(s) on the server.
enableIpv6 Changes to this property will trigger replacement. Boolean
Whether the server has IPv6 networking activated.
gatewayV4 String
The server's IPv4 gateway.
hostname Changes to this property will trigger replacement. String
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. String
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label String
A label for the server.
macAddress Integer
The MAC address associated with the server.
mainIp String
The server's main IP address.
mdiskMode Changes to this property will trigger replacement. String
netmaskV4 String
The server's IPv4 netmask.
os String
The string description of the operating system installed on the server.
osId Integer
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. Boolean
plan Changes to this property will trigger replacement. String
The ID of the plan that you want the server to subscribe to. See List Plans
ram String
The amount of memory available on the server in MB.
region Changes to this property will trigger replacement. String
The ID of the region that the server is to be created in. See List Regions
reservedIpv4 String
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. String
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. String
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. List<String>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
status String
The status of the server's subscription.
tags List<String>
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. String
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. String
The scheme used for the default user. Possible values are root or limited (linux servers only).
v6MainIp String
The main IPv6 network address.
v6Network String
The IPv6 subnet.
v6NetworkSize Integer
The IPv6 network size in bits.
vpc2Ids List<String>
A list of VPC 2.0 IDs to be attached to the server.
activationEmail boolean
Whether an activation email will be sent when the server is ready.
appId number
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. {[key: string]: string}
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
cpuCount number
The number of CPUs available on the server.
dateCreated string
The date the server was added to your Vultr account.
defaultPassword string
The server's default password.
disk string
The description of the disk(s) on the server.
enableIpv6 Changes to this property will trigger replacement. boolean
Whether the server has IPv6 networking activated.
gatewayV4 string
The server's IPv4 gateway.
hostname Changes to this property will trigger replacement. string
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. string
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label string
A label for the server.
macAddress number
The MAC address associated with the server.
mainIp string
The server's main IP address.
mdiskMode Changes to this property will trigger replacement. string
netmaskV4 string
The server's IPv4 netmask.
os string
The string description of the operating system installed on the server.
osId number
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. boolean
plan Changes to this property will trigger replacement. string
The ID of the plan that you want the server to subscribe to. See List Plans
ram string
The amount of memory available on the server in MB.
region Changes to this property will trigger replacement. string
The ID of the region that the server is to be created in. See List Regions
reservedIpv4 string
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. string
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. string
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. string[]
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
status string
The status of the server's subscription.
tags string[]
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. string
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. string
The scheme used for the default user. Possible values are root or limited (linux servers only).
v6MainIp string
The main IPv6 network address.
v6Network string
The IPv6 subnet.
v6NetworkSize number
The IPv6 network size in bits.
vpc2Ids string[]
A list of VPC 2.0 IDs to be attached to the server.
activation_email bool
Whether an activation email will be sent when the server is ready.
app_id int
The ID of the Vultr application to be installed on the server. See List Applications
app_variables Changes to this property will trigger replacement. Mapping[str, str]
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
cpu_count int
The number of CPUs available on the server.
date_created str
The date the server was added to your Vultr account.
default_password str
The server's default password.
disk str
The description of the disk(s) on the server.
enable_ipv6 Changes to this property will trigger replacement. bool
Whether the server has IPv6 networking activated.
gateway_v4 str
The server's IPv4 gateway.
hostname Changes to this property will trigger replacement. str
The hostname to assign to the server.
image_id Changes to this property will trigger replacement. str
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label str
A label for the server.
mac_address int
The MAC address associated with the server.
main_ip str
The server's main IP address.
mdisk_mode Changes to this property will trigger replacement. str
netmask_v4 str
The server's IPv4 netmask.
os str
The string description of the operating system installed on the server.
os_id int
The ID of the operating system to be installed on the server. See List OS
persistent_pxe Changes to this property will trigger replacement. bool
plan Changes to this property will trigger replacement. str
The ID of the plan that you want the server to subscribe to. See List Plans
ram str
The amount of memory available on the server in MB.
region Changes to this property will trigger replacement. str
The ID of the region that the server is to be created in. See List Regions
reserved_ipv4 str
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
script_id Changes to this property will trigger replacement. str
The ID of the startup script you want added to the server.
snapshot_id Changes to this property will trigger replacement. str
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
ssh_key_ids Changes to this property will trigger replacement. Sequence[str]
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
status str
The status of the server's subscription.
tags Sequence[str]
A list of tags to apply to the servier.
user_data Changes to this property will trigger replacement. str
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
user_scheme Changes to this property will trigger replacement. str
The scheme used for the default user. Possible values are root or limited (linux servers only).
v6_main_ip str
The main IPv6 network address.
v6_network str
The IPv6 subnet.
v6_network_size int
The IPv6 network size in bits.
vpc2_ids Sequence[str]
A list of VPC 2.0 IDs to be attached to the server.
activationEmail Boolean
Whether an activation email will be sent when the server is ready.
appId Number
The ID of the Vultr application to be installed on the server. See List Applications
appVariables Changes to this property will trigger replacement. Map<String>
A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
cpuCount Number
The number of CPUs available on the server.
dateCreated String
The date the server was added to your Vultr account.
defaultPassword String
The server's default password.
disk String
The description of the disk(s) on the server.
enableIpv6 Changes to this property will trigger replacement. Boolean
Whether the server has IPv6 networking activated.
gatewayV4 String
The server's IPv4 gateway.
hostname Changes to this property will trigger replacement. String
The hostname to assign to the server.
imageId Changes to this property will trigger replacement. String
The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
label String
A label for the server.
macAddress Number
The MAC address associated with the server.
mainIp String
The server's main IP address.
mdiskMode Changes to this property will trigger replacement. String
netmaskV4 String
The server's IPv4 netmask.
os String
The string description of the operating system installed on the server.
osId Number
The ID of the operating system to be installed on the server. See List OS
persistentPxe Changes to this property will trigger replacement. Boolean
plan Changes to this property will trigger replacement. String
The ID of the plan that you want the server to subscribe to. See List Plans
ram String
The amount of memory available on the server in MB.
region Changes to this property will trigger replacement. String
The ID of the region that the server is to be created in. See List Regions
reservedIpv4 String
The ID of the floating IP to use as the main IP of this server. See Reserved IPs
scriptId Changes to this property will trigger replacement. String
The ID of the startup script you want added to the server.
snapshotId Changes to this property will trigger replacement. String
The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
sshKeyIds Changes to this property will trigger replacement. List<String>
A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
status String
The status of the server's subscription.
tags List<String>
A list of tags to apply to the servier.
userData Changes to this property will trigger replacement. String
Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
userScheme Changes to this property will trigger replacement. String
The scheme used for the default user. Possible values are root or limited (linux servers only).
v6MainIp String
The main IPv6 network address.
v6Network String
The IPv6 subnet.
v6NetworkSize Number
The IPv6 network size in bits.
vpc2Ids List<String>
A list of VPC 2.0 IDs to be attached to the server.

Import

Bare Metal Servers can be imported using the server ID, e.g.

$ pulumi import vultr:index/bareMetalServer:BareMetalServer my_server b6a859c5-b299-49dd-8888-b1abbc517d08
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
vultr dirien/pulumi-vultr
License
Apache-2.0
Notes
This Pulumi package is based on the vultr Terraform Provider.
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr