vm

Documentation

Overview

Package vm implements API functions residing under /provisioning/vm. This path contains methods for provision- and deprovisioning VMs.

Index

• Constants
• Variables
• type API
  • func NewAPI(c client.Client) API
• type Change
  • func NewChange() Change
• type Definition
• type DeprovisionResponse
• type Disk
• type Network
• type ProvisioningResponse

Constants

const (

	// DefaultCPUPerformanceType to be used if a VM definition is created
	// by NewDefinition.
	DefaultCPUPerformanceType = "performance"
	// DefaultDiskType to be used if a VM definition is created
	// by NewDefinition.
	DefaultDiskType = "ENT2"
)

Variables

var ErrProvisioning = errors.New("ProvisioningResponse contains errors")

ErrProvisioning is raised if the API returns an error.

Types

type API

type API interface {
	NewDefinition(location, templateType, templateID, hostname string, cpus, memory, disk int, network []Network) Definition
	Deprovision(ctx context.Context, identifier string, delayed bool) (DeprovisionResponse, error)
	Provision(ctx context.Context, definition Definition, base64Encoding bool) (ProvisioningResponse, error)
	Update(ctx context.Context, vmID string, change Change) (ProvisioningResponse, error)
}

API contains methods for VM provisioning.

func NewAPI

func NewAPI(c client.Client) API

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

type Change

type Change struct {
	MemoryMBs          int       `json:"memory_mb,omitempty"`
	CPUs               int       `json:"cpus,omitempty"`
	CPUSockets         int       `json:"sockets,omitempty"`
	CPUPerformanceType string    `json:"cpu_performance_type,omitempty"`
	DeleteDiskIDs      []int     `json:"disk_to_delete,omitempty"`
	AddDisks           []Disk    `json:"disk_to_add,omitempty"`
	ChangeDisks        []Disk    `json:"disk_to_change,omitempty"`
	AddNICs            []Network `json:"network_to_add,omitempty"`
	BootDelaySecs      int       `json:"boot_delay,omitempty"`
	EnterBIOSSetup     bool      `json:"enter_bios_setup,omitempty"`
	Reboot             bool      `json:"force_restart_if_needed,omitempty"`
	EnableDangerous    bool      `json:"critical_operation_confirmed,omitempty"`
}

Change contains information about requested VM change request.

func NewChange

func NewChange() Change

NewChange create a VM change request with default values.

type Definition

type Definition struct {
	Location     string `json:"-"`
	TemplateType string `json:"-"`
	TemplateID   string `json:"-"`

	// Required - VM hostname
	// Example: ('my-awesome-new-vm', 'web-001', 'db-001', …)
	// The hostname will be auto prefixed with your customer id.
	Hostname string `json:"hostname"`

	// Required - Memory in MB
	// Example: (1024, 2048, 4096, 8192, …)
	// Default: as given in template.
	Memory int `json:"memory_mb"`

	// Required - Amount of CPUs
	// Example: (1, 2, 3, 4 ,…)
	// Default: as given in template.
	CPUs int `json:"cpus"`

	// Required - Disk capacity in GB
	// Example: (1, 2, 4, 5, …)
	// Default: as given in template.
	Disk int `json:"disk_gb"`

	// Disk category (limits disk performance, e.g. IOPS)
	// Example: ('STD1', 'ENT2','HPC1',…)
	// Default: as defined by data center.
	DiskType string `json:"disk_type,omitempty"`

	// CPU type
	// Example: ("best-effort", "standard", "enterprise", "performance")
	// Default: "standard".
	CPUPerformanceType string `json:"cpu_performance_type,omitempty"`

	// Amount of CPU sockets Number of cores have to be a multiple of sockets, as they will be spread evenly across all sockets.
	// Default: number of cores, i.e. one socket per CPU core.
	Sockets int `json:"sockets,omitempty"`

	// Network interfaces
	// IPs are ignored when using template_type "from_scratch".
	Network []Network `json:"network,omitempty"`

	// Primary DNS server
	// Example: '94.16.16.94'
	// Default: as given in template.
	DNS1 string `json:"dns1,omitempty"`

	// Secondary DNS server
	// Example: '94.16.16.16'
	// Default: as given in template.
	DNS2 string `json:"dns2,omitempty"`

	// Tertiary DNS server
	// Example: '2a00:11c0:11c0::2a00'
	// Default: as given in template.
	DNS3 string `json:"dns3,omitempty"`

	// Quaternary DNS server
	// Example: '2a00:11c0:11c0::11c0'
	// Default: as given in template.
	DNS4 string `json:"dns4,omitempty"`

	// Plaintext password
	// Example: ('!anx123mySuperStrongPassword123anx!', 'go3ju0la1ro3', …)
	// USE IT AT YOUR OWN RISK! (or SSH key instead).
	Password string `json:"password,omitempty"`

	// Public key (instead of password, only for Linux systems)
	// Recommended over providing a plaintext password.
	SSH string `json:"ssh,omitempty"`

	// Script to be executed after provisioning
	// Should be base64 encoded
	// Consider the corresponding shebang at the beginning of your script.
	// If you want to use PowerShell, the first line should be: #ps1_sysnative.
	Script string `json:"script,omitempty"`

	// Boot delay in seconds
	// Default: 0.
	BootDelay int `json:"boot_delay,omitempty"`

	// Start the VM into BIOS setup on next boot
	// Default: false.
	EnterBIOSSetup bool `json:"enter_bios_setup,omitempty"`

	// Customer identifier (reseller only).
	Organization string `json:"organization,omitempty"`
}

Definition states the configuration of a VM within the anxcloud.

type DeprovisionResponse

type DeprovisionResponse struct {
	Identifier             string `json:"identifier"`
	DeleteWillBeExecutedAt string `json:"delete_will_be_executed_at"`
}

type Disk

type Disk struct {
	ID      int    `json:"disk_id,omitempty"`
	Type    string `json:"disk_type"`
	SizeGBs int    `json:"disk_gb"`
}

Disk represents a disk of a VM.

type Network

type Network struct {
	// Example: "vmxnet3"
	NICType string `json:"nic_type,omitempty"`

	// Example: "791e8c171e654b459a7fcbbc07675cf3"
	VLAN string `json:"vlan,omitempty"`

	// Example: [ "identifier1", "identifier2", "10.11.12.13", "1.0.0.1" ]
	IPs []string `json:"ips,omitempty"`
}

Network defines the network configuration of a VM.

type ProvisioningResponse

type ProvisioningResponse struct {
	Progress   int      `json:"progress"`
	Errors     []string `json:"errors"`
	Identifier string   `json:"identifier"`
	Queued     bool     `json:"queued"`
}

ProvisioningResponse contains information returned by the API regarding a newly created VM.