import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; import * as enums from "../types/enums"; /** * Provides an Equinix Metal device resource. This can be used to create, modify, and delete devices. * * > **NOTE:** All arguments including the `rootPassword` and `userData` will be stored in the raw state as plain-text. Read more about sensitive data in state. * * ## Example Usage * ### example 1 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const web1 = new equinix.metal.Device("web1", { * hostname: "tf.coreos2", * plan: equinix.metal.Plan.C3SmallX86, * metro: "sv", * operatingSystem: equinix.metal.OperatingSystem.Ubuntu20_04, * billingCycle: equinix.metal.BillingCycle.Hourly, * projectId: projectId, * }); * ``` * ### example 2 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const pxe1 = new equinix.metal.Device("pxe1", { * hostname: "tf.coreos2-pxe", * plan: equinix.metal.Plan.C3SmallX86, * metro: "sv", * operatingSystem: equinix.metal.OperatingSystem.CustomIPXE, * billingCycle: equinix.metal.BillingCycle.Hourly, * projectId: projectId, * ipxeScriptUrl: "https://rawgit.com/cloudnativelabs/pxe/master/packet/coreos-stable-metal.ipxe", * alwaysPxe: false, * userData: example.rendered, * }); * ``` * ### example 3 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const web1 = new equinix.metal.Device("web1", { * hostname: "tf.coreos2", * plan: equinix.metal.Plan.C3SmallX86, * metro: "ny", * operatingSystem: equinix.metal.OperatingSystem.Ubuntu20_04, * billingCycle: equinix.metal.BillingCycle.Hourly, * projectId: projectId, * ipAddresses: [{ * type: "private_ipv4", * cidr: 30, * }], * }); * ``` * ### example 4 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const web1 = new equinix.metal.Device("web1", { * hostname: "tftest", * plan: equinix.metal.Plan.C3SmallX86, * metro: "ny", * operatingSystem: equinix.metal.OperatingSystem.Ubuntu20_04, * billingCycle: equinix.metal.BillingCycle.Hourly, * projectId: projectId, * hardwareReservationId: "next-available", * storage: "{ \\"disks\\": [ { \\"device\\": \\"/dev/sda\\", \\"wipeTable\\": true, \\"partitions\\": [ { \\"label\\": \\"BIOS\\", \\"number\\": 1, \\"size\\": \\"4096\\" }, { \\"label\\": \\"SWAP\\", \\"number\\": 2, \\"size\\": \\"3993600\\" }, { \\"label\\": \\"ROOT\\", \\"number\\": 3, \\"size\\": \\"0\\" } ] } ], \\"filesystems\\": [ { \\"mount\\": { \\"device\\": \\"/dev/sda3\\", \\"format\\": \\"ext4\\", \\"point\\": \\"/\\", \\"create\\": { \\"options\\": [ \\"-L\\", \\"ROOT\\" ] } } }, { \\"mount\\": { \\"device\\": \\"/dev/sda2\\", \\"format\\": \\"swap\\", \\"point\\": \\"none\\", \\"create\\": { \\"options\\": [ \\"-L\\", \\"SWAP\\" ] } } } ]} * ", * }); * ``` * ### example 5 * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as equinix from "@equinix-labs/pulumi-equinix"; * * const pxe1 = new equinix.metal.Device("pxe1", { * hostname: "tf.coreos2-pxe", * plan: equinix.metal.Plan.C3SmallX86, * metro: "sv", * operatingSystem: equinix.metal.OperatingSystem.CustomIPXE, * billingCycle: equinix.metal.BillingCycle.Hourly, * projectId: projectId, * ipxeScriptUrl: "https://rawgit.com/cloudnativelabs/pxe/master/packet/coreos-stable-metal.ipxe", * alwaysPxe: false, * userData: userData, * customData: customData, * behavior: { * allowChanges: [ * "custom_data", * "user_data", * ], * }, * }); * ``` */ export declare class Device extends pulumi.CustomResource { /** * Get an existing Device resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: DeviceState, opts?: pulumi.CustomResourceOptions): Device; /** * Returns true if the given object is an instance of Device. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Device; /** * The ipv4 private IP assigned to the device */ readonly accessPrivateIpv4: pulumi.Output; /** * The ipv4 maintenance IP assigned to the device */ readonly accessPublicIpv4: pulumi.Output; /** * The ipv6 maintenance IP assigned to the device */ readonly accessPublicIpv6: pulumi.Output; /** * If true, a device with OS customIpxe will */ readonly alwaysPxe: pulumi.Output; readonly behavior: pulumi.Output; /** * monthly or hourly */ readonly billingCycle: pulumi.Output; /** * The timestamp for when the device was created */ readonly created: pulumi.Output; /** * 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 or `behavior.allow_changes` includes `"customData"`, the device will be updated in-place instead of recreated. */ readonly customData: pulumi.Output; /** * The facility where the device is deployed * * @deprecated Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices */ readonly deployedFacility: pulumi.Output; /** * ID of hardware reservation where this device was deployed. It is useful when using the next-available hardware reservation */ readonly deployedHardwareReservationId: pulumi.Output; /** * Description string for the device */ readonly description: pulumi.Output; /** * 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](https://metal.equinix.com/developers/api/facilities/), set your API auth token in the top of the page and see JSON from the API response. Conflicts with metro * * @deprecated Use metro instead of facilities. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices */ readonly facilities: pulumi.Output; /** * Delete device even if it has volumes attached. Only applies for destroy action */ readonly forceDetachVolumes: pulumi.Output; /** * 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 */ readonly hardwareReservationId: pulumi.Output; /** * The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration. */ readonly hostname: pulumi.Output; /** * A list of IP address types for the device (structure is documented below) */ readonly ipAddresses: pulumi.Output; /** * URL pointing to a hosted iPXE script. More */ readonly ipxeScriptUrl: pulumi.Output; /** * 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 */ readonly locked: pulumi.Output; /** * Metro area for the new device. Conflicts with facilities */ readonly metro: pulumi.Output; /** * The device's private and public IP (v4 and v6) network details. When a device is run without any special network configuration, it will have 3 addresses: public ipv4, private ipv4 and ipv6 */ readonly network: pulumi.Output; /** * Network type of a device, used in [Layer 2 networking](https://metal.equinix.com/developers/docs/networking/layer2/). Will be one of layer3, hybrid, hybrid-bonded, layer2-individual, layer2-bonded * * @deprecated You should handle Network Type with one of 'equinix_metal_port' or 'equinix_metal_device_network_type' resources. See section 'Guides' for more info */ readonly networkType: pulumi.Output; /** * The operating system slug. To find the slug, or visit [Operating Systems API docs](https://metal.equinix.com/developers/api/operatingsystems), set your API auth token in the top of the page and see JSON from the API response. By default, changing this attribute will cause your device to be deleted and recreated. If `reinstall` is enabled, the device will be updated in-place instead of recreated. */ readonly operatingSystem: pulumi.Output; /** * The device plan slug. To find the plan slug, visit the [bare-metal server](https://deploy.equinix.com/product/bare-metal/servers/) and [plan documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/) */ readonly plan: pulumi.Output; /** * Ports assigned to the device */ readonly ports: pulumi.Output; /** * The ID of the project in which to create the device */ readonly projectId: pulumi.Output; /** * 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*project*ssh*key resource */ readonly projectSshKeyIds: pulumi.Output; readonly reinstall: pulumi.Output; /** * Root password to the server (disabled after 24 hours) */ readonly rootPassword: pulumi.Output; /** * The hostname to use for [Serial over SSH](https://deploy.equinix.com/developers/docs/metal/resilience-recovery/serial-over-ssh/) access to the device */ readonly sosHostname: pulumi.Output; /** * List of IDs of SSH keys deployed in the device, can be both user and project SSH keys */ readonly sshKeyIds: pulumi.Output; /** * The status of the device */ readonly state: pulumi.Output; /** * JSON for custom partitioning. Only usable on reserved hardware. More information in in the [Custom Partitioning and RAID](https://metal.equinix.com/developers/docs/servers/custom-partitioning-raid/) doc */ readonly storage: pulumi.Output; /** * Tags attached to the device */ readonly tags: pulumi.Output; /** * 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. */ readonly terminationTime: pulumi.Output; /** * The timestamp for the last time the device was updated */ readonly updated: pulumi.Output; /** * 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 or `behavior.allow_changes` includes `"userData"`, the device will be updated in-place instead of recreated. */ readonly userData: pulumi.Output; /** * 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*ssh*key resource */ readonly userSshKeyIds: pulumi.Output; /** * 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) */ readonly waitForReservationDeprovision: pulumi.Output; /** * Create a Device resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: DeviceArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Device resources. */ export interface DeviceState { /** * The ipv4 private IP assigned to the device */ accessPrivateIpv4?: pulumi.Input; /** * The ipv4 maintenance IP assigned to the device */ accessPublicIpv4?: pulumi.Input; /** * The ipv6 maintenance IP assigned to the device */ accessPublicIpv6?: pulumi.Input; /** * If true, a device with OS customIpxe will */ alwaysPxe?: pulumi.Input; behavior?: pulumi.Input; /** * monthly or hourly */ billingCycle?: pulumi.Input; /** * The timestamp for when the device was created */ created?: pulumi.Input; /** * 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 or `behavior.allow_changes` includes `"customData"`, the device will be updated in-place instead of recreated. */ customData?: pulumi.Input; /** * The facility where the device is deployed * * @deprecated Use metro instead of facility. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices */ deployedFacility?: pulumi.Input; /** * ID of hardware reservation where this device was deployed. It is useful when using the next-available hardware reservation */ deployedHardwareReservationId?: pulumi.Input; /** * Description string for the device */ description?: pulumi.Input; /** * 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](https://metal.equinix.com/developers/api/facilities/), set your API auth token in the top of the page and see JSON from the API response. Conflicts with metro * * @deprecated Use metro instead of facilities. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices */ facilities?: pulumi.Input[]>; /** * Delete device even if it has volumes attached. Only applies for destroy action */ forceDetachVolumes?: pulumi.Input; /** * 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 */ hardwareReservationId?: pulumi.Input; /** * The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration. */ hostname?: pulumi.Input; /** * A list of IP address types for the device (structure is documented below) */ ipAddresses?: pulumi.Input[]>; /** * URL pointing to a hosted iPXE script. More */ ipxeScriptUrl?: pulumi.Input; /** * 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 */ locked?: pulumi.Input; /** * Metro area for the new device. Conflicts with facilities */ metro?: pulumi.Input; /** * The device's private and public IP (v4 and v6) network details. When a device is run without any special network configuration, it will have 3 addresses: public ipv4, private ipv4 and ipv6 */ network?: pulumi.Input[]>; /** * Network type of a device, used in [Layer 2 networking](https://metal.equinix.com/developers/docs/networking/layer2/). Will be one of layer3, hybrid, hybrid-bonded, layer2-individual, layer2-bonded * * @deprecated You should handle Network Type with one of 'equinix_metal_port' or 'equinix_metal_device_network_type' resources. See section 'Guides' for more info */ networkType?: pulumi.Input; /** * The operating system slug. To find the slug, or visit [Operating Systems API docs](https://metal.equinix.com/developers/api/operatingsystems), set your API auth token in the top of the page and see JSON from the API response. By default, changing this attribute will cause your device to be deleted and recreated. If `reinstall` is enabled, the device will be updated in-place instead of recreated. */ operatingSystem?: pulumi.Input; /** * The device plan slug. To find the plan slug, visit the [bare-metal server](https://deploy.equinix.com/product/bare-metal/servers/) and [plan documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/) */ plan?: pulumi.Input; /** * Ports assigned to the device */ ports?: pulumi.Input[]>; /** * The ID of the project in which to create the device */ projectId?: pulumi.Input; /** * 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*project*ssh*key resource */ projectSshKeyIds?: pulumi.Input[]>; reinstall?: pulumi.Input; /** * Root password to the server (disabled after 24 hours) */ rootPassword?: pulumi.Input; /** * The hostname to use for [Serial over SSH](https://deploy.equinix.com/developers/docs/metal/resilience-recovery/serial-over-ssh/) access to the device */ sosHostname?: pulumi.Input; /** * List of IDs of SSH keys deployed in the device, can be both user and project SSH keys */ sshKeyIds?: pulumi.Input[]>; /** * The status of the device */ state?: pulumi.Input; /** * JSON for custom partitioning. Only usable on reserved hardware. More information in in the [Custom Partitioning and RAID](https://metal.equinix.com/developers/docs/servers/custom-partitioning-raid/) doc */ storage?: pulumi.Input; /** * Tags attached to the device */ tags?: pulumi.Input[]>; /** * 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. */ terminationTime?: pulumi.Input; /** * The timestamp for the last time the device was updated */ updated?: pulumi.Input; /** * 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 or `behavior.allow_changes` includes `"userData"`, the device will be updated in-place instead of recreated. */ userData?: pulumi.Input; /** * 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*ssh*key resource */ userSshKeyIds?: pulumi.Input[]>; /** * 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) */ waitForReservationDeprovision?: pulumi.Input; } /** * The set of arguments for constructing a Device resource. */ export interface DeviceArgs { /** * If true, a device with OS customIpxe will */ alwaysPxe?: pulumi.Input; behavior?: pulumi.Input; /** * monthly or hourly */ billingCycle?: pulumi.Input; /** * 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 or `behavior.allow_changes` includes `"customData"`, the device will be updated in-place instead of recreated. */ customData?: pulumi.Input; /** * Description string for the device */ description?: pulumi.Input; /** * 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](https://metal.equinix.com/developers/api/facilities/), set your API auth token in the top of the page and see JSON from the API response. Conflicts with metro * * @deprecated Use metro instead of facilities. For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices */ facilities?: pulumi.Input[]>; /** * Delete device even if it has volumes attached. Only applies for destroy action */ forceDetachVolumes?: pulumi.Input; /** * 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 */ hardwareReservationId?: pulumi.Input; /** * The device hostname used in deployments taking advantage of Layer3 DHCP or metadata service configuration. */ hostname?: pulumi.Input; /** * A list of IP address types for the device (structure is documented below) */ ipAddresses?: pulumi.Input[]>; /** * URL pointing to a hosted iPXE script. More */ ipxeScriptUrl?: pulumi.Input; /** * 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 */ locked?: pulumi.Input; /** * Metro area for the new device. Conflicts with facilities */ metro?: pulumi.Input; /** * The operating system slug. To find the slug, or visit [Operating Systems API docs](https://metal.equinix.com/developers/api/operatingsystems), set your API auth token in the top of the page and see JSON from the API response. By default, changing this attribute will cause your device to be deleted and recreated. If `reinstall` is enabled, the device will be updated in-place instead of recreated. */ operatingSystem: pulumi.Input; /** * The device plan slug. To find the plan slug, visit the [bare-metal server](https://deploy.equinix.com/product/bare-metal/servers/) and [plan documentation](https://deploy.equinix.com/developers/docs/metal/hardware/standard-servers/) */ plan: pulumi.Input; /** * The ID of the project in which to create the device */ projectId: pulumi.Input; /** * 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*project*ssh*key resource */ projectSshKeyIds?: pulumi.Input[]>; reinstall?: pulumi.Input; /** * JSON for custom partitioning. Only usable on reserved hardware. More information in in the [Custom Partitioning and RAID](https://metal.equinix.com/developers/docs/servers/custom-partitioning-raid/) doc */ storage?: pulumi.Input; /** * Tags attached to the device */ tags?: pulumi.Input[]>; /** * 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. */ terminationTime?: pulumi.Input; /** * 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 or `behavior.allow_changes` includes `"userData"`, the device will be updated in-place instead of recreated. */ userData?: pulumi.Input; /** * 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*ssh*key resource */ userSshKeyIds?: pulumi.Input[]>; /** * 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) */ waitForReservationDeprovision?: pulumi.Input; }