redfish

package

v2.0.4 Latest Latest Go to latest Published: Aug 8, 2023 License: Apache-2.0 Imports: 27 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/nuclearbob/bmclib

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func SupportedFirmwareApplyAtValues() []string
type Config
type Conn
- func New(host, user, pass string, log logr.Logger, opts ...Option) *Conn
type Option

Constants ¶

View Source

const (
	// ProviderName for the provider implementation
	ProviderName = "gofish"
	// ProviderProtocol for the provider implementation
	ProviderProtocol = "redfish"
)

Variables ¶

View Source

var (
	ErrNoUserSlotsAvailable = errors.New("no user account slots available")
	ErrUserNotPresent       = errors.New("account with username was not found")
	ErrUserPassParams       = errors.New("user and pass parameters required")
	ErrUserExists           = errors.New("user exists")
	ErrInvalidUserRole      = errors.New("invalid user role")
	ValidRoles              = []string{"Administrator", "Operator", "ReadOnly", "None"}
)

View Source

var (
	// Features implemented by gofish
	Features = registrar.Features{
		providers.FeaturePowerSet,
		providers.FeaturePowerState,
		providers.FeatureUserCreate,
		providers.FeatureUserUpdate,
		providers.FeatureUserDelete,
		providers.FeatureBootDeviceSet,
		providers.FeatureVirtualMedia,
		providers.FeatureInventoryRead,
		providers.FeatureFirmwareInstall,
		providers.FeatureFirmwareInstallStatus,
		providers.FeatureBmcReset,
	}
)

Functions ¶

func SupportedFirmwareApplyAtValues ¶

func SupportedFirmwareApplyAtValues() []string

SupportedFirmwareApplyAtValues returns the supported redfish firmware applyAt values

Types ¶

type Config ¶

type Config struct {
	HttpClient *http.Client
	Port       string
	// VersionsNotCompatible	is the list of incompatible redfish versions.
	//
	// With this option set, The bmclib.Registry.FilterForCompatible(ctx) method will not proceed on
	// devices with the given redfish version(s).
	VersionsNotCompatible []string
	RootCAs               *x509.CertPool
	UseBasicAuth          bool
}

type Conn ¶

type Conn struct {
	Log logr.Logger
	// contains filtered or unexported fields
}

Conn details for redfish client

func New ¶

func New(host, user, pass string, log logr.Logger, opts ...Option) *Conn

New returns connection with a redfish client initialized

func (*Conn) BmcReset ¶

func (c *Conn) BmcReset(ctx context.Context, resetType string) (ok bool, err error)

BmcReset power cycles the BMC

func (*Conn) BootDeviceSet ¶

func (c *Conn) BootDeviceSet(ctx context.Context, bootDevice string, setPersistent, efiBoot bool) (ok bool, err error)

BootDeviceSet sets the boot device

func (*Conn) Close ¶

func (c *Conn) Close(ctx context.Context) error

Close a connection to a BMC via redfish

func (*Conn) Compatible ¶

func (c *Conn) Compatible(ctx context.Context) bool

Compatible tests whether a BMC is compatible with the gofish provider

func (*Conn) DeviceVendorModel ¶

func (c *Conn) DeviceVendorModel(ctx context.Context) (vendor, model string, err error)

DeviceVendorModel returns the device manufacturer and model attributes

func (*Conn) FirmwareInstall ¶

func (c *Conn) FirmwareInstall(ctx context.Context, component, applyAt string, forceInstall bool, reader io.Reader) (taskID string, err error)

FirmwareInstall uploads and initiates the firmware install process

func (*Conn) FirmwareInstallStatus ¶

func (c *Conn) FirmwareInstallStatus(ctx context.Context, installVersion, component, taskID string) (state string, err error)

FirmwareInstallStatus returns the status of the firmware install task queued

func (*Conn) GetBiosConfiguration ¶

func (c *Conn) GetBiosConfiguration(ctx context.Context) (biosConfig map[string]string, err error)

func (*Conn) GetFirmwareInstallTaskQueued ¶

func (c *Conn) GetFirmwareInstallTaskQueued(ctx context.Context, component string) (*gofishrf.Task, error)

GetFirmwareInstallTaskQueued returns the redfish task object for a queued update task

func (*Conn) Inventory ¶

func (c *Conn) Inventory(ctx context.Context) (device *common.Device, err error)

func (*Conn) Name ¶

func (c *Conn) Name() string

Name returns the client provider name.

func (*Conn) Open ¶

func (c *Conn) Open(ctx context.Context) (err error)

Open a connection to a BMC via redfish

func (*Conn) PowerSet ¶

func (c *Conn) PowerSet(ctx context.Context, state string) (ok bool, err error)

PowerSet sets the power state of a server

func (*Conn) PowerStateGet ¶

func (c *Conn) PowerStateGet(ctx context.Context) (state string, err error)

PowerStateGet gets the power state of a BMC machine

func (*Conn) SetVirtualMedia ¶

func (c *Conn) SetVirtualMedia(ctx context.Context, kind string, mediaURL string) (ok bool, err error)

SetVirtualMedia sets the virtual media

func (*Conn) UserCreate ¶

func (c *Conn) UserCreate(ctx context.Context, user, pass, role string) (ok bool, err error)

UserCreate adds a new user account

func (*Conn) UserDelete ¶

func (c *Conn) UserDelete(ctx context.Context, user string) (ok bool, err error)

UserDelete deletes a user account

func (*Conn) UserRead ¶

func (c *Conn) UserRead(ctx context.Context) (users []map[string]string, err error)

UserRead returns a list of enabled user accounts

func (*Conn) UserUpdate ¶

func (c *Conn) UserUpdate(ctx context.Context, user, pass, role string) (ok bool, err error)

UserUpdate updates a user password and role

type Option ¶

type Option func(*Config)

Option for setting optional Client values

func WithHttpClient ¶

func WithHttpClient(httpClient *http.Client) Option

func WithPort ¶

func WithPort(port string) Option

func WithRootCAs ¶

func WithRootCAs(rootCAs *x509.CertPool) Option

func WithUseBasicAuth ¶

func WithUseBasicAuth(useBasicAuth bool) Option

func WithVersionsNotCompatible ¶

func WithVersionsNotCompatible(versionsNotCompatible []string) Option

Source Files ¶

View all Source files

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