Documentation ¶
Index ¶
- type BmcService
- func (b *BmcService) CreateUser(ctx context.Context, in *v1.CreateUserRequest) (*v1.CreateUserResponse, error)
- func (b *BmcService) DeactivateSOL(ctx context.Context, in *v1.DeactivateSOLRequest) (*v1.DeactivateSOLResponse, error)
- func (b *BmcService) DeleteUser(ctx context.Context, in *v1.DeleteUserRequest) (*v1.DeleteUserResponse, error)
- func (b *BmcService) NetworkSource(_ context.Context, _ *v1.NetworkSourceRequest) (*v1.NetworkSourceResponse, error)
- func (b *BmcService) Reset(ctx context.Context, in *v1.ResetRequest) (*v1.ResetResponse, error)
- func (b *BmcService) UpdateUser(ctx context.Context, in *v1.UpdateUserRequest) (*v1.UpdateUserResponse, error)
- type DiagnosticService
- func (d *DiagnosticService) ClearSystemEventLog(ctx context.Context, in *v1.ClearSystemEventLogRequest) (*v1.ClearSystemEventLogResponse, error)
- func (d *DiagnosticService) Screenshot(ctx context.Context, in *v1.ScreenshotRequest) (*v1.ScreenshotResponse, error)
- func (d *DiagnosticService) SendNMI(ctx context.Context, in *v1.SendNMIRequest) (*emptypb.Empty, error)
- type MachineService
- type TaskService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BmcService ¶
type BmcService struct { // Timeout is how long a task should be run // before it is cancelled. This is for use in a // TaskRunner.Execute function that runs all BMC // interactions in the background. Timeout time.Duration // SkipRedfishVersions is a list of Redfish versions to be ignored, // // When running an action on a BMC, PBnJ will pass the value of the skipRedfishVersions to bmclib // which will then ignore the Redfish endpoint completely on BMCs running the given Redfish versions, // and will proceed to attempt other drivers like - IPMI/SSH/Vendor API instead. // // for more information see https://github.com/bmc-toolbox/bmclib#bmc-connections SkipRedfishVersions []string TaskRunner task.Task v1.UnimplementedBMCServer }
BmcService for doing BMC actions.
func (*BmcService) CreateUser ¶
func (b *BmcService) CreateUser(ctx context.Context, in *v1.CreateUserRequest) (*v1.CreateUserResponse, error)
CreateUser sets the next boot device of a machine.
func (*BmcService) DeactivateSOL ¶
func (b *BmcService) DeactivateSOL(ctx context.Context, in *v1.DeactivateSOLRequest) (*v1.DeactivateSOLResponse, error)
DeactivateSOL deactivates any active SOL session on the BMC.
func (*BmcService) DeleteUser ¶
func (b *BmcService) DeleteUser(ctx context.Context, in *v1.DeleteUserRequest) (*v1.DeleteUserResponse, error)
DeleteUser deletes a user on a BMC.
func (*BmcService) NetworkSource ¶
func (b *BmcService) NetworkSource(_ context.Context, _ *v1.NetworkSourceRequest) (*v1.NetworkSourceResponse, error)
NetworkSource sets the BMC network source.
func (*BmcService) Reset ¶
func (b *BmcService) Reset(ctx context.Context, in *v1.ResetRequest) (*v1.ResetResponse, error)
Reset calls a reset on a BMC.
func (*BmcService) UpdateUser ¶
func (b *BmcService) UpdateUser(ctx context.Context, in *v1.UpdateUserRequest) (*v1.UpdateUserResponse, error)
UpdateUser updates a users credentials on a BMC.
type DiagnosticService ¶
type DiagnosticService struct { v1.UnimplementedDiagnosticServer TaskRunner task.Task Timeout time.Duration }
func (*DiagnosticService) ClearSystemEventLog ¶
func (d *DiagnosticService) ClearSystemEventLog(ctx context.Context, in *v1.ClearSystemEventLogRequest) (*v1.ClearSystemEventLogResponse, error)
func (*DiagnosticService) Screenshot ¶
func (d *DiagnosticService) Screenshot(ctx context.Context, in *v1.ScreenshotRequest) (*v1.ScreenshotResponse, error)
func (*DiagnosticService) SendNMI ¶
func (d *DiagnosticService) SendNMI(ctx context.Context, in *v1.SendNMIRequest) (*emptypb.Empty, error)
type MachineService ¶
type MachineService struct { // Timeout is how long a task should be run // before it is cancelled. This is for use in a // TaskRunner.Execute function that runs all BMC // interactions in the background. Timeout time.Duration TaskRunner task.Task v1.UnimplementedMachineServer }
MachineService for doing power and device actions.
func (*MachineService) BootDevice ¶
func (m *MachineService) BootDevice(ctx context.Context, in *v1.DeviceRequest) (*v1.DeviceResponse, error)
BootDevice sets the next boot device of a machine.
func (*MachineService) Power ¶
func (m *MachineService) Power(ctx context.Context, in *v1.PowerRequest) (*v1.PowerResponse, error)
Power does a power action against a BMC.
type TaskService ¶
type TaskService struct { TaskRunner task.Task v1.UnimplementedTaskServer }
TaskService for retrieving task details.
func (*TaskService) Status ¶
func (t *TaskService) Status(ctx context.Context, in *v1.StatusRequest) (*v1.StatusResponse, error)
Status returns a task record.
Click to show internal directories.
Click to hide internal directories.