1. Docs
  2. Reference
  3. API
  4. @pulumi/packet
  5. types
  6. output

Module types/output

APIs

APIs

interface DeviceIpAddress

interface DeviceIpAddress

property cidr

cidr?: undefined | number;

CIDR suffix for IP address block to be assigned, i.e. amount of addresses.

property reservationIds

reservationIds?: string[];

property type

type: string;

One of [privateIpv4, publicIpv4, publicIpv6]

interface DeviceNetwork

interface DeviceNetwork

property address

address: string;

IPv4 or IPv6 address string

property cidr

cidr: number;

CIDR suffix for IP address block to be assigned, i.e. amount of addresses.

property family

family: number;

IP version - “4” or “6”

property gateway

gateway: string;

address of router

property public

public: boolean;

whether the address is routable from the Internet

interface DevicePort

interface DevicePort

property bonded

bonded: boolean;

Whether this port is part of a bond in bonded network setup * projectId- The ID of the project the device belongs to

property id

id: string;

ID of the port

property mac

mac: string;

MAC address assigned to the port

property name

name: string;

Name of the port (e.g. eth0, or bond0)

property type

type: string;

One of [privateIpv4, publicIpv4, publicIpv6]

interface GetDeviceBgpNeighborsBgpNeighbor

interface GetDeviceBgpNeighborsBgpNeighbor

property addressFamily

addressFamily: number;

IP address version, 4 or 6

property customerAs

customerAs: number;

Local autonomous system number

property customerIp

customerIp: string;

Local used peer IP address

property md5Enabled

md5Enabled: boolean;

Whether BGP session is password enabled

property md5Password

md5Password: string;

BGP session password in plaintext (not a checksum)

property multihop

multihop: boolean;

Whether the neighbor is in EBGP multihop session

property peerAs

peerAs: number;

Peer AS number (different than customerAs for EBGP)

property peerIps

peerIps?: string[];

Array of IP addresses of this neighbor’s peers

property routesIns

routesIns: GetDeviceBgpNeighborsBgpNeighborRoutesIn[];

Array of incoming routes. Each route has attributes:

property routesOuts

routesOuts: GetDeviceBgpNeighborsBgpNeighborRoutesOut[];

Array of outgoing routes in the same format

interface GetDeviceBgpNeighborsBgpNeighborRoutesIn

interface GetDeviceBgpNeighborsBgpNeighborRoutesIn

property exact

exact: boolean;

(bool) Whether the route is exact

property route

route: string;

CIDR expression of route (ip/mask)

interface GetDeviceBgpNeighborsBgpNeighborRoutesOut

interface GetDeviceBgpNeighborsBgpNeighborRoutesOut

property exact

exact: boolean;

(bool) Whether the route is exact

property route

route: string;

CIDR expression of route (ip/mask)

interface GetDeviceNetwork

interface GetDeviceNetwork

property address

address: string;

IPv4 or IPv6 address string

property cidr

cidr: number;

Bit length of the network mask of the address

property family

family: number;

IP version - “4” or “6”

property gateway

gateway: string;

Address of router

property public

public: boolean;

Whether the address is routable from the Internet

interface GetDevicePort

interface GetDevicePort

property bonded

bonded: boolean;

Whether this port is part of a bond in bonded network setup

property id

id: string;

ID of the port

property mac

mac: string;

MAC address assigned to the port

property name

name: string;

Name of the port (e.g. eth0, or bond0)

property type

type: string;

Type of the port (e.g. NetworkPort or NetworkBondPort)

interface GetProjectBgpConfig

interface GetProjectBgpConfig

property asn

asn: number;

Autonomous System Numer for local BGP deployment

property deploymentType

deploymentType: string;

private or public, the private is likely to be usable immediately, the public will need to be review by Packet engineers

property maxPrefix

maxPrefix: number;

The maximum number of route filters allowed per server

property md5

md5?: undefined | string;

Password for BGP session in plaintext (not a checksum)

property status

status: string;

status of BGP configuration in the project

interface GetVolumeSnapshotPolicy

interface GetVolumeSnapshotPolicy

property snapshotCount

snapshotCount: number;

property snapshotFrequency

snapshotFrequency: string;

interface ProjectBgpConfig

interface ProjectBgpConfig

property asn

asn: number;

Autonomous System Number for local BGP deployment

property deploymentType

deploymentType: string;

private or public, the private is likely to be usable immediately, the public will need to be review by Packet engineers

property maxPrefix

maxPrefix: number;

The maximum number of route filters allowed per server

property md5

md5?: undefined | string;

Password for BGP session in plaintext (not a checksum)

property status

status: string;

status of BGP configuration in the project

interface SpotMarketRequestInstanceParameters

interface SpotMarketRequestInstanceParameters

property alwaysPxe

alwaysPxe?: undefined | string;

property billingCycle

billingCycle: string;

property description

description?: undefined | string;

property features

features?: string[];

property hostname

hostname: string;

property locked

locked?: undefined | string;

property operatingSystem

operatingSystem: string;

property plan

plan: string;

property projectSshKeys

projectSshKeys?: string[];

property termintationTime

termintationTime: string;

property userSshKeys

userSshKeys?: string[];

property userdata

userdata?: undefined | string;

interface VolumeAttachment

interface VolumeAttachment

property href

href: string;

interface VolumeSnapshotPolicy

interface VolumeSnapshotPolicy

property snapshotCount

snapshotCount: number;

property snapshotFrequency

snapshotFrequency: string;