BMCLib v2

https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2
Admin
BMCLib is a Go library that abstracts interactions with baseboard management controllers (BMCs)...
Tokens:43,505
Snippets:1,002
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### install-firmware usage and examples

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2/examples/install-firmware

This snippet shows the usage of the install-firmware command and provides examples for installing BIOS and BMC firmware on a Supermicro X11.

```bash
$ go run ./examples/v1/install-firmware/main.go -h
Usage of /tmp/go-build2950657412/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when -secure-tls=true
	-firmware string
		The local path of the firmware to install
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with
	-version string
		The firmware version being installed

# install bios firmware on a supermicro X11
#
$ go run .  -host 192.168.1.1 -user ADMIN -password hunter2 -component bios -firmware BIOS_X11DPH-0981_20220208_3.6_STD.bin
INFO[0007] set firmware install mode                     component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0011] uploading firmware                            component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0091] verifying uploaded firmware                   component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0105] initiating firmware install                   component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0115] firmware install running                      component=bios state=running
INFO[0132] firmware install running                      component=bios state=running
...
...
                       INFO[0628] firmware install running                      component=bios state=running
                       INFO[0635] host powercycle required                      component=bios state=powercycle-host
                       INFO[0637] host power cycled, all done!                  component=bios state=powercycle-host

# install bmc firmware on a supermicro X11
#
$ go run .  -host 192.168.1.1 -user ADMIN -password hunter2 -component bmc -firmware BMC_X11AST2500-4101MS_20220225_01.74.02_STD.bin
                INFO[0007] setting device to firmware install mode       component=BMC ip="https://192.168.1.1"
                INFO[0009] uploading firmware                            ip="https://192.168.1.1"
                INFO[0045] verifying uploaded firmware                   ip="https://192.168.1.1"
                INFO[0047] initiating firmware install                   ip="https://192.168.1.1"
                INFO[0079] firmware install running                      component=bmc state=running
                INFO[0085] firmware install running                      component=bmc state=running
                ...
				...
				INFO[0233] firmware install running                      component=bmc state=running
                    INFO[0238] firmware install completed                    component=bmc state=complete

```

--------------------------------

### install-firmware command usage and examples

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/install-firmware

This snippet shows the command-line usage of the install-firmware example and provides two examples: one for installing BIOS firmware and another for BMC firmware on a Supermicro X11.

```bash
$ go run ./examples/v1/install-firmware/main.go -h
Usage of /tmp/go-build2950657412/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when -secure-tls=true
	-firmware string
		The local path of the firmware to install
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with
	-version string
		The firmware version being installed

# install bios firmware on a supermicro X11
#
$ go run .  -host 192.168.1.1 -user ADMIN -password hunter2 -component bios -firmware BIOS_X11DPH-0981_20220208_3.6_STD.bin
INFO[0007] set firmware install mode                     component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0011] uploading firmware                            component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0091] verifying uploaded firmware                   component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0105] initiating firmware install                   component=BIOS ip="https://192.168.1.1" model=X11DPH-T
INFO[0115] firmware install running                      component=bios state=running
INFO[0132] firmware install running                      component=bios state=running
...
...
                       INFO[0628] firmware install running                      component=bios state=running
                       INFO[0635] host powercycle required                      component=bios state=powercycle-host
                       INFO[0637] host power cycled, all done!                  component=bios state=powercycle-host

		# install bmc firmware on a supermicro X11
		#
		$ go run .  -host 192.168.1.1 -user ADMIN -password hunter2 -component bmc -firmware BMC_X11AST2500-4101MS_20220225_01.74.02_STD.bin
                        INFO[0007] setting device to firmware install mode       component=BMC ip="https://192.168.1.1"
                        INFO[0009] uploading firmware                            ip="https://192.168.1.1"
                        INFO[0045] verifying uploaded firmware                   ip="https://192.168.1.1"
                        INFO[0047] initiating firmware install                   ip="https://192.168.1.1"
                        INFO[0079] firmware install running                      component=bmc state=running
                        INFO[0085] firmware install running                      component=bmc state=running
                        ...
						...
						INFO[0233] firmware install running                      component=bmc state=running
	                    INFO[0238] firmware install completed                    component=bmc state=complete

```

--------------------------------

### Run BIOS example

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/bios

This command demonstrates how to run the bios example to retrieve BIOS configuration information.

```bash
$ BMC_HOST=1.2.3.4 BMC_USERNAME=foo BMC_PASSWORD=bar go run ./examples/bios/main.go

```

--------------------------------

### FirmwareInstallUploadAndInitiate Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Uploads and initiates firmware installation.

```Go
func (c *Conn) FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (taskID string, err error)
```

--------------------------------

### Installation

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Install the bmclib package using go get.

```go
go get github.com/bmc-toolbox/bmclib/v2

```

--------------------------------

### Inventory Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Inventory collects hardware inventory and install firmware information.

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

--------------------------------

### Mount and unmount ISO

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/virtualmedia

Examples of how to mount and unmount an ISO image using the virtualmedia command.

```bash
# mount an ISO
$ go run examples/virtualmedia/main.go \
	-host 10.1.2.3 \
	-user root \
	-password calvin \
	-iso http://example.com/image.iso

# unmount an ISO
$ go run examples/virtualmedia/main.go \
	-host 10.1.2.3 \
	-user root \
	-password calvin \
	-iso ""

```

--------------------------------

### FirmwareInstallUploaded

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Installs firmware after it has been uploaded.

```Go
func (c *Client) FirmwareInstallUploaded(ctx context.Context, component, uploadTaskID string) (installTaskID string, err error)
```

--------------------------------

### Client.StartUpdateForUploadedFirmware Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

StartUpdateForUploadedFirmware starts an update for a firmware file previously uploaded and returns the taskID. Added in v2.2.0.

```Go
func (c *Client) StartUpdateForUploadedFirmware(ctx context.Context) (taskID string, err error)
```

--------------------------------

### FirmwareInstallSteps method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

FirmwareInstallSteps return the order of actions required install firmware for a component.

```go
func (c *Client) FirmwareInstallSteps(ctx context.Context, component string) (actions []constants.FirmwareInstallStep, err error)
```

--------------------------------

### mount and unmount floppy image

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/floppy-image

This example demonstrates how to mount and unmount a floppy image using the command-line interface.

```bash
# mount image
	$ go run examples/floppy-image/main.go \
		-host 10.1.2.3 \
		-user ADMIN \
		-password hunter2 \
		-image /tmp/floppy.img

	# un-mount image
	$ go run examples/floppy-image/main.go \
		-host 10.1.2.3 \
		-user ADMIN \
		-password hunter2 \
		-unmount

```

--------------------------------

### FirmwareInstallSteps

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

FirmwareInstallSteps returns the steps required to install firmware.

```go
func (a *ASRockRack) FirmwareInstallSteps(ctx context.Context, component string) ([]constants.FirmwareInstallStep, error)
```

--------------------------------

### Usage Example

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Connect to a BMC, retrieve device hardware and firmware inventory, and print it as JSON.

```go
import (
  bmclib "github.com/bmc-toolbox/bmclib/v2"
)

    // setup logger
    l := logrus.New()
    l.Level = logrus.DebugLevel
    logger := logrusr.New(l)

    clientOpts := []bmclib.Option{bmclib.WithLogger(logger)}

    // init client
    client := bmclib.NewClient(*host, "admin", "hunter2", clientOpts...)

    // open BMC session
    err := client.Open(ctx)
    if err != nil {
        log.Fatal(err, "bmc login failed")
    }

    defer client.Close(ctx)

    // retrieve inventory data
    inventory, err := client.Inventory(ctx)
    if err != nil {
        l.Error(err)
    }

    b, err := json.MarshalIndent(inventory, "", "  ")
    if err != nil {
        l.Error(err)
    }

    fmt.Println(string(b))

```

--------------------------------

### create-users command usage

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/create-users

This snippet shows the command-line usage for the create-users example, including available flags and their descriptions.

```bash
$ go run ./examples/v1/create-users/main.go -h
Usage of /tmp/go-build440589615/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when --secure-tls=true
	-dry-run
		Connect to the BMC but do not create users
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with
	-user-csv string
		A CSV file of users to create containing 3 columns: username, password, role

```

--------------------------------

### FirmwareInstall method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

FirmwareInstall pass through library function to upload firmware and install firmware

```go
func (c *Client) FirmwareInstall(ctx context.Context, component string, operationApplyTime string, forceInstall bool, reader io.Reader) (taskID string, err error)
```

--------------------------------

### FirmwareInstallProvider Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2/bmc

Interface definition for FirmwareInstallProvider, for uploading and initiating firmware installs.

```go
type FirmwareInstallProvider interface {
	// FirmwareInstallUploadAndInitiate uploads _and_ initiates the firmware install process.
	//
	// return values:
	// taskID - A taskID is returned if the update process on the BMC returns an identifier for the update process.
	FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (taskID string, err error)
}
```

--------------------------------

### PowerStateGet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

PowerStateGet gets the power state of a BMC machine.

```Go
func (p *Config) PowerStateGet(ctx context.Context) (state string, err error)
```

--------------------------------

### FirmwareUpload Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

Uploads a file and initiates the firmware installation process. Added in v2.2.0.

```go
func (c *Client) FirmwareUpload(ctx context.Context, updateFile *os.File, params *RedfishUpdateServiceParameters) (taskID string, err error)
```

--------------------------------

### FirmwareInstallUploaded

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

FirmwareInstallUploaded installs firmware from an uploaded file.

```go
func (a *ASRockRack) FirmwareInstallUploaded(ctx context.Context, component, uploadTaskID string) (installTaskID string, err error)
```

--------------------------------

### FirmwareInstallUploaded method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

FirmwareInstallUploaded kicks off firmware install for a firmware uploaded with FirmwareUpload.

```go
func (c *Client) FirmwareInstallUploaded(ctx context.Context, component, uploadVerifyTaskID string) (installTaskID string, err error)
```

--------------------------------

### FirmwareUpload method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

FirmwareUpload just uploads the firmware for install, it returns a task ID to verify the upload status.

```go
func (c *Client) FirmwareUpload(ctx context.Context, component string, file *os.File) (uploadVerifyTaskID string, err error)
```

--------------------------------

### Get Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

Performs an HTTP GET request.

```go
func (c *Client) Get(url string) (*http.Response, error)
```

--------------------------------

### FirmwareInstallerUploaded Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/bmc

Defines the interface for installing firmware that was previously uploaded.

```go
type FirmwareInstallerUploaded interface {
	// FirmwareInstallUploaded uploads firmware update payload to the BMC returning the firmware install task ID
	//
	// parameters:
	// component - the component slug for the component update being installed.
	// uploadTaskID - the taskID for the firmware upload verify task (returned by FirmwareUpload)
	//
	// return values:
	// installTaskID - A installTaskID is returned if the update process on the BMC returns an identifier for the firmware install process.
	FirmwareInstallUploaded(ctx context.Context, component, uploadTaskID string) (taskID string, err error)
}
```

--------------------------------

### Inventory

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Collects hardware inventory and firmware installation information.

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

--------------------------------

### Client.System Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

System gets the system matching c.systemName or when c.systemName is not set and there is only one system it returns that system. Added in v2.3.5.

```Go
func (c *Client) System() (*redfish.ComputerSystem, error)
```

--------------------------------

### Variables

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Error variables related to firmware installation and multipart form handling.

```go
var (
	ErrFirmwareInstallMode = errors.New("firmware install mode error")
	ErrMultipartForm       = errors.New("multipart form error")
)
```

--------------------------------

### Client.UpdateService Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

UpdateService gets the update service instance.

```Go
func (c *Client) UpdateService() (*redfish.UpdateService, error)
```

--------------------------------

### PowerStateGet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Gets the power state of a BMC machine.

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

--------------------------------

### Constants Definition

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/constants

Defines various constants for environment variables, vendor names, firmware operations, task states, and firmware install steps.

```go
const (
	// EnvEnableDebug is the const for the environment variable to cause bmclib to dump debugging debugging information.
	// the valid parameter for this environment variable is 'true'
	EnvEnableDebug = "DEBUG_BMCLIB"

	// HP is the constant that defines the vendor HP
	HP = "HP"
	// Dell is the constant that defines the vendor Dell
	Dell = "Dell"
	// Supermicro is the constant that defines the vendor Supermicro
	Supermicro = "Supermicro"
	// Cloudline is the constant that defines the cloudlines
	Cloudline = "Cloudline"
	// Quanta is the contant to identify Quanta hardware
	Quanta = "Quanta"
	// Quanta is the contant to identify Intel hardware
	Intel = "Intel"

	// Redfish firmware apply at constants
	// FirmwareApplyImmediate sets the firmware to be installed immediately after upload
	Immediate OperationApplyTime = "Immediate"
	//FirmwareApplyOnReset sets the firmware to be install on device power cycle/reset
	OnReset OperationApplyTime = "OnReset"
	// FirmwareOnStartUpdateRequest sets the firmware install to begin after the start request has been sent.
	OnStartUpdateRequest OperationApplyTime = "OnStartUpdateRequest"

	// FirmwareInstallInitializing indicates the device is performing init actions to install the update
	// this covers the redfish states - 'starting', 'downloading'
	// no action is required from the callers part in this state
	FirmwareInstallInitializing           = "initializing"
	Initializing                TaskState = "initializing"

	// FirmwareInstallQueued indicates the device has queued the update, but has not started the update task yet
	// this covers the redfish states - 'pending', 'new'
	// no action is required from the callers part in this state
	FirmwareInstallQueued           = "queued"
	Queued                TaskState = "queued"

	// FirmwareInstallRunner indicates the device is installing the update
	// this covers the redfish states - 'running', 'stopping', 'cancelling'
	// no action is required from the callers part in this state
	FirmwareInstallRunning           = "running"
	Running                TaskState = "running"

	// FirmwareInstallComplete indicates the device completed the firmware install
	// this covers the redfish state - 'complete'
	FirmwareInstallComplete           = "complete"
	Complete                TaskState = "complete"

	// FirmwareInstallFailed indicates the firmware install failed
	// this covers the redfish states - 'interrupted', 'killed', 'exception', 'cancelled', 'suspended'
	FirmwareInstallFailed           = "failed"
	Failed                TaskState = "failed"

	// FirmwareInstallPowerCycleHost indicates the firmware install requires a host power cycle
	FirmwareInstallPowerCycleHost           = "powercycle-host"
	PowerCycleHost                TaskState = "powercycle-host"

	FirmwareInstallUnknown           = "unknown"
	Unknown                TaskState = "unknown"

	// FirmwareInstallStepUploadInitiateInstall identifies the step to upload _and_ initialize the firmware install.
	// as part of the same call.
	FirmwareInstallStepUploadInitiateInstall FirmwareInstallStep = "upload-initiate-install"

	// FirmwareInstallStepInstallStatus identifies the step to verify the status of the firmware install.
	FirmwareInstallStepInstallStatus FirmwareInstallStep = "install-status"

	// FirmwareInstallStepUpload identifies the upload step in the firmware install process.
	FirmwareInstallStepUpload FirmwareInstallStep = "upload"

	// FirmwareInstallStepUploadStatus identifies the step to verify the upload status as part of the firmware install status.
	FirmwareInstallStepUploadStatus FirmwareInstallStep = "upload-status"

	// FirmwareInstallStepInstallUploaded identifies the step to install firmware uploaded in FirmwareInstallStepUpload.
	FirmwareInstallStepInstallUploaded FirmwareInstallStep = "install-uploaded"

	// FirmwareInstallStepPowerOffHost indicates the host requires to be powered off.
	FirmwareInstallStepPowerOffHost FirmwareInstallStep = "power-off-host"

	// FirmwareInstallStepResetBMCPostInstall indicates the BMC requires a reset after the install.
	FirmwareInstallStepResetBMCPostInstall FirmwareInstallStep = "reset-bmc-post-install"

	// FirmwareInstallStepResetBMCOnInstallFailure indicates the BMC requires a reset if an install fails.
	FirmwareInstallStepResetBMCOnInstallFailure FirmwareInstallStep = "reset-bmc-on-install-failure"

	// device BIOS/UEFI POST code bmclib identifiers
	POSTStateBootINIT = "boot-init/pxe"
	POSTStateUEFI     = "uefi"
	POSTStateOS       = "grub/os"
	POSTCodeUnknown   = "unknown"
)
```

--------------------------------

### Default timeout

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example demonstrating the default timeout behavior when no explicit timeouts are set.

```go
cl := bmclib.NewClient(host, user, pass, bmclib.WithLogger(log))

ctx := context.Background()

if err = cl.Open(ctx); err != nil {
  return(err)
}
def cl.Close(ctx)

state, err := cl.GetPowerState(ctx)
```

--------------------------------

### FirmwareInstallStep Type Definition

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/constants

Definition of the FirmwareInstallStep type, which is a string alias used to identify phases of a firmware install process.

```go
type FirmwareInstallStep string
```

--------------------------------

### Tracing Configuration

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of how to configure the bmclib client to collect trace telemetry using OpenTelemetry.

```go
cl := bmclib.NewClient(
          host,
          user,
          pass,
          bmclib.WithLogger(log),
          bmclib.WithTracerProvider(otel.GetTracerProvider()),
      )

```

--------------------------------

### FirmwareInstallProvider Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/bmc

Interface definition for FirmwareInstallProvider, used for uploading and initiating firmware installation.

```Go
// FirmwareInstallUploadAndInitiate uploads _and_ initiates the firmware install process.
//
// return values:
// taskID - A taskID is returned if the update process on the BMC returns an identifier for the update process.
FirmwareInstallProvider interface {
	FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (taskID string, err error)
}
```

--------------------------------

### FirmwareInstallStepsGetter Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/bmc

Interface definition for FirmwareInstallStepsGetter, used for retrieving firmware installation steps.

```Go
type FirmwareInstallStepsGetter interface {
	FirmwareInstallSteps(ctx context.Context, component string) ([]constants.FirmwareInstallStep, error)
}
```

--------------------------------

### Status command usage

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/screenshot

This code snippet shows the usage of the status command, which is an example command that utilizes the 'v1' bmclib interface methods to capture a screenshot.

```go
$ go run ./examples/v1/status/main.go -h
Usage of /tmp/go-build1941100323/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when --secure-tls=true
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with

```

--------------------------------

### Total max timeout and a per provider; per interaction timeout

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of setting both a total maximum timeout and a per-provider timeout.

```go
cl := bmclib.NewClient(host, user, pass, bmclib.WithLogger(log), bmclib.WithPerProviderTimeout(15*time.Second))

ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
def cancel()

if err = cl.Open(ctx); err != nil {
  return(err)
}
def cl.Close(ctx)

state, err := cl.GetPowerState(ctx)
```

--------------------------------

### BootDeviceSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

BootDeviceSet is a no-op here.

```Go
func (p *Config) BootDeviceSet(ctx context.Context, bootDevice string, setPersistent, efiBoot bool) (ok bool, err error)
```

--------------------------------

### FirmwareInstallSteps Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

BMC client interface implementations methods.

```Go
func (c *Conn) FirmwareInstallSteps(ctx context.Context, component string) ([]constants.FirmwareInstallStep, error)
```

--------------------------------

### PowerStateGet

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Gets the power state of a BMC machine.

```Go
func (c *Client) PowerStateGet(ctx context.Context) (state string, err error)
```

--------------------------------

### PowerStateGet

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

PowerStateGet gets the power state of a machine.

```go
func (a *ASRockRack) PowerStateGet(ctx context.Context) (state string, err error)
```

--------------------------------

### FirmwareInstallStatus method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Note: this interface is to be deprecated in favour of a more generic FirmwareTaskStatus. FirmwareInstallStatus pass through library function to check firmware install status

```go
func (c *Client) FirmwareInstallStatus(ctx context.Context, installVersion, component, taskID string) (status string, err error)
```

--------------------------------

### New Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

New returns connection with a redfish client initialized.

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

--------------------------------

### Open Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Open a connection to Home Assistant, and validate the entity referenced exists.

```Go
func (p *Config) Open(ctx context.Context) error
```

--------------------------------

### PowerStateGet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Gets the power state of a BMC machine.

```Go
func (p *Provider) PowerStateGet(ctx context.Context) (state string, err error)
```

--------------------------------

### New Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

New returns a new Config containing all the defaults for the HomeAssistant provider.

```Go
func New(apiUrl string, apiToken string) *Config
```

--------------------------------

### BootDeviceOverrideGet

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/redfish

BootDeviceOverrideGet gets the boot override device information

```go
func (c *Conn) BootDeviceOverrideGet(ctx context.Context) (bmc.BootDeviceOverride, error)
```

--------------------------------

### Client.SystemBootDeviceSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SystemBootDeviceSet set the boot device for the system.

```Go
func (c *Client) SystemBootDeviceSet(_ context.Context, bootDevice string, setPersistent, efiBoot bool) (ok bool, err error)
```

--------------------------------

### BootDeviceSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Sets the next boot device with options.

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

--------------------------------

### NewClient

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Initializes a new Supermicro client connection.

```Go
func NewClient(host, user, pass string, log logr.Logger, opts ...Option) *Client
```

--------------------------------

### BootDeviceOverrideGetter Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/bmc

Interface definition for BootDeviceOverrideGetter, used for getting boot override settings.

```Go
type BootDeviceOverrideGetter interface {
	BootDeviceOverrideGet(ctx context.Context) (override BootDeviceOverride, err error)
}
```

--------------------------------

### inventory command help

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/inventory

This code snippet shows the help output for the inventory command, detailing its usage and available flags.

```bash
$ go run ./examples/v1/inventory/main.go -h
Usage of /tmp/go-build1853609647/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when --secure-tls=true
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with

```

--------------------------------

### Get System Event Log Raw

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

GetSystemEventLogRaw returns the raw SEL output.

```go
func (i *Ipmi) GetSystemEventLogRaw(ctx context.Context) (eventlog string, err error)
```

--------------------------------

### FirmwareInstallUploadAndInitiate method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

FirmwareInstallUploadAndInitiate method

```go
func (c *Client) FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (taskID string, err error)
```

--------------------------------

### FirmwareInstallVerifier Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2/bmc

Interface definition for FirmwareInstallVerifier, used to check firmware install status.

```go
type FirmwareInstallVerifier interface {
	// FirmwareInstallStatus returns the status of the firmware install process.
	//
	// parameters:
	// installVersion (required) - the version this method should check is installed.
	// component (optional) - the component slug for the component update being installed.
	// taskID (optional) - the task identifier.
	//
	// return values:
	// status - returns one of the FirmwareInstall statuses (see devices/constants.go).
	FirmwareInstallStatus(ctx context.Context, installVersion, component, taskID string) (status string, err error)
}
```

--------------------------------

### func (*Conn) Screenshot

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/dell

No description

```go
func (c *Conn) Screenshot(ctx context.Context) (image []byte, fileType string, err error)
```

--------------------------------

### Open Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

Establishes a new Redfish session.

```go
func (c *Client) Open(ctx context.Context) error
```

--------------------------------

### FirmwareInstallVerifier Interface

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/bmc

Interface definition for FirmwareInstallVerifier, used for checking firmware install status.

```Go
// FirmwareInstallStatus returns the status of the firmware install process.
//
// parameters:
// installVersion (required) - the version this method should check is installed.
// component (optional) - the component slug for the component update being installed.
// taskID (optional) - the task identifier.
//
// return values:
// status - returns one of the FirmwareInstall statuses (see devices/constants.go).
FirmwareInstallVerifier interface {
	FirmwareInstallStatus(ctx context.Context, installVersion, component, taskID string) (status string, err error)
}
```

--------------------------------

### Open Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Opens a connection to the BMC via Intel AMT.

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

--------------------------------

### Name

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Returns the client provider name.

```Go
func (c *Client) Name() string
```

--------------------------------

### FirmwareInstallSteps

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

BMC client interface implementations methods.

```Go
func (c *Client) FirmwareInstallSteps(ctx context.Context, component string) ([]constants.FirmwareInstallStep, error)
```

--------------------------------

### Open method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/sum

Open opens a connection to the BMC.

```go
func (c *Sum) Open(ctx context.Context) (err error)

```

--------------------------------

### WithHttpClient Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Option to provide a custom http.Client.

```go
func WithHttpClient(httpClient *http.Client) Option
```

--------------------------------

### New function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/sum

New creates a new Sum client.

```go
func New(host, user, pass string, opts ...Option) (*Sum, error)

```

--------------------------------

### Client.SetVirtualMedia Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SetVirtualMedia sets virtual media on the system. If mediaURL is empty, matching media may be ejected. When multiple matching virtual media slots exist, each slot is tried in order until one succeeds.

```Go
func (c *Client) SetVirtualMedia(ctx context.Context, kind string, mediaURL string) (bool, error)
```

--------------------------------

### GetBootProgress Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

Retrieves the boot progress information. Added in v2.3.2.

```go
func (c *Client) GetBootProgress() ([]*redfish.BootProgress, error)
```

--------------------------------

### Get System Event Log

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

GetSystemEventLog returns the system event log entries in ID, Timestamp, Description, Message format.

```go
func (i *Ipmi) GetSystemEventLog(ctx context.Context) (entries [][]string, err error)
```

--------------------------------

### Total max timeout only

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of setting only a total maximum timeout for all BMC interactions.

```go
cl := bmclib.NewClient(host, user, pass, bmclib.WithLogger(log))

ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
def cancel()

if err = cl.Open(ctx); err != nil {
  return(err)
}
def cl.Close(ctx)

state, err := cl.GetPowerState(ctx)
```

--------------------------------

### WithHomeAssistantOpt function signature

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Option for Home Assistant configuration.

```go
func WithHomeAssistantOpt(opt homeassistant.Config) Option
```

--------------------------------

### New function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

New returns a new ASRockRack instance ready to be used.

```go
func New(ip string, username string, password string, log logr.Logger) *ASRockRack
```

--------------------------------

### Client.SystemPowerStatus Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SystemPowerStatus returns the system power state.

```Go
func (c *Client) SystemPowerStatus(ctx context.Context) (result string, err error)
```

--------------------------------

### Name Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Returns the name of the provider.

```go
func (c *Conn) Name() string
```

--------------------------------

### func WithVersionsNotCompatible

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/dell

No description

```go
func WithVersionsNotCompatible(versionsNotCompatible []string) Option
```

--------------------------------

### Permanent Filtering - Modifying Provider Order

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of permanently modifying the order of BMC providers using PreferDriver.

```go
cl := bmclib.NewClient(host, user, pass)
// This will modify the order for all subsequent BMC calls
cl.Registry.Drivers = cl.Registry.PreferDriver("gofish")
if err := cl.Open(ctx); err != nil {
  return(err)
}
```

--------------------------------

### New Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/ipmitool

Creates a new ipmitool connection.

```go
func New(host, user, pass string, opts ...Option) (*Conn, error)
```

--------------------------------

### UserCreate

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

UserCreate adds a new user account.

```go
func (a *ASRockRack) UserCreate(ctx context.Context, user, pass, role string) (ok bool, err error)
```

--------------------------------

### Variables

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Features implemented by the HomeAssistant provider.

```Go
var Features = registrar.Features{
	providers.FeaturePowerSet,
	providers.FeaturePowerState,
	providers.FeatureBootDeviceSet,
}
```

--------------------------------

### One-time Filtering - Modifying Provider Order for a Single Call

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of modifying the provider order for a single BMC call using PreferProvider.

```go
cl := bmclib.NewClient(host, user, pass)
// This will modify the order for only this BMC call
if err := cl.PreferProvider("gofish").Open(ctx); err != nil {
  return(err)
}
```

--------------------------------

### PxeOnce

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

PxeOnce makes the machine to boot via pxe once using MBR

```go
func (i *Ipmi) PxeOnce(ctx context.Context) (status bool, err error)
```

--------------------------------

### Per provider; per interaction timeout. No total max timeout

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Example of setting only a per-provider timeout without a total maximum timeout.

```go
cl := bmclib.NewClient(host, user, pass, bmclib.WithLogger(log), bmclib.WithPerProviderTimeout(15*time.Second))

ctx := context.Background()

if err = cl.Open(ctx); err != nil {
  return(err)
}
def cl.Close(ctx)

state, err := cl.GetPowerState(ctx)
```

--------------------------------

### Option type

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/sum

Option for setting optional Client values

```go
type Option func(*Sum)

```

--------------------------------

### PreferProvider Function Signature

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Reorders the registry to have the given provider first. This is a one-time/temporary reordering of the providers in the registry and is not preserved. It is only used for the call that uses the returned Client. Update the Client.Registry to make the change permanent. For example, `cl.Registry.Drivers = cl.Registry.PreferDriver("ipmitool")`

```go
func (c *Client) PreferProvider(name string) *Client
```

--------------------------------

### Open

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

Open a connection to a BMC, implements the Opener interface.

```go
func (a *ASRockRack) Open(ctx context.Context) (err error)
```

--------------------------------

### Constants

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Constants for the OpenBMC provider implementation.

```Go
const (
	// ProviderName for the OpenBMC provider implementation
	ProviderName = "openbmc"
	// ProviderProtocol for the OpenBMC provider implementation
	ProviderProtocol = "redfish"
)
```

--------------------------------

### Client.SystemPowerOn Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SystemPowerOn powers on the system.

```Go
func (c *Client) SystemPowerOn(ctx context.Context) (ok bool, err error)
```

--------------------------------

### BootDeviceSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Sends a next boot device RPC notification.

```Go
func (p *Provider) BootDeviceSet(ctx context.Context, bootDevice string, setPersistent, efiBoot bool) (ok bool, err error)
```

--------------------------------

### WithUseBasicAuth Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Option to enable or disable basic authentication.

```go
func WithUseBasicAuth(useBasicAuth bool) Option
```

--------------------------------

### Config Struct

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Configuration struct for the HomeAssistant provider.

```Go
type Config struct {
	ApiUrl                     string
	ApiToken                   string
	SwitchEntityID             string
	PowerOperationDelaySeconds uint32
	HTTPClient                 *http.Client
	Logger                     logr.Logger
}
```

--------------------------------

### func (*Conn) GetBiosConfiguration

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/dell

GetBiosConfiguration returns the BIOS configuration settings via the BMC

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

--------------------------------

### BmcReset Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

BmcReset power cycles the BMC.

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

--------------------------------

### Constants

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Constants for the HomeAssistant provider.

```Go
const (
	// ProviderName for the HomeAssistant implementation.
	ProviderName = "homeassistant"
	// ProviderProtocol for the HomeAssistant implementation.
	ProviderProtocol = "http"
)
```

--------------------------------

### Build

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/httpclient

Build builds a client session with our default parameters

```go
func Build(opts ...func(*http.Client)) *http.Client
```

--------------------------------

### New Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Creates a new Intel AMT connection.

```go
func New(host string, user string, pass string, opts ...Option) *Conn
```

--------------------------------

### Name Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Name returns the name of this HomeAssistant provider. Implements bmc.Provider interface

```Go
func (p *Config) Name() string
```

--------------------------------

### Execute.GetCmd method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/executor

Returns the command string including its arguments.

```Go
func (e *Execute) GetCmd() string
```

--------------------------------

### PowerSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

PowerSet sets the power state of a BMC machine.

```Go
func (p *Config) PowerSet(ctx context.Context, state string) (ok bool, err error)
```

--------------------------------

### BootDeviceParams are the parameters options used when setting a boot device.

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

BootDeviceParams are the parameters options used when setting a boot device.

```Go
type BootDeviceParams struct {
	Device     string `json:"device"`
	Persistent bool   `json:"persistent"`
	EFIBoot    bool   `json:"efiBoot"`
}
```

--------------------------------

### PxeOnceEfi

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

PxeOnceEfi makes the machine to boot via pxe once using EFI

```go
func (i *Ipmi) PxeOnceEfi(ctx context.Context) (status bool, err error)
```

--------------------------------

### Close Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/homeassistant

Close a connection to the HomeAssistant consumer.

```Go
func (p *Config) Close(_ context.Context) (err error)
```

--------------------------------

### ToShort returns the short version of an algorithm.

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

ToShort returns the short version of an algorithm.

```Go
func (a Algorithm) ToShort() Algorithm
```

--------------------------------

### New Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Returns a new Config with default settings for the RPC provider.

```Go
func New(consumerURL string, host string, secrets Secrets) *Provider
```

--------------------------------

### Features Implemented by Dell Redfish

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/dell

Lists the features supported by the Dell Redfish provider.

```go
var (
	// Features implemented by dell redfish
	Features = registrar.Features{
		providers.FeatureScreenshot,
		providers.FeaturePowerState,
		providers.FeaturePowerSet,
		providers.FeatureFirmwareInstallSteps,
		providers.FeatureFirmwareUploadInitiateInstall,
		providers.FeatureFirmwareTaskStatus,
		providers.FeatureInventoryRead,
		providers.FeatureBmcReset,
		providers.FeatureGetBiosConfiguration,
		providers.FeatureSetBiosConfiguration,
		providers.FeatureResetBiosConfiguration,
	}
)
```

--------------------------------

### Import

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Import the bmclib package into your Go project.

```go
import (
  bmclib "github.com/bmc-toolbox/bmclib/v2"
)

```

--------------------------------

### LoadDefaultBiosCfg method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/sum

LoadDefaultBiosCfg loads the default BIOS configuration.

```go
func (s *Sum) LoadDefaultBiosCfg(ctx context.Context) (err error)

```

--------------------------------

### BootComplete

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Checks if the system has reached the last state for boot.

```Go
func (c *Client) BootComplete() (bool, error)
```

--------------------------------

### Variables

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

Features implemented by the OpenBMC redfish provider.

```Go
var (
	// Features implemented by dell redfish
	Features = registrar.Features{
		providers.FeaturePowerState,
		providers.FeaturePowerSet,
		providers.FeatureBmcReset,
		providers.FeatureFirmwareInstallSteps,
		providers.FeatureFirmwareUploadInitiateInstall,
		providers.FeatureFirmwareTaskStatus,
		providers.FeatureInventoryRead,
	}
)
```

--------------------------------

### NewClient function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

NewClient returns a new Client struct

```go
func NewClient(host, user, pass string, opts ...Option) *Client
```

--------------------------------

### PxeOnceMbr

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

PxeOnceMbr makes the machine to boot via pxe once using MBR

```go
func (i *Ipmi) PxeOnceMbr(ctx context.Context) (status bool, err error)
```

--------------------------------

### Status Command Help

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/examples/status

This is the help output for the status command, showing available flags and their descriptions.

```bash
$ go run ./examples/v1/status/main.go -h
Usage of /tmp/go-build1941100323/b001/exe/main:
	-cert-pool string
		Path to an file containing x509 CAs. An empty string uses the system CAs. Only takes effect when --secure-tls=true
	-host string
		BMC hostname to connect to
	-password string
		Username to login with
	-port int
		BMC port to connect to (default 443)
	-secure-tls
		Enable secure TLS
	-user string
		Username to login with


```

--------------------------------

### Variables

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Features implemented by the Supermicro provider.

```go
var (
	// Features implemented
	Features = registrar.Features{
		providers.FeatureScreenshot,
		providers.FeatureMountFloppyImage,
		providers.FeatureUnmountFloppyImage,
		providers.FeatureFirmwareUpload,
		providers.FeatureFirmwareInstallUploaded,
		providers.FeatureFirmwareTaskStatus,
		providers.FeatureFirmwareInstallSteps,
		providers.FeatureInventoryRead,
		providers.FeaturePowerSet,
		providers.FeaturePowerState,
		providers.FeatureBmcReset,
		providers.FeatureGetBiosConfiguration,
		providers.FeatureSetBiosConfiguration,
		providers.FeatureSetBiosConfigurationFromFile,
		providers.FeatureResetBiosConfiguration,
		providers.FeatureBootProgress,
	}
)
```

--------------------------------

### FirmwareTaskStatus Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/openbmc

FirmwareTaskStatus returns the status of a firmware related task queued on the BMC.

```Go
func (c *Conn) FirmwareTaskStatus(ctx context.Context, kind constants.FirmwareInstallStep, component, taskID, installVersion string) (state constants.TaskState, status string, err error)
```

--------------------------------

### CreateUser method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

CreateUser pass through to library function

```go
func (c *Client) CreateUser(ctx context.Context, user, pass, role string) (ok bool, err error)
```

--------------------------------

### WithIpmitoolPath

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/ipmi

No description

```go
func WithIpmitoolPath(path string) Option
```

--------------------------------

### Open

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Opens a connection to a Supermicro BMC using the vendor API.

```Go
func (c *Client) Open(ctx context.Context) (err error)
```

--------------------------------

### Opts Struct

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Options for configuring the RPC provider.

```Go
type Opts struct {
	// Request is the options used to create the rpc HTTP request.
	Request RequestOpts
	// Signature is the options used for adding an HMAC signature to an HTTP request.
	Signature SignatureOpts
	// HMAC is the options used to create a HMAC signature.
	HMAC HMACOpts
	// Experimental options.
	Experimental Experimental
}
```

--------------------------------

### WithHostScheme Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Option to set the host scheme (http or https).

```go
func WithHostScheme(hostScheme string) Option
```

--------------------------------

### Execute.ExecWithContext method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/executor

Executes the command with a given context and returns the result.

```Go
func (e *Execute) ExecWithContext(ctx context.Context) (result *Result, err error)
```

--------------------------------

### Client.SystemPowerCycle Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SystemPowerCycle power cycles the system.

```Go
func (c *Client) SystemPowerCycle(ctx context.Context) (ok bool, err error)
```

--------------------------------

### NewWithOptions function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

NewWithOptions returns a new ASRockRack instance with options ready to be used.

```go
func NewWithOptions(ip string, username string, password string, log logr.Logger, opts ...ASRockOption) *ASRockRack
```

--------------------------------

### Client struct

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Client for BMC interactions

```go
type Client struct {
	Auth     Auth
	Logger   logr.Logger
	Registry *registrar.Registry
	// contains filtered or unexported fields
}
```

--------------------------------

### Client.SystemReset Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/redfishwrapper

SystemReset power cycles the system.

```Go
func (c *Client) SystemReset(ctx context.Context) (ok bool, err error)
```

--------------------------------

### Type Client

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/supermicro

Connection details for the Supermicro client.

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

--------------------------------

### RequestOpts Struct

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Options for configuring an RPC request.

```Go
type RequestOpts struct {
	// HTTPContentType is the content type to use for the rpc request notification.
	HTTPContentType string
	// HTTPMethod is the HTTP method to use for the rpc request notification.
	HTTPMethod string
	// StaticHeaders are predefined headers that will be added to every request.
	StaticHeaders http.Header
	// TimestampFormat is the time format for the timestamp header.
	TimestampFormat string
	// TimestampHeader is the header name that should contain the timestamp. Example: X-BMCLIB-Timestamp
	TimestampHeader string
}
```

--------------------------------

### Query using Redfish and fallback to IPMI

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5

Configure the bmclib client to prioritize the Redfish driver and fall back to the IPMI driver if Redfish is unavailable.

```go
client := bmclib.NewClient("192.168.1.1", "admin", "hunter2")

// overwrite registered drivers by appending Redfish, IPMI drivers in order
drivers := append(registrar.Drivers{}, bmcClient.Registry.Using("redfish")...)
drivers = append(drivers, bmcClient.Registry.Using("ipmi")...)
client.Registry.Drivers = driver

```

--------------------------------

### SetBiosConfigurationFromFile method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/internal/sum

SetBiosConfigurationFromFile sets the BIOS configuration from a file.

```go
func (s *Sum) SetBiosConfigurationFromFile(ctx context.Context, cfg string) (err error)

```

--------------------------------

### PowerSet Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/intelamt

Sets the power state of a BMC machine.

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

--------------------------------

### CheckCredentials method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/asrockrack

CheckCredentials verify whether the credentials are valid or not.

```go
func (a *ASRockRack) CheckCredentials(ctx context.Context) (err error)
```

--------------------------------

### func (*Conn) SetBiosConfiguration

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/dell

SetBiosConfiguration sets the BIOS configuration settings via the BMC

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

--------------------------------

### Open Method

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/rpc

Opens a connection to the RPC consumer. For the RPC provider, Open means validating the Config and that communication with the RPC consumer can be established.

```Go
func (p *Provider) Open(ctx context.Context) error
```

--------------------------------

### WithPort Function

Source: https://pkg.go.dev/github.com/bmc-toolbox/bmclib/v2%40v2.3.5/providers/ipmitool

Option to set the port.

```go
func WithPort(port string) Option

```
Tokens:
Raw