Documentation
¶
Index ¶
- type API
- func (a *API) AddKey(name, key string) (string, error)
- func (a *API) CreateDevice(hostname string, conf *conf.Conf, console Console) (*packngo.Device, error)
- func (a *API) DeleteDevice(deviceID string) error
- func (a *API) DeleteKey(keyID string) error
- func (a *API) GC(gracePeriod time.Duration) error
- func (a *API) GetDeviceAddress(device *packngo.Device, family int, public bool) string
- func (a *API) ListKeys() ([]packngo.SSHKey, error)
- func (a *API) PreflightCheck() error
- type Console
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
// contains filtered or unexported fields
}
func (*API) CreateDevice ¶
func (a *API) CreateDevice(hostname string, conf *conf.Conf, console Console) (*packngo.Device, error)
console is optional, and is closed on error or when the device is deleted.
func (*API) DeleteDevice ¶
func (*API) GetDeviceAddress ¶
func (*API) PreflightCheck ¶
type Options ¶
type Options struct {
*platform.Options
// Config file. Defaults to $HOME/.config/packet.json.
ConfigPath string
// Profile name
Profile string
// API key (overrides config profile)
ApiKey string
// Project UUID (overrides config profile)
Project string
// Packet location code
Facility string
// Slug of the device type (e.g. "t1.small.x86")
Plan string
// CPU architecture
Architecture string
// e.g. https://raw.githubusercontent.com/coreos/coreos-assembler/main/mantle/platform/api/packet/fcos-x86_64.ipxe
IPXEURL string
// e.g. https://builds.coreos.fedoraproject.org/prod/streams/stable/builds/31.20200223.3.0/x86_64/fedora-coreos-31.20200223.3.0-metal.x86_64.raw.xz
ImageURL string
}
Click to show internal directories.
Click to hide internal directories.