enablement

package
v0.53.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// BasePath the base endpoint for the clusters enablement configuration API
	BasePath = clusters.BasePath + "/%s/enablement"
	// ConfigurationPath the endpoint for the enablement configuration API
	ConfigurationPath = BasePath + "/configuration"
	// TransitionPath the endpoint for the transition API
	TransitionPath = ConfigurationPath + "/transition"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigurationInfo added in v0.53.0 

type ConfigurationInfo struct {
	Status string `json:"status"`
}

ConfigurationInfo contains details about the current configuration status of a cluster https://developer.broadcom.com/xapis/vsphere-automation-api/latest/data-structures/Esx%20Settings%20Clusters%20Enablement%20Configuration%20Transition%20Info/

type DraftImportResult 

type DraftImportResult struct {
	Status string `json:"status"`
	Draft  string `json:"draft"`
}

DraftImportResult contains draft information, a result of importing a configuration from a file or a reference host

type FileSpec 

type FileSpec struct {
	Config   string `json:"config"`
	Filename string `json:"filename"`
}

FileSpec a specification used for importing cluster configuration form a file

type Manager 

type Manager struct {
	*rest.Client
}

Manager extends rest.Client, adding cluster configuration enablement related methods.

func NewManager 

func NewManager(client *rest.Client) *Manager

NewManager creates a new Manager instance with the given client.

func (*Manager) Cancel 

func (c *Manager) Cancel(clusterId string) (string, error)

Cancel deletes the pending cluster configuration Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=cancel/post/

func (*Manager) CheckEligibility 

func (c *Manager) CheckEligibility(clusterId string) (string, error)

CheckEligibility performs server-side validation of whether the cluster is eligible for configuration management via profiles Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=checkEligibility__vmw-task=true/post/

func (*Manager) EnableClusterConfiguration 

func (c *Manager) EnableClusterConfiguration(clusterId string) (string, error)

EnableClusterConfiguration enables cluster configuration profiles Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=enable__vmw-task=true/post/

func (*Manager) GetClusterConfigurationStatus 

func (c *Manager) GetClusterConfigurationStatus(clusterId string) (ConfigurationInfo, error)

GetClusterConfigurationStatus returns the status of the current pending cluster configuration Returns the config status and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition/get/

func (*Manager) ImportFromFile 

func (c *Manager) ImportFromFile(clusterId string, spec FileSpec) (DraftImportResult, error)

ImportFromFile imports the configuration in the provided json string Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=importFromFile/post/

func (*Manager) ImportFromReferenceHost 

func (c *Manager) ImportFromReferenceHost(clusterId, hostId string) (string, error)

ImportFromReferenceHost imports the configuration of an existing ESXi host Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=importFromHost__vmw-task=true/post/

func (*Manager) RunPrecheck 

func (c *Manager) RunPrecheck(clusterId string) (string, error)

RunPrecheck performs server-side pre-checks of the pending cluster configuration Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=precheck__vmw-task=true/post/

func (*Manager) ValidateConfiguration 

func (c *Manager) ValidateConfiguration(clusterId string) (string, error)

ValidateConfiguration performs server-side validation of the pending cluster configuration Returns a task identifier and an error https://developer.broadcom.com/xapis/vsphere-automation-api/latest/api/esx/settings/clusters/cluster/enablement/configuration/transition__action=validateConfig__vmw-task=true/post/

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.