/
server.go
1222 lines (1071 loc) · 35.3 KB
/
server.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package hcloud
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"net"
"net/http"
"net/url"
"strconv"
"time"
"github.com/hetznercloud/hcloud-go/hcloud/schema"
)
// Server represents a server in the Hetzner Cloud.
type Server struct {
ID int
Name string
Status ServerStatus
Created time.Time
PublicNet ServerPublicNet
PrivateNet []ServerPrivateNet
ServerType *ServerType
Datacenter *Datacenter
IncludedTraffic uint64
OutgoingTraffic uint64
IngoingTraffic uint64
BackupWindow string
RescueEnabled bool
Locked bool
ISO *ISO
Image *Image
Protection ServerProtection
Labels map[string]string
Volumes []*Volume
PrimaryDiskSize int
PlacementGroup *PlacementGroup
}
// ServerProtection represents the protection level of a server.
type ServerProtection struct {
Delete, Rebuild bool
}
// ServerStatus specifies a server's status.
type ServerStatus string
const (
// ServerStatusInitializing is the status when a server is initializing.
ServerStatusInitializing ServerStatus = "initializing"
// ServerStatusOff is the status when a server is off.
ServerStatusOff ServerStatus = "off"
// ServerStatusRunning is the status when a server is running.
ServerStatusRunning ServerStatus = "running"
// ServerStatusStarting is the status when a server is being started.
ServerStatusStarting ServerStatus = "starting"
// ServerStatusStopping is the status when a server is being stopped.
ServerStatusStopping ServerStatus = "stopping"
// ServerStatusMigrating is the status when a server is being migrated.
ServerStatusMigrating ServerStatus = "migrating"
// ServerStatusRebuilding is the status when a server is being rebuilt.
ServerStatusRebuilding ServerStatus = "rebuilding"
// ServerStatusDeleting is the status when a server is being deleted.
ServerStatusDeleting ServerStatus = "deleting"
// ServerStatusUnknown is the status when a server's state is unknown.
ServerStatusUnknown ServerStatus = "unknown"
)
// FirewallStatus specifies a Firewall's status.
type FirewallStatus string
const (
// FirewallStatusPending is the status when a Firewall is pending.
FirewallStatusPending FirewallStatus = "pending"
// FirewallStatusApplied is the status when a Firewall is applied.
FirewallStatusApplied FirewallStatus = "applied"
)
// ServerPublicNet represents a server's public network.
type ServerPublicNet struct {
IPv4 ServerPublicNetIPv4
IPv6 ServerPublicNetIPv6
FloatingIPs []*FloatingIP
Firewalls []*ServerFirewallStatus
}
// ServerPublicNetIPv4 represents a server's public IPv4 address.
type ServerPublicNetIPv4 struct {
ID int
IP net.IP
Blocked bool
DNSPtr string
}
func (n *ServerPublicNetIPv4) IsUnspecified() bool {
return n.IP == nil || n.IP.Equal(net.IPv4zero)
}
// ServerPublicNetIPv6 represents a Server's public IPv6 network and address.
type ServerPublicNetIPv6 struct {
ID int
IP net.IP
Network *net.IPNet
Blocked bool
DNSPtr map[string]string
}
func (n *ServerPublicNetIPv6) IsUnspecified() bool {
return n.IP == nil || n.IP.Equal(net.IPv6unspecified)
}
// ServerPrivateNet defines the schema of a Server's private network information.
type ServerPrivateNet struct {
Network *Network
IP net.IP
Aliases []net.IP
MACAddress string
}
// DNSPtrForIP returns the reverse dns pointer of the ip address.
func (n *ServerPublicNetIPv6) DNSPtrForIP(ip net.IP) string {
return n.DNSPtr[ip.String()]
}
// ServerFirewallStatus represents a Firewall and its status on a Server's
// network interface.
type ServerFirewallStatus struct {
Firewall Firewall
Status FirewallStatus
}
// ServerRescueType represents rescue types.
type ServerRescueType string
// List of rescue types.
const (
ServerRescueTypeLinux32 ServerRescueType = "linux32"
ServerRescueTypeLinux64 ServerRescueType = "linux64"
)
// changeDNSPtr changes or resets the reverse DNS pointer for a IP address.
// Pass a nil ptr to reset the reverse DNS pointer to its default value.
func (s *Server) changeDNSPtr(ctx context.Context, client *Client, ip net.IP, ptr *string) (*Action, *Response, error) {
reqBody := schema.ServerActionChangeDNSPtrRequest{
IP: ip.String(),
DNSPtr: ptr,
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/change_dns_ptr", s.ID)
req, err := client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionChangeDNSPtrResponse{}
resp, err := client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// GetDNSPtrForIP searches for the dns assigned to the given IP address.
// It returns an error if there is no dns set for the given IP address.
func (s *Server) GetDNSPtrForIP(ip net.IP) (string, error) {
if net.IP.Equal(s.PublicNet.IPv4.IP, ip) {
return s.PublicNet.IPv4.DNSPtr, nil
} else if dns, ok := s.PublicNet.IPv6.DNSPtr[ip.String()]; ok {
return dns, nil
}
return "", DNSNotFoundError{ip}
}
// ServerClient is a client for the servers API.
type ServerClient struct {
client *Client
Action *ResourceActionClient
}
// GetByID retrieves a server by its ID. If the server does not exist, nil is returned.
func (c *ServerClient) GetByID(ctx context.Context, id int) (*Server, *Response, error) {
req, err := c.client.NewRequest(ctx, "GET", fmt.Sprintf("/servers/%d", id), nil)
if err != nil {
return nil, nil, err
}
var body schema.ServerGetResponse
resp, err := c.client.Do(req, &body)
if err != nil {
if IsError(err, ErrorCodeNotFound) {
return nil, resp, nil
}
return nil, nil, err
}
return ServerFromSchema(body.Server), resp, nil
}
// GetByName retrieves a server by its name. If the server does not exist, nil is returned.
func (c *ServerClient) GetByName(ctx context.Context, name string) (*Server, *Response, error) {
if name == "" {
return nil, nil, nil
}
servers, response, err := c.List(ctx, ServerListOpts{Name: name})
if len(servers) == 0 {
return nil, response, err
}
return servers[0], response, err
}
// Get retrieves a server by its ID if the input can be parsed as an integer, otherwise it
// retrieves a server by its name. If the server does not exist, nil is returned.
func (c *ServerClient) Get(ctx context.Context, idOrName string) (*Server, *Response, error) {
if id, err := strconv.Atoi(idOrName); err == nil {
return c.GetByID(ctx, int(id))
}
return c.GetByName(ctx, idOrName)
}
// ServerListOpts specifies options for listing servers.
type ServerListOpts struct {
ListOpts
Name string
Status []ServerStatus
Sort []string
}
func (l ServerListOpts) values() url.Values {
vals := l.ListOpts.Values()
if l.Name != "" {
vals.Add("name", l.Name)
}
for _, status := range l.Status {
vals.Add("status", string(status))
}
for _, sort := range l.Sort {
vals.Add("sort", sort)
}
return vals
}
// List returns a list of servers for a specific page.
//
// Please note that filters specified in opts are not taken into account
// when their value corresponds to their zero value or when they are empty.
func (c *ServerClient) List(ctx context.Context, opts ServerListOpts) ([]*Server, *Response, error) {
path := "/servers?" + opts.values().Encode()
req, err := c.client.NewRequest(ctx, "GET", path, nil)
if err != nil {
return nil, nil, err
}
var body schema.ServerListResponse
resp, err := c.client.Do(req, &body)
if err != nil {
return nil, nil, err
}
servers := make([]*Server, 0, len(body.Servers))
for _, s := range body.Servers {
servers = append(servers, ServerFromSchema(s))
}
return servers, resp, nil
}
// All returns all servers.
func (c *ServerClient) All(ctx context.Context) ([]*Server, error) {
return c.AllWithOpts(ctx, ServerListOpts{ListOpts: ListOpts{PerPage: 50}})
}
// AllWithOpts returns all servers for the given options.
func (c *ServerClient) AllWithOpts(ctx context.Context, opts ServerListOpts) ([]*Server, error) {
allServers := []*Server{}
err := c.client.all(func(page int) (*Response, error) {
opts.Page = page
servers, resp, err := c.List(ctx, opts)
if err != nil {
return resp, err
}
allServers = append(allServers, servers...)
return resp, nil
})
if err != nil {
return nil, err
}
return allServers, nil
}
// ServerCreateOpts specifies options for creating a new server.
type ServerCreateOpts struct {
Name string
ServerType *ServerType
Image *Image
SSHKeys []*SSHKey
Location *Location
Datacenter *Datacenter
UserData string
StartAfterCreate *bool
Labels map[string]string
Automount *bool
Volumes []*Volume
Networks []*Network
Firewalls []*ServerCreateFirewall
PlacementGroup *PlacementGroup
PublicNet *ServerCreatePublicNet
}
type ServerCreatePublicNet struct {
EnableIPv4 bool
EnableIPv6 bool
IPv4 *PrimaryIP
IPv6 *PrimaryIP
}
// ServerCreateFirewall defines which Firewalls to apply when creating a Server.
type ServerCreateFirewall struct {
Firewall Firewall
}
// Validate checks if options are valid.
func (o ServerCreateOpts) Validate() error {
if o.Name == "" {
return errors.New("missing name")
}
if o.ServerType == nil || (o.ServerType.ID == 0 && o.ServerType.Name == "") {
return errors.New("missing server type")
}
if o.Image == nil || (o.Image.ID == 0 && o.Image.Name == "") {
return errors.New("missing image")
}
if o.Location != nil && o.Datacenter != nil {
return errors.New("location and datacenter are mutually exclusive")
}
if o.PublicNet != nil {
if !o.PublicNet.EnableIPv4 && !o.PublicNet.EnableIPv6 &&
len(o.Networks) == 0 && (o.StartAfterCreate == nil || *o.StartAfterCreate) {
return errors.New("missing networks or StartAfterCreate == false when EnableIPv4 and EnableIPv6 is false")
}
}
return nil
}
// ServerCreateResult is the result of a create server call.
type ServerCreateResult struct {
Server *Server
Action *Action
RootPassword string
NextActions []*Action
}
// Create creates a new server.
func (c *ServerClient) Create(ctx context.Context, opts ServerCreateOpts) (ServerCreateResult, *Response, error) {
if err := opts.Validate(); err != nil {
return ServerCreateResult{}, nil, err
}
var reqBody schema.ServerCreateRequest
reqBody.UserData = opts.UserData
reqBody.Name = opts.Name
reqBody.Automount = opts.Automount
reqBody.StartAfterCreate = opts.StartAfterCreate
if opts.ServerType.ID != 0 {
reqBody.ServerType = opts.ServerType.ID
} else if opts.ServerType.Name != "" {
reqBody.ServerType = opts.ServerType.Name
}
if opts.Image.ID != 0 {
reqBody.Image = opts.Image.ID
} else if opts.Image.Name != "" {
reqBody.Image = opts.Image.Name
}
if opts.Labels != nil {
reqBody.Labels = &opts.Labels
}
for _, sshKey := range opts.SSHKeys {
reqBody.SSHKeys = append(reqBody.SSHKeys, sshKey.ID)
}
for _, volume := range opts.Volumes {
reqBody.Volumes = append(reqBody.Volumes, volume.ID)
}
for _, network := range opts.Networks {
reqBody.Networks = append(reqBody.Networks, network.ID)
}
for _, firewall := range opts.Firewalls {
reqBody.Firewalls = append(reqBody.Firewalls, schema.ServerCreateFirewalls{
Firewall: firewall.Firewall.ID,
})
}
if opts.PublicNet != nil {
reqBody.PublicNet = &schema.ServerCreatePublicNet{
EnableIPv4: opts.PublicNet.EnableIPv4,
EnableIPv6: opts.PublicNet.EnableIPv6,
}
if opts.PublicNet.IPv4 != nil {
reqBody.PublicNet.IPv4ID = opts.PublicNet.IPv4.ID
}
if opts.PublicNet.IPv6 != nil {
reqBody.PublicNet.IPv6ID = opts.PublicNet.IPv6.ID
}
}
if opts.Location != nil {
if opts.Location.ID != 0 {
reqBody.Location = strconv.Itoa(opts.Location.ID)
} else {
reqBody.Location = opts.Location.Name
}
}
if opts.Datacenter != nil {
if opts.Datacenter.ID != 0 {
reqBody.Datacenter = strconv.Itoa(opts.Datacenter.ID)
} else {
reqBody.Datacenter = opts.Datacenter.Name
}
}
if opts.PlacementGroup != nil {
reqBody.PlacementGroup = opts.PlacementGroup.ID
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return ServerCreateResult{}, nil, err
}
req, err := c.client.NewRequest(ctx, "POST", "/servers", bytes.NewReader(reqBodyData))
if err != nil {
return ServerCreateResult{}, nil, err
}
var respBody schema.ServerCreateResponse
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerCreateResult{}, resp, err
}
result := ServerCreateResult{
Server: ServerFromSchema(respBody.Server),
Action: ActionFromSchema(respBody.Action),
NextActions: ActionsFromSchema(respBody.NextActions),
}
if respBody.RootPassword != nil {
result.RootPassword = *respBody.RootPassword
}
return result, resp, nil
}
// ServerDeleteResult is the result of a delete server call.
type ServerDeleteResult struct {
Action *Action
}
// Delete deletes a server.
//
// Deprecated: Use [ServerClient.DeleteWithResult] instead.
func (c *ServerClient) Delete(ctx context.Context, server *Server) (*Response, error) {
_, resp, err := c.DeleteWithResult(ctx, server)
return resp, err
}
// DeleteWithResult deletes a server and returns the parsed response containing the action.
func (c *ServerClient) DeleteWithResult(ctx context.Context, server *Server) (*ServerDeleteResult, *Response, error) {
req, err := c.client.NewRequest(ctx, "DELETE", fmt.Sprintf("/servers/%d", server.ID), nil)
if err != nil {
return &ServerDeleteResult{}, nil, err
}
var respBody schema.ServerDeleteResponse
resp, err := c.client.Do(req, &respBody)
if err != nil {
return &ServerDeleteResult{}, resp, err
}
return &ServerDeleteResult{
Action: ActionFromSchema(respBody.Action),
}, resp, nil
}
// ServerUpdateOpts specifies options for updating a server.
type ServerUpdateOpts struct {
Name string
Labels map[string]string
}
// Update updates a server.
func (c *ServerClient) Update(ctx context.Context, server *Server, opts ServerUpdateOpts) (*Server, *Response, error) {
reqBody := schema.ServerUpdateRequest{
Name: opts.Name,
}
if opts.Labels != nil {
reqBody.Labels = &opts.Labels
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d", server.ID)
req, err := c.client.NewRequest(ctx, "PUT", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerUpdateResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ServerFromSchema(respBody.Server), resp, nil
}
// Poweron starts a server.
func (c *ServerClient) Poweron(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/poweron", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionPoweronResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// Reboot reboots a server.
func (c *ServerClient) Reboot(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/reboot", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionRebootResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// Reset resets a server.
func (c *ServerClient) Reset(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/reset", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionResetResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// Shutdown shuts down a server.
func (c *ServerClient) Shutdown(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/shutdown", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionShutdownResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// Poweroff stops a server.
func (c *ServerClient) Poweroff(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/poweroff", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionPoweroffResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// ServerResetPasswordResult is the result of resetting a server's password.
type ServerResetPasswordResult struct {
Action *Action
RootPassword string
}
// ResetPassword resets a server's password.
func (c *ServerClient) ResetPassword(ctx context.Context, server *Server) (ServerResetPasswordResult, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/reset_password", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return ServerResetPasswordResult{}, nil, err
}
respBody := schema.ServerActionResetPasswordResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerResetPasswordResult{}, resp, err
}
return ServerResetPasswordResult{
Action: ActionFromSchema(respBody.Action),
RootPassword: respBody.RootPassword,
}, resp, nil
}
// ServerCreateImageOpts specifies options for creating an image from a server.
type ServerCreateImageOpts struct {
Type ImageType
Description *string
Labels map[string]string
}
// Validate checks if options are valid.
func (o ServerCreateImageOpts) Validate() error {
switch o.Type {
case ImageTypeSnapshot, ImageTypeBackup:
break
case "":
break
default:
return errors.New("invalid type")
}
return nil
}
// ServerCreateImageResult is the result of creating an image from a server.
type ServerCreateImageResult struct {
Action *Action
Image *Image
}
// CreateImage creates an image from a server.
func (c *ServerClient) CreateImage(ctx context.Context, server *Server, opts *ServerCreateImageOpts) (ServerCreateImageResult, *Response, error) {
var reqBody schema.ServerActionCreateImageRequest
if opts != nil {
if err := opts.Validate(); err != nil {
return ServerCreateImageResult{}, nil, fmt.Errorf("invalid options: %s", err)
}
if opts.Description != nil {
reqBody.Description = opts.Description
}
if opts.Type != "" {
reqBody.Type = Ptr(string(opts.Type))
}
if opts.Labels != nil {
reqBody.Labels = &opts.Labels
}
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return ServerCreateImageResult{}, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/create_image", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return ServerCreateImageResult{}, nil, err
}
respBody := schema.ServerActionCreateImageResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerCreateImageResult{}, resp, err
}
return ServerCreateImageResult{
Action: ActionFromSchema(respBody.Action),
Image: ImageFromSchema(respBody.Image),
}, resp, nil
}
// ServerEnableRescueOpts specifies options for enabling rescue mode for a server.
type ServerEnableRescueOpts struct {
Type ServerRescueType
SSHKeys []*SSHKey
}
// ServerEnableRescueResult is the result of enabling rescue mode for a server.
type ServerEnableRescueResult struct {
Action *Action
RootPassword string
}
// EnableRescue enables rescue mode for a server.
func (c *ServerClient) EnableRescue(ctx context.Context, server *Server, opts ServerEnableRescueOpts) (ServerEnableRescueResult, *Response, error) {
reqBody := schema.ServerActionEnableRescueRequest{
Type: Ptr(string(opts.Type)),
}
for _, sshKey := range opts.SSHKeys {
reqBody.SSHKeys = append(reqBody.SSHKeys, sshKey.ID)
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return ServerEnableRescueResult{}, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/enable_rescue", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return ServerEnableRescueResult{}, nil, err
}
respBody := schema.ServerActionEnableRescueResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerEnableRescueResult{}, resp, err
}
result := ServerEnableRescueResult{
Action: ActionFromSchema(respBody.Action),
RootPassword: respBody.RootPassword,
}
return result, resp, nil
}
// DisableRescue disables rescue mode for a server.
func (c *ServerClient) DisableRescue(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/disable_rescue", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionDisableRescueResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// ServerRebuildOpts specifies options for rebuilding a server.
type ServerRebuildOpts struct {
Image *Image
}
// ServerRebuildResult is the result of a create server call.
type ServerRebuildResult struct {
Action *Action
RootPassword string
}
// Rebuild rebuilds a server.
//
// Deprecated: Use [ServerClient.RebuildWithResult] instead.
func (c *ServerClient) Rebuild(ctx context.Context, server *Server, opts ServerRebuildOpts) (*Action, *Response, error) {
result, resp, err := c.RebuildWithResult(ctx, server, opts)
return result.Action, resp, err
}
// RebuildWithResult rebuilds a server.
func (c *ServerClient) RebuildWithResult(ctx context.Context, server *Server, opts ServerRebuildOpts) (ServerRebuildResult, *Response, error) {
reqBody := schema.ServerActionRebuildRequest{}
if opts.Image.ID != 0 {
reqBody.Image = opts.Image.ID
} else {
reqBody.Image = opts.Image.Name
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return ServerRebuildResult{}, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/rebuild", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return ServerRebuildResult{}, nil, err
}
respBody := schema.ServerActionRebuildResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerRebuildResult{}, resp, err
}
result := ServerRebuildResult{
Action: ActionFromSchema(respBody.Action),
}
if respBody.RootPassword != nil {
result.RootPassword = *respBody.RootPassword
}
return result, resp, nil
}
// AttachISO attaches an ISO to a server.
func (c *ServerClient) AttachISO(ctx context.Context, server *Server, iso *ISO) (*Action, *Response, error) {
reqBody := schema.ServerActionAttachISORequest{}
if iso.ID != 0 {
reqBody.ISO = iso.ID
} else {
reqBody.ISO = iso.Name
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/attach_iso", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionAttachISOResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// DetachISO detaches the currently attached ISO from a server.
func (c *ServerClient) DetachISO(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/detach_iso", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionDetachISOResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// EnableBackup enables backup for a server. Pass in an empty backup window to let the
// API pick a window for you. See the API documentation at docs.hetzner.cloud for a list
// of valid backup windows.
func (c *ServerClient) EnableBackup(ctx context.Context, server *Server, window string) (*Action, *Response, error) {
reqBody := schema.ServerActionEnableBackupRequest{}
if window != "" {
reqBody.BackupWindow = Ptr(window)
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/enable_backup", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionEnableBackupResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// DisableBackup disables backup for a server.
func (c *ServerClient) DisableBackup(ctx context.Context, server *Server) (*Action, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/disable_backup", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionDisableBackupResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// ServerChangeTypeOpts specifies options for changing a server's type.
type ServerChangeTypeOpts struct {
ServerType *ServerType // new server type
UpgradeDisk bool // whether disk should be upgraded
}
// ChangeType changes a server's type.
func (c *ServerClient) ChangeType(ctx context.Context, server *Server, opts ServerChangeTypeOpts) (*Action, *Response, error) {
reqBody := schema.ServerActionChangeTypeRequest{
UpgradeDisk: opts.UpgradeDisk,
}
if opts.ServerType.ID != 0 {
reqBody.ServerType = opts.ServerType.ID
} else {
reqBody.ServerType = opts.ServerType.Name
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/change_type", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionChangeTypeResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, nil
}
// ChangeDNSPtr changes or resets the reverse DNS pointer for a server IP address.
// Pass a nil ptr to reset the reverse DNS pointer to its default value.
func (c *ServerClient) ChangeDNSPtr(ctx context.Context, server *Server, ip string, ptr *string) (*Action, *Response, error) {
netIP := net.ParseIP(ip)
if netIP == nil {
return nil, nil, InvalidIPError{ip}
}
return server.changeDNSPtr(ctx, c.client, net.ParseIP(ip), ptr)
}
// ServerChangeProtectionOpts specifies options for changing the resource protection level of a server.
type ServerChangeProtectionOpts struct {
Rebuild *bool
Delete *bool
}
// ChangeProtection changes the resource protection level of a server.
func (c *ServerClient) ChangeProtection(ctx context.Context, server *Server, opts ServerChangeProtectionOpts) (*Action, *Response, error) {
reqBody := schema.ServerActionChangeProtectionRequest{
Rebuild: opts.Rebuild,
Delete: opts.Delete,
}
reqBodyData, err := json.Marshal(reqBody)
if err != nil {
return nil, nil, err
}
path := fmt.Sprintf("/servers/%d/actions/change_protection", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, bytes.NewReader(reqBodyData))
if err != nil {
return nil, nil, err
}
respBody := schema.ServerActionChangeProtectionResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return nil, resp, err
}
return ActionFromSchema(respBody.Action), resp, err
}
// ServerRequestConsoleResult is the result of requesting a WebSocket VNC console.
type ServerRequestConsoleResult struct {
Action *Action
WSSURL string
Password string
}
// RequestConsole requests a WebSocket VNC console.
func (c *ServerClient) RequestConsole(ctx context.Context, server *Server) (ServerRequestConsoleResult, *Response, error) {
path := fmt.Sprintf("/servers/%d/actions/request_console", server.ID)
req, err := c.client.NewRequest(ctx, "POST", path, nil)
if err != nil {
return ServerRequestConsoleResult{}, nil, err
}
respBody := schema.ServerActionRequestConsoleResponse{}
resp, err := c.client.Do(req, &respBody)
if err != nil {
return ServerRequestConsoleResult{}, resp, err
}
return ServerRequestConsoleResult{
Action: ActionFromSchema(respBody.Action),
WSSURL: respBody.WSSURL,
Password: respBody.Password,
}, resp, nil
}
// ServerAttachToNetworkOpts specifies options for attaching a server to a network.