equinix.metal.Device
Explore with Pulumi AI
Provides an Equinix Metal device resource. This can be used to create, modify, and delete devices.
NOTE: All arguments including the
root_password
anduser_data
will be stored in the raw state as plain-text. Read more about sensitive data in state.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Equinix = Pulumi.Equinix;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var projectId = config.Require("projectId");
var web = new Equinix.Metal.Device("web", new()
{
Hostname = "webserver1",
Plan = "c3.small.x86",
OperatingSystem = "ubuntu_20_04",
Metro = "sv",
BillingCycle = "hourly",
ProjectId = projectId,
});
return new Dictionary<string, object?>
{
["webPublicIp"] = web.AccessPublicIpv4.Apply(accessPublicIpv4 => $"http://{accessPublicIpv4}"),
};
});
package main
import (
"fmt"
"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
projectId := cfg.Require("projectId")
web, err := metal.NewDevice(ctx, "web", &metal.DeviceArgs{
Hostname: pulumi.String("webserver1"),
Plan: pulumi.String("c3.small.x86"),
OperatingSystem: pulumi.String("ubuntu_20_04"),
Metro: pulumi.String("sv"),
BillingCycle: pulumi.String("hourly"),
ProjectId: pulumi.String(projectId),
})
if err != nil {
return err
}
ctx.Export("webPublicIp", web.AccessPublicIpv4.ApplyT(func(accessPublicIpv4 string) (string, error) {
return fmt.Sprintf("http://%v", accessPublicIpv4), nil
}).(pulumi.StringOutput))
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.equinix.pulumi.metal.Device;
import com.equinix.pulumi.metal.DeviceArgs;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var projectId = config.get("projectId").get();
var web = new Device("web", DeviceArgs.builder()
.hostname("webserver1")
.plan("c3.small.x86")
.operatingSystem("ubuntu_20_04")
.metro("sv")
.billingCycle("hourly")
.projectId(projectId)
.build());
ctx.export("webPublicIp", web.accessPublicIpv4().applyValue(accessPublicIpv4 -> String.format("http://%s", accessPublicIpv4)));
}
}
import pulumi
import pulumi_equinix as equinix
config = pulumi.Config()
project_id = config.require("projectId")
web = equinix.metal.Device("web",
hostname="webserver1",
plan="c3.small.x86",
operating_system="ubuntu_20_04",
metro="sv",
billing_cycle="hourly",
project_id=project_id)
pulumi.export("webPublicIp", web.access_public_ipv4.apply(lambda access_public_ipv4: f"http://{access_public_ipv4}"))
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";
const config = new pulumi.Config();
const projectId = config.require("projectId");
const web = new equinix.metal.Device("web", {
hostname: "webserver1",
plan: "c3.small.x86",
operatingSystem: "ubuntu_20_04",
metro: "sv",
billingCycle: "hourly",
projectId: projectId,
});
export const webPublicIp = pulumi.interpolate`http://${web.accessPublicIpv4}`;
config:
projectId:
type: string
resources:
web:
type: equinix:metal:Device
properties:
hostname: webserver1
plan: c3.small.x86
operatingSystem: ubuntu_20_04
metro: sv
billingCycle: hourly
projectId: ${projectId}
outputs:
webPublicIp: http://${web.accessPublicIpv4}
Create Device Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);
@overload
def Device(resource_name: str,
args: DeviceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Device(resource_name: str,
opts: Optional[ResourceOptions] = None,
operating_system: Optional[Union[str, OperatingSystem]] = None,
project_id: Optional[str] = None,
plan: Optional[Union[str, Plan]] = None,
metro: Optional[str] = None,
billing_cycle: Optional[Union[str, BillingCycle]] = None,
facilities: Optional[Sequence[Union[str, Facility]]] = None,
force_detach_volumes: Optional[bool] = None,
hardware_reservation_id: Optional[str] = None,
hostname: Optional[str] = None,
ip_addresses: Optional[Sequence[DeviceIpAddressArgs]] = None,
ipxe_script_url: Optional[str] = None,
locked: Optional[bool] = None,
always_pxe: Optional[bool] = None,
custom_data: Optional[str] = None,
description: Optional[str] = None,
behavior: Optional[DeviceBehaviorArgs] = None,
project_ssh_key_ids: Optional[Sequence[str]] = None,
reinstall: Optional[DeviceReinstallArgs] = None,
storage: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
termination_time: Optional[str] = None,
user_data: Optional[str] = None,
user_ssh_key_ids: Optional[Sequence[str]] = None,
wait_for_reservation_deprovision: Optional[bool] = None)
func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)
public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)
public Device(String name, DeviceArgs args)
public Device(String name, DeviceArgs args, CustomResourceOptions options)
type: equinix:metal:Device
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DeviceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DeviceArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeviceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeviceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeviceArgs
- 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 deviceResource = new Equinix.Metal.Device("deviceResource", new()
{
OperatingSystem = "string",
ProjectId = "string",
Plan = "string",
Metro = "string",
BillingCycle = "string",
ForceDetachVolumes = false,
HardwareReservationId = "string",
Hostname = "string",
IpAddresses = new[]
{
new Equinix.Metal.Inputs.DeviceIpAddressArgs
{
Type = "string",
Cidr = 0,
ReservationIds = new[]
{
"string",
},
},
},
IpxeScriptUrl = "string",
Locked = false,
AlwaysPxe = false,
CustomData = "string",
Description = "string",
Behavior = new Equinix.Metal.Inputs.DeviceBehaviorArgs
{
AllowChanges = new[]
{
"string",
},
},
ProjectSshKeyIds = new[]
{
"string",
},
Reinstall = new Equinix.Metal.Inputs.DeviceReinstallArgs
{
DeprovisionFast = false,
Enabled = false,
PreserveData = false,
},
Storage = "string",
Tags = new[]
{
"string",
},
TerminationTime = "string",
UserData = "string",
UserSshKeyIds = new[]
{
"string",
},
WaitForReservationDeprovision = false,
});
example, err := metal.NewDevice(ctx, "deviceResource", &metal.DeviceArgs{
OperatingSystem: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Plan: pulumi.String("string"),
Metro: pulumi.String("string"),
BillingCycle: pulumi.String("string"),
ForceDetachVolumes: pulumi.Bool(false),
HardwareReservationId: pulumi.String("string"),
Hostname: pulumi.String("string"),
IpAddresses: metal.DeviceIpAddressArray{
&metal.DeviceIpAddressArgs{
Type: pulumi.String("string"),
Cidr: pulumi.Int(0),
ReservationIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IpxeScriptUrl: pulumi.String("string"),
Locked: pulumi.Bool(false),
AlwaysPxe: pulumi.Bool(false),
CustomData: pulumi.String("string"),
Description: pulumi.String("string"),
Behavior: &metal.DeviceBehaviorArgs{
AllowChanges: pulumi.StringArray{
pulumi.String("string"),
},
},
ProjectSshKeyIds: pulumi.StringArray{
pulumi.String("string"),
},
Reinstall: &metal.DeviceReinstallArgs{
DeprovisionFast: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
PreserveData: pulumi.Bool(false),
},
Storage: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TerminationTime: pulumi.String("string"),
UserData: pulumi.String("string"),
UserSshKeyIds: pulumi.StringArray{
pulumi.String("string"),
},
WaitForReservationDeprovision: pulumi.Bool(false),
})
var deviceResource = new Device("deviceResource", DeviceArgs.builder()
.operatingSystem("string")
.projectId("string")
.plan("string")
.metro("string")
.billingCycle("string")
.forceDetachVolumes(false)
.hardwareReservationId("string")
.hostname("string")
.ipAddresses(DeviceIpAddressArgs.builder()
.type("string")
.cidr(0)
.reservationIds("string")
.build())
.ipxeScriptUrl("string")
.locked(false)
.alwaysPxe(false)
.customData("string")
.description("string")
.behavior(DeviceBehaviorArgs.builder()
.allowChanges("string")
.build())
.projectSshKeyIds("string")
.reinstall(DeviceReinstallArgs.builder()
.deprovisionFast(false)
.enabled(false)
.preserveData(false)
.build())
.storage("string")
.tags("string")
.terminationTime("string")
.userData("string")
.userSshKeyIds("string")
.waitForReservationDeprovision(false)
.build());
device_resource = equinix.metal.Device("deviceResource",
operating_system="string",
project_id="string",
plan="string",
metro="string",
billing_cycle="string",
force_detach_volumes=False,
hardware_reservation_id="string",
hostname="string",
ip_addresses=[equinix.metal.DeviceIpAddressArgs(
type="string",
cidr=0,
reservation_ids=["string"],
)],
ipxe_script_url="string",
locked=False,
always_pxe=False,
custom_data="string",
description="string",
behavior=equinix.metal.DeviceBehaviorArgs(
allow_changes=["string"],
),
project_ssh_key_ids=["string"],
reinstall=equinix.metal.DeviceReinstallArgs(
deprovision_fast=False,
enabled=False,
preserve_data=False,
),
storage="string",
tags=["string"],
termination_time="string",
user_data="string",
user_ssh_key_ids=["string"],
wait_for_reservation_deprovision=False)
const deviceResource = new equinix.metal.Device("deviceResource", {
operatingSystem: "string",
projectId: "string",
plan: "string",
metro: "string",
billingCycle: "string",
forceDetachVolumes: false,
hardwareReservationId: "string",
hostname: "string",
ipAddresses: [{
type: "string",
cidr: 0,
reservationIds: ["string"],
}],
ipxeScriptUrl: "string",
locked: false,
alwaysPxe: false,
customData: "string",
description: "string",
behavior: {
allowChanges: ["string"],
},
projectSshKeyIds: ["string"],
reinstall: {
deprovisionFast: false,
enabled: false,
preserveData: false,
},
storage: "string",
tags: ["string"],
terminationTime: "string",
userData: "string",
userSshKeyIds: ["string"],
waitForReservationDeprovision: false,
});
type: equinix:metal:Device
properties:
alwaysPxe: false
behavior:
allowChanges:
- string
billingCycle: string
customData: string
description: string
forceDetachVolumes: false
hardwareReservationId: string
hostname: string
ipAddresses:
- cidr: 0
reservationIds:
- string
type: string
ipxeScriptUrl: string
locked: false
metro: string
operatingSystem: string
plan: string
projectId: string
projectSshKeyIds:
- string
reinstall:
deprovisionFast: false
enabled: false
preserveData: false
storage: string
tags:
- string
terminationTime: string
userData: string
userSshKeyIds:
- string
waitForReservationDeprovision: false
Device Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Device resource accepts the following input properties:
- Operating
System string | Pulumi.Equinix. Metal. Operating System - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- Plan
string | Pulumi.
Equinix. Metal. Plan - The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- Project
Id string - The ID of the project in which to create the device
- Always
Pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - Behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- Billing
Cycle string | Pulumi.Equinix. Metal. Billing Cycle - monthly or hourly
- Custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - Description string
- The device description.
- Facilities
List<Union<string, Pulumi.
Equinix. Metal. Facility>> - List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - Force
Detach boolVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- Hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - Hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- Ip
Addresses List<DeviceIp Address> - A list of IP address types for the device. See IP address below for more details.
- Ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- Locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- Metro string
- Metro area for the new device. Conflicts with
facilities
. - Project
Ssh List<string>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- Reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- Storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<string>
- Tags attached to the device.
- Termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - User
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - User
Ssh List<string>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- Wait
For boolReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- Operating
System string | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- Plan string | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- Project
Id string - The ID of the project in which to create the device
- Always
Pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - Behavior
Device
Behavior Args - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- Billing
Cycle string | BillingCycle - monthly or hourly
- Custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - Description string
- The device description.
- Facilities []string
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - Force
Detach boolVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- Hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - Hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- Ip
Addresses []DeviceIp Address Args - A list of IP address types for the device. See IP address below for more details.
- Ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- Locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- Metro string
- Metro area for the new device. Conflicts with
facilities
. - Project
Ssh []stringKey Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- Reinstall
Device
Reinstall Args - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- Storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- []string
- Tags attached to the device.
- Termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - User
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - User
Ssh []stringKey Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- Wait
For boolReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- operating
System String | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan String | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- project
Id String - The ID of the project in which to create the device
- always
Pxe Boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle String | BillingCycle - monthly or hourly
- custom
Data String - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - description String
- The device description.
- facilities List<Either<String,Facility>>
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach BooleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation StringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname String
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses List<DeviceIp Address> - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script StringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked Boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro String
- Metro area for the new device. Conflicts with
facilities
. - project
Ssh List<String>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- storage String
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<String>
- Tags attached to the device.
- termination
Time String - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - user
Data String - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh List<String>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For BooleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- operating
System string | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan string | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- project
Id string - The ID of the project in which to create the device
- always
Pxe boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle string | BillingCycle - monthly or hourly
- custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - description string
- The device description.
- facilities (string | Facility)[]
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach booleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses DeviceIp Address[] - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro string
- Metro area for the new device. Conflicts with
facilities
. - project
Ssh string[]Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- string[]
- Tags attached to the device.
- termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - user
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh string[]Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For booleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- operating_
system str | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan str | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- project_
id str - The ID of the project in which to create the device
- always_
pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior Args - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing_
cycle str | BillingCycle - monthly or hourly
- custom_
data str - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - description str
- The device description.
- facilities Sequence[Union[str, Facility]]
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force_
detach_ boolvolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware_
reservation_ strid - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname str
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip_
addresses Sequence[DeviceIp Address Args] - A list of IP address types for the device. See IP address below for more details.
- ipxe_
script_ strurl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro str
- Metro area for the new device. Conflicts with
facilities
. - project_
ssh_ Sequence[str]key_ ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall Args - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- storage str
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- Sequence[str]
- Tags attached to the device.
- termination_
time str - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - user_
data str - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user_
ssh_ Sequence[str]key_ ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait_
for_ boolreservation_ deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- operating
System String | "alma_8" | "alma_9" | "alpine_3" | "centos_6" | "centos_7" | "centos_8" | "coreos_alpha" | "coreos_ beta" | "coreos_ stable" | "custom_ ipxe" | "debian_10" | "debian_11" | "debian_7" | "debian_8" | "debian_9" | "fedora_31" | "fedora_34" | "flatcar_ alpha" | "flatcar_ beta" | "flatcar_ edge" | "flatcar_ lts" | "flatcar_ stable" | "freebsd_10_3" | "freebsd_10_4" | "freebsd_11_0" | "freebsd_11_1" | "freebsd_11_2" | "freebsd_11_3" | "freebsd_11_4" | "freebsd_12_ testing" | "freebsd_12_1" | "freebsd_13_0" | "freebsd_13_1" | "freebsd_13_ testing" | "hook_ esxi7" | "nixos_17_03" | "nixos_18_03" | "nixos_19_03" | "nixos_20_09" | "nixos_21_11" | "nixos_22_05" | "nixos_22_11" | "nixos_21_05" | "nutanix_ centos" | "nutanix_ lts_5_19_1" | "nutanix_ lts_5_20" | "opensuse_42_3" | "rhel_7" | "rhel_8" | "rhel_9" | "rancher" | "rocky_8" | "rocky_9" | "suse_ sles12_ sp3" | "scientific_6" | "talos_ v1" | "ubuntu_17_10" | "ubuntu_18_04" | "ubuntu_19_04" | "ubuntu_19_10" | "ubuntu_20_04" | "ubuntu_20_04_ legacy" | "ubuntu_20_10" | "ubuntu_22_04" | "vmware_ alloy_ vcf" | "vmware_ esxi_5_5" | "vmware_ esxi_6_0" | "vmware_ esxi_6_5" | "vmware_ esxi_6_7" | "vmware_ esxi_6_7_ vcf" | "vmware_ esxi_7_0" | "vmware_ esxi_7_0U2a" | "vmware_ esxi_7_0_ vcf" | "vmware_ nsx_2_5_0" | "vmware_ nsx_3_0_0" | "virtuozzo_7" | "windows_2012_ r2" | "windows_2016" | "windows_2019" | "windows_2022" - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan String | "a3.large.x86" | "c2.large.arm" | "c2.medium.x86" | "c3.large.arm64" | "c3.medium.x86" | "c3.small.x86" | "f3.large.x86" | "f3.medium.x86" | "g2.large.x86" | "m2.xlarge.x86" | "m3.large.x86" | "m3.small.x86" | "n2.xlarge.x86" | "n3.xlarge.x86" | "s3.xlarge.x86" | "t3.small.x86" | "x2.xlarge.x86" | "x3.xlarge.x86"
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- project
Id String - The ID of the project in which to create the device
- always
Pxe Boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior Property Map
- Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle String | "hourly" | "monthly" - monthly or hourly
- custom
Data String - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - description String
- The device description.
- facilities List<String | "am2" | "am6" | "ma5" | "nrt1" | "pa4" | "sk2" | "me2" | "hk2" | "ty11" | "la4" | "da6" | "da11" | "da3" | "sp4" | "mt1" | "sv16" | "sjc1" | "fra2" | "fr8" | "ny5" | "ny6" | "ny7" | "ch3" | "sl1" | "sy5" | "os3" | "ld7" | "dc10" | "ams1" | "sg4" | "se4" | "sy4" | "at4" | "dfw2" | "tr2" | "dc13" | "he7" | "ewr1" | "sg5" | "sg1" | "md2" | "sv15">
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach BooleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation StringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname String
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses List<Property Map> - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script StringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked Boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro String
- Metro area for the new device. Conflicts with
facilities
. - project
Ssh List<String>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall Property Map
- Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- storage String
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<String>
- Tags attached to the device.
- termination
Time String - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - user
Data String - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh List<String>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For BooleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
Outputs
All input properties are implicitly available as output properties. Additionally, the Device resource produces the following output properties:
- Access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- Access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- Access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- Created string
- The timestamp for when the device was created.
- Deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- Deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - Id string
- The provider-assigned unique ID for this managed resource.
- Network
List<Device
Network> - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- Network
Type string - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- Ports
List<Device
Port> - List of ports assigned to the device. See Ports Attribute below for more details.
- Root
Password string - Root password to the server (disabled after 24 hours).
- Sos
Hostname string - The hostname to use for Serial over SSH access to the device
- Ssh
Key List<string>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- State string
- The status of the device.
- Updated string
- The timestamp for the last time the device was updated.
- Access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- Access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- Access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- Created string
- The timestamp for when the device was created.
- Deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- Deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - Id string
- The provider-assigned unique ID for this managed resource.
- Network
[]Device
Network - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- Network
Type string - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- Ports
[]Device
Port - List of ports assigned to the device. See Ports Attribute below for more details.
- Root
Password string - Root password to the server (disabled after 24 hours).
- Sos
Hostname string - The hostname to use for Serial over SSH access to the device
- Ssh
Key []stringIds - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- State string
- The status of the device.
- Updated string
- The timestamp for the last time the device was updated.
- access
Private StringIpv4 - The ipv4 private IP assigned to the device.
- access
Public StringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public StringIpv6 - The ipv6 maintenance IP assigned to the device.
- created String
- The timestamp for when the device was created.
- deployed
Facility String - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware StringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - id String
- The provider-assigned unique ID for this managed resource.
- network
List<Device
Network> - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type String - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- ports
List<Device
Port> - List of ports assigned to the device. See Ports Attribute below for more details.
- root
Password String - Root password to the server (disabled after 24 hours).
- sos
Hostname String - The hostname to use for Serial over SSH access to the device
- ssh
Key List<String>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state String
- The status of the device.
- updated String
- The timestamp for the last time the device was updated.
- access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- created string
- The timestamp for when the device was created.
- deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - id string
- The provider-assigned unique ID for this managed resource.
- network
Device
Network[] - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type string - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- ports
Device
Port[] - List of ports assigned to the device. See Ports Attribute below for more details.
- root
Password string - Root password to the server (disabled after 24 hours).
- sos
Hostname string - The hostname to use for Serial over SSH access to the device
- ssh
Key string[]Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state string
- The status of the device.
- updated string
- The timestamp for the last time the device was updated.
- access_
private_ stripv4 - The ipv4 private IP assigned to the device.
- access_
public_ stripv4 - The ipv4 maintenance IP assigned to the device.
- access_
public_ stripv6 - The ipv6 maintenance IP assigned to the device.
- created str
- The timestamp for when the device was created.
- deployed_
facility str - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed_
hardware_ strreservation_ id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - id str
- The provider-assigned unique ID for this managed resource.
- network
Sequence[Device
Network] - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network_
type str - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- ports
Sequence[Device
Port] - List of ports assigned to the device. See Ports Attribute below for more details.
- root_
password str - Root password to the server (disabled after 24 hours).
- sos_
hostname str - The hostname to use for Serial over SSH access to the device
- ssh_
key_ Sequence[str]ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state str
- The status of the device.
- updated str
- The timestamp for the last time the device was updated.
- access
Private StringIpv4 - The ipv4 private IP assigned to the device.
- access
Public StringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public StringIpv6 - The ipv6 maintenance IP assigned to the device.
- created String
- The timestamp for when the device was created.
- deployed
Facility String - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware StringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - id String
- The provider-assigned unique ID for this managed resource.
- network List<Property Map>
- The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type String - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- ports List<Property Map>
- List of ports assigned to the device. See Ports Attribute below for more details.
- root
Password String - Root password to the server (disabled after 24 hours).
- sos
Hostname String - The hostname to use for Serial over SSH access to the device
- ssh
Key List<String>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state String
- The status of the device.
- updated String
- The timestamp for the last time the device was updated.
Look up Existing Device Resource
Get an existing Device 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?: DeviceState, opts?: CustomResourceOptions): Device
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_private_ipv4: Optional[str] = None,
access_public_ipv4: Optional[str] = None,
access_public_ipv6: Optional[str] = None,
always_pxe: Optional[bool] = None,
behavior: Optional[DeviceBehaviorArgs] = None,
billing_cycle: Optional[Union[str, BillingCycle]] = None,
created: Optional[str] = None,
custom_data: Optional[str] = None,
deployed_facility: Optional[str] = None,
deployed_hardware_reservation_id: Optional[str] = None,
description: Optional[str] = None,
facilities: Optional[Sequence[Union[str, Facility]]] = None,
force_detach_volumes: Optional[bool] = None,
hardware_reservation_id: Optional[str] = None,
hostname: Optional[str] = None,
ip_addresses: Optional[Sequence[DeviceIpAddressArgs]] = None,
ipxe_script_url: Optional[str] = None,
locked: Optional[bool] = None,
metro: Optional[str] = None,
network: Optional[Sequence[DeviceNetworkArgs]] = None,
network_type: Optional[Union[str, NetworkType]] = None,
operating_system: Optional[Union[str, OperatingSystem]] = None,
plan: Optional[Union[str, Plan]] = None,
ports: Optional[Sequence[DevicePortArgs]] = None,
project_id: Optional[str] = None,
project_ssh_key_ids: Optional[Sequence[str]] = None,
reinstall: Optional[DeviceReinstallArgs] = None,
root_password: Optional[str] = None,
sos_hostname: Optional[str] = None,
ssh_key_ids: Optional[Sequence[str]] = None,
state: Optional[str] = None,
storage: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
termination_time: Optional[str] = None,
updated: Optional[str] = None,
user_data: Optional[str] = None,
user_ssh_key_ids: Optional[Sequence[str]] = None,
wait_for_reservation_deprovision: Optional[bool] = None) -> Device
func GetDevice(ctx *Context, name string, id IDInput, state *DeviceState, opts ...ResourceOption) (*Device, error)
public static Device Get(string name, Input<string> id, DeviceState? state, CustomResourceOptions? opts = null)
public static Device get(String name, Output<String> id, DeviceState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- Access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- Access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- Always
Pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - Behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- Billing
Cycle string | Pulumi.Equinix. Metal. Billing Cycle - monthly or hourly
- Created string
- The timestamp for when the device was created.
- Custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - Deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- Deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - Description string
- The device description.
- Facilities
List<Union<string, Pulumi.
Equinix. Metal. Facility>> - List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - Force
Detach boolVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- Hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - Hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- Ip
Addresses List<DeviceIp Address> - A list of IP address types for the device. See IP address below for more details.
- Ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- Locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- Metro string
- Metro area for the new device. Conflicts with
facilities
. - Network
List<Device
Network> - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- Network
Type string | Pulumi.Equinix. Metal. Network Type - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- Operating
System string | Pulumi.Equinix. Metal. Operating System - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- Plan
string | Pulumi.
Equinix. Metal. Plan - The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- Ports
List<Device
Port> - List of ports assigned to the device. See Ports Attribute below for more details.
- Project
Id string - The ID of the project in which to create the device
- Project
Ssh List<string>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- Reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- Root
Password string - Root password to the server (disabled after 24 hours).
- Sos
Hostname string - The hostname to use for Serial over SSH access to the device
- Ssh
Key List<string>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- State string
- The status of the device.
- Storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<string>
- Tags attached to the device.
- Termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - Updated string
- The timestamp for the last time the device was updated.
- User
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - User
Ssh List<string>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- Wait
For boolReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- Access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- Access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- Access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- Always
Pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - Behavior
Device
Behavior Args - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- Billing
Cycle string | BillingCycle - monthly or hourly
- Created string
- The timestamp for when the device was created.
- Custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - Deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- Deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - Description string
- The device description.
- Facilities []string
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - Force
Detach boolVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- Hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - Hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- Ip
Addresses []DeviceIp Address Args - A list of IP address types for the device. See IP address below for more details.
- Ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- Locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- Metro string
- Metro area for the new device. Conflicts with
facilities
. - Network
[]Device
Network Args - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- Network
Type string | NetworkType - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- Operating
System string | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- Plan string | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- Ports
[]Device
Port Args - List of ports assigned to the device. See Ports Attribute below for more details.
- Project
Id string - The ID of the project in which to create the device
- Project
Ssh []stringKey Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- Reinstall
Device
Reinstall Args - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- Root
Password string - Root password to the server (disabled after 24 hours).
- Sos
Hostname string - The hostname to use for Serial over SSH access to the device
- Ssh
Key []stringIds - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- State string
- The status of the device.
- Storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- []string
- Tags attached to the device.
- Termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - Updated string
- The timestamp for the last time the device was updated.
- User
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - User
Ssh []stringKey Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- Wait
For boolReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- access
Private StringIpv4 - The ipv4 private IP assigned to the device.
- access
Public StringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public StringIpv6 - The ipv6 maintenance IP assigned to the device.
- always
Pxe Boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle String | BillingCycle - monthly or hourly
- created String
- The timestamp for when the device was created.
- custom
Data String - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - deployed
Facility String - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware StringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - description String
- The device description.
- facilities List<Either<String,Facility>>
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach BooleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation StringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname String
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses List<DeviceIp Address> - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script StringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked Boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro String
- Metro area for the new device. Conflicts with
facilities
. - network
List<Device
Network> - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type String | NetworkType - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- operating
System String | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan String | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- ports
List<Device
Port> - List of ports assigned to the device. See Ports Attribute below for more details.
- project
Id String - The ID of the project in which to create the device
- project
Ssh List<String>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- root
Password String - Root password to the server (disabled after 24 hours).
- sos
Hostname String - The hostname to use for Serial over SSH access to the device
- ssh
Key List<String>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state String
- The status of the device.
- storage String
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<String>
- Tags attached to the device.
- termination
Time String - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - updated String
- The timestamp for the last time the device was updated.
- user
Data String - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh List<String>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For BooleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- access
Private stringIpv4 - The ipv4 private IP assigned to the device.
- access
Public stringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public stringIpv6 - The ipv6 maintenance IP assigned to the device.
- always
Pxe boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle string | BillingCycle - monthly or hourly
- created string
- The timestamp for when the device was created.
- custom
Data string - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - deployed
Facility string - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware stringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - description string
- The device description.
- facilities (string | Facility)[]
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach booleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation stringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname string
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses DeviceIp Address[] - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script stringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro string
- Metro area for the new device. Conflicts with
facilities
. - network
Device
Network[] - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type string | NetworkType - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- operating
System string | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan string | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- ports
Device
Port[] - List of ports assigned to the device. See Ports Attribute below for more details.
- project
Id string - The ID of the project in which to create the device
- project
Ssh string[]Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- root
Password string - Root password to the server (disabled after 24 hours).
- sos
Hostname string - The hostname to use for Serial over SSH access to the device
- ssh
Key string[]Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state string
- The status of the device.
- storage string
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- string[]
- Tags attached to the device.
- termination
Time string - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - updated string
- The timestamp for the last time the device was updated.
- user
Data string - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh string[]Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For booleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- access_
private_ stripv4 - The ipv4 private IP assigned to the device.
- access_
public_ stripv4 - The ipv4 maintenance IP assigned to the device.
- access_
public_ stripv6 - The ipv6 maintenance IP assigned to the device.
- always_
pxe bool - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior
Device
Behavior Args - Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing_
cycle str | BillingCycle - monthly or hourly
- created str
- The timestamp for when the device was created.
- custom_
data str - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - deployed_
facility str - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed_
hardware_ strreservation_ id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - description str
- The device description.
- facilities Sequence[Union[str, Facility]]
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force_
detach_ boolvolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware_
reservation_ strid - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname str
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip_
addresses Sequence[DeviceIp Address Args] - A list of IP address types for the device. See IP address below for more details.
- ipxe_
script_ strurl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked bool
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro str
- Metro area for the new device. Conflicts with
facilities
. - network
Sequence[Device
Network Args] - The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network_
type str | NetworkType - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- operating_
system str | OperatingSystem - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan str | Plan
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- ports
Sequence[Device
Port Args] - List of ports assigned to the device. See Ports Attribute below for more details.
- project_
id str - The ID of the project in which to create the device
- project_
ssh_ Sequence[str]key_ ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall
Device
Reinstall Args - Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- root_
password str - Root password to the server (disabled after 24 hours).
- sos_
hostname str - The hostname to use for Serial over SSH access to the device
- ssh_
key_ Sequence[str]ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state str
- The status of the device.
- storage str
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- Sequence[str]
- Tags attached to the device.
- termination_
time str - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - updated str
- The timestamp for the last time the device was updated.
- user_
data str - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user_
ssh_ Sequence[str]key_ ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait_
for_ boolreservation_ deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
- access
Private StringIpv4 - The ipv4 private IP assigned to the device.
- access
Public StringIpv4 - The ipv4 maintenance IP assigned to the device.
- access
Public StringIpv6 - The ipv6 maintenance IP assigned to the device.
- always
Pxe Boolean - If true, a device with OS
custom_ipxe
will continue to boot via iPXE on reboots. - behavior Property Map
- Behavioral overrides that change how the resource handles certain attribute updates. See Behavior below for more details.
- billing
Cycle String | "hourly" | "monthly" - monthly or hourly
- created String
- The timestamp for when the device was created.
- custom
Data String - A string of the desired Custom Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"custom_data"
, the device will be updated in-place instead of recreated. - deployed
Facility String - (Deprecated) The facility where the device is deployed. Use metro instead; read the facility to metro migration guide
- deployed
Hardware StringReservation Id - ID of hardware reservation where this device was deployed.
It is useful when using the
next-available
hardware reservation. - description String
- The device description.
- facilities List<String | "am2" | "am6" | "ma5" | "nrt1" | "pa4" | "sk2" | "me2" | "hk2" | "ty11" | "la4" | "da6" | "da11" | "da3" | "sp4" | "mt1" | "sv16" | "sjc1" | "fra2" | "fr8" | "ny5" | "ny6" | "ny7" | "ch3" | "sl1" | "sy5" | "os3" | "ld7" | "dc10" | "ams1" | "sg4" | "se4" | "sy4" | "at4" | "dfw2" | "tr2" | "dc13" | "he7" | "ewr1" | "sg5" | "sg1" | "md2" | "sv15">
- List of facility codes with deployment preferences. Equinix Metal API will go
through the list and will deploy your device to first facility with free capacity. List items must
be facility codes or
any
(a wildcard). To find the facility code, visit Facilities API docs, set your API auth token in the top of the page and see JSON from the API response. Conflicts withmetro
. Use metro instead; read the facility to metro migration guide - force
Detach BooleanVolumes - Delete device even if it has volumes attached. Only applies for destroy action.
- hardware
Reservation StringId - The UUID of the hardware reservation where you want this
device deployed, or
next-available
if you want to pick your next available reservation automatically. Changing this from a reservation UUID tonext-available
will re-create the device in another reservation. Please be careful when using hardware reservation UUID andnext-available
together for the same pool of reservations. It might happen that the reservation which Equinix Metal API will pick asnext-available
is the reservation which you refer with UUID in another equinix.metal.Device resource. If that happens, and the equinix.metal.Device with the UUID is created later, resource creation will fail because the reservation is already in use (by the resource created withnext-available
). To workaround this, have thenext-available
resource explicitly depend_on the resource with hardware reservation UUID, so that the latter is created first. For more details, see issue #176. - hostname String
- The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration.
- ip
Addresses List<Property Map> - A list of IP address types for the device. See IP address below for more details.
- ipxe
Script StringUrl - URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
- locked Boolean
- Whether the device is locked or unlocked. Locking a device prevents you from deleting or reinstalling the device or performing a firmware update on the device, and it prevents an instance with a termination time set from being reclaimed, even if the termination time was reached
- metro String
- Metro area for the new device. Conflicts with
facilities
. - network List<Property Map>
- The device's private and public IP (v4 and v6) network details. See Network Attribute below for more details.
- network
Type String | "layer3" | "layer2-individual" | "layer2-bonded" | "hybrid" - (Deprecated) Network type of a device, used in Layer 2 networking. Since this attribute is deprecated you should handle Network Type with one of equinix_metal_port, equinix.metal.DeviceNetworkType resources or equinix.metal.Port datasource. See network_types guide for more info.
- operating
System String | "alma_8" | "alma_9" | "alpine_3" | "centos_6" | "centos_7" | "centos_8" | "coreos_alpha" | "coreos_ beta" | "coreos_ stable" | "custom_ ipxe" | "debian_10" | "debian_11" | "debian_7" | "debian_8" | "debian_9" | "fedora_31" | "fedora_34" | "flatcar_ alpha" | "flatcar_ beta" | "flatcar_ edge" | "flatcar_ lts" | "flatcar_ stable" | "freebsd_10_3" | "freebsd_10_4" | "freebsd_11_0" | "freebsd_11_1" | "freebsd_11_2" | "freebsd_11_3" | "freebsd_11_4" | "freebsd_12_ testing" | "freebsd_12_1" | "freebsd_13_0" | "freebsd_13_1" | "freebsd_13_ testing" | "hook_ esxi7" | "nixos_17_03" | "nixos_18_03" | "nixos_19_03" | "nixos_20_09" | "nixos_21_11" | "nixos_22_05" | "nixos_22_11" | "nixos_21_05" | "nutanix_ centos" | "nutanix_ lts_5_19_1" | "nutanix_ lts_5_20" | "opensuse_42_3" | "rhel_7" | "rhel_8" | "rhel_9" | "rancher" | "rocky_8" | "rocky_9" | "suse_ sles12_ sp3" | "scientific_6" | "talos_ v1" | "ubuntu_17_10" | "ubuntu_18_04" | "ubuntu_19_04" | "ubuntu_19_10" | "ubuntu_20_04" | "ubuntu_20_04_ legacy" | "ubuntu_20_10" | "ubuntu_22_04" | "vmware_ alloy_ vcf" | "vmware_ esxi_5_5" | "vmware_ esxi_6_0" | "vmware_ esxi_6_5" | "vmware_ esxi_6_7" | "vmware_ esxi_6_7_ vcf" | "vmware_ esxi_7_0" | "vmware_ esxi_7_0U2a" | "vmware_ esxi_7_0_ vcf" | "vmware_ nsx_2_5_0" | "vmware_ nsx_3_0_0" | "virtuozzo_7" | "windows_2012_ r2" | "windows_2016" | "windows_2019" | "windows_2022" - The operating system slug. To find the slug, or visit Operating Systems API docs, set your API auth token in the top of the page and see JSON from the API response.
- plan String | "a3.large.x86" | "c2.large.arm" | "c2.medium.x86" | "c3.large.arm64" | "c3.medium.x86" | "c3.small.x86" | "f3.large.x86" | "f3.medium.x86" | "g2.large.x86" | "m2.xlarge.x86" | "m3.large.x86" | "m3.small.x86" | "n2.xlarge.x86" | "n3.xlarge.x86" | "s3.xlarge.x86" | "t3.small.x86" | "x2.xlarge.x86" | "x3.xlarge.x86"
- The device plan slug. To find the plan slug, visit the bare-metal server and plan documentation.
- ports List<Property Map>
- List of ports assigned to the device. See Ports Attribute below for more details.
- project
Id String - The ID of the project in which to create the device
- project
Ssh List<String>Key Ids - Array of IDs of the project SSH keys which should be added to the device. If you specify this array, only the listed project SSH keys (and any SSH keys for the users specified in user_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. Project SSH keys can be created with the equinix.metal.ProjectSshKey resource.
- reinstall Property Map
- Whether the device should be reinstalled instead of destroyed when modifying user_data, custom_data, or operating system. See Reinstall below for more details.
- root
Password String - Root password to the server (disabled after 24 hours).
- sos
Hostname String - The hostname to use for Serial over SSH access to the device
- ssh
Key List<String>Ids - List of IDs of SSH keys deployed in the device, can be both user and project SSH keys.
- state String
- The status of the device.
- storage String
- JSON for custom partitioning. Only usable on reserved hardware. More information in in the Custom Partitioning and RAID doc. Please note that the disks.partitions.size attribute must be a string, not an integer. It can be a number string, or size notation string, e.g. "4G" or "8M" (for gigabytes and megabytes).
- List<String>
- Tags attached to the device.
- termination
Time String - Timestamp for device termination. For example
2021-09-03T16:32:00+03:00
. If you don't supply timezone info, timestamp is assumed to be in UTC. - updated String
- The timestamp for the last time the device was updated.
- user
Data String - A string of the desired User Data for the device. By default, changing this attribute will cause the provider to destroy and recreate your device. If
reinstall
is specified orbehavior.allow_changes
includes"user_data"
, the device will be updated in-place instead of recreated. - user
Ssh List<String>Key Ids - Array of IDs of the users whose SSH keys should be added to the device. If you specify this array, only the listed users' SSH keys (and any project SSH keys specified in project_ssh_key_ids) will be added. If no SSH keys are specified (both user_ssh_keys_ids and project_ssh_key_ids are empty lists or omitted), all parent project keys, parent project members keys and organization members keys will be included. User SSH keys can be created with the equinix.metal.SshKey resource.
- wait
For BooleanReservation Deprovision - Only used for devices in reserved hardware. If set, the deletion of this device will block until the hardware reservation is marked provisionable (about 4 minutes in August 2019).
Supporting Types
BillingCycle, BillingCycleArgs
- Hourly
- hourly
- Monthly
- monthly
- Billing
Cycle Hourly - hourly
- Billing
Cycle Monthly - monthly
- Hourly
- hourly
- Monthly
- monthly
- Hourly
- hourly
- Monthly
- monthly
- HOURLY
- hourly
- MONTHLY
- monthly
- "hourly"
- hourly
- "monthly"
- monthly
DeviceBehavior, DeviceBehaviorArgs
- Allow
Changes List<string> - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
- Allow
Changes []string - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
- allow
Changes List<String> - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
- allow
Changes string[] - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
- allow_
changes Sequence[str] - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
- allow
Changes List<String> - List of attributes that are allowed to change without recreating the instance. Supported attributes:
custom_data
,user_data
"
DeviceIpAddress, DeviceIpAddressArgs
- Type string
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - Cidr int
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- Reservation
Ids List<string> List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
- Type string
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - Cidr int
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- Reservation
Ids []string List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
- type String
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - cidr Integer
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- reservation
Ids List<String> List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
- type string
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - cidr number
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- reservation
Ids string[] List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
- type str
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - cidr int
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- reservation_
ids Sequence[str] List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
- type String
- One of
private_ipv4
,public_ipv4
,public_ipv6
. - cidr Number
- CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
- reservation
Ids List<String> List of UUIDs of IP block reservations from which the public IPv4 address should be taken.
You can supply one
ip_address
block per IP address type. If you use theip_address
you must always pass a block forprivate_ipv4
.To learn more about using the reserved IP addresses for new devices, see the examples in the equinix.metal.ReservedIpBlock documentation.
DeviceNetwork, DeviceNetworkArgs
DevicePort, DevicePortArgs
DeviceReinstall, DeviceReinstallArgs
- Deprovision
Fast bool - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - Enabled bool
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - Preserve
Data bool - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
- Deprovision
Fast bool - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - Enabled bool
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - Preserve
Data bool - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
- deprovision
Fast Boolean - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - enabled Boolean
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - preserve
Data Boolean - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
- deprovision
Fast boolean - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - enabled boolean
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - preserve
Data boolean - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
- deprovision_
fast bool - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - enabled bool
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - preserve_
data bool - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
- deprovision
Fast Boolean - Whether the OS disk should be filled with
00h
bytes before reinstall. Defaults tofalse
. - enabled Boolean
- Whether the provider should favour reinstall over destroy and create. Defaults to
false
. - preserve
Data Boolean - Whether the non-OS disks should be kept or wiped during reinstall.
Defaults to
false
.
Facility, FacilityArgs
- AM2
- am2Amsterdam 2
- AM6
- am6Amsterdam 6
- MA5
- ma5Manchester 5
- NRT1
- nrt1Tokio 1
- PA4
- pa4Paris 4
- SK2
- sk2Stockholm 2
- ME2
- me2Melbourne 2
- HK2
- hk2Hong Kong 2
- TY11
- ty11Tokyo 11
- LA4
- la4Los Angeles 4
- DA6
- da6Dallas 6
- DA11
- da11Dallas 11
- DA3
- da3Dallas 3
- SP4
- sp4Sao Paulo 4
- MT1
- mt1Montreal 1
- SV16
- sv16Silicon Valley 16
- SJC1
- sjc1Sunnyvale, CA 1
- FRA2
- fra2Frankfurt 2
- FRA8
- fr8Frankfurt 8
- NY5
- ny5New York 5
- NY6
- ny6New York 6
- NY7
- ny7New York 7
- CH3
- ch3Chicago 3
- SL1
- sl1Seoul 1
- SY5
- sy5Sydney 5
- OS3
- os3Osaka 3
- LD7
- ld7London 7
- DC10
- dc10Washington DC 10
- AMS1
- ams1Amsterdam 1
- SG4
- sg4Singapore 4
- SE4
- se4Seattle 4
- SY4
- sy4Sydney 4
- AT4
- at4Atlanta 4
- DFW2
- dfw2Dallas 2
- TR2
- tr2Toronto
- DC13
- dc13Washington DC
- HE7
- he7Helsinki
- EWR1
- ewr1Parsippany, NJ 1
- SG5
- sg5Singapore 5
- SG1
- sg1Singapore 1
- MD2
- md2Madrid 2
- SV15
- sv15Silicon Valley 15
- Facility
AM2 - am2Amsterdam 2
- Facility
AM6 - am6Amsterdam 6
- Facility
MA5 - ma5Manchester 5
- Facility
NRT1 - nrt1Tokio 1
- Facility
PA4 - pa4Paris 4
- Facility
SK2 - sk2Stockholm 2
- Facility
ME2 - me2Melbourne 2
- Facility
HK2 - hk2Hong Kong 2
- Facility
TY11 - ty11Tokyo 11
- Facility
LA4 - la4Los Angeles 4
- Facility
DA6 - da6Dallas 6
- Facility
DA11 - da11Dallas 11
- Facility
DA3 - da3Dallas 3
- Facility
SP4 - sp4Sao Paulo 4
- Facility
MT1 - mt1Montreal 1
- Facility
SV16 - sv16Silicon Valley 16
- Facility
SJC1 - sjc1Sunnyvale, CA 1
- Facility
FRA2 - fra2Frankfurt 2
- Facility
FRA8 - fr8Frankfurt 8
- Facility
NY5 - ny5New York 5
- Facility
NY6 - ny6New York 6
- Facility
NY7 - ny7New York 7
- Facility
CH3 - ch3Chicago 3
- Facility
SL1 - sl1Seoul 1
- Facility
SY5 - sy5Sydney 5
- Facility
OS3 - os3Osaka 3
- Facility
LD7 - ld7London 7
- Facility
DC10 - dc10Washington DC 10
- Facility
AMS1 - ams1Amsterdam 1
- Facility
SG4 - sg4Singapore 4
- Facility
SE4 - se4Seattle 4
- Facility
SY4 - sy4Sydney 4
- Facility
AT4 - at4Atlanta 4
- Facility
DFW2 - dfw2Dallas 2
- Facility
TR2 - tr2Toronto
- Facility
DC13 - dc13Washington DC
- Facility
HE7 - he7Helsinki
- Facility
EWR1 - ewr1Parsippany, NJ 1
- Facility
SG5 - sg5Singapore 5
- Facility
SG1 - sg1Singapore 1
- Facility
MD2 - md2Madrid 2
- Facility
SV15 - sv15Silicon Valley 15
- AM2
- am2Amsterdam 2
- AM6
- am6Amsterdam 6
- MA5
- ma5Manchester 5
- NRT1
- nrt1Tokio 1
- PA4
- pa4Paris 4
- SK2
- sk2Stockholm 2
- ME2
- me2Melbourne 2
- HK2
- hk2Hong Kong 2
- TY11
- ty11Tokyo 11
- LA4
- la4Los Angeles 4
- DA6
- da6Dallas 6
- DA11
- da11Dallas 11
- DA3
- da3Dallas 3
- SP4
- sp4Sao Paulo 4
- MT1
- mt1Montreal 1
- SV16
- sv16Silicon Valley 16
- SJC1
- sjc1Sunnyvale, CA 1
- FRA2
- fra2Frankfurt 2
- FRA8
- fr8Frankfurt 8
- NY5
- ny5New York 5
- NY6
- ny6New York 6
- NY7
- ny7New York 7
- CH3
- ch3Chicago 3
- SL1
- sl1Seoul 1
- SY5
- sy5Sydney 5
- OS3
- os3Osaka 3
- LD7
- ld7London 7
- DC10
- dc10Washington DC 10
- AMS1
- ams1Amsterdam 1
- SG4
- sg4Singapore 4
- SE4
- se4Seattle 4
- SY4
- sy4Sydney 4
- AT4
- at4Atlanta 4
- DFW2
- dfw2Dallas 2
- TR2
- tr2Toronto
- DC13
- dc13Washington DC
- HE7
- he7Helsinki
- EWR1
- ewr1Parsippany, NJ 1
- SG5
- sg5Singapore 5
- SG1
- sg1Singapore 1
- MD2
- md2Madrid 2
- SV15
- sv15Silicon Valley 15
- AM2
- am2Amsterdam 2
- AM6
- am6Amsterdam 6
- MA5
- ma5Manchester 5
- NRT1
- nrt1Tokio 1
- PA4
- pa4Paris 4
- SK2
- sk2Stockholm 2
- ME2
- me2Melbourne 2
- HK2
- hk2Hong Kong 2
- TY11
- ty11Tokyo 11
- LA4
- la4Los Angeles 4
- DA6
- da6Dallas 6
- DA11
- da11Dallas 11
- DA3
- da3Dallas 3
- SP4
- sp4Sao Paulo 4
- MT1
- mt1Montreal 1
- SV16
- sv16Silicon Valley 16
- SJC1
- sjc1Sunnyvale, CA 1
- FRA2
- fra2Frankfurt 2
- FRA8
- fr8Frankfurt 8
- NY5
- ny5New York 5
- NY6
- ny6New York 6
- NY7
- ny7New York 7
- CH3
- ch3Chicago 3
- SL1
- sl1Seoul 1
- SY5
- sy5Sydney 5
- OS3
- os3Osaka 3
- LD7
- ld7London 7
- DC10
- dc10Washington DC 10
- AMS1
- ams1Amsterdam 1
- SG4
- sg4Singapore 4
- SE4
- se4Seattle 4
- SY4
- sy4Sydney 4
- AT4
- at4Atlanta 4
- DFW2
- dfw2Dallas 2
- TR2
- tr2Toronto
- DC13
- dc13Washington DC
- HE7
- he7Helsinki
- EWR1
- ewr1Parsippany, NJ 1
- SG5
- sg5Singapore 5
- SG1
- sg1Singapore 1
- MD2
- md2Madrid 2
- SV15
- sv15Silicon Valley 15
- AM2
- am2Amsterdam 2
- AM6
- am6Amsterdam 6
- MA5
- ma5Manchester 5
- NRT1
- nrt1Tokio 1
- PA4
- pa4Paris 4
- SK2
- sk2Stockholm 2
- ME2
- me2Melbourne 2
- HK2
- hk2Hong Kong 2
- TY11
- ty11Tokyo 11
- LA4
- la4Los Angeles 4
- DA6
- da6Dallas 6
- DA11
- da11Dallas 11
- DA3
- da3Dallas 3
- SP4
- sp4Sao Paulo 4
- MT1
- mt1Montreal 1
- SV16
- sv16Silicon Valley 16
- SJC1
- sjc1Sunnyvale, CA 1
- FRA2
- fra2Frankfurt 2
- FRA8
- fr8Frankfurt 8
- NY5
- ny5New York 5
- NY6
- ny6New York 6
- NY7
- ny7New York 7
- CH3
- ch3Chicago 3
- SL1
- sl1Seoul 1
- SY5
- sy5Sydney 5
- OS3
- os3Osaka 3
- LD7
- ld7London 7
- DC10
- dc10Washington DC 10
- AMS1
- ams1Amsterdam 1
- SG4
- sg4Singapore 4
- SE4
- se4Seattle 4
- SY4
- sy4Sydney 4
- AT4
- at4Atlanta 4
- DFW2
- dfw2Dallas 2
- TR2
- tr2Toronto
- DC13
- dc13Washington DC
- HE7
- he7Helsinki
- EWR1
- ewr1Parsippany, NJ 1
- SG5
- sg5Singapore 5
- SG1
- sg1Singapore 1
- MD2
- md2Madrid 2
- SV15
- sv15Silicon Valley 15
- "am2"
- am2Amsterdam 2
- "am6"
- am6Amsterdam 6
- "ma5"
- ma5Manchester 5
- "nrt1"
- nrt1Tokio 1
- "pa4"
- pa4Paris 4
- "sk2"
- sk2Stockholm 2
- "me2"
- me2Melbourne 2
- "hk2"
- hk2Hong Kong 2
- "ty11"
- ty11Tokyo 11
- "la4"
- la4Los Angeles 4
- "da6"
- da6Dallas 6
- "da11"
- da11Dallas 11
- "da3"
- da3Dallas 3
- "sp4"
- sp4Sao Paulo 4
- "mt1"
- mt1Montreal 1
- "sv16"
- sv16Silicon Valley 16
- "sjc1"
- sjc1Sunnyvale, CA 1
- "fra2"
- fra2Frankfurt 2
- "fr8"
- fr8Frankfurt 8
- "ny5"
- ny5New York 5
- "ny6"
- ny6New York 6
- "ny7"
- ny7New York 7
- "ch3"
- ch3Chicago 3
- "sl1"
- sl1Seoul 1
- "sy5"
- sy5Sydney 5
- "os3"
- os3Osaka 3
- "ld7"
- ld7London 7
- "dc10"
- dc10Washington DC 10
- "ams1"
- ams1Amsterdam 1
- "sg4"
- sg4Singapore 4
- "se4"
- se4Seattle 4
- "sy4"
- sy4Sydney 4
- "at4"
- at4Atlanta 4
- "dfw2"
- dfw2Dallas 2
- "tr2"
- tr2Toronto
- "dc13"
- dc13Washington DC
- "he7"
- he7Helsinki
- "ewr1"
- ewr1Parsippany, NJ 1
- "sg5"
- sg5Singapore 5
- "sg1"
- sg1Singapore 1
- "md2"
- md2Madrid 2
- "sv15"
- sv15Silicon Valley 15
OperatingSystem, OperatingSystemArgs
- Alma8
- alma_8
- Alma9
- alma_9
- Alpine3
- alpine_3
- Cent
OS6 - centos_6
- Cent
OS7 - centos_7
- Cent
OS8 - centos_8
- Core
OSAlpha - coreos_alpha
- Core
OSBeta - coreos_beta
- Core
OSStable - coreos_stable
- Custom
IPXE - custom_ipxe
- Debian10
- debian_10
- Debian11
- debian_11
- Debian7
- debian_7
- Debian8
- debian_8
- Debian9
- debian_9
- Fedora31
- fedora_31
- Fedora34
- fedora_34
- Flatcar
Alpha - flatcar_alpha
- Flatcar
Beta - flatcar_beta
- Flatcar
Edge - flatcar_edge
- Flatcar
LTS - flatcar_lts
- Flatcar
Stable - flatcar_stable
- Free
BSD10_3 - freebsd_10_3
- Free
BSD10_4 - freebsd_10_4
- Free
BSD11_0 - freebsd_11_0
- Free
BSD11_1 - freebsd_11_1
- Free
BSD11_2 - freebsd_11_2
- Free
BSD11_3 - freebsd_11_3
- Free
BSD11_4 - freebsd_11_4
- Free
BSD12Testing - freebsd_12_testing
- Free
BSD12_1 - freebsd_12_1
- Free
BSD13_0 - freebsd_13_0
- Free
BSD13_1 - freebsd_13_1
- Free
BSD13_ testing - freebsd_13_testing
- Hook
Esxi7 - hook_esxi7
- Nix
OS17_03 - nixos_17_03
- Nix
OS18_03 - nixos_18_03
- Nix
OS19_03 - nixos_19_03
- Nix
OS20_09 - nixos_20_09
- Nix
OS21_11 - nixos_21_11
- Nix
OS22_05 - nixos_22_05
- Nix
OS22_11 - nixos_22_11
- Nixos21_05
- nixos_21_05
- Nutanix
Centos - nutanix_centos
- Nutanix
LTS5_19_1 - nutanix_lts_5_19_1
- Nutanix
LTS5_20 - nutanix_lts_5_20
- Open
SUSE42_3 - opensuse_42_3
- RHEL7
- rhel_7
- RHEL8
- rhel_8
- RHEL9
- rhel_9
- Rancher
OS - rancher
- Rocky8
- rocky_8
- Rocky9
- rocky_9
- SLES12SP3
- suse_sles12_sp3
- Scientific
Linux6 - scientific_6
- Talos
V1 - talos_v1
- Ubuntu1710
- ubuntu_17_10
- Ubuntu18_04
- ubuntu_18_04
- Ubuntu1904
- ubuntu_19_04
- Ubuntu19_10
- ubuntu_19_10
- Ubuntu20_04
- ubuntu_20_04
- Ubuntu20_04_
legacy - ubuntu_20_04_legacy
- Ubuntu20_10
- ubuntu_20_10
- Ubuntu2204
- ubuntu_22_04
- VMWare
Alloy Vcf - vmware_alloy_vcf
- VMWare
Esxi5_5 - vmware_esxi_5_5
- VMWare
Esxi6_0 - vmware_esxi_6_0
- VMWare
Esxi6_5 - vmware_esxi_6_5
- VMWare
Esxi6_7 - vmware_esxi_6_7
- VMWare
Esxi6_7_ vcf - vmware_esxi_6_7_vcf
- VMWare
Esxi7_0 - vmware_esxi_7_0
- VMWare
Esxi7_0U2a - vmware_esxi_7_0U2a
- VMWare
Esxi7_0_ vcf - vmware_esxi_7_0_vcf
- VMWare
Nsx2_5_0 - vmware_nsx_2_5_0
- VMWare
Nsx3_0_0 - vmware_nsx_3_0_0
- Virtuozzo7
- virtuozzo_7
- Windows2012R2
- windows_2012_r2
- Windows2016
- windows_2016
- Windows2019
- windows_2019
- Windows2022
- windows_2022
- Operating
System Alma8 - alma_8
- Operating
System Alma9 - alma_9
- Operating
System Alpine3 - alpine_3
- Operating
System Cent OS6 - centos_6
- Operating
System Cent OS7 - centos_7
- Operating
System Cent OS8 - centos_8
- Operating
System Core OSAlpha - coreos_alpha
- Operating
System Core OSBeta - coreos_beta
- Operating
System Core OSStable - coreos_stable
- Operating
System Custom IPXE - custom_ipxe
- Operating
System Debian10 - debian_10
- Operating
System Debian11 - debian_11
- Operating
System Debian7 - debian_7
- Operating
System Debian8 - debian_8
- Operating
System Debian9 - debian_9
- Operating
System Fedora31 - fedora_31
- Operating
System Fedora34 - fedora_34
- Operating
System Flatcar Alpha - flatcar_alpha
- Operating
System Flatcar Beta - flatcar_beta
- Operating
System Flatcar Edge - flatcar_edge
- Operating
System Flatcar LTS - flatcar_lts
- Operating
System Flatcar Stable - flatcar_stable
- Operating
System_Free BSD10_3 - freebsd_10_3
- Operating
System_Free BSD10_4 - freebsd_10_4
- Operating
System_Free BSD11_0 - freebsd_11_0
- Operating
System_Free BSD11_1 - freebsd_11_1
- Operating
System_Free BSD11_2 - freebsd_11_2
- Operating
System_Free BSD11_3 - freebsd_11_3
- Operating
System_Free BSD11_4 - freebsd_11_4
- Operating
System Free BSD12Testing - freebsd_12_testing
- Operating
System_Free BSD12_1 - freebsd_12_1
- Operating
System_Free BSD13_0 - freebsd_13_0
- Operating
System_Free BSD13_1 - freebsd_13_1
- Operating
System_Free BSD13_ testing - freebsd_13_testing
- Operating
System Hook Esxi7 - hook_esxi7
- Operating
System_Nix OS17_03 - nixos_17_03
- Operating
System_Nix OS18_03 - nixos_18_03
- Operating
System_Nix OS19_03 - nixos_19_03
- Operating
System_Nix OS20_09 - nixos_20_09
- Operating
System_Nix OS21_11 - nixos_21_11
- Operating
System_Nix OS22_05 - nixos_22_05
- Operating
System_Nix OS22_11 - nixos_22_11
- Operating
System_Nixos21_05 - nixos_21_05
- Operating
System Nutanix Centos - nutanix_centos
- Operating
System_Nutanix LTS5_19_1 - nutanix_lts_5_19_1
- Operating
System_Nutanix LTS5_20 - nutanix_lts_5_20
- Operating
System_Open SUSE42_3 - opensuse_42_3
- Operating
System RHEL7 - rhel_7
- Operating
System RHEL8 - rhel_8
- Operating
System RHEL9 - rhel_9
- Operating
System Rancher OS - rancher
- Operating
System Rocky8 - rocky_8
- Operating
System Rocky9 - rocky_9
- Operating
System SLES12SP3 - suse_sles12_sp3
- Operating
System Scientific Linux6 - scientific_6
- Operating
System Talos V1 - talos_v1
- Operating
System Ubuntu1710 - ubuntu_17_10
- Operating
System_Ubuntu18_04 - ubuntu_18_04
- Operating
System Ubuntu1904 - ubuntu_19_04
- Operating
System_Ubuntu19_10 - ubuntu_19_10
- Operating
System_Ubuntu20_04 - ubuntu_20_04
- Operating
System_Ubuntu20_04_ legacy - ubuntu_20_04_legacy
- Operating
System_Ubuntu20_10 - ubuntu_20_10
- Operating
System Ubuntu2204 - ubuntu_22_04
- Operating
System VMWare Alloy Vcf - vmware_alloy_vcf
- Operating
System_VMWare Esxi5_5 - vmware_esxi_5_5
- Operating
System_VMWare Esxi6_0 - vmware_esxi_6_0
- Operating
System_VMWare Esxi6_5 - vmware_esxi_6_5
- Operating
System_VMWare Esxi6_7 - vmware_esxi_6_7
- Operating
System_VMWare Esxi6_7_ vcf - vmware_esxi_6_7_vcf
- Operating
System_VMWare Esxi7_0 - vmware_esxi_7_0
- Operating
System_VMWare Esxi7_0U2a - vmware_esxi_7_0U2a
- Operating
System_VMWare Esxi7_0_ vcf - vmware_esxi_7_0_vcf
- Operating
System_VMWare Nsx2_5_0 - vmware_nsx_2_5_0
- Operating
System_VMWare Nsx3_0_0 - vmware_nsx_3_0_0
- Operating
System Virtuozzo7 - virtuozzo_7
- Operating
System Windows2012R2 - windows_2012_r2
- Operating
System Windows2016 - windows_2016
- Operating
System Windows2019 - windows_2019
- Operating
System Windows2022 - windows_2022
- Alma8
- alma_8
- Alma9
- alma_9
- Alpine3
- alpine_3
- Cent
OS6 - centos_6
- Cent
OS7 - centos_7
- Cent
OS8 - centos_8
- Core
OSAlpha - coreos_alpha
- Core
OSBeta - coreos_beta
- Core
OSStable - coreos_stable
- Custom
IPXE - custom_ipxe
- Debian10
- debian_10
- Debian11
- debian_11
- Debian7
- debian_7
- Debian8
- debian_8
- Debian9
- debian_9
- Fedora31
- fedora_31
- Fedora34
- fedora_34
- Flatcar
Alpha - flatcar_alpha
- Flatcar
Beta - flatcar_beta
- Flatcar
Edge - flatcar_edge
- Flatcar
LTS - flatcar_lts
- Flatcar
Stable - flatcar_stable
- Free
BSD10_3 - freebsd_10_3
- Free
BSD10_4 - freebsd_10_4
- Free
BSD11_0 - freebsd_11_0
- Free
BSD11_1 - freebsd_11_1
- Free
BSD11_2 - freebsd_11_2
- Free
BSD11_3 - freebsd_11_3
- Free
BSD11_4 - freebsd_11_4
- Free
BSD12Testing - freebsd_12_testing
- Free
BSD12_1 - freebsd_12_1
- Free
BSD13_0 - freebsd_13_0
- Free
BSD13_1 - freebsd_13_1
- Free
BSD13_ testing - freebsd_13_testing
- Hook
Esxi7 - hook_esxi7
- Nix
OS17_03 - nixos_17_03
- Nix
OS18_03 - nixos_18_03
- Nix
OS19_03 - nixos_19_03
- Nix
OS20_09 - nixos_20_09
- Nix
OS21_11 - nixos_21_11
- Nix
OS22_05 - nixos_22_05
- Nix
OS22_11 - nixos_22_11
- Nixos21_05
- nixos_21_05
- Nutanix
Centos - nutanix_centos
- Nutanix
LTS5_19_1 - nutanix_lts_5_19_1
- Nutanix
LTS5_20 - nutanix_lts_5_20
- Open
SUSE42_3 - opensuse_42_3
- RHEL7
- rhel_7
- RHEL8
- rhel_8
- RHEL9
- rhel_9
- Rancher
OS - rancher
- Rocky8
- rocky_8
- Rocky9
- rocky_9
- SLES12SP3
- suse_sles12_sp3
- Scientific
Linux6 - scientific_6
- Talos
V1 - talos_v1
- Ubuntu1710
- ubuntu_17_10
- Ubuntu18_04
- ubuntu_18_04
- Ubuntu1904
- ubuntu_19_04
- Ubuntu19_10
- ubuntu_19_10
- Ubuntu20_04
- ubuntu_20_04
- Ubuntu20_04_
legacy - ubuntu_20_04_legacy
- Ubuntu20_10
- ubuntu_20_10
- Ubuntu2204
- ubuntu_22_04
- VMWare
Alloy Vcf - vmware_alloy_vcf
- VMWare
Esxi5_5 - vmware_esxi_5_5
- VMWare
Esxi6_0 - vmware_esxi_6_0
- VMWare
Esxi6_5 - vmware_esxi_6_5
- VMWare
Esxi6_7 - vmware_esxi_6_7
- VMWare
Esxi6_7_ vcf - vmware_esxi_6_7_vcf
- VMWare
Esxi7_0 - vmware_esxi_7_0
- VMWare
Esxi7_0U2a - vmware_esxi_7_0U2a
- VMWare
Esxi7_0_ vcf - vmware_esxi_7_0_vcf
- VMWare
Nsx2_5_0 - vmware_nsx_2_5_0
- VMWare
Nsx3_0_0 - vmware_nsx_3_0_0
- Virtuozzo7
- virtuozzo_7
- Windows2012R2
- windows_2012_r2
- Windows2016
- windows_2016
- Windows2019
- windows_2019
- Windows2022
- windows_2022
- Alma8
- alma_8
- Alma9
- alma_9
- Alpine3
- alpine_3
- Cent
OS6 - centos_6
- Cent
OS7 - centos_7
- Cent
OS8 - centos_8
- Core
OSAlpha - coreos_alpha
- Core
OSBeta - coreos_beta
- Core
OSStable - coreos_stable
- Custom
IPXE - custom_ipxe
- Debian10
- debian_10
- Debian11
- debian_11
- Debian7
- debian_7
- Debian8
- debian_8
- Debian9
- debian_9
- Fedora31
- fedora_31
- Fedora34
- fedora_34
- Flatcar
Alpha - flatcar_alpha
- Flatcar
Beta - flatcar_beta
- Flatcar
Edge - flatcar_edge
- Flatcar
LTS - flatcar_lts
- Flatcar
Stable - flatcar_stable
- Free
BSD10_3 - freebsd_10_3
- Free
BSD10_4 - freebsd_10_4
- Free
BSD11_0 - freebsd_11_0
- Free
BSD11_1 - freebsd_11_1
- Free
BSD11_2 - freebsd_11_2
- Free
BSD11_3 - freebsd_11_3
- Free
BSD11_4 - freebsd_11_4
- Free
BSD12Testing - freebsd_12_testing
- Free
BSD12_1 - freebsd_12_1
- Free
BSD13_0 - freebsd_13_0
- Free
BSD13_1 - freebsd_13_1
- Free
BSD13_ testing - freebsd_13_testing
- Hook
Esxi7 - hook_esxi7
- Nix
OS17_03 - nixos_17_03
- Nix
OS18_03 - nixos_18_03
- Nix
OS19_03 - nixos_19_03
- Nix
OS20_09 - nixos_20_09
- Nix
OS21_11 - nixos_21_11
- Nix
OS22_05 - nixos_22_05
- Nix
OS22_11 - nixos_22_11
- Nixos21_05
- nixos_21_05
- Nutanix
Centos - nutanix_centos
- Nutanix
LTS5_19_1 - nutanix_lts_5_19_1
- Nutanix
LTS5_20 - nutanix_lts_5_20
- Open
SUSE42_3 - opensuse_42_3
- RHEL7
- rhel_7
- RHEL8
- rhel_8
- RHEL9
- rhel_9
- Rancher
OS - rancher
- Rocky8
- rocky_8
- Rocky9
- rocky_9
- SLES12SP3
- suse_sles12_sp3
- Scientific
Linux6 - scientific_6
- Talos
V1 - talos_v1
- Ubuntu1710
- ubuntu_17_10
- Ubuntu18_04
- ubuntu_18_04
- Ubuntu1904
- ubuntu_19_04
- Ubuntu19_10
- ubuntu_19_10
- Ubuntu20_04
- ubuntu_20_04
- Ubuntu20_04_
legacy - ubuntu_20_04_legacy
- Ubuntu20_10
- ubuntu_20_10
- Ubuntu2204
- ubuntu_22_04
- VMWare
Alloy Vcf - vmware_alloy_vcf
- VMWare
Esxi5_5 - vmware_esxi_5_5
- VMWare
Esxi6_0 - vmware_esxi_6_0
- VMWare
Esxi6_5 - vmware_esxi_6_5
- VMWare
Esxi6_7 - vmware_esxi_6_7
- VMWare
Esxi6_7_ vcf - vmware_esxi_6_7_vcf
- VMWare
Esxi7_0 - vmware_esxi_7_0
- VMWare
Esxi7_0U2a - vmware_esxi_7_0U2a
- VMWare
Esxi7_0_ vcf - vmware_esxi_7_0_vcf
- VMWare
Nsx2_5_0 - vmware_nsx_2_5_0
- VMWare
Nsx3_0_0 - vmware_nsx_3_0_0
- Virtuozzo7
- virtuozzo_7
- Windows2012R2
- windows_2012_r2
- Windows2016
- windows_2016
- Windows2019
- windows_2019
- Windows2022
- windows_2022
- ALMA8
- alma_8
- ALMA9
- alma_9
- ALPINE3
- alpine_3
- CENT_OS6
- centos_6
- CENT_OS7
- centos_7
- CENT_OS8
- centos_8
- CORE_OS_ALPHA
- coreos_alpha
- CORE_OS_BETA
- coreos_beta
- CORE_OS_STABLE
- coreos_stable
- CUSTOM_IPXE
- custom_ipxe
- DEBIAN10
- debian_10
- DEBIAN11
- debian_11
- DEBIAN7
- debian_7
- DEBIAN8
- debian_8
- DEBIAN9
- debian_9
- FEDORA31
- fedora_31
- FEDORA34
- fedora_34
- FLATCAR_ALPHA
- flatcar_alpha
- FLATCAR_BETA
- flatcar_beta
- FLATCAR_EDGE
- flatcar_edge
- FLATCAR_LTS
- flatcar_lts
- FLATCAR_STABLE
- flatcar_stable
- FREE_BSD10_3
- freebsd_10_3
- FREE_BSD10_4
- freebsd_10_4
- FREE_BSD11_0
- freebsd_11_0
- FREE_BSD11_1
- freebsd_11_1
- FREE_BSD11_2
- freebsd_11_2
- FREE_BSD11_3
- freebsd_11_3
- FREE_BSD11_4
- freebsd_11_4
- FREE_BSD12_TESTING
- freebsd_12_testing
- FREE_BSD12_1
- freebsd_12_1
- FREE_BSD13_0
- freebsd_13_0
- FREE_BSD13_1
- freebsd_13_1
- FREE_BSD13_TESTING
- freebsd_13_testing
- HOOK_ESXI7
- hook_esxi7
- NIX_OS17_03
- nixos_17_03
- NIX_OS18_03
- nixos_18_03
- NIX_OS19_03
- nixos_19_03
- NIX_OS20_09
- nixos_20_09
- NIX_OS21_11
- nixos_21_11
- NIX_OS22_05
- nixos_22_05
- NIX_OS22_11
- nixos_22_11
- NIXOS21_05
- nixos_21_05
- NUTANIX_CENTOS
- nutanix_centos
- NUTANIX_LTS5_19_1
- nutanix_lts_5_19_1
- NUTANIX_LTS5_20
- nutanix_lts_5_20
- OPEN_SUSE42_3
- opensuse_42_3
- RHEL7
- rhel_7
- RHEL8
- rhel_8
- RHEL9
- rhel_9
- RANCHER_OS
- rancher
- ROCKY8
- rocky_8
- ROCKY9
- rocky_9
- SLES12_SP3
- suse_sles12_sp3
- SCIENTIFIC_LINUX6
- scientific_6
- TALOS_V1
- talos_v1
- UBUNTU1710
- ubuntu_17_10
- UBUNTU18_04
- ubuntu_18_04
- UBUNTU1904
- ubuntu_19_04
- UBUNTU19_10
- ubuntu_19_10
- UBUNTU20_04
- ubuntu_20_04
- UBUNTU20_04_LEGACY
- ubuntu_20_04_legacy
- UBUNTU20_10
- ubuntu_20_10
- UBUNTU2204
- ubuntu_22_04
- VM_WARE_ALLOY_VCF
- vmware_alloy_vcf
- VM_WARE_ESXI5_5
- vmware_esxi_5_5
- VM_WARE_ESXI6_0
- vmware_esxi_6_0
- VM_WARE_ESXI6_5
- vmware_esxi_6_5
- VM_WARE_ESXI6_7
- vmware_esxi_6_7
- VM_WARE_ESXI6_7_VCF
- vmware_esxi_6_7_vcf
- VM_WARE_ESXI7_0
- vmware_esxi_7_0
- VM_WARE_ESXI7_0_U2A
- vmware_esxi_7_0U2a
- VM_WARE_ESXI7_0_VCF
- vmware_esxi_7_0_vcf
- VM_WARE_NSX2_5_0
- vmware_nsx_2_5_0
- VM_WARE_NSX3_0_0
- vmware_nsx_3_0_0
- VIRTUOZZO7
- virtuozzo_7
- WINDOWS2012_R2
- windows_2012_r2
- WINDOWS2016
- windows_2016
- WINDOWS2019
- windows_2019
- WINDOWS2022
- windows_2022
- "alma_8"
- alma_8
- "alma_9"
- alma_9
- "alpine_3"
- alpine_3
- "centos_6"
- centos_6
- "centos_7"
- centos_7
- "centos_8"
- centos_8
- "coreos_
alpha" - coreos_alpha
- "coreos_
beta" - coreos_beta
- "coreos_
stable" - coreos_stable
- "custom_
ipxe" - custom_ipxe
- "debian_10"
- debian_10
- "debian_11"
- debian_11
- "debian_7"
- debian_7
- "debian_8"
- debian_8
- "debian_9"
- debian_9
- "fedora_31"
- fedora_31
- "fedora_34"
- fedora_34
- "flatcar_
alpha" - flatcar_alpha
- "flatcar_
beta" - flatcar_beta
- "flatcar_
edge" - flatcar_edge
- "flatcar_
lts" - flatcar_lts
- "flatcar_
stable" - flatcar_stable
- "freebsd_10_3"
- freebsd_10_3
- "freebsd_10_4"
- freebsd_10_4
- "freebsd_11_0"
- freebsd_11_0
- "freebsd_11_1"
- freebsd_11_1
- "freebsd_11_2"
- freebsd_11_2
- "freebsd_11_3"
- freebsd_11_3
- "freebsd_11_4"
- freebsd_11_4
- "freebsd_12_
testing" - freebsd_12_testing
- "freebsd_12_1"
- freebsd_12_1
- "freebsd_13_0"
- freebsd_13_0
- "freebsd_13_1"
- freebsd_13_1
- "freebsd_13_
testing" - freebsd_13_testing
- "hook_
esxi7" - hook_esxi7
- "nixos_17_03"
- nixos_17_03
- "nixos_18_03"
- nixos_18_03
- "nixos_19_03"
- nixos_19_03
- "nixos_20_09"
- nixos_20_09
- "nixos_21_11"
- nixos_21_11
- "nixos_22_05"
- nixos_22_05
- "nixos_22_11"
- nixos_22_11
- "nixos_21_05"
- nixos_21_05
- "nutanix_
centos" - nutanix_centos
- "nutanix_
lts_5_19_1" - nutanix_lts_5_19_1
- "nutanix_
lts_5_20" - nutanix_lts_5_20
- "opensuse_42_3"
- opensuse_42_3
- "rhel_7"
- rhel_7
- "rhel_8"
- rhel_8
- "rhel_9"
- rhel_9
- "rancher"
- rancher
- "rocky_8"
- rocky_8
- "rocky_9"
- rocky_9
- "suse_
sles12_ sp3" - suse_sles12_sp3
- "scientific_6"
- scientific_6
- "talos_
v1" - talos_v1
- "ubuntu_17_10"
- ubuntu_17_10
- "ubuntu_18_04"
- ubuntu_18_04
- "ubuntu_19_04"
- ubuntu_19_04
- "ubuntu_19_10"
- ubuntu_19_10
- "ubuntu_20_04"
- ubuntu_20_04
- "ubuntu_20_04_
legacy" - ubuntu_20_04_legacy
- "ubuntu_20_10"
- ubuntu_20_10
- "ubuntu_22_04"
- ubuntu_22_04
- "vmware_
alloy_ vcf" - vmware_alloy_vcf
- "vmware_
esxi_5_5" - vmware_esxi_5_5
- "vmware_
esxi_6_0" - vmware_esxi_6_0
- "vmware_
esxi_6_5" - vmware_esxi_6_5
- "vmware_
esxi_6_7" - vmware_esxi_6_7
- "vmware_
esxi_6_7_ vcf" - vmware_esxi_6_7_vcf
- "vmware_
esxi_7_0" - vmware_esxi_7_0
- "vmware_
esxi_7_0U2a" - vmware_esxi_7_0U2a
- "vmware_
esxi_7_0_ vcf" - vmware_esxi_7_0_vcf
- "vmware_
nsx_2_5_0" - vmware_nsx_2_5_0
- "vmware_
nsx_3_0_0" - vmware_nsx_3_0_0
- "virtuozzo_7"
- virtuozzo_7
- "windows_2012_
r2" - windows_2012_r2
- "windows_2016"
- windows_2016
- "windows_2019"
- windows_2019
- "windows_2022"
- windows_2022
Plan, PlanArgs
- A3Large
X86 - a3.large.x86
- C2Large
ARM - c2.large.arm
- C2Medium
X86 - c2.medium.x86
- C3Large
ARM - c3.large.arm64
- C3Medium
X86 - c3.medium.x86
- C3Small
X86 - c3.small.x86
- F3Large
X86 - f3.large.x86
- F3Medium
X86 - f3.medium.x86
- G2Large
X86 - g2.large.x86
- M2XLarge
X86 - m2.xlarge.x86
- M3Large
X86 - m3.large.x86
- M3Small
X86 - m3.small.x86
- N2XLarge
X86 - n2.xlarge.x86
- N3XLarge
X86 - n3.xlarge.x86
- S3XLarge
X86 - s3.xlarge.x86
- T3Small
X86 - t3.small.x86
- X2XLarge
X86 - x2.xlarge.x86
- X3XLarge
X86 - x3.xlarge.x86
- Plan
A3Large X86 - a3.large.x86
- Plan
C2Large ARM - c2.large.arm
- Plan
C2Medium X86 - c2.medium.x86
- Plan
C3Large ARM - c3.large.arm64
- Plan
C3Medium X86 - c3.medium.x86
- Plan
C3Small X86 - c3.small.x86
- Plan
F3Large X86 - f3.large.x86
- Plan
F3Medium X86 - f3.medium.x86
- Plan
G2Large X86 - g2.large.x86
- Plan
M2XLarge X86 - m2.xlarge.x86
- Plan
M3Large X86 - m3.large.x86
- Plan
M3Small X86 - m3.small.x86
- Plan
N2XLarge X86 - n2.xlarge.x86
- Plan
N3XLarge X86 - n3.xlarge.x86
- Plan
S3XLarge X86 - s3.xlarge.x86
- Plan
T3Small X86 - t3.small.x86
- Plan
X2XLarge X86 - x2.xlarge.x86
- Plan
X3XLarge X86 - x3.xlarge.x86
- A3Large
X86 - a3.large.x86
- C2Large
ARM - c2.large.arm
- C2Medium
X86 - c2.medium.x86
- C3Large
ARM - c3.large.arm64
- C3Medium
X86 - c3.medium.x86
- C3Small
X86 - c3.small.x86
- F3Large
X86 - f3.large.x86
- F3Medium
X86 - f3.medium.x86
- G2Large
X86 - g2.large.x86
- M2XLarge
X86 - m2.xlarge.x86
- M3Large
X86 - m3.large.x86
- M3Small
X86 - m3.small.x86
- N2XLarge
X86 - n2.xlarge.x86
- N3XLarge
X86 - n3.xlarge.x86
- S3XLarge
X86 - s3.xlarge.x86
- T3Small
X86 - t3.small.x86
- X2XLarge
X86 - x2.xlarge.x86
- X3XLarge
X86 - x3.xlarge.x86
- A3Large
X86 - a3.large.x86
- C2Large
ARM - c2.large.arm
- C2Medium
X86 - c2.medium.x86
- C3Large
ARM - c3.large.arm64
- C3Medium
X86 - c3.medium.x86
- C3Small
X86 - c3.small.x86
- F3Large
X86 - f3.large.x86
- F3Medium
X86 - f3.medium.x86
- G2Large
X86 - g2.large.x86
- M2XLarge
X86 - m2.xlarge.x86
- M3Large
X86 - m3.large.x86
- M3Small
X86 - m3.small.x86
- N2XLarge
X86 - n2.xlarge.x86
- N3XLarge
X86 - n3.xlarge.x86
- S3XLarge
X86 - s3.xlarge.x86
- T3Small
X86 - t3.small.x86
- X2XLarge
X86 - x2.xlarge.x86
- X3XLarge
X86 - x3.xlarge.x86
- A3_LARGE_X86
- a3.large.x86
- C2_LARGE_ARM
- c2.large.arm
- C2_MEDIUM_X86
- c2.medium.x86
- C3_LARGE_ARM
- c3.large.arm64
- C3_MEDIUM_X86
- c3.medium.x86
- C3_SMALL_X86
- c3.small.x86
- F3_LARGE_X86
- f3.large.x86
- F3_MEDIUM_X86
- f3.medium.x86
- G2_LARGE_X86
- g2.large.x86
- M2_X_LARGE_X86
- m2.xlarge.x86
- M3_LARGE_X86
- m3.large.x86
- M3_SMALL_X86
- m3.small.x86
- N2_X_LARGE_X86
- n2.xlarge.x86
- N3_X_LARGE_X86
- n3.xlarge.x86
- S3_X_LARGE_X86
- s3.xlarge.x86
- T3_SMALL_X86
- t3.small.x86
- X2_X_LARGE_X86
- x2.xlarge.x86
- X3_X_LARGE_X86
- x3.xlarge.x86
- "a3.large.x86"
- a3.large.x86
- "c2.large.arm"
- c2.large.arm
- "c2.medium.x86"
- c2.medium.x86
- "c3.large.arm64"
- c3.large.arm64
- "c3.medium.x86"
- c3.medium.x86
- "c3.small.x86"
- c3.small.x86
- "f3.large.x86"
- f3.large.x86
- "f3.medium.x86"
- f3.medium.x86
- "g2.large.x86"
- g2.large.x86
- "m2.xlarge.x86"
- m2.xlarge.x86
- "m3.large.x86"
- m3.large.x86
- "m3.small.x86"
- m3.small.x86
- "n2.xlarge.x86"
- n2.xlarge.x86
- "n3.xlarge.x86"
- n3.xlarge.x86
- "s3.xlarge.x86"
- s3.xlarge.x86
- "t3.small.x86"
- t3.small.x86
- "x2.xlarge.x86"
- x2.xlarge.x86
- "x3.xlarge.x86"
- x3.xlarge.x86
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.