Device

Provides a Packet device resource. This can be used to create, modify, and delete devices.

Note: All arguments including the root_password and user_data will be stored in the raw state as plain-text. Read more about sensitive data in state.

Create a Device Resource

new Device(name: string, args: DeviceArgs, opts?: CustomResourceOptions);

def Device(resource_name, opts=None, always_pxe=None, billing_cycle=None, description=None, facilities=None, force_detach_volumes=None, hardware_reservation_id=None, hostname=None, ip_addresses=None, ipxe_script_url=None, network_type=None, operating_system=None, plan=None, project_id=None, project_ssh_key_ids=None, storage=None, tags=None, user_data=None, wait_for_reservation_deprovision=None, __props__=None);

func NewDevice(ctx *Context, name string, args DeviceArgs, opts ...ResourceOption) (*Device, error)

public Device(string name, DeviceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Device Resource Properties

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

Inputs

The Device resource accepts the following input properties:

BillingCycle string: monthly or hourly
Facilities List<string>: List of facility codes with deployment preferences. Packet 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.
Hostname string: The device name
OperatingSystem string: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
ProjectId string: The ID of the project in which to create the device
AlwaysPxe bool: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
Description string: Description string for the device
ForceDetachVolumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
HardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
IpAddresses List<DeviceIpAddressArgs>: A list of IP address types for the device (structure is documented below).
IpxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
NetworkType string
ProjectSshKeyIds List<string>
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).
Tags List<string>: Tags attached to the device
UserData string: A string of the desired User Data for the device.
WaitForReservationDeprovision bool: 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).

BillingCycle string: monthly or hourly
Facilities []string: List of facility codes with deployment preferences. Packet 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.
Hostname string: The device name
OperatingSystem string: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
ProjectId string: The ID of the project in which to create the device
AlwaysPxe bool: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
Description string: Description string for the device
ForceDetachVolumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
HardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
IpAddresses []DeviceIpAddress: A list of IP address types for the device (structure is documented below).
IpxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
NetworkType string
ProjectSshKeyIds []string
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).
Tags []string: Tags attached to the device
UserData string: A string of the desired User Data for the device.
WaitForReservationDeprovision bool: 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).

billingCycle BillingCycle: monthly or hourly
facilities Facility[]: List of facility codes with deployment preferences. Packet 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.
hostname string: The device name
operatingSystem 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 Plan: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
projectId string: The ID of the project in which to create the device
alwaysPxe boolean: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
description string: Description string for the device
forceDetachVolumes boolean: Delete device even if it has volumes attached. Only applies for destroy action.
hardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
ipAddresses DeviceIpAddress[]: A list of IP address types for the device (structure is documented below).
ipxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
networkType NetworkType
projectSshKeyIds string[]
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).
tags string[]: Tags attached to the device
userData string: A string of the desired User Data for the device.
waitForReservationDeprovision boolean: 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).

billing_cycle str: monthly or hourly
facilities List[Facility]: List of facility codes with deployment preferences. Packet 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.
hostname str: The device name
operating_system str: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
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.
description str: Description string for the device
force_detach_volumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
hardware_reservation_id str: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
ip_addresses List[DeviceIpAddress]: A list of IP address types for the device (structure is documented below).
ipxe_script_url str: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
network_type str
project_ssh_key_ids List[str]
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).
tags List[str]: Tags attached to the device
user_data str: A string of the desired User Data for the device.
wait_for_reservation_deprovision bool: 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:

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
AccessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
Created string: The timestamp for when the device was created
DeployedFacility string: The facility where the device is deployed.
Id string: The provider-assigned unique ID for this managed resource.
Locked bool: Whether the device is locked
Networks List<DeviceNetwork>: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
Ports List<DevicePort>: Ports assigned to the device
RootPassword string: Root password to the server (disabled after 24 hours)
SshKeyIds List<string>: 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

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
AccessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
Created string: The timestamp for when the device was created
DeployedFacility string: The facility where the device is deployed.
Id string: The provider-assigned unique ID for this managed resource.
Locked bool: Whether the device is locked
Networks []DeviceNetwork: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
Ports []DevicePort: Ports assigned to the device
RootPassword string: Root password to the server (disabled after 24 hours)
SshKeyIds []string: 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

accessPrivateIpv4 string: The ipv4 private IP assigned to the device
accessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
accessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
created string: The timestamp for when the device was created
deployedFacility string: The facility where the device is deployed.
id string: The provider-assigned unique ID for this managed resource.
locked boolean: Whether the device is locked
networks DeviceNetwork[]: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
ports DevicePort[]: Ports assigned to the device
rootPassword string: Root password to the server (disabled after 24 hours)
sshKeyIds string[]: 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_ipv4 str: The ipv4 private IP assigned to the device
access_public_ipv4 str: The ipv4 maintenance IP assigned to the device
access_public_ipv6 str: The ipv6 maintenance IP assigned to the device
created str: The timestamp for when the device was created
deployed_facility str: The facility where the device is deployed.
id str: The provider-assigned unique ID for this managed resource.
locked bool: Whether the device is locked
networks List[DeviceNetwork]: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
ports List[DevicePort]: Ports assigned to the device
root_password str: Root password to the server (disabled after 24 hours)
ssh_key_ids List[str]: 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

Look up an 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

static get(resource_name, id, opts=None, access_private_ipv4=None, access_public_ipv4=None, access_public_ipv6=None, always_pxe=None, billing_cycle=None, created=None, deployed_facility=None, description=None, facilities=None, force_detach_volumes=None, hardware_reservation_id=None, hostname=None, ip_addresses=None, ipxe_script_url=None, locked=None, network_type=None, networks=None, operating_system=None, plan=None, ports=None, project_id=None, project_ssh_key_ids=None, root_password=None, ssh_key_ids=None, state=None, storage=None, tags=None, updated=None, user_data=None, wait_for_reservation_deprovision=None, __props__=None);

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)

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.

The following state arguments are supported:

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
AccessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
AlwaysPxe bool: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
BillingCycle string: monthly or hourly
Created string: The timestamp for when the device was created
DeployedFacility string: The facility where the device is deployed.
Description string: Description string for the device
Facilities List<string>: List of facility codes with deployment preferences. Packet 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.
ForceDetachVolumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
HardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
Hostname string: The device name
IpAddresses List<DeviceIpAddressArgs>: A list of IP address types for the device (structure is documented below).
IpxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
Locked bool: Whether the device is locked
NetworkType string
Networks List<DeviceNetworkArgs>: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
OperatingSystem string: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
Ports List<DevicePortArgs>: Ports assigned to the device
ProjectId string: The ID of the project in which to create the device
ProjectSshKeyIds List<string>
RootPassword string: Root password to the server (disabled after 24 hours)
SshKeyIds List<string>: 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).
Tags List<string>: Tags attached to the device
Updated string: The timestamp for the last time the device was updated
UserData string: A string of the desired User Data for the device.
WaitForReservationDeprovision bool: 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).

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
AccessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
AlwaysPxe bool: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
BillingCycle string: monthly or hourly
Created string: The timestamp for when the device was created
DeployedFacility string: The facility where the device is deployed.
Description string: Description string for the device
Facilities []string: List of facility codes with deployment preferences. Packet 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.
ForceDetachVolumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
HardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
Hostname string: The device name
IpAddresses []DeviceIpAddress: A list of IP address types for the device (structure is documented below).
IpxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
Locked bool: Whether the device is locked
NetworkType string
Networks []DeviceNetwork: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
OperatingSystem string: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
Ports []DevicePort: Ports assigned to the device
ProjectId string: The ID of the project in which to create the device
ProjectSshKeyIds []string
RootPassword string: Root password to the server (disabled after 24 hours)
SshKeyIds []string: 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).
Tags []string: Tags attached to the device
Updated string: The timestamp for the last time the device was updated
UserData string: A string of the desired User Data for the device.
WaitForReservationDeprovision bool: 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).

accessPrivateIpv4 string: The ipv4 private IP assigned to the device
accessPublicIpv4 string: The ipv4 maintenance IP assigned to the device
accessPublicIpv6 string: The ipv6 maintenance IP assigned to the device
alwaysPxe boolean: If true, a device with OS custom_ipxe will continue to boot via iPXE on reboots.
billingCycle BillingCycle: monthly or hourly
created string: The timestamp for when the device was created
deployedFacility string: The facility where the device is deployed.
description string: Description string for the device
facilities Facility[]: List of facility codes with deployment preferences. Packet 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.
forceDetachVolumes boolean: Delete device even if it has volumes attached. Only applies for destroy action.
hardwareReservationId string: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
hostname string: The device name
ipAddresses DeviceIpAddress[]: A list of IP address types for the device (structure is documented below).
ipxeScriptUrl string: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
locked boolean: Whether the device is locked
networkType NetworkType
networks DeviceNetwork[]: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
operatingSystem 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 Plan: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
ports DevicePort[]: Ports assigned to the device
projectId string: The ID of the project in which to create the device
projectSshKeyIds string[]
rootPassword string: Root password to the server (disabled after 24 hours)
sshKeyIds string[]: 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).
tags string[]: Tags attached to the device
updated string: The timestamp for the last time the device was updated
userData string: A string of the desired User Data for the device.
waitForReservationDeprovision boolean: 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_ipv4 str: The ipv4 private IP assigned to the device
access_public_ipv4 str: The ipv4 maintenance IP assigned to the device
access_public_ipv6 str: 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.
billing_cycle str: monthly or hourly
created str: The timestamp for when the device was created
deployed_facility str: The facility where the device is deployed.
description str: Description string for the device
facilities List[Facility]: List of facility codes with deployment preferences. Packet 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.
force_detach_volumes bool: Delete device even if it has volumes attached. Only applies for destroy action.
hardware_reservation_id str: The ID of hardware reservation which this device occupies * hostname- The hostname of the device
hostname str: The device name
ip_addresses List[DeviceIpAddress]: A list of IP address types for the device (structure is documented below).
ipxe_script_url str: URL pointing to a hosted iPXE script. More information is in the Custom iPXE doc.
locked bool: Whether the device is locked
network_type str
networks List[DeviceNetwork]: 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 networks: * Public IPv4 at packet_device.name.network.0 * IPv6 at packet_device.name.network.1 * Private IPv4 at packet_device.name.network.2 Elastic addresses then stack by type - an assigned public IPv4 will go after the management public IPv4 (to index 1), and will then shift the indices of the IPv6 and private IPv4. Assigned private IPv4 will go after the management private IPv4 (to the end of the network list). The fields of the network attributes are:
operating_system str: 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: The device plan slug. To find the plan slug, visit Device plans API docs, set your auth token in the top of the page and see JSON from the API response.
ports List[DevicePort]: Ports assigned to the device
project_id str: The ID of the project in which to create the device
project_ssh_key_ids List[str]
root_password str: Root password to the server (disabled after 24 hours)
ssh_key_ids List[str]: 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).
tags List[str]: Tags attached to the device
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.
wait_for_reservation_deprovision bool: 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

DeviceIpAddress

See the input and output API doc for this type.

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.
ReservationIds List<string>

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.
ReservationIds []string

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.
reservationIds string[]

type str: One of [private_ipv4, public_ipv4, public_ipv6]
cidr float: CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
reservationIds List[str]

DeviceNetwork

See the output API doc for this type.

Address string: IPv4 or IPv6 address string
Cidr int: CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
Family int: IP version - “4” or “6”
Gateway string: address of router
Public bool: whether the address is routable from the Internet

Address string: IPv4 or IPv6 address string
Cidr int: CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
Family int: IP version - “4” or “6”
Gateway string: address of router
Public bool: whether the address is routable from the Internet

address string: IPv4 or IPv6 address string
cidr number: CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
family number: IP version - “4” or “6”
gateway string: address of router
public boolean: whether the address is routable from the Internet

address str: IPv4 or IPv6 address string
cidr float: CIDR suffix for IP address block to be assigned, i.e. amount of addresses.
family float: IP version - “4” or “6”
gateway str: address of router
public bool: whether the address is routable from the Internet

DevicePort

See the output API doc for this type.

Bonded bool: Whether this port is part of a bond in bonded network setup * project_id- The ID of the project the device belongs to
Id string: ID of the port
Mac string: MAC address assigned to the port
Name string: Name of the port (e.g. eth0, or bond0)
Type string: One of [private_ipv4, public_ipv4, public_ipv6]

Bonded bool: Whether this port is part of a bond in bonded network setup * project_id- The ID of the project the device belongs to
Id string: ID of the port
Mac string: MAC address assigned to the port
Name string: Name of the port (e.g. eth0, or bond0)
Type string: One of [private_ipv4, public_ipv4, public_ipv6]

bonded boolean: Whether this port is part of a bond in bonded network setup * project_id- The ID of the project the device belongs to
id string: ID of the port
mac string: MAC address assigned to the port
name string: Name of the port (e.g. eth0, or bond0)
type string: One of [private_ipv4, public_ipv4, public_ipv6]

bonded bool: Whether this port is part of a bond in bonded network setup * project_id- The ID of the project the device belongs to
id str: ID of the port
mac str: MAC address assigned to the port
name str: Name of the port (e.g. eth0, or bond0)
type str: One of [private_ipv4, public_ipv4, public_ipv6]

Package Details

Repository: https://github.com/pulumi/pulumi-packet
License: Apache-2.0
Notes: This Pulumi package is based on the packet Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud