redfish

Documentation

Overview

Package redfish provides BMC functionality using Redfish.

Index

• Variables
• type Client
  • func NewClient(options Options, address, username, password string, logger *zap.Logger) *Client
  • func (c *Client) Close() error
  • func (c *Client) IsPoweredOn(ctx context.Context) (bool, error)
  • func (c *Client) PowerOff(ctx context.Context) error
  • func (c *Client) PowerOn(ctx context.Context) error
  • func (c *Client) Reboot(ctx context.Context) error
  • func (c *Client) SetPXEBootOnce(ctx context.Context, mode pxe.BootMode) error
• type Options

Variables

var DefaultOptions = Options{
	UseAlways:                 false,
	UseWhenAvailable:          true,
	UseHTTPS:                  true,
	InsecureSkipTLSVerify:     true,
	Port:                      443,
	SetBootSourceOverrideMode: true,
}

DefaultOptions is the default RedFish configuration options.

Types

type Client

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

Client is a wrapper around the gofish client.

func NewClient

func NewClient(options Options, address, username, password string, logger *zap.Logger) *Client

NewClient returns a new Redfish BMC client.

func (*Client) Close

func (c *Client) Close() error

Close implements the power.Client interface.

func (*Client) IsPoweredOn

func (c *Client) IsPoweredOn(ctx context.Context) (bool, error)

IsPoweredOn implements the power.Client interface.

func (*Client) PowerOff

func (c *Client) PowerOff(ctx context.Context) error

PowerOff implements the power.Client interface.

func (*Client) PowerOn

func (c *Client) PowerOn(ctx context.Context) error

PowerOn implements the power.Client interface.

func (*Client) Reboot

func (c *Client) Reboot(ctx context.Context) error

Reboot implements the power.Client interface.

func (*Client) SetPXEBootOnce

func (c *Client) SetPXEBootOnce(ctx context.Context, mode pxe.BootMode) error

SetPXEBootOnce implements the power.Client interface.

type Options

type Options struct {
	UseAlways                 bool
	UseWhenAvailable          bool
	UseHTTPS                  bool
	InsecureSkipTLSVerify     bool
	SetBootSourceOverrideMode bool
	Port                      int
}

Options is a struct that holds the RedFish configuration options.