servers

Documentation

Index

• Constants
• type Flavor
• type Images
• type Links
• type ListOpts
• type SecurityGroups
• type Server
  • func ExtractServers(r pagination.Page) ([]Server, error)
  • func Get(client *golangsdk.ServiceClient, id string) (*Server, error)
  • func List(c *golangsdk.ServiceClient, opts ListOpts) ([]Server, error)
• type ServerPage
  • func (r ServerPage) IsEmpty() (bool, error)
  • func (r ServerPage) NextPageURL() (string, error)
• type SortDir
• type SortKey

Constants

const (
	// SortAsc is used to sort a list of servers in ascending order.
	SortAsc SortDir = "asc"
	// SortDesc is used to sort a list of servers in descending order.
	SortDesc SortDir = "desc"
	// SortUUID is used to sort a list of servers by uuid.
	SortUUID SortKey = "uuid"
	// SortVMState is used to sort a list of servers by vm_state.
	SortVMState SortKey = "vm_state"
	// SortDisplayName is used to sort a list of servers by display_name.
	SortDisplayName SortKey = "display_name"
	// SortTaskState is used to sort a list of servers by task_state.
	SortTaskState SortKey = "task_state"
	// SortPowerState is used to sort a list of servers by power_state.
	SortPowerState SortKey = "power_state"
	// SortAvailabilityZone is used to sort a list of servers by availability_zone.
	SortAvailabilityZone SortKey = "availability_zone"
)

Types

type Flavor

type Flavor struct {
	ID    string  `json:"id"`
	Links []Links `json:"links"`
}

type Images

type Images struct {
	ID    string  `json:"id"`
	Links []Links `json:"links"`
}

type Links

type Links struct {
	Rel  string `json:"rel"`
	Href string `json:"href"`
}

type ListOpts

type ListOpts struct {
	// ID uniquely identifies this server amongst all other servers,
	// including those not accessible to the current tenant.
	ID string
	// ID of the user to which the BMS belongs.
	UserID string
	// Contains the nova-compute status
	HostStatus string
	// Contains the host ID of the BMS.
	HostID string
	// KeyName indicates which public key was injected into the server on launch.
	KeyName string
	// Specifies the BMS name, not added in query since returns like results.
	Name string
	// Specifies the BMS image ID.
	ImageID string `q:"image"`
	// Specifies flavor ID.
	FlavorID string `q:"flavor"`
	// Specifies the BMS status.
	Status string `q:"status"`
	// Filters out the BMSs that have been updated since the changes-since time.
	// The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z.
	ChangesSince string `q:"changes-since"`
	// Specifies whether to query the BMSs of all tenants. This parameter is available only to administrators.
	// The value can be 0 (do not query the BMSs of all tenants) or 1 (query the BMSs of all tenants).
	AllTenants int `q:"all_tenants"`
	// Specifies the IP address. This parameter supports fuzzy matching.
	IP string `q:"ip"`
	// Specifies the tag list. Returns BMSs that match all tags. Use commas (,) to separate multiple tags
	Tags string `q:"tags"`
	// Specifies the tag list. Returns BMSs that match any tag
	TagsAny string `q:"tags-any"`
	// Specifies the tag list. Returns BMSs that do not match all tags.
	NotTags string `q:"not-tags"`
	// Specifies the tag list. Returns BMSs that do not match any of the tags.
	NotTagsAny string `q:"not-tags-any"`
	// Specifies the BMS sorting attribute, which can be the BMS UUID (uuid), BMS status (vm_state),
	// BMS name (display_name), BMS task status (task_state), power status (power_state),
	// creation time (created_at), last time when the BMS is updated (updated_at), and availability zone
	// (availability_zone). You can specify multiple sort_key and sort_dir pairs.
	SortKey SortKey `q:"sort_key"`
	// Specifies the sorting direction, i.e. asc or desc.
	SortDir SortDir `q:"sort_dir"`
}

ListOpts allows the filtering and sorting of paginated collections through the API. Filtering is achieved by passing in struct field values that map to the server attributes you want to see returned.

type SecurityGroups

type SecurityGroups struct {
	Name string `json:"name"`
}

type Server

type Server struct {
	// ID uniquely identifies this server amongst all other servers, including those not accessible to the current tenant.
	ID string `json:"id"`
	// TenantID identifies the tenant owning this server resource.
	TenantID string `json:"tenant_id"`
	// UserID uniquely identifies the user account owning the tenant.
	UserID string `json:"user_id"`
	// Name contains the human-readable name for the server.
	Name string `json:"name"`
	// Status contains the current operational status of the server, such as IN_PROGRESS or ACTIVE.
	Status string `json:"status"`
	// Updated and Created contain ISO-8601 timestamps of when the state of the server last changed, and when it was created.
	Updated time.Time `json:"updated"`
	Created time.Time `json:"created"`
	// Specifies the nova-compute status.
	HostStatus string `json:"host_status"`
	// Specifies the host ID of the BMS.
	HostID string `json:"hostid"`
	// Progress ranges from 0..100.
	// A request made against the server completes only once Progress reaches 100.
	Progress int `json:"progress"`
	// AccessIPv4 and AccessIPv6 contain the IP addresses of the server, suitable for remote access for administration.
	AccessIPv4 string `json:"accessIPv4"`
	AccessIPv6 string `json:"accessIPv6"`
	// Image refers to a JSON object, which itself indicates the OS image used to deploy the server.
	Image Images `json:"image"`
	// Flavor refers to a JSON object, which itself indicates the hardware configuration of the deployed server.
	Flavor Flavor `json:"flavor"`
	// Addresses includes a list of all IP addresses assigned to the server, keyed by pool.
	Addresses map[string]interface{} `json:"addresses"`
	// Metadata includes a list of all user-specified key-value pairs attached to the server.
	Metadata map[string]string `json:"metadata"`
	// Links includes HTTP references to itself, useful for passing along to other APIs that might want a server reference.
	Links []Links `json:"links"`
	// KeyName indicates which public key was injected into the server on launch.
	KeyName string `json:"key_name"`
	// AdminPass will generally be empty.  However, it will contain the administrative password chosen when
	// provisioning a new server without a set AdminPass setting in the first place.
	// Note that this is the ONLY time this field will be valid.
	AdminPass string `json:"adminPass"`
	// SecurityGroups includes the security groups that this instance has applied to it
	SecurityGroups []SecurityGroups `json:"security_groups"`
	// Specifies the BMS tag.
	// Added in micro version 2.26.
	Tags []string `json:"tags"`
	// Specifies whether a BMS is locked
	Locked      bool   `json:"locked"`
	ConfigDrive string `json:"config_drive"`
	// Specifies the AZ ID. This is an extended attribute.
	AvailabilityZone string `json:"OS-EXT-AZ:availability_zone"`
	// Specifies the disk configuration mode. This is an extended attribute.
	DiskConfig string `json:"OS-DCF:diskConfig"`
	// Specifies the name of a host on the hypervisor.
	// It is an extended attribute provided by the Nova driver
	HostName string `json:"OS-EXT-SRV-ATTR:hostname"`
	// Specifies the server description.
	Description string `json:"description"`
	// Specifies the job status of the BMS. This is an extended attribute.
	TaskState string `json:"OS-EXT-STS:task_state"`
	// Specifies the power status of the BMS. This is an extended attribute
	PowerState int `json:"OS-EXT-STS:power_state"`
	// Specifies the UUID of the kernel image when the AMI image is used
	KernelId string `json:"OS-EXT-SRV-ATTR:kernel_id"`
	// Specifies the host name of the BMS. This is an extended attribute
	Host string `json:"OS-EXT-SRV-ATTR:host"`
	// Specifies the UUID of the Ramdisk image when the AMI image is used.
	RamdiskId string `json:"OS-EXT-SRV-ATTR:ramdisk_id"`
	// Specifies the BMS startup sequence in the batch BMS creation scenario.
	Launch_index int `json:"OS-EXT-SRV-ATTR:launch_index"`
	// Specifies the user data specified during BMS creation.
	UserData string `json:"OS-EXT-SRV-ATTR:user_data"`
	// Specifies the reserved BMS IDs in the batch BMS creation scenario.
	ReservationID string `json:"OS-EXT-SRV-ATTR:reservation_id"`
	// Specifies the device name of the BMS system disk
	RootDevicName string `json:"OS-EXT-SRV-ATTR:root_device_name"`
	// Specifies the name of a host on the hypervisor.
	HypervisorHostName string `json:"OS-EXT-SRV-ATTR:hypervisor_hostname"`
	// Specifies the BMS status. This is an extended attribute.
	VMState string `json:"OS-EXT-STS:vm_state"`
	// Specifies the BMS ID. This is an extended attribute.
	InstanceName string `json:"OS-EXT-SRV-ATTR:instance_name"`
}

Server exposes fields corresponding to a given server on the user's account.

func ExtractServers

func ExtractServers(r pagination.Page) ([]Server, error)

ExtractServers accepts a Page struct, specifically a ServerPage struct, and extracts the elements into a slice of Server structs. In other words, a generic collection is mapped into a relevant slice.

func Get

func Get(client *golangsdk.ServiceClient, id string) (*Server, error)

Get requests details on a single server, by ID.

func List

func List(c *golangsdk.ServiceClient, opts ListOpts) ([]Server, error)

List returns a Pager which allows you to iterate over a collection of BMS Server resources. It accepts a ListServerOpts struct, which allows you to filter the returned collection for greater efficiency.

type ServerPage

type ServerPage struct {
	pagination.LinkedPageBase
}

func (ServerPage) IsEmpty

func (r ServerPage) IsEmpty() (bool, error)

IsEmpty returns true if a page contains no Server results.

func (ServerPage) NextPageURL

func (r ServerPage) NextPageURL() (string, error)

NextPageURL uses the response's embedded link reference to navigate to the next page of results.

type SortDir

type SortDir string

SortDir is a type for specifying in which direction to sort a list of servers.

type SortKey

type SortKey string

SortKey is a type for specifying by which key to sort a list of servers.