GetDevice

Provides a Packet device datasource.

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.

Using GetDevice

function getDevice(args: GetDeviceArgs, opts?: InvokeOptions): Promise<GetDeviceResult>

function  get_device(device_id=None, hostname=None, project_id=None, opts=None)

func LookupDevice(ctx *Context, args *LookupDeviceArgs, opts ...InvokeOption) (*LookupDeviceResult, error)

Note: This function is named LookupDevice in the Go SDK.

public static class GetDevice {
    public static Task<GetDeviceResult> InvokeAsync(GetDeviceArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DeviceId string: Device ID
Hostname string: The device name
ProjectId string: The id of the project in which the devices exists

DeviceId string: Device ID
Hostname string: The device name
ProjectId string: The id of the project in which the devices exists

deviceId string: Device ID
hostname string: The device name
projectId string: The id of the project in which the devices exists

device_id str: Device ID
hostname str: The device name
project_id str: The id of the project in which the devices exists

GetDevice Result

The following output properties are available:

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 management IP assigned to the device
AccessPublicIpv6 string: The ipv6 management IP assigned to the device
AlwaysPxe bool
BillingCycle string: The billing cycle of the device (monthly or hourly)
Description string: Description string for the device
DeviceId string
Facility string: The facility where the device is deployed.
HardwareReservationId string: The id of hardware reservation which this device occupies
Hostname string
Id string: The provider-assigned unique ID for this managed resource.
IpxeScriptUrl string
NetworkType string: L2 network type of the device, one of “layer3”, “layer2-bonded”, “layer2-individual”, “hybrid”
Networks List<GetDeviceNetwork>: 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 running on the device
Plan string: The hardware config of the device
Ports List<GetDevicePort>: Ports assigned to the device
ProjectId string
RootPassword string: Root password to the server (if still available)
SshKeyIds List<string>: List of IDs of SSH keys deployed in the device, can be both user or project SSH keys
State string: The state of the device
Storage string
Tags List<string>: Tags attached to the device

AccessPrivateIpv4 string: The ipv4 private IP assigned to the device
AccessPublicIpv4 string: The ipv4 management IP assigned to the device
AccessPublicIpv6 string: The ipv6 management IP assigned to the device
AlwaysPxe bool
BillingCycle string: The billing cycle of the device (monthly or hourly)
Description string: Description string for the device
DeviceId string
Facility string: The facility where the device is deployed.
HardwareReservationId string: The id of hardware reservation which this device occupies
Hostname string
Id string: The provider-assigned unique ID for this managed resource.
IpxeScriptUrl string
NetworkType string: L2 network type of the device, one of “layer3”, “layer2-bonded”, “layer2-individual”, “hybrid”
Networks []GetDeviceNetwork: 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 running on the device
Plan string: The hardware config of the device
Ports []GetDevicePort: Ports assigned to the device
ProjectId string
RootPassword string: Root password to the server (if still available)
SshKeyIds []string: List of IDs of SSH keys deployed in the device, can be both user or project SSH keys
State string: The state of the device
Storage string
Tags []string: Tags attached to the device

accessPrivateIpv4 string: The ipv4 private IP assigned to the device
accessPublicIpv4 string: The ipv4 management IP assigned to the device
accessPublicIpv6 string: The ipv6 management IP assigned to the device
alwaysPxe boolean
billingCycle string: The billing cycle of the device (monthly or hourly)
description string: Description string for the device
deviceId string
facility string: The facility where the device is deployed.
hardwareReservationId string: The id of hardware reservation which this device occupies
hostname string
id string: The provider-assigned unique ID for this managed resource.
ipxeScriptUrl string
networkType string: L2 network type of the device, one of “layer3”, “layer2-bonded”, “layer2-individual”, “hybrid”
networks GetDeviceNetwork[]: 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 running on the device
plan string: The hardware config of the device
ports GetDevicePort[]: Ports assigned to the device
projectId string
rootPassword string: Root password to the server (if still available)
sshKeyIds string[]: List of IDs of SSH keys deployed in the device, can be both user or project SSH keys
state string: The state of the device
storage string
tags string[]: Tags attached to the device

access_private_ipv4 str: The ipv4 private IP assigned to the device
access_public_ipv4 str: The ipv4 management IP assigned to the device
access_public_ipv6 str: The ipv6 management IP assigned to the device
always_pxe bool
billing_cycle str: The billing cycle of the device (monthly or hourly)
description str: Description string for the device
device_id str
facility str: The facility where the device is deployed.
hardware_reservation_id str: The id of hardware reservation which this device occupies
hostname str
id str: The provider-assigned unique ID for this managed resource.
ipxe_script_url str
network_type str: L2 network type of the device, one of “layer3”, “layer2-bonded”, “layer2-individual”, “hybrid”
networks List[GetDeviceNetwork]: 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 running on the device
plan str: The hardware config of the device
ports List[GetDevicePort]: Ports assigned to the device
project_id str
root_password str: Root password to the server (if still available)
ssh_key_ids List[str]: List of IDs of SSH keys deployed in the device, can be both user or project SSH keys
state str: The state of the device
storage str
tags List[str]: Tags attached to the device

Supporting Types

GetDeviceNetwork

See the output API doc for this type.

Address string: IPv4 or IPv6 address string
Cidr int: Bit length of the network mask of the address
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: Bit length of the network mask of the address
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: Bit length of the network mask of the address
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: Bit length of the network mask of the address
family float: IP version - “4” or “6”
gateway str: Address of router
public bool: Whether the address is routable from the Internet

GetDevicePort

See the output API doc for this type.

Bonded bool: Whether this port is part of a bond in bonded network setup
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: Type of the port (e.g. NetworkPort or NetworkBondPort)

Bonded bool: Whether this port is part of a bond in bonded network setup
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: Type of the port (e.g. NetworkPort or NetworkBondPort)

bonded boolean: Whether this port is part of a bond in bonded network setup
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: Type of the port (e.g. NetworkPort or NetworkBondPort)

bonded bool: Whether this port is part of a bond in bonded network setup
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: Type of the port (e.g. NetworkPort or NetworkBondPort)

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

GetDevice

Using GetDevice

GetDevice Result

Supporting Types

GetDeviceNetwork

GetDevicePort

Package Details

On This Page