session

Documentation

Index

• func Clear()
• func IsUnidentifiedVCenterVersion(err error) bool
• type Feature
  • func DefaultFeature() Feature
• type Params
  • func NewParams() *Params
  • func (p *Params) WithDatacenter(datacenter string) *Params
  • func (p *Params) WithFeatures(feature Feature) *Params
  • func (p *Params) WithServer(server string) *Params
  • func (p *Params) WithThumbprint(thumbprint string) *Params
  • func (p *Params) WithUserInfo(username, password string) *Params
• type Session
  • func GetOrCreate(ctx context.Context, params *Params) (*Session, error)
  • func (s *Session) FindByBIOSUUID(ctx context.Context, uuid string) (object.Reference, error)
  • func (s *Session) FindByInstanceUUID(ctx context.Context, uuid string) (object.Reference, error)
  • func (s *Session) GetVersion() (infrav1.VCenterVersion, error)

Functions

func Clear

func Clear()

Clear is meant to destroy all the cached sessions.

func IsUnidentifiedVCenterVersion

func IsUnidentifiedVCenterVersion(err error) bool

Types

type Feature

type Feature struct {
	EnableKeepAlive   bool
	KeepAliveDuration time.Duration
}

func DefaultFeature

func DefaultFeature() Feature

type Params

type Params struct {
	// contains filtered or unexported fields
}

func NewParams

func NewParams() *Params

func (*Params) WithDatacenter

func (p *Params) WithDatacenter(datacenter string) *Params

func (*Params) WithFeatures

func (p *Params) WithFeatures(feature Feature) *Params

func (*Params) WithServer

func (p *Params) WithServer(server string) *Params

func (*Params) WithThumbprint

func (p *Params) WithThumbprint(thumbprint string) *Params

func (*Params) WithUserInfo

func (p *Params) WithUserInfo(username, password string) *Params

type Session

type Session struct {
	*govmomi.Client
	Finder *find.Finder

	TagManager *tags.Manager
	// contains filtered or unexported fields
}

Session is a vSphere session with a configured Finder.

func GetOrCreate

func GetOrCreate(ctx context.Context, params *Params) (*Session, error)

GetOrCreate gets a cached session or creates a new one if one does not already exist.

func (*Session) FindByBIOSUUID

func (s *Session) FindByBIOSUUID(ctx context.Context, uuid string) (object.Reference, error)

FindByBIOSUUID finds an object by its BIOS UUID.

To avoid comments about this function's name, please see the Golang WIKI https://github.com/golang/go/wiki/CodeReviewComments#initialisms. This function is named in accordance with the example "XMLHTTP".

func (*Session) FindByInstanceUUID

func (s *Session) FindByInstanceUUID(ctx context.Context, uuid string) (object.Reference, error)

FindByInstanceUUID finds an object by its instance UUID.

func (*Session) GetVersion

func (s *Session) GetVersion() (infrav1.VCenterVersion, error)