rfphandler

Documentation

Overview

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ..

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Package rfphandler ...

Index

• Variables
• func ChangeSettings(ctx iris.Context)
• func CreateEventSubscription(ctx iris.Context)
• func CreateSession(ctx iris.Context)
• func CreateVolume(ctx iris.Context)
• func DeleteEventSubscription(ctx iris.Context)
• func DeleteVolume(ctx iris.Context)
• func GetDeviceData(uri string, device *rfputilities.RedfishDevice) (int, []byte, map[string]interface{}, error)
• func GetManagersCollection(ctx iris.Context)
• func GetManagersInfo(ctx iris.Context)
• func GetPluginStartup(ctx iris.Context)
• func GetPluginStatus(ctx iris.Context)
• func GetResource(ctx iris.Context)
• func RedfishEvents(w http.ResponseWriter, r *http.Request)
• func ResetComputerSystem(ctx iris.Context)
• func SetDefaultBootOrder(ctx iris.Context)
• func SimpleUpdate(ctx iris.Context)
• func StartUpdate(ctx iris.Context)
• func TokenValidation(token string) bool
• func Validate(ctx iris.Context)
• func VirtualMediaActions(ctx iris.Context)
• type DeviceClient
• type ExternalInterface
  • func (e *ExternalInterface) GetMetricReport(ctx iris.Context)
• type TokenMap

Variables

var (
	// In Channel
	In chan<- interface{}
	// Out Channel
	Out <-chan interface{}
)

Functions

func ChangeSettings

func ChangeSettings(ctx iris.Context)

ChangeSettings is generic function where we can do following operations on different call 1. change bios settings 2. change boot order settings

func CreateEventSubscription

func CreateEventSubscription(ctx iris.Context)

CreateEventSubscription : Subscribes for events

func CreateSession

func CreateSession(ctx iris.Context)

CreateSession is used to create session for odimra to interact with plugin

func CreateVolume

func CreateVolume(ctx iris.Context)

CreateVolume function is used for creating a volume under storage

func DeleteEventSubscription

func DeleteEventSubscription(ctx iris.Context)

DeleteEventSubscription : Delete subscription

func DeleteVolume

func DeleteVolume(ctx iris.Context)

DeleteVolume function is used for deleting a volume under storage

func GetDeviceData

func GetDeviceData(uri string, device *rfputilities.RedfishDevice) (int, []byte, map[string]interface{}, error)

GetDeviceData connects with the device and collect the information

func GetManagersCollection

func GetManagersCollection(ctx iris.Context)

GetManagersCollection Fetches details of the given resource from the device

func GetManagersInfo

func GetManagersInfo(ctx iris.Context)

GetManagersInfo Fetches details of the given resource from the device

func GetPluginStartup

func GetPluginStartup(ctx iris.Context)

GetPluginStartup ...

func GetPluginStatus

func GetPluginStatus(ctx iris.Context)

GetPluginStatus defines the GetPluginStatus iris handler. and returns status

func GetResource

func GetResource(ctx iris.Context)

GetResource : Fetches details of the given resource from the device

func RedfishEvents

func RedfishEvents(w http.ResponseWriter, r *http.Request)

RedfishEvents receives the subscribed events from the south bound system Then it will send the received data and ip to publish method

func ResetComputerSystem

func ResetComputerSystem(ctx iris.Context)

ResetComputerSystem : reset computer system

func SetDefaultBootOrder

func SetDefaultBootOrder(ctx iris.Context)

SetDefaultBootOrder : sets the defult boot order

func SimpleUpdate

func SimpleUpdate(ctx iris.Context)

SimpleUpdate updates the BMC resources

func StartUpdate

func StartUpdate(ctx iris.Context)

StartUpdate updates the BMC resources

func TokenValidation

func TokenValidation(token string) bool

TokenValidation validates sent token with the list of plugin generated tokens

func Validate

func Validate(ctx iris.Context)

Validate does Basic authentication with device and returns UUID of device in response

func VirtualMediaActions

func VirtualMediaActions(ctx iris.Context)

VirtualMediaActions performs insert and eject virtual media operations on the device based on the request

Types

type DeviceClient

type DeviceClient struct {
	ChangeSettingsOnDevice func(device *rfputilities.RedfishDevice, url, method string) (*http.Response, error)
	DecryptPassword        func(password []byte) ([]byte, error)
}

DeviceClient struct to call device for the operation

type ExternalInterface

type ExternalInterface struct {
	TokenValidation func(string) bool
	GetDeviceData   func(string, *rfputilities.RedfishDevice) (int, []byte, map[string]interface{}, error)
}

ExternalInterface enables the communicunication with the external functions

func (*ExternalInterface) GetMetricReport

func (e *ExternalInterface) GetMetricReport(ctx iris.Context)

GetMetricReport is for to get metric report from southbound resource

type TokenMap

type TokenMap struct {
	Token    string
	LastUsed time.Time
}

TokenMap is used to define the plugin generated tokens