dmiserver

Documentation

Index

• func Contains(arr []string, element string) bool
• func StartDmiAPIServer() (*grpc.Server, error)
• type DmiAPIServer
  • func (dms *DmiAPIServer) ActivateImage(req *dmi.HardwareID, ...) error
  • func (dms *DmiAPIServer) DownloadImage(req *dmi.DownloadImageRequest, ...) error
  • func (dms *DmiAPIServer) GetHWComponentInfo(req *dmi.HWComponentInfoGetRequest, ...) error
  • func (dms *DmiAPIServer) GetLoggingEndpoint(context.Context, *dmi.Uuid) (*dmi.GetLoggingEndpointResponse, error)
  • func (dms *DmiAPIServer) GetManagedDevices(context.Context, *empty.Empty) (*dmi.ManagedDevicesResponse, error)
  • func (dms *DmiAPIServer) GetMetric(ctx context.Context, req *dmi.GetMetricRequest) (*dmi.GetMetricResponse, error)
  • func (dms *DmiAPIServer) GetMsgBusEndpoint(context.Context, *empty.Empty) (*dmi.GetMsgBusEndpointResponse, error)
  • func (dms *DmiAPIServer) GetPhysicalInventory(req *dmi.PhysicalInventoryRequest, ...) error
  • func (dms *DmiAPIServer) GetSoftwareVersion(ctx context.Context, req *dmi.HardwareID) (*dmi.GetSoftwareVersionInformationResponse, error)
  • func (dms *DmiAPIServer) ListEvents(ctx context.Context, req *dmi.HardwareID) (*dmi.ListEventsResponse, error)
  • func (dms *DmiAPIServer) ListMetrics(ctx context.Context, req *dmi.HardwareID) (*dmi.ListMetricsResponse, error)
  • func (dms *DmiAPIServer) RevertToStandbyImage(req *dmi.HardwareID, ...) error
  • func (dms *DmiAPIServer) SetHWComponentInfo(context.Context, *dmi.HWComponentInfoSetRequest) (*dmi.HWComponentInfoSetResponse, error)
  • func (dms *DmiAPIServer) SetLoggingEndpoint(context.Context, *dmi.SetLoggingEndpointRequest) (*dmi.SetRemoteEndpointResponse, error)
  • func (dms *DmiAPIServer) SetMsgBusEndpoint(context.Context, *dmi.SetMsgBusEndpointRequest) (*dmi.SetRemoteEndpointResponse, error)
  • func (dms *DmiAPIServer) StartManagingDevice(req *dmi.ModifiableComponent, ...) error
  • func (dms *DmiAPIServer) StopManagingDevice(context.Context, *dmi.StopManagingDeviceRequest) (*dmi.StopManagingDeviceResponse, error)
  • func (dms *DmiAPIServer) UpdateEventsConfiguration(ctx context.Context, req *dmi.EventsConfigurationRequest) (*dmi.EventsConfigurationResponse, error)
  • func (dms *DmiAPIServer) UpdateMetricsConfiguration(ctx context.Context, req *dmi.MetricsConfigurationRequest) (*dmi.MetricsConfigurationResponse, error)

Functions

func Contains

func Contains(arr []string, element string) bool

Contains tells whether arr contains element.

func StartDmiAPIServer

func StartDmiAPIServer() (*grpc.Server, error)

StartDmiAPIServer starts a new grpc server for the Device Manager Interface

Types

type DmiAPIServer

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

DmiAPIServer has the attributes for the Server handling the Device Management Interface

func (*DmiAPIServer) ActivateImage

func (dms *DmiAPIServer) ActivateImage(req *dmi.HardwareID, stream dmi.NativeSoftwareManagementService_ActivateImageServer) error

ActivateImage Activates and runs the OLT with the image in the standby partition

func (*DmiAPIServer) DownloadImage

func (dms *DmiAPIServer) DownloadImage(req *dmi.DownloadImageRequest, stream dmi.NativeSoftwareManagementService_DownloadImageServer) error

DownloadImage downloads and installs the image in the standby partition, returns the status/progress of the Install

func (*DmiAPIServer) GetHWComponentInfo

func (dms *DmiAPIServer) GetHWComponentInfo(req *dmi.HWComponentInfoGetRequest, stream dmi.NativeHWManagementService_GetHWComponentInfoServer) error

GetHWComponentInfo gets the details of a particular HW component

func (*DmiAPIServer) GetLoggingEndpoint

func (dms *DmiAPIServer) GetLoggingEndpoint(context.Context, *dmi.Uuid) (*dmi.GetLoggingEndpointResponse, error)

GetLoggingEndpoint gets the configured location to which the logs are being shipped

func (*DmiAPIServer) GetManagedDevices

func (dms *DmiAPIServer) GetManagedDevices(context.Context, *empty.Empty) (*dmi.ManagedDevicesResponse, error)

GetManagedDevices returns an object containing a list of devices managed by this entity

func (*DmiAPIServer) GetMetric

func (dms *DmiAPIServer) GetMetric(ctx context.Context, req *dmi.GetMetricRequest) (*dmi.GetMetricResponse, error)

GetMetric gets the instantenous value of a metric

func (*DmiAPIServer) GetMsgBusEndpoint

func (dms *DmiAPIServer) GetMsgBusEndpoint(context.Context, *empty.Empty) (*dmi.GetMsgBusEndpointResponse, error)

GetMsgBusEndpoint gets the configured location to which the events and metrics are being shipped

func (*DmiAPIServer) GetPhysicalInventory

func (dms *DmiAPIServer) GetPhysicalInventory(req *dmi.PhysicalInventoryRequest, stream dmi.NativeHWManagementService_GetPhysicalInventoryServer) error

GetPhysicalInventory gets the HW inventory details of the Device

func (*DmiAPIServer) GetSoftwareVersion

func (dms *DmiAPIServer) GetSoftwareVersion(ctx context.Context, req *dmi.HardwareID) (*dmi.GetSoftwareVersionInformationResponse, error)

GetSoftwareVersion gets the software version information of the Active and Standby images

func (*DmiAPIServer) ListEvents

func (dms *DmiAPIServer) ListEvents(ctx context.Context, req *dmi.HardwareID) (*dmi.ListEventsResponse, error)

ListEvents lists the supported events for the passed device

func (*DmiAPIServer) ListMetrics

func (dms *DmiAPIServer) ListMetrics(ctx context.Context, req *dmi.HardwareID) (*dmi.ListMetricsResponse, error)

ListMetrics lists the supported metrics for the passed device.

func (*DmiAPIServer) RevertToStandbyImage

func (dms *DmiAPIServer) RevertToStandbyImage(req *dmi.HardwareID, stream dmi.NativeSoftwareManagementService_RevertToStandbyImageServer) error

RevertToStandbyImage marks the image in the Standby as Active and reboots the device, so that it boots from that image which was in the standby.

func (*DmiAPIServer) SetHWComponentInfo

func (dms *DmiAPIServer) SetHWComponentInfo(context.Context, *dmi.HWComponentInfoSetRequest) (*dmi.HWComponentInfoSetResponse, error)

SetHWComponentInfo sets the permissible attributes of a HW component

func (*DmiAPIServer) SetLoggingEndpoint

func (dms *DmiAPIServer) SetLoggingEndpoint(context.Context, *dmi.SetLoggingEndpointRequest) (*dmi.SetRemoteEndpointResponse, error)

SetLoggingEndpoint sets the location to which logs need to be shipped

func (*DmiAPIServer) SetMsgBusEndpoint

func (dms *DmiAPIServer) SetMsgBusEndpoint(context.Context, *dmi.SetMsgBusEndpointRequest) (*dmi.SetRemoteEndpointResponse, error)

SetMsgBusEndpoint sets the location of the Message Bus to which events and metrics are shipped

func (*DmiAPIServer) StartManagingDevice

func (dms *DmiAPIServer) StartManagingDevice(req *dmi.ModifiableComponent, stream dmi.NativeHWManagementService_StartManagingDeviceServer) error

StartManagingDevice establishes connection with the device and does checks to ascertain if the device with passed identity can be managed

func (*DmiAPIServer) StopManagingDevice

func (dms *DmiAPIServer) StopManagingDevice(context.Context, *dmi.StopManagingDeviceRequest) (*dmi.StopManagingDeviceResponse, error)

StopManagingDevice stops management of a device and cleans up any context and caches for that device

func (*DmiAPIServer) UpdateEventsConfiguration

func (dms *DmiAPIServer) UpdateEventsConfiguration(ctx context.Context, req *dmi.EventsConfigurationRequest) (*dmi.EventsConfigurationResponse, error)

UpdateEventsConfiguration updates the configuration of the list of events in the request

func (*DmiAPIServer) UpdateMetricsConfiguration

func (dms *DmiAPIServer) UpdateMetricsConfiguration(ctx context.Context, req *dmi.MetricsConfigurationRequest) (*dmi.MetricsConfigurationResponse, error)

UpdateMetricsConfiguration updates the configuration of the list of metrics in the request