discover

Documentation

Index

• Constants
• func ScanAndConnect(host string, username string, password string, options ...Option) (bmcConnection interface{}, err error)
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithHintCallBack(fn func(string) error) Option
  • func WithLogger(log logr.Logger) Option
  • func WithProbeHint(hint string) Option
• type Options
• type Probe

Constants

const (
	ProbeHpIlo       = "hpilo"
	ProbeIdrac8      = "idrac8"
	ProbeIdrac9      = "idrac9"
	ProbeSupermicrox = "supermicrox"
	ProbeHpC7000     = "hpc7000"
	ProbeM1000e      = "m1000e"
	ProbeQuanta      = "quanta"
	ProbeHpCl100     = "hpcl100"
)

Functions

func ScanAndConnect

func ScanAndConnect(host string, username string, password string, options ...Option) (bmcConnection interface{}, err error)

ScanAndConnect will scan the bmc trying to learn the device type and return a working connection.

Types

type Option

type Option func(*Options)

Option is part of the functional options pattern, see the `With*` functions and https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis

func WithContext

func WithContext(ctx context.Context) Option

WithContext sets the Options.Context option

func WithHintCallBack

func WithHintCallBack(fn func(string) error) Option

WithHintCallBack sets the Options.HintCallback option.

func WithLogger

func WithLogger(log logr.Logger) Option

WithLogger sets the Options.Logger option

func WithProbeHint

func WithProbeHint(hint string) Option

WithProbeHint sets the Options.Hint option.

type Options

type Options struct {
	// Hint is a probe ID that hints which probe should be probed first.
	Hint string

	// HintCallBack is a function that is called back with a probe ID that might be used
	// for the next ScanAndConnect attempt.  The callback is called only on successful scan.
	// If your code persists the hint as "best effort", always return a nil error.  Callback is
	// synchronous.
	HintCallback func(string) error
	Logger       logr.Logger
	Context      context.Context
}

Options to pass in

type Probe

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