instance

Documentation

Overview

Package instance contains structs for the Instance payload.

Index

• func ActionStrings() []string
• func StateStrings() []string
• type Action
  • func ActionString(s string) (Action, error)
  • func ActionValues() []Action
  • func (i Action) IsAAction() bool
  • func (i Action) MarshalText() ([]byte, error)
  • func (i Action) String() string
  • func (i *Action) UnmarshalText(text []byte) error
• type CPUModel
• type Context
• type Disk
• type DiskSize
• type DiskSnapshots
• type Graphics
• type GroupRole
• type History
• type ImageSnapshot
• type Monitoring
• type NIC
• type NICAlias
• type OS
• type SchedAction
• type Snapshot
• type Snapshots
• type State
  • func StateString(s string) (State, error)
  • func StateValues() []State
  • func (i State) IsAState() bool
  • func (i State) MarshalText() ([]byte, error)
  • func (i State) String() string
  • func (i *State) UnmarshalText(text []byte) error
  • func (s State) V1() hc.InstanceState
• type Template
• type UserTemplate

Functions

func ActionStrings

func ActionStrings() []string

ActionStrings returns a slice of all String values of the enum

func StateStrings

func StateStrings() []string

StateStrings returns a slice of all String values of the enum

Types

type Action

type Action int

Action is the action to perform on an intstance.

const (
	NoneAction               Action = iota // none
	MigrateAction                          // migrate
	LiveMigrateAction                      // live-migrate
	ShutdownAction                         // shutdown
	ShutdownHardAction                     // shutdown-hard
	UndeployAction                         // undeploy
	UndeployHardAction                     // undeploy-hard
	HoldAction                             // hold
	ReleaseAction                          // release
	StopAction                             // stop
	SuspendAction                          // suspend
	ResumeAction                           // resume
	BootAction                             // boot
	DeleteAction                           // delete
	DeleteRecreateAction                   // delete-recreate
	RebootAction                           // reboot
	RebootHardAction                       // reboot-hard
	RescheduleAction                       // resched
	UnrescheduleAction                     // unresched
	PowerOffAction                         // poweroff
	PowerOffHardAction                     // poweroff-hard
	DiskAttachAction                       // disk-attach
	DiskDetachAction                       // disk-detach
	NicAttachAction                        // nic-attach
	NicDetachAction                        // nic-detach
	DiskSnapshotCreateAction               // disk-snapshot-create
	DiskSnapshotDeleteAction               // disk-snapshot-delete
	TerminateAction                        // terminate
	TerminateHardAction                    // terminate-hard
	DiskResizeAction                       // disk-resize
	DeployAction                           // deploy
	ChownAction                            // chown
	ChmodAction                            // chmod
	UpdateconfAction                       // updateconf
	RenameAction                           // rename
	ResizeAction                           // resize
	UpdateAction                           // update
	SnapshotCreateAction                   // snapshot-create
	SnapshotDeleteAction                   // snapshot-delete
	SnapshotRevertAction                   // snapshot-revert
	DiskSaveasAction                       // disk-saveas
	DiskSnapshotRevertAction               // disk-snapshot-revert
	RecoverAction                          // recover
	RetryAction                            // retry
	MonitorAction                          // monitor
	DiskSnapshotRenameAction               // disk-snapshot-rename
	AliasAttachAction                      // alias-attach
	AliasDetachAction                      // alias-detach
	PoffMigrateAction                      // poff-migrate
	PoffHardMigrateAction                  // poff-hard-migrate
)

Action values.

func ActionString

func ActionString(s string) (Action, error)

ActionString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ActionValues

func ActionValues() []Action

ActionValues returns all values of the enum

func (Action) IsAAction

func (i Action) IsAAction() bool

IsAAction returns "true" if the value is listed in the enum definition. "false" otherwise

func (Action) MarshalText

func (i Action) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for Action

func (Action) String

func (i Action) String() string

func (*Action) UnmarshalText

func (i *Action) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for Action

type CPUModel

type CPUModel struct {
	Values map[string]string `json:"values" yaml:"values"`
	Model  string            `json:"model" yaml:"model"`
}

CPUModel is the API payload based on the legacy xmlrpc backend.

type Context

type Context struct {
	Values       map[string]string `json:"values" yaml:"values"`
	DiskID       int               `json:"disk_id" yaml:"disk_id"`
	Firmware     string            `json:"firmware" yaml:"firmware"`
	GuestOS      string            `json:"guest_os" yaml:"guest_os"`
	Network      bool              `json:"network" yaml:"network"`
	SSHPublicKey string            `json:"ssh_public_key" yaml:"ssh_public_key"`
	Target       string            `json:"target" yaml:"target"`
}

Context is the API payload based on the legacy xmlrpc backend.

type Disk

type Disk struct {
	Values                map[string]string `json:"values" yaml:"values"`
	Format                string            `json:"format" yaml:"format"`
	AllowOrphans          string            `json:"allow_orphans" yaml:"allow_orphans"`
	Clone                 bool              `json:"clone" yaml:"clone"`
	CloneTarget           string            `json:"clone_target" yaml:"clone_target"`
	ClusterID             int               `json:"cluster_id" yaml:"cluster_id"`
	Datastore             string            `json:"datastore" yaml:"datastore"`
	DatastoreID           int               `json:"datastore_id" yaml:"datastore_id"`
	DevPrefix             string            `json:"dev_prefix" yaml:"dev_prefix"`
	DiskID                int               `json:"disk_id" yaml:"disk_id"`
	DiskSnapshotTotalSize int               `json:"disk_snapshot_total_size" yaml:"disk_snapshot_total_size"`
	DiskType              string            `json:"disk_type" yaml:"disk_type"`
	Driver                string            `json:"driver" yaml:"driver"`
	Image                 string            `json:"image" yaml:"image"`
	ImageID               int               `json:"image_id" yaml:"image_id"`
	ImageState            int               `json:"image_state" yaml:"image_state"`
	ImageUserName         string            `json:"image_uname" yaml:"image_uname"`
	LnTarget              string            `json:"ln_target" yaml:"ln_target"`
	OriginalSize          int               `json:"original_size" yaml:"original_size"`
	Persistent            bool              `json:"persistent" yaml:"persistent"`
	PoolName              string            `json:"pool_name" yaml:"pool_name"`
	Readonly              bool              `json:"readonly" yaml:"readonly"`
	Save                  bool              `json:"save" yaml:"save"`
	Size                  int               `json:"size" yaml:"size"`
	Source                string            `json:"source" yaml:"source"`
	Target                string            `json:"target" yaml:"target"`
	TmMAD                 string            `json:"tm_mad" yaml:"tm_mad"`
	TmMADSystem           string            `json:"tm_madsystem" yaml:"tm_madsystem"`
	Type                  string            `json:"type" yaml:"type"`
	VCenterDSRef          string            `json:"vcenter_dsref" yaml:"vcenter_dsref"`
	VCenterInstanceID     string            `json:"vcenter_instance_id" yaml:"vcenter_instance_id"`
}

Disk is the API payload based on the legacy xmlrpc backend.

type DiskSize

type DiskSize struct {
	ID   int `json:"id" yaml:"id"`
	Size int `json:"size" yaml:"size"`
}

DiskSize is the API payload based on the legacy xmlrpc backend.

type DiskSnapshots

type DiskSnapshots struct {
	Snapshots
	DiskID int `json:"disk_id" yaml:"disk_id"`
}

DiskSnapshots is a Snapshots for a specific disk.

type Graphics

type Graphics struct {
	Values       map[string]string `json:"values" yaml:"values"`
	Listen       string            `json:"listen" yaml:"listen"`
	Port         int               `json:"port" yaml:"port"`
	GraphicsType string            `json:"type" yaml:"type"`
	Password     string            `json:"password" yaml:"password"`
	Keymap       string            `json:"keymap" yaml:"keymap"`
}

Graphics is the API payload based on the legacy xmlrpc backend.

type GroupRole

type GroupRole struct {
	HostAffined     string `json:"host_affined" yaml:"host_affined"`
	HostAntiAffined string `json:"host_anti_affined" yaml:"host_anti_affined"`
	ID              int    `json:"id" yaml:"id"`
	Name            string `json:"name" yaml:"name"`
	Policy          string `json:"policy" yaml:"policy"`
}

GroupRole is the API payload based on the legacy xmlrpc backend.

type History

type History struct {
	ID                 int      `json:"id" yaml:"id"`
	SequenceNumber     int      `json:"sequence_number" yaml:"sequence_number"`
	Hostname           string   `json:"hostname" yaml:"hostname"`
	HostID             int      `json:"host_id" yaml:"host_id"`
	ClusterID          int      `json:"cluster_id" yaml:"cluster_id"`
	StartTime          api.Time `json:"start_time" yaml:"start_time"`
	EndTime            api.Time `json:"end_time" yaml:"end_time"`
	InstanceMAD        string   `json:"instance_mad" yaml:"instance_mad"`
	TransferManagerMAD string   `json:"transfer_manager_mad" yaml:"transfer_manager_mad"`
	DatastoreID        int      `json:"datastore_id" yaml:"datastore_id"`
	PrologStartTime    api.Time `json:"prolog_start_time" yaml:"prolog_start_time"`
	PrologEndtime      api.Time `json:"prolog_end_time" yaml:"prolog_end_time"`
	RunningStartTime   api.Time `json:"running_start_time" yaml:"running_start_time"`
	RunningEndTime     api.Time `json:"running_end_time" yaml:"running_end_time"`
	EpilogStartTime    api.Time `json:"epilog_start_time" yaml:"epilog_start_time"`
	EpilogEndTime      api.Time `json:"epilog_end_time" yaml:"epilog_end_time"`
	Action             Action   `json:"action" yaml:"action"`
	UserID             int      `json:"user_id" yaml:"user_id"`
	GroupID            int      `json:"group_id" yaml:"group_id"`
	RequestID          int      `json:"request_id" yaml:"request_id"`
}

History is the API payload based on the legacy xmlrpc backend.

type ImageSnapshot

type ImageSnapshot struct {
	Active   string `json:"active" yaml:"active"`
	Children string `json:"children" yaml:"children"`
	Date     int    `json:"date" yaml:"date"`
	ID       int    `json:"id" yaml:"id"`
	Name     string `json:"name" yaml:"name"`
	Parent   int    `json:"parent" yaml:"parent"`
	Size     int    `json:"size" yaml:"size"`
}

ImageSnapshot is the API payload based on the legacy xmlrpc backend.

type Monitoring

type Monitoring struct {
	CPU                             float64    `json:"cpu" yaml:"cpu"`
	DiskReadBytes                   int        `json:"disk_read_bytes" yaml:"disk_read_bytes"`
	DiskReadIOps                    int        `json:"disk_read_iops" yaml:"disk_read_iops"`
	DiskWriteBytes                  int        `json:"disk_write_bytes" yaml:"disk_write_bytes"`
	DiskWriteIOps                   int        `json:"disk_write_iops" yaml:"disk_write_iops"`
	DiskSize                        []DiskSize `json:"disk_size" yaml:"disk_size"`
	ID                              int        `json:"id" yaml:"id"`
	Memory                          int        `json:"memory" yaml:"memory"`
	NetRX                           int        `json:"netrx" yaml:"netrx"`
	NetTX                           int        `json:"nettx" yaml:"nettx"`
	Timestamp                       api.Time   `json:"timestamp" yaml:"timestamp"`
	VCenterESXHost                  string     `json:"vcenter_esxhost" yaml:"vcenter_esxhost"`
	VCenterGuestState               string     `json:"vcenter_guest_state" yaml:"vcenter_guest_state"`
	VCenterRPName                   string     `json:"vcenter_rpname" yaml:"vcenter_rpname"`
	VCenterVMWareToolsRunningStatus string     `json:"vcenter_vmware_tools_running_status" yaml:"vcenter_vmware_tools_running_status"`
	VCenterVMWareToolsVersion       string     `json:"vcenter_vmware_tools_version" yaml:"vcenter_vmware_tools_version"`
	VCenterVMWareToolsVersionStatus string     `json:"vcenter_vmware_tools_version_status" yaml:"vcenter_vmware_tools_version_status"`
	VCenterVMName                   string     `json:"vcenter_vmname" yaml:"vcenter_vmname"`
}

Monitoring is the API payload based on the legacy xmlrpc backend.

type NIC

type NIC struct {
	Values               map[string]string `json:"values" yaml:"values"`
	ID                   int               `json:"id" yaml:"id"`
	NetworkID            int               `json:"network_id" yaml:"network_id"`
	IP                   string            `json:"ip" yaml:"ip"`
	MAC                  string            `json:"mac" yaml:"mac"`
	Model                string            `json:"model" yaml:"model"`
	VirtioQueues         string            `json:"virtio_queues" yaml:"virtio_queues"`
	Phydev               string            `json:"phy_dev" yaml:"phy_dev"`
	SecurityGroups       string            `json:"security_groups" yaml:"security_groups"`
	VCenterInstanceID    string            `json:"vcenter_instance_id" yaml:"vcenter_instance_id"`
	VCenterNetRef        string            `json:"vcenter_net_ref" yaml:"vcenter_net_ref"`
	VCenterPortgroupType string            `json:"vcenter_portgroup_type" yaml:"vcenter_portgroup_type"`
}

NIC is the API payload based on the legacy xmlrpc backend.

type NICAlias

type NICAlias struct {
	Values               map[string]string `json:"values" yaml:"values"`
	AliasID              string            `json:"alias_id" yaml:"alias_id"`
	Parent               string            `json:"parent" yaml:"parent"`
	ParentID             string            `json:"parent_id" yaml:"parent_id"`
	VCenterInstanceID    string            `json:"vcenter_instance_id" yaml:"vcenter_instance_id"`
	VCenterNetRef        string            `json:"vcenter_net_ref" yaml:"vcenter_net_ref"`
	VCenterPortgroupType string            `json:"vcenter_portgroup_type" yaml:"vcenter_portgroup_type"`
}

NICAlias is the API payload based on the legacy xmlrpc backend.

type OS

type OS struct {
	Values  map[string]string `json:"values" yaml:"values"`
	UUID    string            `json:"uuid" yaml:"uuid"`
	Arch    string            `json:"arch" yaml:"arch"`
	Boot    string            `json:"boot" yaml:"boot"`
	DiskBus string            `json:"sd_disk_bus" yaml:"sd_disk_bus"`
}

OS is the API payload based on the legacy xmlrpc backend.

type SchedAction

type SchedAction struct {
	Values   map[string]string `json:"values" yaml:"values"`
	Action   string            `json:"action" yaml:"action"`
	Args     string            `json:"args" yaml:"args"`
	Days     string            `json:"days" yaml:"days"`
	EndType  string            `json:"end_type" yaml:"end_type"`
	EndValue string            `json:"end_value" yaml:"end_value"`
	ID       string            `json:"id" yaml:"id"`
	Repeat   string            `json:"repeat" yaml:"repeat"`
	Time     string            `json:"time" yaml:"time"`
	Warning  string            `json:"warning" yaml:"warning"`
}

SchedAction is the API payload based on the legacy xmlrpc backend.

type Snapshot

type Snapshot struct {
	Values         map[string]string `json:"values" yaml:"values"`
	Action         string            `json:"action" yaml:"action"`
	Active         bool              `json:"active" yaml:"active"`
	HypervisorID   string            `json:"hypervisor_id" yaml:"hypervisor_id"`
	Name           string            `json:"name" yaml:"name"`
	SnapshotID     int               `json:"snapshot_id" yaml:"snapshot_id"`
	SystemDiskSize int               `json:"system_disk_size" yaml:"system_disk_size"`
	Time           api.Time          `json:"time" yaml:"time"`
}

Snapshot is the API payload based on the legacy xmlrpc backend.

type Snapshots

type Snapshots struct {
	AllowOrphans string          `json:"allow_orphans" yaml:"allow_orphans"`
	CurrentBase  int             `json:"current_base" yaml:"current_base"`
	NextSnapshot int             `json:"next_snapshot" yaml:"next_snapshot"`
	Snapshot     []ImageSnapshot `json:"snapshot" yaml:"snapshot"`
}

Snapshots is the API payload based on the legacy xmlrpc backend.

type State

type State int

State represents the state of an instance.

const (
	InitState      State = iota // init
	PendingState                // pending
	HoldState                   // hold
	ActiveState                 // active
	StoppedState                // stopped
	SuspendedState              // suspended
	DoneState                   // done

	OffState                      // off
	UndeployedState               // undeployed
	CloningState                  // cloning
	CloningFailedState            // cloning_failed
	AnyState           State = -2 // all
	NotDoneState       State = -1 // not_done
)

State values.

func StateString

func StateString(s string) (State, error)

StateString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func StateValues

func StateValues() []State

StateValues returns all values of the enum

func (State) IsAState

func (i State) IsAState() bool

IsAState returns "true" if the value is listed in the enum definition. "false" otherwise

func (State) MarshalText

func (i State) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for State

func (State) String

func (i State) String() string

func (*State) UnmarshalText

func (i *State) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for State

func (State) V1

func (s State) V1() hc.InstanceState

V1 returns the v1 hc.InstanceState that corresponds to the State.

type Template

type Template struct {
	Values                    map[string]string `json:"values" yaml:"values"`
	AutomaticDSRequirements   string            `json:"automatic_dsrequirements" yaml:"automatic_dsrequirements"`
	AutomaticNICRequirements  string            `json:"automatic_nicrequirements" yaml:"automatic_nicrequirements"`
	AutomaticRequirements     string            `json:"automatic_requirements" yaml:"automatic_requirements"`
	CPU                       float32           `json:"cpu" yaml:"cpu"`
	CPUCost                   string            `json:"cpu_cost" yaml:"cpu_cost"`
	CPUModel                  CPUModel          `json:"cpu_model" yaml:"cpu_model"`
	CloningTemplateID         string            `json:"cloning_template_id" yaml:"cloning_template_id"`
	Context                   Context           `json:"context" yaml:"context"`
	CreatedBy                 string            `json:"created_by" yaml:"created_by"`
	Disk                      []Disk            `json:"disk" yaml:"disk"`
	DiskCost                  string            `json:"disk_cost" yaml:"disk_cost"`
	Emulator                  string            `json:"emulator" yaml:"emulator"`
	Features                  string            `json:"features" yaml:"features"`
	Graphics                  Graphics          `json:"graphics" yaml:"graphics"`
	HypervOptions             string            `json:"hyperv_options" yaml:"hyperv_options"`
	Imported                  string            `json:"imported" yaml:"imported"`
	Input                     string            `json:"input" yaml:"input"`
	InstanceGroup             []string          `json:"instance_group" yaml:"instance_group"`
	InstanceID                int               `json:"instance_id" yaml:"instance_id"`
	Memory                    int               `json:"memory" yaml:"memory"`
	MemoryCost                string            `json:"memory_cost" yaml:"memory_cost"`
	MemoryMax                 string            `json:"memory_max" yaml:"memory_max"`
	MemoryResizeMode          string            `json:"memory_resize_mode" yaml:"memory_resize_mode"`
	MemorySlots               string            `json:"memory_slots" yaml:"memory_slots"`
	NIC                       []NIC             `json:"nic" yaml:"nic"`
	NICAlias                  []NICAlias        `json:"nic_alias" yaml:"nic_alias"`
	NICDefault                string            `json:"nic_default" yaml:"nic_default"`
	NumaNode                  string            `json:"numa_node" yaml:"numa_node"`
	OS                        OS                `json:"os" yaml:"os"`
	PCI                       string            `json:"pci" yaml:"pci"`
	Raw                       string            `json:"raw" yaml:"raw"`
	SchedAction               []SchedAction     `json:"sched_action" yaml:"sched_action"`
	SecurityGroupRule         []string          `json:"security_group_rule" yaml:"security_group_rule"`
	Snapshot                  []Snapshot        `json:"snapshot" yaml:"snapshot"`
	SpiceOptions              string            `json:"spice_options" yaml:"spice_options"`
	SubmitOnHold              string            `json:"submit_on_hold" yaml:"submit_on_hold"`
	TemplateID                int               `json:"template_id" yaml:"template_id"`
	TmMADSystem               string            `json:"tm_madsystem" yaml:"tm_madsystem"`
	Topology                  string            `json:"topology" yaml:"topology"`
	VCPU                      int               `json:"vcpu" yaml:"vcpu"`
	VCPUMax                   string            `json:"vcpu_max" yaml:"vcpu_max"`
	VRouterID                 string            `json:"vrouter_id" yaml:"vrouter_id"`
	VRouterKeepalivedID       string            `json:"vrouter_keepalived_id" yaml:"vrouter_keepalived_id"`
	VRouterKeepalivedPassword string            `json:"vrouter_keepalived_password" yaml:"vrouter_keepalived_password"`
}

Template is the API payload based on the legacy xmlrpc backend.

type UserTemplate

type UserTemplate struct {
	Values                map[string]string `json:"values" yaml:"values"`
	EFI                   string            `json:"efi" yaml:"efi"`
	VCenterCCRRef         string            `json:"vcenter_ccrref" yaml:"vcenter_ccrref"`
	VCenterDSRef          string            `json:"vcenter_dsref" yaml:"vcenter_dsref"`
	VCenterInstanceID     string            `json:"vcenter_instance_id" yaml:"vcenter_instance_id"`
	Error                 string            `json:"error" yaml:"error"`
	Hypervisor            string            `json:"hypervisor" yaml:"hypervisor"`
	Info                  string            `json:"info" yaml:"info"`
	Logo                  string            `json:"logo" yaml:"logo"`
	LXDSecurityPrivileged bool              `json:"lxdsecurity_privileged" yaml:"lxdsecurity_privileged"`
	SchedRequirements     string            `json:"sched_requirements" yaml:"sched_requirements"`
	SnapshotSchedule      string            `json:"snapshot_schedule" yaml:"snapshot_schedule"`
}

UserTemplate is the API payload based on the legacy xmlrpc backend.