info

Documentation

Overview

Package info implements API functions residing under /info. This path contains methods to query information about created VMs.

Index

• type API
  • func NewAPI(c client.Client) API
• type DiskInfo
• type Info
• type Network

Types

type API

type API interface {
	Get(ctx context.Context, identifier string) (Info, error)
}

API contains methods for VM info querying.

func NewAPI

func NewAPI(c client.Client) API

NewAPI creates a new info API instance with the given client.

type DiskInfo

type DiskInfo struct {
	DiskType     string  `json:"disk_type"`
	StorageType  string  `json:"storage_type"`
	BusType      string  `json:"bus_type"`
	BusTypeLabel string  `json:"bus_type_label"`
	DiskGB       float64 `json:"disk_gb"`
	DiskID       int     `json:"disk_id"`
	IOPS         int     `json:"iops"`
	Latency      int     `json:"latence"`
}

DiskInfo contains meta information of attached disks to a VM.

type Info

type Info struct {
	Name             string     `json:"name"`
	CustomName       string     `json:"custom_name"`
	Identifier       string     `json:"identifier"`
	GuestOS          string     `json:"guest_os"`
	LocationID       string     `json:"location_identifier"`
	LocationCode     string     `json:"location_code"`
	LocationCountry  string     `json:"location_country"`
	LocationName     string     `json:"location_name"`
	TemplateID       string     `json:"template_id"`
	TemplateType     string     `json:"template_type"`
	Status           string     `json:"status"`
	VersionTools     string     `json:"version_tools"`
	GuestToolsStatus string     `json:"guest_tools_status"`
	RAM              int        `json:"ram"`
	CPU              int        `json:"cpu"`
	Cores            int        `json:"cores"`
	Disks            int        `json:"disks"`
	DiskInfo         []DiskInfo `json:"disk_info"`
	Network          []Network  `json:"network"`
}

Info contains meta information of a VM.

type Network

type Network struct {
	NIC        int      `json:"nic"`
	ID         int      `json:"id"`
	VLAN       string   `json:"vlan"`
	MACAddress string   `json:"mac_address"`
	IPv4       []string `json:"ips_v4"`
	IPv6       []string `json:"ips_v6"`
}

Network contains meta information of attached NICs to a VM.