chore: Replace /rest with /api in vcsa.shutdown API's

Closes: #2757

Author: pradeep288

govc/USAGE.md

@@ -5241,8 +5241,11 @@ Options:
 Usage: govc vcsa.shutdown.cancel [OPTIONS]
 
 Cancel pending shutdown action.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.cancel
+govc vcsa.shutdown.cancel
 
 Options:
 ```
@@ -5253,8 +5256,11 @@ Options:
 Usage: govc vcsa.shutdown.get [OPTIONS]
 
 Get details about the pending shutdown action.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.get
+govc vcsa.shutdown.get
 
 Options:
 ```
@@ -5265,8 +5271,11 @@ Options:
 Usage: govc vcsa.shutdown.poweroff [OPTIONS] REASON
 
 Power off the appliance.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.poweroff -delay 10 "powering off for maintenance"
+govc vcsa.shutdown.poweroff -delay 10 "powering off for maintenance"
 
 Options:
   -delay=0               Minutes after which poweroff should start.
@@ -5278,8 +5287,11 @@ Options:
 Usage: govc vcsa.shutdown.reboot [OPTIONS] REASON
 
 Reboot the appliance.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.reboot -delay 10 "rebooting for maintenance"
+govc vcsa.shutdown.reboot -delay 10 "rebooting for maintenance"
 
 Options:
   -delay=0               Minutes after which reboot should start.

govc/vcsa/shutdown/cancel.go

@@ -40,8 +40,11 @@ func (cmd *cancel) Register(ctx context.Context, f *flag.FlagSet) {
 
 func (cmd *cancel) Description() string {
 	return `Cancel pending shutdown action.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.cancel`
+govc vcsa.shutdown.cancel`
 }
 
 func (cmd *cancel) Run(ctx context.Context, f *flag.FlagSet) error {

govc/vcsa/shutdown/get.go

@@ -57,12 +57,15 @@ func (cmd *get) Process(ctx context.Context) error {
 
 func (cmd *get) Description() string {
 	return `Get details about the pending shutdown action.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.get`
+govc vcsa.shutdown.get`
 }
 
-type shutdownStatus struct {
-	Values shutdown.Config `json:"values"`
+type config struct {
+	shutdown.Config
 }
 
 func (cmd *get) Run(ctx context.Context, f *flag.FlagSet) error {
@@ -71,23 +74,23 @@ func (cmd *get) Run(ctx context.Context, f *flag.FlagSet) error {
 		return err
 	}
 
-	s := shutdown.NewManager(c)
+	m := shutdown.NewManager(c)
 
-	r, err := s.Get(ctx)
+	s, err := m.Get(ctx)
 	if err != nil {
 		return err
 	}
 
-	return cmd.WriteResult(shutdownStatus{
-		Values: r,
+	return cmd.WriteResult(config{
+		s,
 	})
 }
 
-func (res shutdownStatus) Write(w io.Writer) error {
+func (c config) Write(w io.Writer) error {
 	tw := tabwriter.NewWriter(w, 2, 0, 2, ' ', 0)
-	fmt.Fprintf(tw, "Action:%s\n", res.Values.Action)
-	fmt.Fprintf(tw, "Reason:%s\n", res.Values.Reason)
-	fmt.Fprintf(tw, "ShutDown Time:%s\n", res.Values.ShutdownTime)
+	fmt.Fprintf(tw, "Action:%s\n", c.Action)
+	fmt.Fprintf(tw, "Reason:%s\n", c.Reason)
+	fmt.Fprintf(tw, "ShutDown Time:%s\n", c.ShutdownTime)
 
 	return tw.Flush()
 }

govc/vcsa/shutdown/poweroff.go

@@ -52,8 +52,11 @@ func (cmd *powerOff) Usage() string {
 
 func (cmd *powerOff) Description() string {
 	return `Power off the appliance.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.poweroff -delay 10 "powering off for maintenance"`
+govc vcsa.shutdown.poweroff -delay 10 "powering off for maintenance"`
 }
 
 func (cmd *powerOff) Run(ctx context.Context, f *flag.FlagSet) error {

govc/vcsa/shutdown/reboot.go

@@ -60,8 +60,11 @@ func (cmd *reboot) Usage() string {
 
 func (cmd *reboot) Description() string {
 	return `Reboot the appliance.
+
+Note: This command requires vCenter 7.0.2 or higher.
+
 Examples:
-  govc vcsa.shutdown.reboot -delay 10 "rebooting for maintenance"`
+govc vcsa.shutdown.reboot -delay 10 "rebooting for maintenance"`
 }
 
 func (cmd *reboot) Run(ctx context.Context, f *flag.FlagSet) error {

vapi/appliance/shutdown/shutdown.go

@@ -24,7 +24,7 @@ import (
 )
 
 const (
-	Path     = "/appliance/shutdown"
+	Path     = "/api/appliance/shutdown"
 	Action   = "action"
 	Cancel   = "cancel"
 	PowerOff = "poweroff"
@@ -56,7 +56,7 @@ type Spec struct {
 	Reason string `json:"reason"`
 }
 
-// Config  defines shutdown configuration returned by the Shutdown.get operation
+// Config defines shutdown configuration returned by the Shutdown.get operation
 type Config struct {
 	Action       string `json:"action"`
 	Reason       string `json:"reason"`
@@ -73,23 +73,21 @@ func (m *Manager) Get(ctx context.Context) (Config, error) {
 }
 
 // PowerOff powers off the appliance.
-func (m *Manager) PowerOff(ctx context.Context, powerOffReason string, delay int) error {
+func (m *Manager) PowerOff(ctx context.Context, reason string, delay int) error {
 	r := m.Resource(Path).WithParam(Action, PowerOff)
-	s := Spec{
-		Delay:  delay,
-		Reason: powerOffReason,
-	}
 
-	return m.Do(ctx, r.Request(http.MethodPost, s), nil)
+	return m.Do(ctx, r.Request(http.MethodPost, Spec{
+		Delay:  delay,
+		Reason: reason,
+	}), nil)
 }
 
 // Reboot reboots the appliance
-func (m *Manager) Reboot(ctx context.Context, rebootReason string, delay int) error {
+func (m *Manager) Reboot(ctx context.Context, reason string, delay int) error {
 	r := m.Resource(Path).WithParam(Action, Reboot)
-	s := Spec{
-		Delay:  delay,
-		Reason: rebootReason,
-	}
 
-	return m.Do(ctx, r.Request(http.MethodPost, s), nil)
+	return m.Do(ctx, r.Request(http.MethodPost, Spec{
+		Delay:  delay,
+		Reason: reason,
+	}), nil)
 }

vapi/appliance/simulator/simulator.go

@@ -21,12 +21,14 @@ import (
 	"log"
 	"net/http"
 	"net/url"
+	"time"
 
 	"github.com/vmware/govmomi/simulator"
 	"github.com/vmware/govmomi/vapi/appliance/access/consolecli"
 	"github.com/vmware/govmomi/vapi/appliance/access/dcui"
 	"github.com/vmware/govmomi/vapi/appliance/access/shell"
 	"github.com/vmware/govmomi/vapi/appliance/access/ssh"
+	"github.com/vmware/govmomi/vapi/appliance/shutdown"
 	vapi "github.com/vmware/govmomi/vapi/simulator"
 )
 
@@ -38,21 +40,23 @@ func init() {
 
 // Handler implements the Appliance API simulator
 type Handler struct {
-	URL        *url.URL
-	consolecli consolecli.Access
-	dcui       dcui.Access
-	ssh        ssh.Access
-	shell      shell.Access
+	URL            *url.URL
+	consolecli     consolecli.Access
+	dcui           dcui.Access
+	ssh            ssh.Access
+	shell          shell.Access
+	shutdownConfig shutdown.Config
 }
 
 // New creates a Handler instance
 func New(u *url.URL) *Handler {
 	return &Handler{
-		URL:        nil,
-		consolecli: consolecli.Access{Enabled: false},
-		dcui:       dcui.Access{Enabled: false},
-		ssh:        ssh.Access{Enabled: false},
-		shell:      shell.Access{Enabled: false, Timeout: 0},
+		URL:            nil,
+		consolecli:     consolecli.Access{Enabled: false},
+		dcui:           dcui.Access{Enabled: false},
+		ssh:            ssh.Access{Enabled: false},
+		shell:          shell.Access{Enabled: false, Timeout: 0},
+		shutdownConfig: shutdown.Config{},
 	}
 }
 
@@ -62,6 +66,7 @@ func (h *Handler) Register(s *simulator.Service, r *simulator.Registry) {
 	s.HandleFunc(dcui.Path, h.dcuiAccess)
 	s.HandleFunc(ssh.Path, h.sshAccess)
 	s.HandleFunc(shell.Path, h.shellAccess)
+	s.HandleFunc(shutdown.Path, h.shutdown)
 }
 
 func (h *Handler) decode(r *http.Request, w http.ResponseWriter, val interface{}) bool {
@@ -147,3 +152,38 @@ func (h *Handler) shellAccess(writer http.ResponseWriter, request *http.Request)
 		http.NotFound(writer, request)
 	}
 }
+
+func (h *Handler) shutdown(w http.ResponseWriter, r *http.Request) {
+	switch r.Method {
+	case http.MethodGet:
+		vapi.StatusOK(w, h.shutdownConfig)
+	case http.MethodPost:
+		switch r.URL.Query().Get(shutdown.Action) {
+		case shutdown.Cancel:
+			h.shutdownConfig.ShutdownTime = ""
+			h.shutdownConfig.Action = ""
+			h.shutdownConfig.Reason = ""
+			w.WriteHeader(http.StatusNoContent)
+		case shutdown.Reboot:
+			var spec shutdown.Spec
+			if h.decode(r, w, &spec) {
+				h.shutdownConfig.ShutdownTime = time.Now().UTC().Add(time.Duration(spec.Delay) * time.Minute).String()
+				h.shutdownConfig.Reason = spec.Reason
+				h.shutdownConfig.Action = shutdown.Reboot
+				w.WriteHeader(http.StatusNoContent)
+			}
+		case shutdown.PowerOff:
+			var spec shutdown.Spec
+			if h.decode(r, w, &spec) {
+				h.shutdownConfig.ShutdownTime = time.Now().UTC().Add(time.Duration(spec.Delay) * time.Minute).String()
+				h.shutdownConfig.Reason = spec.Reason
+				h.shutdownConfig.Action = shutdown.PowerOff
+				w.WriteHeader(http.StatusNoContent)
+			}
+		default:
+			http.NotFound(w, r)
+		}
+	default:
+		http.NotFound(w, r)
+	}
+}

vapi/simulator/simulator.go

@@ -43,7 +43,6 @@ import (
 	"github.com/vmware/govmomi/object"
 	"github.com/vmware/govmomi/ovf"
 	"github.com/vmware/govmomi/simulator"
-	"github.com/vmware/govmomi/vapi/appliance/shutdown"
 	"github.com/vmware/govmomi/vapi/internal"
 	"github.com/vmware/govmomi/vapi/library"
 	"github.com/vmware/govmomi/vapi/rest"
@@ -92,7 +91,6 @@ type handler struct {
 	Library     map[string]*content
 	Update      map[string]update
 	Download    map[string]download
-	Config      shutdown.Config
 }
 
 func init() {
@@ -116,7 +114,6 @@ func New(u *url.URL, settings []vim.BaseOptionValue) (string, http.Handler) {
 		Library:     make(map[string]*content),
 		Update:      make(map[string]update),
 		Download:    make(map[string]download),
-		Config:      shutdown.Config{},
 	}
 
 	handlers := []struct {
@@ -158,7 +155,6 @@ func New(u *url.URL, settings []vim.BaseOptionValue) (string, http.Handler) {
 		{internal.VCenterVMTXLibraryItem + "/", s.libraryItemTemplateID},
 		{internal.VCenterVM + "/", s.vmID},
 		{internal.DebugEcho, s.debugEcho},
-		{shutdown.Path, s.shutdown},
 	}
 
 	for i := range handlers {
@@ -2103,48 +2099,3 @@ func (s *handler) vmID(w http.ResponseWriter, r *http.Request) {
 func (s *handler) debugEcho(w http.ResponseWriter, r *http.Request) {
 	r.Write(w)
 }
-
-func (s *handler) shutdown(w http.ResponseWriter, r *http.Request) {
-	delayShutdown := func(delay int) {
-		go time.AfterFunc(time.Duration(delay)*time.Minute, func() {
-			s.Lock()
-			s.Config.ShutdownTime = ""
-			s.Config.Action = ""
-			s.Config.Reason = ""
-			s.Unlock()
-		})
-	}
-
-	switch r.Method {
-	case http.MethodGet:
-		OK(w, s.Config)
-	case http.MethodPost:
-		switch r.URL.Query().Get(shutdown.Action) {
-		case shutdown.Cancel:
-			delayShutdown(0)
-			w.WriteHeader(http.StatusNoContent)
-		case shutdown.Reboot:
-			var spec shutdown.Spec
-			if s.decode(r, w, &spec) {
-				s.Config.ShutdownTime = time.Now().UTC().Add(time.Duration(spec.Delay) * time.Minute).String()
-				s.Config.Reason = spec.Reason
-				s.Config.Action = shutdown.Reboot
-				delayShutdown(spec.Delay)
-				w.WriteHeader(http.StatusNoContent)
-			}
-		case shutdown.PowerOff:
-			var spec shutdown.Spec
-			if s.decode(r, w, &spec) {
-				s.Config.ShutdownTime = time.Now().Local().Add(time.Duration(spec.Delay) * time.Minute).String()
-				s.Config.Reason = spec.Reason
-				s.Config.Action = shutdown.PowerOff
-				delayShutdown(spec.Delay)
-				w.WriteHeader(http.StatusNoContent)
-			}
-		default:
-			http.NotFound(w, r)
-		}
-	default:
-		http.NotFound(w, r)
-	}
-}