vcenter

package

v0.1.6 Latest Latest Go to latest Published: Dec 16, 2024 License: Apache-2.0 Imports: 3 Imported by: 3

Documentation ¶

Overview ¶

Package vcenter contains vCenter object types.

Index ¶

Constants
type Account
- func (a Account) Userinfo() *url.Userinfo
type AdditionalDisk
type Datastore
type HostDateInfo
- func (i *HostDateInfo) Servers() []string
type HostSystem
type Metrics
type Network
type SSHInfo
type VM
type VMInfo

Constants ¶

View Source

const (
	// ClusterDefaultResourcePoolName is the default resource pool name for a cluster.
	ClusterDefaultResourcePoolName = "Resources"

	// DefaultDomain is the default vCenter domain.
	DefaultDomain = "VSPHERE.LOCAL"
)

View Source

const (
	// DatastoreInventoryPrefix is the prefix for datastore inventory.
	// Replacements: datacenter name.
	DatastoreInventoryPrefix = "/%s/datastore/"

	// HostInventoryPath is the path for cluster or host system inventory.
	// Replacements: datacenter name, cluster or host system name.
	HostInventoryPath = "/%s/host/%s"

	// HostInventoryPrefix is the prefix for host inventory.
	// Replacements: datacenter name.
	HostInventoryPrefix = "/%s/host/"

	// HostInventoryGlob is the path for listing all host inventory in a
	// datacenter; including host systems and clusters.
	// Replacements: datacenter name.
	HostInventoryGlob = "/%s/host/*"

	// HostChildInventoryPath is the path for host system or resource pool inventory.
	// Replacements: datacenter name, cluster, host system, or resource pool name.
	HostChildInventoryPath = "/%s/host/%s/%s"

	// NetworkInventoryPath is the path for network inventory.
	// Replacements: datacenter name, network name.
	NetworkInventoryPath = "/%s/network/%s"

	// NetworkInventoryPrefix is the prefix for network inventory.
	// Replacements: datacenter name.
	NetworkInventoryPrefix = "/%s/network/"

	// ResourcePoolInventoryPath is the path for resource pool inventory.
	// Replacements: datacenter name, cluster name, resource pool name.
	ResourcePoolInventoryPath = "/%s/host/%s/Resources/%s"

	// ResourcePoolInventoryGlob is the path for listing all resource pools
	// in a cluster.
	// Replacements: datacenter name, cluster name.
	ResourcePoolInventoryGlob = "/%s/host/%s/Resources/*"

	// ResourcePoolChildInventoryGlob is the path for listing all child inventory
	// in a resource pool.
	// Replacements: datacenter name, cluster name, resource pool name.
	ResourcePoolChildInventoryGlob = "/%s/host/%s/Resources/%s/*"

	// VMFolderInventoryPath is the path for VM folder inventory.
	// Replacements: datacenter name, vm folder name.
	VMFolderInventoryPath = "/%s/vm/%s"

	// VMFolderInventoryPrefix is the prefix for VM folder inventory.
	// Replacements: datacenter name.
	VMFolderInventoryPrefix = "/%s/vm/"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Account ¶

type Account struct {
	// Insecure controls whether to validate the vCenter server's certificate.
	Insecure bool `json:"insecure" yaml:"insecure"`

	// Password is the vCenter password.
	Password string `json:"password" yaml:"password"`

	// Username is the vCenter username.
	Username string `json:"username" yaml:"username"`

	// Host is the vCenter URL.
	Host string `json:"host" yaml:"host"`
}

Account contains vCenter account details.

func (Account) Userinfo ¶

func (a Account) Userinfo() *url.Userinfo

Userinfo returns a vCenter account's credentials in Userinfo format.

type AdditionalDisk ¶

type AdditionalDisk struct {
	Name      string
	Device    string
	Capacity  string
	Used      string
	Available string
	Usage     string
}

AdditionalDisk defines an additional disk.

type Datastore ¶

type Datastore struct {
	Name string
	ID   string
}

Datastore defines a datastore

type HostDateInfo ¶

type HostDateInfo struct {
	types.HostDateTimeInfo
	HostName      string
	NTPServers    []string
	Service       *types.HostService
	Current       *time.Time
	ClientStatus  string
	ServiceStatus string
}

HostDateInfo defines date information for a vCenter host system.

func (*HostDateInfo) Servers ¶

func (i *HostDateInfo) Servers() []string

Servers returns a slice of NTP servers for a vCenter host system.

type HostSystem ¶

type HostSystem struct {
	Name      string
	Reference string
}

HostSystem defines a vCenter host system.

type Metrics ¶

type Metrics struct {
	CPUCores        string
	CPUUsage        string
	MemoryBytes     string
	MemoryUsage     string
	DiskUsage       string
	DiskProvisioned string
}

Metrics defines the VM metrics.

type Network ¶

type Network struct {
	Type      string
	IP        string
	Interface string
}

Network defines a vCenter network.

type SSHInfo ¶

type SSHInfo struct {
	Username   string
	Password   string
	PublicKey  []string
	PrivateKey []string
}

SSHInfo defines the SSH information.

type VM ¶

type VM struct {
	Name           string
	Type           string
	Status         string
	IPAddress      string
	Host           string
	CPU            int32
	Memory         int32
	RootDiskSize   int32
	Network        []Network
	VMInfo         VMInfo
	SSHInfo        SSHInfo
	AdditionalDisk []AdditionalDisk
	Metrics        Metrics
	Storage        []Datastore
}

VM defines a vCenter virtual machine.

type VMInfo ¶

type VMInfo struct {
	Folder    string
	Cluster   string
	Datastore string
	Network   string
}

VMInfo defines scope information for a vCenter VM.

Source Files ¶

View all Source files

types.go

Directories ¶

Path	Synopsis
entity Package entity contains vCenter objects/entities.	Package entity contains vCenter objects/entities.

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