Versions in this module Expand all Collapse all v2 v2.8.0 Aug 18, 2025 Changes in this version type UpdateOpts + Hostname *string v2.7.0 Apr 3, 2025 v2.6.0 Mar 3, 2025 Changes in this version type CreateOpts + HypervisorHostname string v2.5.0 Feb 11, 2025 v2.4.0 Dec 19, 2024 Changes in this version type Server + Locked *bool v2.3.0 Dec 6, 2024 v2.2.0 Oct 18, 2024 v2.1.1 Sep 18, 2024 v2.1.0 Jul 24, 2024 v2.0.0 Jun 5, 2024 Changes in this version + const CRASHED + const DestinationLocal + const DestinationVolume + const HardReboot + const NOSTATE + const OSReboot + const PAUSED + const PowerCycle + const RUNNING + const SHUTDOWN + const SUSPENDED + const SoftReboot + const SourceBlank + const SourceImage + const SourceSnapshot + const SourceVolume + func ExtractAddresses(r pagination.Page) (map[string][]Address, error) + func ExtractServersInto(r pagination.Page, v any) error + func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager + func ListAddresses(client *gophercloud.ServiceClient, id string) pagination.Pager + func ListAddressesByNetwork(client *gophercloud.ServiceClient, id, network string) pagination.Pager + func ListSimple(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager + func WaitForStatus(ctx context.Context, c *gophercloud.ServiceClient, id, status string) error + type ActionResult struct + func ChangeAdminPassword(ctx context.Context, client *gophercloud.ServiceClient, id, newPassword string) (r ActionResult) + func ConfirmResize(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ActionResult) + func ForceDelete(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ActionResult) + func Reboot(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r ActionResult) + func Resize(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r ActionResult) + func RevertResize(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ActionResult) + type Address struct + Address string + Version int + func ExtractNetworkAddresses(r pagination.Page) ([]Address, error) + type AddressPage struct + func (r AddressPage) IsEmpty() (bool, error) + type AttachedVolume struct + ID string + type BlockDevice struct + BootIndex int + DeleteOnTermination bool + DestinationType DestinationType + DeviceType string + DiskBus string + GuestFormat string + SourceType SourceType + Tag string + UUID string + VolumeSize int + VolumeType string + type CreateImageOpts struct + Metadata map[string]string + Name string + func (opts CreateImageOpts) ToServerCreateImageMap() (map[string]any, error) + type CreateImageOptsBuilder interface + ToServerCreateImageMap func() (map[string]any, error) + type CreateImageResult struct + func CreateImage(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r CreateImageResult) + func (r CreateImageResult) ExtractImageID() (string, error) + type CreateMetadatumResult struct + func CreateMetadatum(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r CreateMetadatumResult) + type CreateOpts struct + AccessIPv4 string + AccessIPv6 string + AdminPass string + AvailabilityZone string + BlockDevice []BlockDevice + ConfigDrive *bool + DiskConfig DiskConfig + FlavorRef string + Hostname string + ImageRef string + Max int + Metadata map[string]string + Min int + Name string + Networks any + Personality Personality + SecurityGroups []string + Tags []string + UserData []byte + func (opts CreateOpts) ToServerCreateMap() (map[string]any, error) + type CreateOptsBuilder interface + ToServerCreateMap func() (map[string]any, error) + type CreateResult struct + func Create(ctx context.Context, client *gophercloud.ServiceClient, opts CreateOptsBuilder, ...) (r CreateResult) + func (r CreateResult) Extract() (*Server, error) + func (r CreateResult) ExtractInto(v any) error + type DeleteMetadatumResult struct + func DeleteMetadatum(ctx context.Context, client *gophercloud.ServiceClient, id, key string) (r DeleteMetadatumResult) + type DeleteResult struct + func Delete(ctx context.Context, client *gophercloud.ServiceClient, id string) (r DeleteResult) + type DestinationType string + type DiskConfig string + const Auto + const Manual + type ErrInvalidHowParameterProvided struct + type ErrNeitherFlavorIDNorFlavorNameProvided struct + func (e ErrNeitherFlavorIDNorFlavorNameProvided) Error() string + type ErrNeitherImageIDNorImageNameProvided struct + func (e ErrNeitherImageIDNorImageNameProvided) Error() string + type ErrNoAdminPassProvided struct + type ErrNoClientProvidedForIDByName struct + func (e ErrNoClientProvidedForIDByName) Error() string + type ErrNoIDProvided struct + type ErrNoImageIDProvided struct + type ErrServer struct + ID string + func (se ErrServer) Error() string + func (se ErrServer) Error404(e gophercloud.ErrUnexpectedResponseCode) error + type ErrServerNotFound struct + func (e ErrServerNotFound) Error() string + type EvacuateOpts struct + AdminPass string + Host string + OnSharedStorage bool + func (opts EvacuateOpts) ToEvacuateMap() (map[string]any, error) + type EvacuateOptsBuilder interface + ToEvacuateMap func() (map[string]any, error) + type EvacuateResult struct + func Evacuate(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r EvacuateResult) + func (r EvacuateResult) ExtractAdminPass() (string, error) + type Fault struct + Code int + Created time.Time + Details string + Message string + type File struct + Contents []byte + Path string + func (f *File) MarshalJSON() ([]byte, error) + type GetMetadataResult struct + func Metadata(ctx context.Context, client *gophercloud.ServiceClient, id string) (r GetMetadataResult) + type GetMetadatumResult struct + func Metadatum(ctx context.Context, client *gophercloud.ServiceClient, id, key string) (r GetMetadatumResult) + type GetPasswordResult struct + func GetPassword(ctx context.Context, client *gophercloud.ServiceClient, serverId string) (r GetPasswordResult) + func (r GetPasswordResult) ExtractPassword(privateKey *rsa.PrivateKey) (string, error) + type GetResult struct + func Get(ctx context.Context, client *gophercloud.ServiceClient, id string) (r GetResult) + func (r GetResult) Extract() (*Server, error) + func (r GetResult) ExtractInto(v any) error + type InjectNetworkResult struct + func InjectNetworkInfo(ctx context.Context, client *gophercloud.ServiceClient, id string) (r InjectNetworkResult) + type ListOpts struct + AllTenants bool + AvailabilityZone string + ChangesSince string + Flavor string + Host string + IP string + IP6 string + Image string + Limit int + Marker string + Name string + NotTags string + NotTagsAny string + Status string + Tags string + TagsAny string + TenantID string + UserID string + func (opts ListOpts) ToServerListQuery() (string, error) + type ListOptsBuilder interface + ToServerListQuery func() (string, error) + type LiveMigrateOpts struct + BlockMigration *bool + DiskOverCommit *bool + Host *string + func (opts LiveMigrateOpts) ToLiveMigrateMap() (map[string]any, error) + type LiveMigrateOptsBuilder interface + ToLiveMigrateMap func() (map[string]any, error) + type LockResult struct + func Lock(ctx context.Context, client *gophercloud.ServiceClient, id string) (r LockResult) + type MetadataOpts map[string]string + func (opts MetadataOpts) ToMetadataResetMap() (map[string]any, error) + func (opts MetadataOpts) ToMetadataUpdateMap() (map[string]any, error) + type MetadataResult struct + func (r MetadataResult) Extract() (map[string]string, error) + type MetadatumOpts map[string]string + func (opts MetadatumOpts) ToMetadatumCreateMap() (map[string]any, string, error) + type MetadatumOptsBuilder interface + ToMetadatumCreateMap func() (map[string]any, string, error) + type MetadatumResult struct + func (r MetadatumResult) Extract() (map[string]string, error) + type MigrateResult struct + func LiveMigrate(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r MigrateResult) + func Migrate(ctx context.Context, client *gophercloud.ServiceClient, id string) (r MigrateResult) + type Network struct + FixedIP string + Port string + Tag string + UUID string + type NetworkAddressPage struct + func (r NetworkAddressPage) IsEmpty() (bool, error) + type PauseResult struct + func Pause(ctx context.Context, client *gophercloud.ServiceClient, id string) (r PauseResult) + type Personality []*File + type PowerState int + func (r PowerState) String() string + type RebootMethod string + type RebootOpts struct + Type RebootMethod + func (opts RebootOpts) ToServerRebootMap() (map[string]any, error) + type RebootOptsBuilder interface + ToServerRebootMap func() (map[string]any, error) + type RebuildOpts struct + AccessIPv4 string + AccessIPv6 string + AdminPass string + DiskConfig DiskConfig + ImageRef string + Metadata map[string]string + Name string + Personality Personality + func (opts RebuildOpts) ToServerRebuildMap() (map[string]any, error) + type RebuildOptsBuilder interface + ToServerRebuildMap func() (map[string]any, error) + type RebuildResult struct + func Rebuild(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r RebuildResult) + func (r RebuildResult) Extract() (*Server, error) + func (r RebuildResult) ExtractInto(v any) error + type RescueOpts struct + AdminPass string + RescueImageRef string + func (opts RescueOpts) ToServerRescueMap() (map[string]any, error) + type RescueOptsBuilder interface + ToServerRescueMap func() (map[string]any, error) + type RescueResult struct + func Rescue(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r RescueResult) + func (r RescueResult) Extract() (string, error) + type ResetMetadataOptsBuilder interface + ToMetadataResetMap func() (map[string]any, error) + type ResetMetadataResult struct + func ResetMetadata(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r ResetMetadataResult) + type ResetNetworkResult struct + func ResetNetwork(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ResetNetworkResult) + type ResetStateResult struct + func ResetState(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r ResetStateResult) + type ResizeOpts struct + DiskConfig DiskConfig + FlavorRef string + func (opts ResizeOpts) ToServerResizeMap() (map[string]any, error) + type ResizeOptsBuilder interface + ToServerResizeMap func() (map[string]any, error) + type ResumeResult struct + func Resume(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ResumeResult) + type SchedulerHintOpts struct + AdditionalProperties map[string]any + BuildNearHostIP string + DifferentCell []string + DifferentHost []string + Group string + Query []any + SameHost []string + TargetCell string + func (opts SchedulerHintOpts) ToSchedulerHintsMap() (map[string]any, error) + type SchedulerHintOptsBuilder interface + ToSchedulerHintsMap func() (map[string]any, error) + type Server struct + AccessIPv4 string + AccessIPv6 string + Addresses map[string]any + AdminPass string + AttachedVolumes []AttachedVolume + AvailabilityZone string + Created time.Time + DiskConfig DiskConfig + Fault Fault + Flavor map[string]any + Host string + HostID string + Hostname *string + HypervisorHostname string + ID string + Image map[string]any + InstanceName string + KernelID *string + KeyName string + LaunchIndex *int + LaunchedAt time.Time + Links []any + Metadata map[string]string + Name string + PowerState PowerState + Progress int + RAMDiskID *string + ReservationID *string + RootDeviceName *string + SecurityGroups []map[string]any + ServerGroups *[]string + Status string + Tags *[]string + TaskState string + TenantID string + TerminatedAt time.Time + Updated time.Time + UserID string + Userdata *string + VmState string + func ExtractServers(r pagination.Page) ([]Server, error) + func (r *Server) UnmarshalJSON(b []byte) error + type ServerExtendedStatusExt struct + PowerState PowerState + TaskState string + VmState string + type ServerPage struct + func (r ServerPage) IsEmpty() (bool, error) + func (r ServerPage) NextPageURL() (string, error) + type ServerState string + const StateActive + const StateError + type ShelveOffloadResult struct + func ShelveOffload(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ShelveOffloadResult) + type ShelveResult struct + func Shelve(ctx context.Context, client *gophercloud.ServiceClient, id string) (r ShelveResult) + type ShowConsoleOutputOpts struct + Length int + func (opts ShowConsoleOutputOpts) ToServerShowConsoleOutputMap() (map[string]any, error) + type ShowConsoleOutputOptsBuilder interface + ToServerShowConsoleOutputMap func() (map[string]any, error) + type ShowConsoleOutputResult struct + func ShowConsoleOutput(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r ShowConsoleOutputResult) + func (r ShowConsoleOutputResult) Extract() (string, error) + type SourceType string + type StartResult struct + func Start(ctx context.Context, client *gophercloud.ServiceClient, id string) (r StartResult) + type StopResult struct + func Stop(ctx context.Context, client *gophercloud.ServiceClient, id string) (r StopResult) + type SuspendResult struct + func Suspend(ctx context.Context, client *gophercloud.ServiceClient, id string) (r SuspendResult) + type UnlockResult struct + func Unlock(ctx context.Context, client *gophercloud.ServiceClient, id string) (r UnlockResult) + type UnpauseResult struct + func Unpause(ctx context.Context, client *gophercloud.ServiceClient, id string) (r UnpauseResult) + type UnrescueResult struct + func Unrescue(ctx context.Context, client *gophercloud.ServiceClient, id string) (r UnrescueResult) + type UnshelveOpts struct + AvailabilityZone string + func (opts UnshelveOpts) ToUnshelveMap() (map[string]any, error) + type UnshelveOptsBuilder interface + ToUnshelveMap func() (map[string]any, error) + type UnshelveResult struct + func Unshelve(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r UnshelveResult) + type UpdateMetadataOptsBuilder interface + ToMetadataUpdateMap func() (map[string]any, error) + type UpdateMetadataResult struct + func UpdateMetadata(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r UpdateMetadataResult) + type UpdateOpts struct + AccessIPv4 string + AccessIPv6 string + Name string + func (opts UpdateOpts) ToServerUpdateMap() (map[string]any, error) + type UpdateOptsBuilder interface + ToServerUpdateMap func() (map[string]any, error) + type UpdateResult struct + func Update(ctx context.Context, client *gophercloud.ServiceClient, id string, ...) (r UpdateResult) + func (r UpdateResult) Extract() (*Server, error) + func (r UpdateResult) ExtractInto(v any) error v2.0.0-rc.3 Jun 5, 2024 v2.0.0-rc.2 May 29, 2024 v2.0.0-rc.1 May 27, 2024 v2.0.0-beta.5 May 6, 2024 v2.0.0-beta.4 Apr 16, 2024 v2.0.0-beta.3 Apr 6, 2024 v2.0.0-beta.2 Feb 27, 2024 v2.0.0-beta.1 Feb 8, 2024 Other modules containing this package github.com/gophercloud/gophercloud
Go to main page