depots

package

v0.53.0 Latest Latest Go to latest Published: Feb 18, 2026 License: Apache-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/vmware/govmomi

Links

Documentation ¶

Index ¶

Constants
type BaseImagesSummary
type ComponentVersion
type Manager
- func NewManager(client *rest.Client) *Manager
type SettingsDepotsComponentSummary
type SettingsDepotsMetadataInfo
type SettingsDepotsOfflineContentInfo
type SettingsDepotsOfflineCreateSpec
type SettingsDepotsOfflineInfo
type SettingsDepotsOfflineSummary
type SourceType

Constants ¶

View Source

const (
	// DepotsOfflinePath The endpoint for the offline depots API
	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 = settings.BasePath + "/depot-content/base-images"
)

View Source

const (
	SourceTypePush = SourceType("PUSH")
	SourceTypePull = SourceType("PULL")
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BaseImagesSummary ¶

type BaseImagesSummary struct {
	DisplayName    string `json:"display_name"`
	DisplayVersion string `json:"display_version"`
	Kb             string `json:"kb"`
	ReleaseDate    string `json:"release_date"`
	Summary        string `json:"summary"`
	Version        string `json:"version"`
}

BaseImagesSummary is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/DepotContent/BaseImages/Summary/

type ComponentVersion ¶

type ComponentVersion struct {
	DisplayVersion string `json:"display_version"`
	Version        string `json:"version"`
}

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

type Manager ¶

type Manager struct {
	*rest.Client
}

Manager extends rest.Client, adding vLCM related methods.

func NewManager ¶

func NewManager(client *rest.Client) *Manager

NewManager creates a new Manager instance with the given client.

func (*Manager) CreateOfflineDepot ¶

func (c *Manager) CreateOfflineDepot(spec SettingsDepotsOfflineCreateSpec) (string, error)

CreateOfflineDepot triggers a task to create an offline depot https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depots/offlinevmw-tasktrue/post/

func (*Manager) DeleteOfflineDepot ¶

func (c *Manager) DeleteOfflineDepot(depotId string) (string, error)

DeleteOfflineDepot triggers a task to delete an offline depot by its identifier https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depots/offline/depotvmw-tasktrue/delete/

func (*Manager) GetOfflineDepot ¶

func (c *Manager) GetOfflineDepot(depotId string) (SettingsDepotsOfflineSummary, error)

GetOfflineDepot retrieves an offline depot by its identifier https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depots/offline/depot/get/

func (*Manager) GetOfflineDepotContent ¶

func (c *Manager) GetOfflineDepotContent(depotId string) (SettingsDepotsOfflineContentInfo, error)

GetOfflineDepotContent retrieves the contents of a depot https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depots/offline/depot/content/get/

func (*Manager) GetOfflineDepots ¶

func (c *Manager) GetOfflineDepots() (map[string]SettingsDepotsOfflineInfo, error)

GetOfflineDepots retrieves all offline depots https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depots/offline/get/

func (*Manager) ListBaseImages ¶

func (c *Manager) ListBaseImages() ([]BaseImagesSummary, error)

ListBaseImages retrieves the available ESXi versions https://developer.vmware.com/apis/vsphere-automation/latest/esx/api/esx/settings/depot-content/base-images/get/

type SettingsDepotsComponentSummary ¶

type SettingsDepotsComponentSummary struct {
	DisplayName string             `json:"display_name"`
	Versions    []ComponentVersion `json:"versions"`
}

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

type SettingsDepotsMetadataInfo ¶

type SettingsDepotsMetadataInfo struct {
	Addons                map[string]any                            `json:"addons,omitempty"`
	BaseImages            []any                                     `json:"base_images,omitempty"`
	FileName              string                                    `json:"file_name"`
	HardwareSupport       map[string]any                            `json:"hardware_support,omitempty"`
	IndependentComponents map[string]SettingsDepotsComponentSummary `json:"independent_components,omitempty"`
	Solutions             map[string]any                            `json:"solutions,omitempty"`
	Updates               map[string]any                            `json:"updates,omitempty"`
}

SettingsDepotsMetadataInfo is a partial type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Depots/MetadataInfo/

type SettingsDepotsOfflineContentInfo ¶

type SettingsDepotsOfflineContentInfo struct {
	MetadataBundles map[string][]SettingsDepotsMetadataInfo `json:"metadata_bundles"`
}

SettingsDepotsOfflineContentInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Depots/Offline/Content/Info/

type SettingsDepotsOfflineCreateSpec ¶

type SettingsDepotsOfflineCreateSpec struct {
	Description string `json:"description,omitempty"`
	SourceType  string `json:"source_type"`
	FileId      string `json:"file_id,omitempty"`
	Location    string `json:"location,omitempty"`
	OwnerData   string `json:"owner_data,omitempty"`
}

SettingsDepotsOfflineCreateSpec is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Depots/Offline/CreateSpec/

type SettingsDepotsOfflineInfo ¶

type SettingsDepotsOfflineInfo struct {
	CreateTime  string `json:"create_time"`
	Description string `json:"description"`
	SourceType  string `json:"source_type"`
	FileId      string `json:"file_id,omitempty"`
	Location    string `json:"location,omitempty"`
	Owner       string `json:"owner,omitempty"`
	OwnerData   string `json:"owner_data,omitempty"`
}

SettingsDepotsOfflineInfo is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Depots/Offline/Info/

type SettingsDepotsOfflineSummary ¶

type SettingsDepotsOfflineSummary struct {
	Description string `json:"description"`
	SourceType  string `json:"source_type"`
	FileId      string `json:"file_id,omitempty"`
	Location    string `json:"location,omitempty"`
	Owner       string `json:"owner,omitempty"`
	OwnerData   string `json:"owner_data,omitempty"`
}

SettingsDepotsOfflineSummary is a type mapping for https://developer.vmware.com/apis/vsphere-automation/latest/esx/data-structures/Settings/Depots/Offline/Summary/

type SourceType ¶

type SourceType string

Source Files ¶

View all Source files

depots.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL