admin

README

Admin

Specific structures for admin users.

• ListVirtualMachines with the ListAll argument.

Documentation

Overview

Package admin contains the privileged API calls.

Some aspects of the Exoscale API are restricted to admin privileges, meaning not all field would be useful for everyone if we allowed them to coexist with the base structs. E.g. an admin can list all resources belonging to anyone using the listall=true parameter.

Index

• type ListVirtualMachines
  • func (ListVirtualMachines) Response() interface{}
• type ListVirtualMachinesResponse
• type VirtualMachine

Types

type ListVirtualMachines

type ListVirtualMachines struct {
	egoscale.ListVirtualMachines
	ListAll *bool `json:"listall,omitempty"`
}

ListVirtualMachines represents the enriched ListVirtualMachines command

func (ListVirtualMachines) Response

func (ListVirtualMachines) Response() interface{}

Response returns the struct to unmarshal

type ListVirtualMachinesResponse

type ListVirtualMachinesResponse struct {
	Count          int              `json:"count"`
	VirtualMachine []VirtualMachine `json:"virtualmachine"`
}

ListVirtualMachinesResponse represents the list of VirtualMachine in the admin world

type VirtualMachine

type VirtualMachine struct {
	egoscale.VirtualMachine
	Account   string         `json:"account,omitempty" doc:"list resources by account"`
	AccountID *egoscale.UUID `json:"accountid,omitempty"`
	HostID    *egoscale.UUID `json:"hostid,omitempty" doc:"the host ID"`
	PodID     *egoscale.UUID `json:"podid,omitempty" doc:"the pod ID"`
	StorageID *egoscale.UUID `json:"storageid,omitempty" doc:"the storage ID where vm's volumes belong to"`
	HostName  string         `json:"string,omitempty"`
}

VirtualMachine represents the enriched VirtualMachine in the admin world