api: add bindings for esx/settings/cluster/enablement/configuration/transition

Signed-off-by: Stoyan Zhelyazkov <[email protected]>

Author: spacegospod

vapi/esx/settings/clusters/clusters.go

@@ -10,19 +10,21 @@ import (
 	"net/http"
 	"strings"
 
+	"github.com/vmware/govmomi/vapi/esx/settings"
 	"github.com/vmware/govmomi/vapi/rest"
 )
 
 const (
-	basePath = "/api/esx/settings"
+	// BasePath The base endpoint for the clusters API
+	BasePath = settings.BasePath + "/clusters"
 	// SoftwareDraftsPath The endpoint for the software drafts API
-	SoftwareDraftsPath = basePath + "/clusters/%s/software/drafts"
+	SoftwareDraftsPath = BasePath + "/%s/software/drafts"
 	// SoftwareComponentsPath The endpoint for retrieving the custom components in a software draft
 	SoftwareComponentsPath = SoftwareDraftsPath + "/%s/software/components"
 	// BaseImagePath The endpoint for retrieving the base image of a software draft
 	BaseImagePath = SoftwareDraftsPath + "/%s/software/base-image"
 	// SoftwareEnablementPath The endpoint for retrieving the vLCM status (enabled/disabled) of a cluster
-	SoftwareEnablementPath = basePath + "/clusters/%s/enablement/software"
+	SoftwareEnablementPath = BasePath + "/%s/enablement/software"
 )
 
 // Manager extends rest.Client, adding Software Drafts related methods.

vapi/esx/settings/clusters/enablement/enablement.go

@@ -0,0 +1,105 @@
+// © Broadcom. All Rights Reserved.
+// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: Apache-2.0
+
+package enablement
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+
+	"github.com/vmware/govmomi/vapi/esx/settings"
+	"github.com/vmware/govmomi/vapi/rest"
+)
+
+const (
+	// BasePath The base endpoint for the clusters configuration enablement API
+	BasePath      = settings.BasePath + "/%s/enablement"
+	Configuration = BasePath + "/configuration"
+	Transition    = Configuration + "/transition"
+)
+
+type FileSpec struct {
+	Config   string `json:"config"`
+	Filename string `json:"filename"`
+}
+
+// Manager extends rest.Client, adding cluster configuration enablement related methods.
+type Manager struct {
+	*rest.Client
+}
+
+// NewManager creates a new Manager instance with the given client.
+func NewManager(client *rest.Client) *Manager {
+	return &Manager{
+		Client: client,
+	}
+}
+
+// EnableClusterConfiguration enables cluster configuration profiles
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) EnableClusterConfiguration(clusterId string) (string, error) {
+	path := c.getBaseTransitionUrl(clusterId, "enable")
+	req := path.Request(http.MethodPost, nil)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// ImportFromReferenceHost imports the configuration of an existing ESXi host
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) ImportFromReferenceHost(clusterId, hostId string) (string, error) {
+	path := c.getBaseTransitionUrl(clusterId, "importFromHost")
+	req := path.Request(http.MethodPost, hostId)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// ImportFromFile imports the configuration in the provided json string
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) ImportFromFile(clusterId string, spec FileSpec) (string, error) {
+	path := c.getBaseTransitionUrl(clusterId, "importFromFile")
+	req := path.Request(http.MethodPost, spec)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// ValidateConfiguration performs server-side validation of the pending cluster configuration
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) ValidateConfiguration(clusterId string) (string, error) {
+	path := c.getBaseTransitionUrl(clusterId, "validateConfig")
+	req := path.Request(http.MethodPost, nil)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// RunPrecheck performs server-side pre-checks of the pending cluster configuration
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) RunPrecheck(clusterId string) (string, error) {
+	path := c.getBaseTransitionUrl(clusterId, "precheck")
+	req := path.Request(http.MethodPost, nil)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// Cancel deletes the pending cluster configuration
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) Cancel(clusterId string) (string, error) {
+	path := c.Resource(fmt.Sprintf(Transition, clusterId)).WithParam("action", "cancel")
+	req := path.Request(http.MethodPost, nil)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+// GetClusterConfigurationStatus returns the status of the current pending cluster configuration
+// https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition
+func (c *Manager) GetClusterConfigurationStatus(clusterId string) (string, error) {
+	path := c.Resource(fmt.Sprintf(Transition, clusterId))
+	req := path.Request(http.MethodGet)
+	var res string
+	return res, c.Do(context.Background(), req, &res)
+}
+
+func (c *Manager) getBaseTransitionUrl(clusterId, action string) *rest.Resource {
+	return c.Resource(fmt.Sprintf(Transition, clusterId)).WithParam("action", action).WithParam("vmw-task", "true")
+}

vapi/esx/settings/depots/depots.go

@@ -9,17 +9,17 @@ import (
 	"fmt"
 	"net/http"
 
+	"github.com/vmware/govmomi/vapi/esx/settings"
 	"github.com/vmware/govmomi/vapi/rest"
 )
 
 const (
-	basePath = "/api/esx/settings"
 	// DepotsOfflinePath The endpoint for the offline depots API
-	DepotsOfflinePath = basePath + "/depots/offline"
+	DepotsOfflinePath = settings.BasePath + "/depots/offline"
 	// DepotsOfflineContentPath The endpoint for retrieving the components in a depot
 	DepotsOfflineContentPath = DepotsOfflinePath + "/%s/content"
 	// BaseImagesPath The endpoint for retrieving the list of base ESXi images
-	BaseImagesPath = basePath + "/depot-content/base-images"
+	BaseImagesPath = settings.BasePath + "/depot-content/base-images"
 )
 
 // Manager extends rest.Client, adding vLCM related methods.

vapi/esx/settings/settings.go

@@ -0,0 +1,5 @@
+package settings
+
+const (
+	BasePath = "/api/esx/settings"
+)