power

Documentation

Overview

Package power provides power management functionality for machines.

Index

• Variables
• type Client
• type ClientFactory
  • func NewClientFactory(options ClientFactoryOptions, logger *zap.Logger) *ClientFactory
  • func (factory *ClientFactory) GetClient(mgmt *specs.PowerManagement) (Client, error)
• type ClientFactoryOptions

Variables

var ErrNoPowerManagementInfo = fmt.Errorf("no power management info found")

ErrNoPowerManagementInfo is returned when there is no power management info present yet for a machine.

Types

type Client

type Client interface {
	io.Closer
	Reboot(ctx context.Context) error
	IsPoweredOn(ctx context.Context) (bool, error)
	PowerOn(ctx context.Context) error
	PowerOff(ctx context.Context) error
	SetPXEBootOnce(ctx context.Context, mode pxe.BootMode) error
}

Client is the interface to interact with a single machine to send power commands to it.

type ClientFactory

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

ClientFactory is a factory to create power management clients.

func NewClientFactory

func NewClientFactory(options ClientFactoryOptions, logger *zap.Logger) *ClientFactory

NewClientFactory creates a new power management client factory.

func (*ClientFactory) GetClient

func (factory *ClientFactory) GetClient(mgmt *specs.PowerManagement) (Client, error)

GetClient returns a power management client for the given bare metal machine.

type ClientFactoryOptions

type ClientFactoryOptions struct {
	ExperimentalUseRedfish           bool
	RedfishSetBootSourceOverrideMode bool
}

ClientFactoryOptions contains options for the client factory.