clusters

package
v0.45.0 Latest Latest
Warning

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

 Go to latest Published: Oct 21, 2024 License: Apache-2.0 Imports: 5 Imported by: 5

Documentation

Index

Constants

View Source 
const (

	// SoftwareDraftsPath The endpoint for the software drafts API
	SoftwareDraftsPath = basePath + "/clusters/%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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type EnableSoftwareManagementSpec 

type EnableSoftwareManagementSpec struct {
	SkipSoftwareCheck bool `json:"skip_software_check"`
}

EnableSoftwareManagementSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Enablement/Software/EnableSpec/

type Manager 

type Manager struct {
	*rest.Client
}

Manager extends rest.Client, adding Software Drafts related methods.

func NewManager 

func NewManager(client *rest.Client) *Manager

NewManager creates a new Manager instance with the given client.

func (*Manager) CommitSoftwareDraft 

func (c *Manager) CommitSoftwareDraft(clusterId, draftId string, spec SettingsClustersSoftwareDraftsCommitSpec) (string, error)

CommitSoftwareDraft closes and applies the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draftactioncommitvmw-tasktrue/post/

func (*Manager) CreateSoftwareDraft 

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

CreateSoftwareDraft creates a software draft on the provided cluster https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/post/

func (*Manager) DeleteSoftwareDraft 

func (c *Manager) DeleteSoftwareDraft(clusterId, draftId string) error

DeleteSoftwareDraft removes the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/delete/

func (*Manager) EnableSoftwareManagement 

func (c *Manager) EnableSoftwareManagement(clusterId string, skipCheck bool) (string, error)

EnableSoftwareManagement enables vLCM on the cluster https://developer.vmware.com/apis/vsphere-automation/latest/esx/settings/clusters.enablement.software/put

func (*Manager) GetSoftwareDraft 

func (c *Manager) GetSoftwareDraft(clusterId, draftId string) (SettingsClustersSoftwareDraftsInfo, error)

GetSoftwareDraft returns the set of components in the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/get/

func (*Manager) GetSoftwareDraftBaseImage 

func (c *Manager) GetSoftwareDraftBaseImage(clusterId, draftId string) (SettingsBaseImageInfo, error)

GetSoftwareDraftBaseImage retrieves the ESXi image version on the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/software/base-image/get

func (*Manager) GetSoftwareDraftComponent 

func (c *Manager) GetSoftwareDraftComponent(clusterId, draftId, component string) (SettingsComponentInfo, error)

GetSoftwareDraftComponent returns a component from the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/software/components/component/get/

func (*Manager) GetSoftwareManagement 

func (c *Manager) GetSoftwareManagement(clusterId string) (SoftwareManagementInfo, error)

GetSoftwareManagement checks whether vLCM is enabled on the cluster https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/enablement/software/get/

func (*Manager) ListSoftwareDraftComponents 

func (c *Manager) ListSoftwareDraftComponents(clusterId, draftId string) (map[string]SettingsComponentInfo, error)

ListSoftwareDraftComponents returns all components in the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/software/components/get/

func (*Manager) ListSoftwareDrafts 

func (c *Manager) ListSoftwareDrafts(clusterId string, owners *[]string) (map[string]SettingsClustersSoftwareDraftsMetadata, error)

ListSoftwareDrafts retrieves the software drafts for a cluster https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/get/

func (*Manager) RemoveSoftwareDraftComponents 

func (c *Manager) RemoveSoftwareDraftComponents(clusterId, draftId, component string) error

RemoveSoftwareDraftComponents removes a component from the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/software/components/component/delete/

func (*Manager) SetSoftwareDraftBaseImage 

func (c *Manager) SetSoftwareDraftBaseImage(clusterId, draftId, version string) error

SetSoftwareDraftBaseImage sets the ESXi image version on the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/settings/clusters.software.drafts.software.base_image/put

func (*Manager) UpdateSoftwareDraftComponents 

func (c *Manager) UpdateSoftwareDraftComponents(clusterId, draftId string, spec SoftwareComponentsUpdateSpec) error

UpdateSoftwareDraftComponents updates the set of components in the specified draft https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/clusters/cluster/software/drafts/draft/software/components/patch/

type SettingsAddOnDetails 

type SettingsAddOnDetails struct {
	DisplayName    string `json:"display_name"`
	DisplayVersion string `json:"display_version"`
	Vendor         string `json:"vendor"`
}

SettingsAddOnDetails is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/AddOnDetails/

type SettingsAddOnInfo 

type SettingsAddOnInfo struct {
	Name    string               `json:"name"`
	Version string               `json:"version"`
	Details SettingsAddOnDetails `json:"details,omitempty"`
}

SettingsAddOnInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/AddOnInfo/

type SettingsBaseImageDetails 

type SettingsBaseImageDetails struct {
	DisplayName    string `json:"display_name"`
	DisplayVersion string `json:"display_version"`
	ReleaseDate    string `json:"release_date"`
}

SettingsBaseImageDetails is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/BaseImageDetails/

type SettingsBaseImageInfo 

type SettingsBaseImageInfo struct {
	Version string                   `json:"version"`
	Details SettingsBaseImageDetails `json:"details"`
}

SettingsBaseImageInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/BaseImageInfo/

type SettingsBaseImageSpec 

type SettingsBaseImageSpec struct {
	Version string `json:"version"`
}

SettingsBaseImageSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/BaseImageSpec/

type SettingsClustersSoftwareDraftsCommitSpec 

type SettingsClustersSoftwareDraftsCommitSpec struct {
	Message string `json:"message,omitempty"`
}

SettingsClustersSoftwareDraftsCommitSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Software/Drafts/CommitSpec/

type SettingsClustersSoftwareDraftsInfo 

type SettingsClustersSoftwareDraftsInfo struct {
	Metadata SettingsClustersSoftwareDraftsMetadata `json:"metadata"`
	Software SettingsSoftwareInfo                   `json:"software"`
}

SettingsClustersSoftwareDraftsInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Software/Drafts/Info/

type SettingsClustersSoftwareDraftsMetadata 

type SettingsClustersSoftwareDraftsMetadata struct {
	CreationTime string `json:"creation_time"`
	Owner        string `json:"owner"`
	Status       string `json:"status"`
}

SettingsClustersSoftwareDraftsMetadata is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Software/Drafts/Metadata/

type SettingsComponentDetails 

type SettingsComponentDetails struct {
	DisplayName string `json:"display_name"`
	Vendor      string `json:"vendor"`
}

SettingsComponentDetails is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/ComponentDetails/

type SettingsComponentInfo 

type SettingsComponentInfo struct {
	Version string                   `json:"version"`
	Details SettingsComponentDetails `json:"details"`
}

SettingsComponentInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/ComponentInfo/

type SettingsHardwareSupportInfo 

type SettingsHardwareSupportInfo struct {
	Packages map[string]SettingsHardwareSupportPackageInfo `json:"packages"`
}

SettingsHardwareSupportInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/HardwareSupportInfo/

type SettingsHardwareSupportPackageInfo 

type SettingsHardwareSupportPackageInfo struct {
	Pkg     string `json:"pkg"`
	Version string `json:"version"`
}

SettingsHardwareSupportPackageInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/HardwareSupportPackageInfo/

type SettingsSoftwareInfo 

type SettingsSoftwareInfo struct {
	BaseImage       SettingsBaseImageInfo            `json:"base_image"`
	Components      map[string]SettingsComponentInfo `json:"components"`
	Solutions       map[string]SettingsSolutionInfo  `json:"solutions"`
	AddOn           SettingsAddOnInfo                `json:"add_on,omitempty"`
	HardwareSupport SettingsHardwareSupportInfo      `json:"hardware_support,omitempty"`
}

SettingsSoftwareInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/SoftwareInfo/

type SettingsSolutionComponentDetails 

type SettingsSolutionComponentDetails struct {
	Component      string `json:"component"`
	DisplayName    string `json:"display_name"`
	Vendor         string `json:"vendor"`
	DisplayVersion string `json:"display_version,omitempty"`
}

SettingsSolutionComponentDetails is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/SolutionComponentDetails/

type SettingsSolutionComponentSpec 

type SettingsSolutionComponentSpec struct {
	Component string `json:"component"`
}

SettingsSolutionComponentSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/SolutionComponentSpec/

type SettingsSolutionDetails 

type SettingsSolutionDetails struct {
	DisplayName    string `json:"display_name"`
	DisplayVersion string `json:"display_version"`
}

SettingsSolutionDetails is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/SolutionDetails/

type SettingsSolutionInfo 

type SettingsSolutionInfo struct {
	Version    string                          `json:"version"`
	Components []SettingsSolutionComponentSpec `json:"components"`
	Details    SettingsSolutionDetails         `json:"details"`
}

SettingsSolutionInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/SolutionInfo/

type SoftwareComponentsUpdateSpec 

type SoftwareComponentsUpdateSpec struct {
	ComponentsToDelete []string          `json:"components_to_delete,omitempty"`
	ComponentsToSet    map[string]string `json:"components_to_set,omitempty"`
}

SoftwareComponentsUpdateSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Software/Drafts/Software/Components/UpdateSpec/

type SoftwareManagementInfo 

type SoftwareManagementInfo struct {
	Enabled bool `json:"enabled"`
}

SoftwareManagementInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Clusters/Enablement/Software/Info/

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.