voltha

package
v5.7.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 22, 2026 License: Apache-2.0 Imports: 20 Imported by: 7

Documentation

Index

Constants

View Source
const (
	VolthaService_GetVoltha_FullMethodName                         = "/voltha.VolthaService/GetVoltha"
	VolthaService_ListCoreInstances_FullMethodName                 = "/voltha.VolthaService/ListCoreInstances"
	VolthaService_GetCoreInstance_FullMethodName                   = "/voltha.VolthaService/GetCoreInstance"
	VolthaService_ListAdapters_FullMethodName                      = "/voltha.VolthaService/ListAdapters"
	VolthaService_ListLogicalDevices_FullMethodName                = "/voltha.VolthaService/ListLogicalDevices"
	VolthaService_GetLogicalDevice_FullMethodName                  = "/voltha.VolthaService/GetLogicalDevice"
	VolthaService_ListLogicalDevicePorts_FullMethodName            = "/voltha.VolthaService/ListLogicalDevicePorts"
	VolthaService_GetLogicalDevicePort_FullMethodName              = "/voltha.VolthaService/GetLogicalDevicePort"
	VolthaService_EnableLogicalDevicePort_FullMethodName           = "/voltha.VolthaService/EnableLogicalDevicePort"
	VolthaService_DisableLogicalDevicePort_FullMethodName          = "/voltha.VolthaService/DisableLogicalDevicePort"
	VolthaService_ListLogicalDeviceFlows_FullMethodName            = "/voltha.VolthaService/ListLogicalDeviceFlows"
	VolthaService_UpdateLogicalDeviceFlowTable_FullMethodName      = "/voltha.VolthaService/UpdateLogicalDeviceFlowTable"
	VolthaService_UpdateLogicalDeviceMeterTable_FullMethodName     = "/voltha.VolthaService/UpdateLogicalDeviceMeterTable"
	VolthaService_ListLogicalDeviceMeters_FullMethodName           = "/voltha.VolthaService/ListLogicalDeviceMeters"
	VolthaService_ListLogicalDeviceFlowGroups_FullMethodName       = "/voltha.VolthaService/ListLogicalDeviceFlowGroups"
	VolthaService_UpdateLogicalDeviceFlowGroupTable_FullMethodName = "/voltha.VolthaService/UpdateLogicalDeviceFlowGroupTable"
	VolthaService_ListDevices_FullMethodName                       = "/voltha.VolthaService/ListDevices"
	VolthaService_ListDeviceIds_FullMethodName                     = "/voltha.VolthaService/ListDeviceIds"
	VolthaService_ReconcileDevices_FullMethodName                  = "/voltha.VolthaService/ReconcileDevices"
	VolthaService_GetDevice_FullMethodName                         = "/voltha.VolthaService/GetDevice"
	VolthaService_CreateDevice_FullMethodName                      = "/voltha.VolthaService/CreateDevice"
	VolthaService_EnableDevice_FullMethodName                      = "/voltha.VolthaService/EnableDevice"
	VolthaService_DisableDevice_FullMethodName                     = "/voltha.VolthaService/DisableDevice"
	VolthaService_RebootDevice_FullMethodName                      = "/voltha.VolthaService/RebootDevice"
	VolthaService_DeleteDevice_FullMethodName                      = "/voltha.VolthaService/DeleteDevice"
	VolthaService_ForceDeleteDevice_FullMethodName                 = "/voltha.VolthaService/ForceDeleteDevice"
	VolthaService_DownloadImage_FullMethodName                     = "/voltha.VolthaService/DownloadImage"
	VolthaService_GetImageDownloadStatus_FullMethodName            = "/voltha.VolthaService/GetImageDownloadStatus"
	VolthaService_GetImageDownload_FullMethodName                  = "/voltha.VolthaService/GetImageDownload"
	VolthaService_ListImageDownloads_FullMethodName                = "/voltha.VolthaService/ListImageDownloads"
	VolthaService_CancelImageDownload_FullMethodName               = "/voltha.VolthaService/CancelImageDownload"
	VolthaService_ActivateImageUpdate_FullMethodName               = "/voltha.VolthaService/ActivateImageUpdate"
	VolthaService_RevertImageUpdate_FullMethodName                 = "/voltha.VolthaService/RevertImageUpdate"
	VolthaService_DownloadImageToDevice_FullMethodName             = "/voltha.VolthaService/DownloadImageToDevice"
	VolthaService_GetImageStatus_FullMethodName                    = "/voltha.VolthaService/GetImageStatus"
	VolthaService_AbortImageUpgradeToDevice_FullMethodName         = "/voltha.VolthaService/AbortImageUpgradeToDevice"
	VolthaService_GetOnuImages_FullMethodName                      = "/voltha.VolthaService/GetOnuImages"
	VolthaService_ActivateImage_FullMethodName                     = "/voltha.VolthaService/ActivateImage"
	VolthaService_CommitImage_FullMethodName                       = "/voltha.VolthaService/CommitImage"
	VolthaService_ListDevicePorts_FullMethodName                   = "/voltha.VolthaService/ListDevicePorts"
	VolthaService_ListDevicePmConfigs_FullMethodName               = "/voltha.VolthaService/ListDevicePmConfigs"
	VolthaService_UpdateDevicePmConfigs_FullMethodName             = "/voltha.VolthaService/UpdateDevicePmConfigs"
	VolthaService_ListDeviceFlows_FullMethodName                   = "/voltha.VolthaService/ListDeviceFlows"
	VolthaService_ListDeviceFlowGroups_FullMethodName              = "/voltha.VolthaService/ListDeviceFlowGroups"
	VolthaService_ListDeviceTypes_FullMethodName                   = "/voltha.VolthaService/ListDeviceTypes"
	VolthaService_GetDeviceType_FullMethodName                     = "/voltha.VolthaService/GetDeviceType"
	VolthaService_StreamPacketsOut_FullMethodName                  = "/voltha.VolthaService/StreamPacketsOut"
	VolthaService_ReceivePacketsIn_FullMethodName                  = "/voltha.VolthaService/ReceivePacketsIn"
	VolthaService_ReceiveChangeEvents_FullMethodName               = "/voltha.VolthaService/ReceiveChangeEvents"
	VolthaService_CreateEventFilter_FullMethodName                 = "/voltha.VolthaService/CreateEventFilter"
	VolthaService_GetEventFilter_FullMethodName                    = "/voltha.VolthaService/GetEventFilter"
	VolthaService_UpdateEventFilter_FullMethodName                 = "/voltha.VolthaService/UpdateEventFilter"
	VolthaService_DeleteEventFilter_FullMethodName                 = "/voltha.VolthaService/DeleteEventFilter"
	VolthaService_ListEventFilters_FullMethodName                  = "/voltha.VolthaService/ListEventFilters"
	VolthaService_GetImages_FullMethodName                         = "/voltha.VolthaService/GetImages"
	VolthaService_SelfTest_FullMethodName                          = "/voltha.VolthaService/SelfTest"
	VolthaService_GetMibDeviceData_FullMethodName                  = "/voltha.VolthaService/GetMibDeviceData"
	VolthaService_GetAlarmDeviceData_FullMethodName                = "/voltha.VolthaService/GetAlarmDeviceData"
	VolthaService_SimulateAlarm_FullMethodName                     = "/voltha.VolthaService/SimulateAlarm"
	VolthaService_EnablePort_FullMethodName                        = "/voltha.VolthaService/EnablePort"
	VolthaService_DisablePort_FullMethodName                       = "/voltha.VolthaService/DisablePort"
	VolthaService_GetExtValue_FullMethodName                       = "/voltha.VolthaService/GetExtValue"
	VolthaService_SetExtValue_FullMethodName                       = "/voltha.VolthaService/SetExtValue"
	VolthaService_StartOmciTestAction_FullMethodName               = "/voltha.VolthaService/StartOmciTestAction"
	VolthaService_PutVoipSystemProfile_FullMethodName              = "/voltha.VolthaService/PutVoipSystemProfile"
	VolthaService_DeleteVoipSystemProfile_FullMethodName           = "/voltha.VolthaService/DeleteVoipSystemProfile"
	VolthaService_PutVoipUserProfile_FullMethodName                = "/voltha.VolthaService/PutVoipUserProfile"
	VolthaService_DeleteVoipUserProfile_FullMethodName             = "/voltha.VolthaService/DeleteVoipUserProfile"
	VolthaService_DisableOnuDevice_FullMethodName                  = "/voltha.VolthaService/DisableOnuDevice"
	VolthaService_EnableOnuDevice_FullMethodName                   = "/voltha.VolthaService/EnableOnuDevice"
	VolthaService_DisableOnuSerialNumber_FullMethodName            = "/voltha.VolthaService/DisableOnuSerialNumber"
	VolthaService_EnableOnuSerialNumber_FullMethodName             = "/voltha.VolthaService/EnableOnuSerialNumber"
	VolthaService_UpdateDevice_FullMethodName                      = "/voltha.VolthaService/UpdateDevice"
)
View Source
const AdminState_DISABLED = common.AdminState_DISABLED
View Source
const AdminState_DOWNLOADING_IMAGE = common.AdminState_DOWNLOADING_IMAGE
View Source
const AdminState_ENABLED = common.AdminState_ENABLED
View Source
const AdminState_PREPROVISIONED = common.AdminState_PREPROVISIONED
View Source
const AdminState_UNKNOWN = common.AdminState_UNKNOWN
View Source
const ConnectStatus_REACHABLE = common.ConnectStatus_REACHABLE
View Source
const ConnectStatus_UNKNOWN = common.ConnectStatus_UNKNOWN
View Source
const ConnectStatus_UNREACHABLE = common.ConnectStatus_UNREACHABLE
View Source
const OperStatus_ACTIVATING = common.OperStatus_ACTIVATING
View Source
const OperStatus_ACTIVE = common.OperStatus_ACTIVE
View Source
const OperStatus_DISCOVERED = common.OperStatus_DISCOVERED
View Source
const OperStatus_FAILED = common.OperStatus_FAILED
View Source
const OperStatus_REBOOTED = common.OperStatus_REBOOTED
View Source
const OperStatus_RECONCILING = common.OperStatus_RECONCILING
View Source
const OperStatus_RECONCILING_FAILED = common.OperStatus_RECONCILING_FAILED
View Source
const OperStatus_TESTING = common.OperStatus_TESTING
View Source
const OperStatus_UNKNOWN = common.OperStatus_UNKNOWN
View Source
const OperationResp_OPERATION_FAILURE = common.OperationResp_OPERATION_FAILURE
View Source
const OperationResp_OPERATION_IN_PROGRESS = common.OperationResp_OPERATION_IN_PROGRESS
View Source
const OperationResp_OPERATION_SUCCESS = common.OperationResp_OPERATION_SUCCESS
View Source
const OperationResp_OPERATION_UNSUPPORTED = common.OperationResp_OPERATION_UNSUPPORTED
View Source
const TestModeKeys_api_test = common.TestModeKeys_api_test

Variables

View Source
var (
	PmConfig_PmType_name = map[int32]string{
		0: "COUNTER",
		1: "GAUGE",
		2: "STATE",
		3: "CONTEXT",
	}
	PmConfig_PmType_value = map[string]int32{
		"COUNTER": 0,
		"GAUGE":   1,
		"STATE":   2,
		"CONTEXT": 3,
	}
)

Enum value maps for PmConfig_PmType.

View Source
var (
	ImageDownload_ImageDownloadState_name = map[int32]string{
		0: "DOWNLOAD_UNKNOWN",
		1: "DOWNLOAD_SUCCEEDED",
		2: "DOWNLOAD_REQUESTED",
		3: "DOWNLOAD_STARTED",
		4: "DOWNLOAD_FAILED",
		5: "DOWNLOAD_UNSUPPORTED",
		6: "DOWNLOAD_CANCELLED",
	}
	ImageDownload_ImageDownloadState_value = map[string]int32{
		"DOWNLOAD_UNKNOWN":     0,
		"DOWNLOAD_SUCCEEDED":   1,
		"DOWNLOAD_REQUESTED":   2,
		"DOWNLOAD_STARTED":     3,
		"DOWNLOAD_FAILED":      4,
		"DOWNLOAD_UNSUPPORTED": 5,
		"DOWNLOAD_CANCELLED":   6,
	}
)

Enum value maps for ImageDownload_ImageDownloadState.

View Source
var (
	ImageDownload_ImageDownloadFailureReason_name = map[int32]string{
		0: "NO_ERROR",
		1: "INVALID_URL",
		2: "DEVICE_BUSY",
		3: "INSUFFICIENT_SPACE",
		4: "UNKNOWN_ERROR",
		5: "CANCELLED",
	}
	ImageDownload_ImageDownloadFailureReason_value = map[string]int32{
		"NO_ERROR":           0,
		"INVALID_URL":        1,
		"DEVICE_BUSY":        2,
		"INSUFFICIENT_SPACE": 3,
		"UNKNOWN_ERROR":      4,
		"CANCELLED":          5,
	}
)

Enum value maps for ImageDownload_ImageDownloadFailureReason.

View Source
var (
	ImageDownload_ImageActivateState_name = map[int32]string{
		0: "IMAGE_UNKNOWN",
		1: "IMAGE_INACTIVE",
		2: "IMAGE_ACTIVATING",
		3: "IMAGE_ACTIVE",
		4: "IMAGE_REVERTING",
		5: "IMAGE_REVERTED",
	}
	ImageDownload_ImageActivateState_value = map[string]int32{
		"IMAGE_UNKNOWN":    0,
		"IMAGE_INACTIVE":   1,
		"IMAGE_ACTIVATING": 2,
		"IMAGE_ACTIVE":     3,
		"IMAGE_REVERTING":  4,
		"IMAGE_REVERTED":   5,
	}
)

Enum value maps for ImageDownload_ImageActivateState.

View Source
var (
	ImageState_ImageDownloadState_name = map[int32]string{
		0: "DOWNLOAD_UNKNOWN",
		1: "DOWNLOAD_SUCCEEDED",
		2: "DOWNLOAD_REQUESTED",
		3: "DOWNLOAD_STARTED",
		4: "DOWNLOAD_FAILED",
		5: "DOWNLOAD_UNSUPPORTED",
		6: "DOWNLOAD_CANCELLING",
		7: "DOWNLOAD_CANCELLED",
	}
	ImageState_ImageDownloadState_value = map[string]int32{
		"DOWNLOAD_UNKNOWN":     0,
		"DOWNLOAD_SUCCEEDED":   1,
		"DOWNLOAD_REQUESTED":   2,
		"DOWNLOAD_STARTED":     3,
		"DOWNLOAD_FAILED":      4,
		"DOWNLOAD_UNSUPPORTED": 5,
		"DOWNLOAD_CANCELLING":  6,
		"DOWNLOAD_CANCELLED":   7,
	}
)

Enum value maps for ImageState_ImageDownloadState.

View Source
var (
	ImageState_ImageFailureReason_name = map[int32]string{
		0: "NO_ERROR",
		1: "INVALID_URL",
		2: "DEVICE_BUSY",
		3: "INSUFFICIENT_SPACE",
		4: "UNKNOWN_ERROR",
		5: "CANCELLED_ON_REQUEST",
		6: "CANCELLED_ON_ONU_STATE",
		7: "VENDOR_DEVICE_MISMATCH",
		8: "OMCI_TRANSFER_ERROR",
		9: "IMAGE_REFUSED_BY_ONU",
	}
	ImageState_ImageFailureReason_value = map[string]int32{
		"NO_ERROR":               0,
		"INVALID_URL":            1,
		"DEVICE_BUSY":            2,
		"INSUFFICIENT_SPACE":     3,
		"UNKNOWN_ERROR":          4,
		"CANCELLED_ON_REQUEST":   5,
		"CANCELLED_ON_ONU_STATE": 6,
		"VENDOR_DEVICE_MISMATCH": 7,
		"OMCI_TRANSFER_ERROR":    8,
		"IMAGE_REFUSED_BY_ONU":   9,
	}
)

Enum value maps for ImageState_ImageFailureReason.

View Source
var (
	ImageState_ImageActivationState_name = map[int32]string{
		0:  "IMAGE_UNKNOWN",
		1:  "IMAGE_INACTIVE",
		2:  "IMAGE_ACTIVATING",
		3:  "IMAGE_ACTIVE",
		4:  "IMAGE_COMMITTING",
		5:  "IMAGE_COMMITTED",
		6:  "IMAGE_ACTIVATION_ABORTING",
		7:  "IMAGE_ACTIVATION_ABORTED",
		8:  "IMAGE_COMMIT_ABORTING",
		9:  "IMAGE_COMMIT_ABORTED",
		10: "IMAGE_DOWNLOADING",
		11: "IMAGE_DOWNLOADING_ABORTED",
	}
	ImageState_ImageActivationState_value = map[string]int32{
		"IMAGE_UNKNOWN":             0,
		"IMAGE_INACTIVE":            1,
		"IMAGE_ACTIVATING":          2,
		"IMAGE_ACTIVE":              3,
		"IMAGE_COMMITTING":          4,
		"IMAGE_COMMITTED":           5,
		"IMAGE_ACTIVATION_ABORTING": 6,
		"IMAGE_ACTIVATION_ABORTED":  7,
		"IMAGE_COMMIT_ABORTING":     8,
		"IMAGE_COMMIT_ABORTED":      9,
		"IMAGE_DOWNLOADING":         10,
		"IMAGE_DOWNLOADING_ABORTED": 11,
	}
)

Enum value maps for ImageState_ImageActivationState.

View Source
var (
	Port_PortType_name = map[int32]string{
		0: "UNKNOWN",
		1: "ETHERNET_NNI",
		2: "ETHERNET_UNI",
		3: "PON_OLT",
		4: "PON_ONU",
		5: "VENET_OLT",
		6: "VENET_ONU",
	}
	Port_PortType_value = map[string]int32{
		"UNKNOWN":      0,
		"ETHERNET_NNI": 1,
		"ETHERNET_UNI": 2,
		"PON_OLT":      3,
		"PON_ONU":      4,
		"VENET_OLT":    5,
		"VENET_ONU":    6,
	}
)

Enum value maps for Port_PortType.

View Source
var (
	SelfTestResponse_SelfTestResult_name = map[int32]string{
		0: "SUCCESS",
		1: "FAILURE",
		2: "NOT_SUPPORTED",
		3: "UNKNOWN_ERROR",
	}
	SelfTestResponse_SelfTestResult_value = map[string]int32{
		"SUCCESS":       0,
		"FAILURE":       1,
		"NOT_SUPPORTED": 2,
		"UNKNOWN_ERROR": 3,
	}
)

Enum value maps for SelfTestResponse_SelfTestResult.

View Source
var (
	SimulateAlarmRequest_OperationType_name = map[int32]string{
		0: "RAISE",
		1: "CLEAR",
	}
	SimulateAlarmRequest_OperationType_value = map[string]int32{
		"RAISE": 0,
		"CLEAR": 1,
	}
)

Enum value maps for SimulateAlarmRequest_OperationType.

View Source
var (
	EventFilterRuleKey_EventFilterRuleType_name = map[int32]string{
		0: "filter_all",
		1: "category",
		2: "sub_category",
		3: "kpi_event_type",
		4: "config_event_type",
		5: "device_event_type",
	}
	EventFilterRuleKey_EventFilterRuleType_value = map[string]int32{
		"filter_all":        0,
		"category":          1,
		"sub_category":      2,
		"kpi_event_type":    3,
		"config_event_type": 4,
		"device_event_type": 5,
	}
)

Enum value maps for EventFilterRuleKey_EventFilterRuleType.

View Source
var (
	ConfigEventType_Types_name = map[int32]string{
		0: "add",
		1: "remove",
		2: "update",
	}
	ConfigEventType_Types_value = map[string]int32{
		"add":    0,
		"remove": 1,
		"update": 2,
	}
)

Enum value maps for ConfigEventType_Types.

View Source
var (
	KpiEventType_Types_name = map[int32]string{
		0: "slice",
		1: "ts",
	}
	KpiEventType_Types_value = map[string]int32{
		"slice": 0,
		"ts":    1,
	}
)

Enum value maps for KpiEventType_Types.

View Source
var (
	EventCategory_Types_name = map[int32]string{
		0: "COMMUNICATION",
		1: "ENVIRONMENT",
		2: "EQUIPMENT",
		3: "SERVICE",
		4: "PROCESSING",
		5: "SECURITY",
	}
	EventCategory_Types_value = map[string]int32{
		"COMMUNICATION": 0,
		"ENVIRONMENT":   1,
		"EQUIPMENT":     2,
		"SERVICE":       3,
		"PROCESSING":    4,
		"SECURITY":      5,
	}
)

Enum value maps for EventCategory_Types.

View Source
var (
	EventSubCategory_Types_name = map[int32]string{
		0: "PON",
		1: "OLT",
		2: "ONT",
		3: "ONU",
		4: "NNI",
		5: "NONE",
	}
	EventSubCategory_Types_value = map[string]int32{
		"PON":  0,
		"OLT":  1,
		"ONT":  2,
		"ONU":  3,
		"NNI":  4,
		"NONE": 5,
	}
)

Enum value maps for EventSubCategory_Types.

View Source
var (
	EventType_Types_name = map[int32]string{
		0: "CONFIG_EVENT",
		1: "KPI_EVENT",
		2: "KPI_EVENT2",
		3: "DEVICE_EVENT",
		4: "RPC_EVENT",
		5: "KPI_EVENT3",
	}
	EventType_Types_value = map[string]int32{
		"CONFIG_EVENT": 0,
		"KPI_EVENT":    1,
		"KPI_EVENT2":   2,
		"DEVICE_EVENT": 3,
		"RPC_EVENT":    4,
		"KPI_EVENT3":   5,
	}
)

Enum value maps for EventType_Types.

View Source
var AdminState_Types_name = common.AdminState_Types_name
View Source
var AdminState_Types_value = common.AdminState_Types_value
View Source
var ConnectStatus_Types_name = common.ConnectStatus_Types_name
View Source
var ConnectStatus_Types_value = common.ConnectStatus_Types_value
View Source
var File_voltha_protos_adapter_proto protoreflect.FileDescriptor
View Source
var File_voltha_protos_device_proto protoreflect.FileDescriptor
View Source
var File_voltha_protos_events_proto protoreflect.FileDescriptor
View Source
var File_voltha_protos_logical_device_proto protoreflect.FileDescriptor
View Source
var File_voltha_protos_voltha_proto protoreflect.FileDescriptor
View Source
var OperStatus_Types_name = common.OperStatus_Types_name
View Source
var OperStatus_Types_value = common.OperStatus_Types_value
View Source
var OperationResp_OperationReturnCode_name = common.OperationResp_OperationReturnCode_name
View Source
var OperationResp_OperationReturnCode_value = common.OperationResp_OperationReturnCode_value
View Source
var TestModeKeys_name = common.TestModeKeys_name
View Source
var TestModeKeys_value = common.TestModeKeys_value
View Source
var VolthaService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "voltha.VolthaService",
	HandlerType: (*VolthaServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetVoltha",
			Handler:    _VolthaService_GetVoltha_Handler,
		},
		{
			MethodName: "ListCoreInstances",
			Handler:    _VolthaService_ListCoreInstances_Handler,
		},
		{
			MethodName: "GetCoreInstance",
			Handler:    _VolthaService_GetCoreInstance_Handler,
		},
		{
			MethodName: "ListAdapters",
			Handler:    _VolthaService_ListAdapters_Handler,
		},
		{
			MethodName: "ListLogicalDevices",
			Handler:    _VolthaService_ListLogicalDevices_Handler,
		},
		{
			MethodName: "GetLogicalDevice",
			Handler:    _VolthaService_GetLogicalDevice_Handler,
		},
		{
			MethodName: "ListLogicalDevicePorts",
			Handler:    _VolthaService_ListLogicalDevicePorts_Handler,
		},
		{
			MethodName: "GetLogicalDevicePort",
			Handler:    _VolthaService_GetLogicalDevicePort_Handler,
		},
		{
			MethodName: "EnableLogicalDevicePort",
			Handler:    _VolthaService_EnableLogicalDevicePort_Handler,
		},
		{
			MethodName: "DisableLogicalDevicePort",
			Handler:    _VolthaService_DisableLogicalDevicePort_Handler,
		},
		{
			MethodName: "ListLogicalDeviceFlows",
			Handler:    _VolthaService_ListLogicalDeviceFlows_Handler,
		},
		{
			MethodName: "UpdateLogicalDeviceFlowTable",
			Handler:    _VolthaService_UpdateLogicalDeviceFlowTable_Handler,
		},
		{
			MethodName: "UpdateLogicalDeviceMeterTable",
			Handler:    _VolthaService_UpdateLogicalDeviceMeterTable_Handler,
		},
		{
			MethodName: "ListLogicalDeviceMeters",
			Handler:    _VolthaService_ListLogicalDeviceMeters_Handler,
		},
		{
			MethodName: "ListLogicalDeviceFlowGroups",
			Handler:    _VolthaService_ListLogicalDeviceFlowGroups_Handler,
		},
		{
			MethodName: "UpdateLogicalDeviceFlowGroupTable",
			Handler:    _VolthaService_UpdateLogicalDeviceFlowGroupTable_Handler,
		},
		{
			MethodName: "ListDevices",
			Handler:    _VolthaService_ListDevices_Handler,
		},
		{
			MethodName: "ListDeviceIds",
			Handler:    _VolthaService_ListDeviceIds_Handler,
		},
		{
			MethodName: "ReconcileDevices",
			Handler:    _VolthaService_ReconcileDevices_Handler,
		},
		{
			MethodName: "GetDevice",
			Handler:    _VolthaService_GetDevice_Handler,
		},
		{
			MethodName: "CreateDevice",
			Handler:    _VolthaService_CreateDevice_Handler,
		},
		{
			MethodName: "EnableDevice",
			Handler:    _VolthaService_EnableDevice_Handler,
		},
		{
			MethodName: "DisableDevice",
			Handler:    _VolthaService_DisableDevice_Handler,
		},
		{
			MethodName: "RebootDevice",
			Handler:    _VolthaService_RebootDevice_Handler,
		},
		{
			MethodName: "DeleteDevice",
			Handler:    _VolthaService_DeleteDevice_Handler,
		},
		{
			MethodName: "ForceDeleteDevice",
			Handler:    _VolthaService_ForceDeleteDevice_Handler,
		},
		{
			MethodName: "DownloadImage",
			Handler:    _VolthaService_DownloadImage_Handler,
		},
		{
			MethodName: "GetImageDownloadStatus",
			Handler:    _VolthaService_GetImageDownloadStatus_Handler,
		},
		{
			MethodName: "GetImageDownload",
			Handler:    _VolthaService_GetImageDownload_Handler,
		},
		{
			MethodName: "ListImageDownloads",
			Handler:    _VolthaService_ListImageDownloads_Handler,
		},
		{
			MethodName: "CancelImageDownload",
			Handler:    _VolthaService_CancelImageDownload_Handler,
		},
		{
			MethodName: "ActivateImageUpdate",
			Handler:    _VolthaService_ActivateImageUpdate_Handler,
		},
		{
			MethodName: "RevertImageUpdate",
			Handler:    _VolthaService_RevertImageUpdate_Handler,
		},
		{
			MethodName: "DownloadImageToDevice",
			Handler:    _VolthaService_DownloadImageToDevice_Handler,
		},
		{
			MethodName: "GetImageStatus",
			Handler:    _VolthaService_GetImageStatus_Handler,
		},
		{
			MethodName: "AbortImageUpgradeToDevice",
			Handler:    _VolthaService_AbortImageUpgradeToDevice_Handler,
		},
		{
			MethodName: "GetOnuImages",
			Handler:    _VolthaService_GetOnuImages_Handler,
		},
		{
			MethodName: "ActivateImage",
			Handler:    _VolthaService_ActivateImage_Handler,
		},
		{
			MethodName: "CommitImage",
			Handler:    _VolthaService_CommitImage_Handler,
		},
		{
			MethodName: "ListDevicePorts",
			Handler:    _VolthaService_ListDevicePorts_Handler,
		},
		{
			MethodName: "ListDevicePmConfigs",
			Handler:    _VolthaService_ListDevicePmConfigs_Handler,
		},
		{
			MethodName: "UpdateDevicePmConfigs",
			Handler:    _VolthaService_UpdateDevicePmConfigs_Handler,
		},
		{
			MethodName: "ListDeviceFlows",
			Handler:    _VolthaService_ListDeviceFlows_Handler,
		},
		{
			MethodName: "ListDeviceFlowGroups",
			Handler:    _VolthaService_ListDeviceFlowGroups_Handler,
		},
		{
			MethodName: "ListDeviceTypes",
			Handler:    _VolthaService_ListDeviceTypes_Handler,
		},
		{
			MethodName: "GetDeviceType",
			Handler:    _VolthaService_GetDeviceType_Handler,
		},
		{
			MethodName: "CreateEventFilter",
			Handler:    _VolthaService_CreateEventFilter_Handler,
		},
		{
			MethodName: "GetEventFilter",
			Handler:    _VolthaService_GetEventFilter_Handler,
		},
		{
			MethodName: "UpdateEventFilter",
			Handler:    _VolthaService_UpdateEventFilter_Handler,
		},
		{
			MethodName: "DeleteEventFilter",
			Handler:    _VolthaService_DeleteEventFilter_Handler,
		},
		{
			MethodName: "ListEventFilters",
			Handler:    _VolthaService_ListEventFilters_Handler,
		},
		{
			MethodName: "GetImages",
			Handler:    _VolthaService_GetImages_Handler,
		},
		{
			MethodName: "SelfTest",
			Handler:    _VolthaService_SelfTest_Handler,
		},
		{
			MethodName: "GetMibDeviceData",
			Handler:    _VolthaService_GetMibDeviceData_Handler,
		},
		{
			MethodName: "GetAlarmDeviceData",
			Handler:    _VolthaService_GetAlarmDeviceData_Handler,
		},
		{
			MethodName: "SimulateAlarm",
			Handler:    _VolthaService_SimulateAlarm_Handler,
		},
		{
			MethodName: "EnablePort",
			Handler:    _VolthaService_EnablePort_Handler,
		},
		{
			MethodName: "DisablePort",
			Handler:    _VolthaService_DisablePort_Handler,
		},
		{
			MethodName: "GetExtValue",
			Handler:    _VolthaService_GetExtValue_Handler,
		},
		{
			MethodName: "SetExtValue",
			Handler:    _VolthaService_SetExtValue_Handler,
		},
		{
			MethodName: "StartOmciTestAction",
			Handler:    _VolthaService_StartOmciTestAction_Handler,
		},
		{
			MethodName: "PutVoipSystemProfile",
			Handler:    _VolthaService_PutVoipSystemProfile_Handler,
		},
		{
			MethodName: "DeleteVoipSystemProfile",
			Handler:    _VolthaService_DeleteVoipSystemProfile_Handler,
		},
		{
			MethodName: "PutVoipUserProfile",
			Handler:    _VolthaService_PutVoipUserProfile_Handler,
		},
		{
			MethodName: "DeleteVoipUserProfile",
			Handler:    _VolthaService_DeleteVoipUserProfile_Handler,
		},
		{
			MethodName: "DisableOnuDevice",
			Handler:    _VolthaService_DisableOnuDevice_Handler,
		},
		{
			MethodName: "EnableOnuDevice",
			Handler:    _VolthaService_EnableOnuDevice_Handler,
		},
		{
			MethodName: "DisableOnuSerialNumber",
			Handler:    _VolthaService_DisableOnuSerialNumber_Handler,
		},
		{
			MethodName: "EnableOnuSerialNumber",
			Handler:    _VolthaService_EnableOnuSerialNumber_Handler,
		},
		{
			MethodName: "UpdateDevice",
			Handler:    _VolthaService_UpdateDevice_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamPacketsOut",
			Handler:       _VolthaService_StreamPacketsOut_Handler,
			ClientStreams: true,
		},
		{
			StreamName:    "ReceivePacketsIn",
			Handler:       _VolthaService_ReceivePacketsIn_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ReceiveChangeEvents",
			Handler:       _VolthaService_ReceiveChangeEvents_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "voltha_protos/voltha.proto",
}

VolthaService_ServiceDesc is the grpc.ServiceDesc for VolthaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterVolthaServiceServer

func RegisterVolthaServiceServer(s grpc.ServiceRegistrar, srv VolthaServiceServer)

Types

type Adapter

type Adapter struct {

	// the adapter ID has to be unique,
	// it will be generated as Type + CurrentReplica
	Id      string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Vendor  string `protobuf:"bytes,2,opt,name=vendor,proto3" json:"vendor,omitempty"`
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// Adapter configuration
	Config *AdapterConfig `protobuf:"bytes,16,opt,name=config,proto3" json:"config,omitempty"`
	// Custom descriptors and custom configuration
	AdditionalDescription *anypb.Any `protobuf:"bytes,64,opt,name=additional_description,json=additionalDescription,proto3" json:"additional_description,omitempty"`
	LogicalDeviceIds      []string   `protobuf:"bytes,4,rep,name=logical_device_ids,json=logicalDeviceIds,proto3" json:"logical_device_ids,omitempty"` // Logical devices "owned"
	// timestamp when the adapter last sent a message to the core
	LastCommunication int64  `protobuf:"varint,5,opt,name=last_communication,json=lastCommunication,proto3" json:"last_communication,omitempty"`
	CurrentReplica    int32  `protobuf:"varint,6,opt,name=currentReplica,proto3" json:"currentReplica,omitempty"`
	TotalReplicas     int32  `protobuf:"varint,7,opt,name=totalReplicas,proto3" json:"totalReplicas,omitempty"`
	Endpoint          string `protobuf:"bytes,8,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// all replicas of the same adapter will have the same type
	// it is used to associate a device to an adapter
	Type string `protobuf:"bytes,9,opt,name=type,proto3" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Adapter (software plugin)

func (*Adapter) Descriptor deprecated

func (*Adapter) Descriptor() ([]byte, []int)

Deprecated: Use Adapter.ProtoReflect.Descriptor instead.

func (*Adapter) GetAdditionalDescription

func (x *Adapter) GetAdditionalDescription() *anypb.Any

func (*Adapter) GetConfig

func (x *Adapter) GetConfig() *AdapterConfig

func (*Adapter) GetCurrentReplica

func (x *Adapter) GetCurrentReplica() int32

func (*Adapter) GetEndpoint

func (x *Adapter) GetEndpoint() string

func (*Adapter) GetId

func (x *Adapter) GetId() string

func (*Adapter) GetLastCommunication

func (x *Adapter) GetLastCommunication() int64

func (*Adapter) GetLogicalDeviceIds

func (x *Adapter) GetLogicalDeviceIds() []string

func (*Adapter) GetTotalReplicas

func (x *Adapter) GetTotalReplicas() int32

func (*Adapter) GetType

func (x *Adapter) GetType() string

func (*Adapter) GetVendor

func (x *Adapter) GetVendor() string

func (*Adapter) GetVersion

func (x *Adapter) GetVersion() string

func (*Adapter) ProtoMessage

func (*Adapter) ProtoMessage()

func (*Adapter) ProtoReflect added in v5.7.1

func (x *Adapter) ProtoReflect() protoreflect.Message

func (*Adapter) Reset

func (x *Adapter) Reset()

func (*Adapter) String

func (x *Adapter) String() string

type AdapterConfig

type AdapterConfig struct {

	// Custom (vendor-specific) configuration attributes
	AdditionalConfig *anypb.Any `protobuf:"bytes,64,opt,name=additional_config,json=additionalConfig,proto3" json:"additional_config,omitempty"`
	// contains filtered or unexported fields
}

func (*AdapterConfig) Descriptor deprecated

func (*AdapterConfig) Descriptor() ([]byte, []int)

Deprecated: Use AdapterConfig.ProtoReflect.Descriptor instead.

func (*AdapterConfig) GetAdditionalConfig

func (x *AdapterConfig) GetAdditionalConfig() *anypb.Any

func (*AdapterConfig) ProtoMessage

func (*AdapterConfig) ProtoMessage()

func (*AdapterConfig) ProtoReflect added in v5.7.1

func (x *AdapterConfig) ProtoReflect() protoreflect.Message

func (*AdapterConfig) Reset

func (x *AdapterConfig) Reset()

func (*AdapterConfig) String

func (x *AdapterConfig) String() string

type Adapters

type Adapters struct {
	Items []*Adapter `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*Adapters) Descriptor deprecated

func (*Adapters) Descriptor() ([]byte, []int)

Deprecated: Use Adapters.ProtoReflect.Descriptor instead.

func (*Adapters) GetItems

func (x *Adapters) GetItems() []*Adapter

func (*Adapters) ProtoMessage

func (*Adapters) ProtoMessage()

func (*Adapters) ProtoReflect added in v5.7.1

func (x *Adapters) ProtoReflect() protoreflect.Message

func (*Adapters) Reset

func (x *Adapters) Reset()

func (*Adapters) String

func (x *Adapters) String() string

type AdminState

type AdminState = common.AdminState

type AdminState_Types

type AdminState_Types = common.AdminState_Types

type ConfigEvent

type ConfigEvent struct {
	Type ConfigEventType_Types `protobuf:"varint,1,opt,name=type,proto3,enum=event.ConfigEventType_Types" json:"type,omitempty"`
	Hash string                `protobuf:"bytes,2,opt,name=hash,proto3" json:"hash,omitempty"` // hash for this change, can be used for quick lookup
	Data string                `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"` // the actual new data, in json format
	// contains filtered or unexported fields
}

func (*ConfigEvent) Descriptor deprecated

func (*ConfigEvent) Descriptor() ([]byte, []int)

Deprecated: Use ConfigEvent.ProtoReflect.Descriptor instead.

func (*ConfigEvent) GetData

func (x *ConfigEvent) GetData() string

func (*ConfigEvent) GetHash

func (x *ConfigEvent) GetHash() string

func (*ConfigEvent) GetType

func (x *ConfigEvent) GetType() ConfigEventType_Types

func (*ConfigEvent) ProtoMessage

func (*ConfigEvent) ProtoMessage()

func (*ConfigEvent) ProtoReflect added in v5.7.1

func (x *ConfigEvent) ProtoReflect() protoreflect.Message

func (*ConfigEvent) Reset

func (x *ConfigEvent) Reset()

func (*ConfigEvent) String

func (x *ConfigEvent) String() string

type ConfigEventType

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

func (*ConfigEventType) Descriptor deprecated

func (*ConfigEventType) Descriptor() ([]byte, []int)

Deprecated: Use ConfigEventType.ProtoReflect.Descriptor instead.

func (*ConfigEventType) ProtoMessage

func (*ConfigEventType) ProtoMessage()

func (*ConfigEventType) ProtoReflect added in v5.7.1

func (x *ConfigEventType) ProtoReflect() protoreflect.Message

func (*ConfigEventType) Reset

func (x *ConfigEventType) Reset()

func (*ConfigEventType) String

func (x *ConfigEventType) String() string

type ConfigEventType_Types

type ConfigEventType_Types int32
const (
	ConfigEventType_add    ConfigEventType_Types = 0 // A new config has been added
	ConfigEventType_remove ConfigEventType_Types = 1 // A config has been removed
	ConfigEventType_update ConfigEventType_Types = 2 // A config has been updated
)

func (ConfigEventType_Types) Descriptor added in v5.7.1

func (ConfigEventType_Types) Enum added in v5.7.1

func (ConfigEventType_Types) EnumDescriptor deprecated

func (ConfigEventType_Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use ConfigEventType_Types.Descriptor instead.

func (ConfigEventType_Types) Number added in v5.7.1

func (ConfigEventType_Types) String

func (x ConfigEventType_Types) String() string

func (ConfigEventType_Types) Type added in v5.7.1

type ConnectStatus

type ConnectStatus = common.ConnectStatus

type ConnectStatus_Types

type ConnectStatus_Types = common.ConnectStatus_Types

type Connection

type Connection = common.Connection

type CoreInstance

type CoreInstance struct {
	InstanceId string               `protobuf:"bytes,1,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	Health     *health.HealthStatus `protobuf:"bytes,2,opt,name=health,proto3" json:"health,omitempty"`
	// contains filtered or unexported fields
}

CoreInstance represents a core instance. It is data held in memory when a core is running. This data is not persistent.

func (*CoreInstance) Descriptor deprecated

func (*CoreInstance) Descriptor() ([]byte, []int)

Deprecated: Use CoreInstance.ProtoReflect.Descriptor instead.

func (*CoreInstance) GetHealth

func (x *CoreInstance) GetHealth() *health.HealthStatus

func (*CoreInstance) GetInstanceId

func (x *CoreInstance) GetInstanceId() string

func (*CoreInstance) ProtoMessage

func (*CoreInstance) ProtoMessage()

func (*CoreInstance) ProtoReflect added in v5.7.1

func (x *CoreInstance) ProtoReflect() protoreflect.Message

func (*CoreInstance) Reset

func (x *CoreInstance) Reset()

func (*CoreInstance) String

func (x *CoreInstance) String() string

type CoreInstances

type CoreInstances struct {
	Items []*CoreInstance `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*CoreInstances) Descriptor deprecated

func (*CoreInstances) Descriptor() ([]byte, []int)

Deprecated: Use CoreInstances.ProtoReflect.Descriptor instead.

func (*CoreInstances) GetItems

func (x *CoreInstances) GetItems() []*CoreInstance

func (*CoreInstances) ProtoMessage

func (*CoreInstances) ProtoMessage()

func (*CoreInstances) ProtoReflect added in v5.7.1

func (x *CoreInstances) ProtoReflect() protoreflect.Message

func (*CoreInstances) Reset

func (x *CoreInstances) Reset()

func (*CoreInstances) String

func (x *CoreInstances) String() string

type Device

type Device struct {

	// Voltha's device identifier
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Device type, refers to one of the registered device types
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Is this device a root device. Each logical switch has one root
	// device that is associated with the logical flow switch.
	Root bool `protobuf:"varint,3,opt,name=root,proto3" json:"root,omitempty"`
	// Parent device id, in the device tree (for a root device, the parent_id
	// is the logical_device.id)
	ParentId     string `protobuf:"bytes,4,opt,name=parent_id,json=parentId,proto3" json:"parent_id,omitempty"`
	ParentPortNo uint32 `protobuf:"varint,20,opt,name=parent_port_no,json=parentPortNo,proto3" json:"parent_port_no,omitempty"`
	// Vendor, version, serial number, etc.
	Vendor          string `protobuf:"bytes,5,opt,name=vendor,proto3" json:"vendor,omitempty"`
	Model           string `protobuf:"bytes,6,opt,name=model,proto3" json:"model,omitempty"`
	HardwareVersion string `protobuf:"bytes,7,opt,name=hardware_version,json=hardwareVersion,proto3" json:"hardware_version,omitempty"`
	FirmwareVersion string `protobuf:"bytes,8,opt,name=firmware_version,json=firmwareVersion,proto3" json:"firmware_version,omitempty"`
	// List of software on the device
	Images       *Images `protobuf:"bytes,9,opt,name=images,proto3" json:"images,omitempty"`
	SerialNumber string  `protobuf:"bytes,10,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
	VendorId     string  `protobuf:"bytes,24,opt,name=vendor_id,json=vendorId,proto3" json:"vendor_id,omitempty"`
	// Indicates how to reach the adapter instance that manages this device
	AdapterEndpoint string `protobuf:"bytes,25,opt,name=adapter_endpoint,json=adapterEndpoint,proto3" json:"adapter_endpoint,omitempty"`
	// Device contact on vlan (if 0, no vlan)
	Vlan uint32 `protobuf:"varint,12,opt,name=vlan,proto3" json:"vlan,omitempty"`
	// Device contact MAC address (format: "xx:xx:xx:xx:xx:xx")
	MacAddress string `protobuf:"bytes,13,opt,name=mac_address,json=macAddress,proto3" json:"mac_address,omitempty"`
	// Types that are valid to be assigned to Address:
	//
	//	*Device_Ipv4Address
	//	*Device_Ipv6Address
	//	*Device_HostAndPort
	Address       isDevice_Address           `protobuf_oneof:"address"`
	ExtraArgs     string                     `protobuf:"bytes,23,opt,name=extra_args,json=extraArgs,proto3" json:"extra_args,omitempty"` // Used to pass additional device specific arguments
	ProxyAddress  *Device_ProxyAddress       `protobuf:"bytes,19,opt,name=proxy_address,json=proxyAddress,proto3" json:"proxy_address,omitempty"`
	AdminState    common.AdminState_Types    `protobuf:"varint,16,opt,name=admin_state,json=adminState,proto3,enum=common.AdminState_Types" json:"admin_state,omitempty"`
	OperStatus    common.OperStatus_Types    `protobuf:"varint,17,opt,name=oper_status,json=operStatus,proto3,enum=common.OperStatus_Types" json:"oper_status,omitempty"`
	Reason        string                     `protobuf:"bytes,22,opt,name=reason,proto3" json:"reason,omitempty"` //  Used in FAILED state
	ConnectStatus common.ConnectStatus_Types ``                                                                   /* 134-byte string literal not displayed */
	// Device type specific attributes
	Custom *anypb.Any `protobuf:"bytes,64,opt,name=custom,proto3" json:"custom,omitempty"`
	// PmConfigs type
	PmConfigs      *PmConfigs       `protobuf:"bytes,131,opt,name=pm_configs,json=pmConfigs,proto3" json:"pm_configs,omitempty"`
	ImageDownloads []*ImageDownload `protobuf:"bytes,133,rep,name=image_downloads,json=imageDownloads,proto3" json:"image_downloads,omitempty"`
	// contains filtered or unexported fields
}

A Physical Device instance

func (*Device) Descriptor deprecated

func (*Device) Descriptor() ([]byte, []int)

Deprecated: Use Device.ProtoReflect.Descriptor instead.

func (*Device) GetAdapterEndpoint

func (x *Device) GetAdapterEndpoint() string

func (*Device) GetAddress

func (x *Device) GetAddress() isDevice_Address

func (*Device) GetAdminState

func (x *Device) GetAdminState() common.AdminState_Types

func (*Device) GetConnectStatus

func (x *Device) GetConnectStatus() common.ConnectStatus_Types

func (*Device) GetCustom

func (x *Device) GetCustom() *anypb.Any

func (*Device) GetExtraArgs

func (x *Device) GetExtraArgs() string

func (*Device) GetFirmwareVersion

func (x *Device) GetFirmwareVersion() string

func (*Device) GetHardwareVersion

func (x *Device) GetHardwareVersion() string

func (*Device) GetHostAndPort

func (x *Device) GetHostAndPort() string

func (*Device) GetId

func (x *Device) GetId() string

func (*Device) GetImageDownloads

func (x *Device) GetImageDownloads() []*ImageDownload

func (*Device) GetImages

func (x *Device) GetImages() *Images

func (*Device) GetIpv4Address

func (x *Device) GetIpv4Address() string

func (*Device) GetIpv6Address

func (x *Device) GetIpv6Address() string

func (*Device) GetMacAddress

func (x *Device) GetMacAddress() string

func (*Device) GetModel

func (x *Device) GetModel() string

func (*Device) GetOperStatus

func (x *Device) GetOperStatus() common.OperStatus_Types

func (*Device) GetParentId

func (x *Device) GetParentId() string

func (*Device) GetParentPortNo

func (x *Device) GetParentPortNo() uint32

func (*Device) GetPmConfigs

func (x *Device) GetPmConfigs() *PmConfigs

func (*Device) GetProxyAddress

func (x *Device) GetProxyAddress() *Device_ProxyAddress

func (*Device) GetReason

func (x *Device) GetReason() string

func (*Device) GetRoot

func (x *Device) GetRoot() bool

func (*Device) GetSerialNumber

func (x *Device) GetSerialNumber() string

func (*Device) GetType

func (x *Device) GetType() string

func (*Device) GetVendor

func (x *Device) GetVendor() string

func (*Device) GetVendorId

func (x *Device) GetVendorId() string

func (*Device) GetVlan

func (x *Device) GetVlan() uint32

func (*Device) ProtoMessage

func (*Device) ProtoMessage()

func (*Device) ProtoReflect added in v5.7.1

func (x *Device) ProtoReflect() protoreflect.Message

func (*Device) Reset

func (x *Device) Reset()

func (*Device) String

func (x *Device) String() string

type DeviceEvent

type DeviceEvent struct {

	// Identifier of the originating resource of the event, for ex: device_id
	ResourceId string `protobuf:"bytes,1,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// device_event_name indicates clearly the name of the device event
	DeviceEventName string `protobuf:"bytes,2,opt,name=device_event_name,json=deviceEventName,proto3" json:"device_event_name,omitempty"`
	// Textual explanation of the device event
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Key/Value storage for extra information that may give context to the event
	Context map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

Describes the events specific to device

func (*DeviceEvent) Descriptor deprecated

func (*DeviceEvent) Descriptor() ([]byte, []int)

Deprecated: Use DeviceEvent.ProtoReflect.Descriptor instead.

func (*DeviceEvent) GetContext

func (x *DeviceEvent) GetContext() map[string]string

func (*DeviceEvent) GetDescription

func (x *DeviceEvent) GetDescription() string

func (*DeviceEvent) GetDeviceEventName

func (x *DeviceEvent) GetDeviceEventName() string

func (*DeviceEvent) GetResourceId

func (x *DeviceEvent) GetResourceId() string

func (*DeviceEvent) ProtoMessage

func (*DeviceEvent) ProtoMessage()

func (*DeviceEvent) ProtoReflect added in v5.7.1

func (x *DeviceEvent) ProtoReflect() protoreflect.Message

func (*DeviceEvent) Reset

func (x *DeviceEvent) Reset()

func (*DeviceEvent) String

func (x *DeviceEvent) String() string

type DeviceImageDownloadRequest

type DeviceImageDownloadRequest struct {

	// Device Id
	// allows for operations on multiple devices.
	DeviceId []*common.ID `protobuf:"bytes,1,rep,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// The image for the device containing all the information
	Image *Image `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// Activate the image if the download to the device is successful
	ActivateOnSuccess bool `protobuf:"varint,3,opt,name=activateOnSuccess,proto3" json:"activateOnSuccess,omitempty"`
	// Automatically commit the image if the activation on the device is successful
	CommitOnSuccess bool `protobuf:"varint,4,opt,name=commitOnSuccess,proto3" json:"commitOnSuccess,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceImageDownloadRequest) Descriptor deprecated

func (*DeviceImageDownloadRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeviceImageDownloadRequest.ProtoReflect.Descriptor instead.

func (*DeviceImageDownloadRequest) GetActivateOnSuccess

func (x *DeviceImageDownloadRequest) GetActivateOnSuccess() bool

func (*DeviceImageDownloadRequest) GetCommitOnSuccess

func (x *DeviceImageDownloadRequest) GetCommitOnSuccess() bool

func (*DeviceImageDownloadRequest) GetDeviceId

func (x *DeviceImageDownloadRequest) GetDeviceId() []*common.ID

func (*DeviceImageDownloadRequest) GetImage

func (x *DeviceImageDownloadRequest) GetImage() *Image

func (*DeviceImageDownloadRequest) ProtoMessage

func (*DeviceImageDownloadRequest) ProtoMessage()

func (*DeviceImageDownloadRequest) ProtoReflect added in v5.7.1

func (*DeviceImageDownloadRequest) Reset

func (x *DeviceImageDownloadRequest) Reset()

func (*DeviceImageDownloadRequest) String

func (x *DeviceImageDownloadRequest) String() string

type DeviceImageRequest

type DeviceImageRequest struct {

	// Device Id
	// allows for operations on multiple adapters.
	DeviceId []*common.ID `protobuf:"bytes,1,rep,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	// Image Version, this is the sole identifier of the image. it's the vendor specified OMCI version
	// must be known at the time of initiating a download, activate, commit image on an onu.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Automatically commit the image if the activation on the device is successful
	CommitOnSuccess bool `protobuf:"varint,3,opt,name=commitOnSuccess,proto3" json:"commitOnSuccess,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceImageRequest) Descriptor deprecated

func (*DeviceImageRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeviceImageRequest.ProtoReflect.Descriptor instead.

func (*DeviceImageRequest) GetCommitOnSuccess

func (x *DeviceImageRequest) GetCommitOnSuccess() bool

func (*DeviceImageRequest) GetDeviceId

func (x *DeviceImageRequest) GetDeviceId() []*common.ID

func (*DeviceImageRequest) GetVersion

func (x *DeviceImageRequest) GetVersion() string

func (*DeviceImageRequest) ProtoMessage

func (*DeviceImageRequest) ProtoMessage()

func (*DeviceImageRequest) ProtoReflect added in v5.7.1

func (x *DeviceImageRequest) ProtoReflect() protoreflect.Message

func (*DeviceImageRequest) Reset

func (x *DeviceImageRequest) Reset()

func (*DeviceImageRequest) String

func (x *DeviceImageRequest) String() string

type DeviceImageResponse

type DeviceImageResponse struct {

	// Image state for the different devices
	DeviceImageStates []*DeviceImageState `protobuf:"bytes,1,rep,name=device_image_states,json=deviceImageStates,proto3" json:"device_image_states,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceImageResponse) Descriptor deprecated

func (*DeviceImageResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeviceImageResponse.ProtoReflect.Descriptor instead.

func (*DeviceImageResponse) GetDeviceImageStates

func (x *DeviceImageResponse) GetDeviceImageStates() []*DeviceImageState

func (*DeviceImageResponse) ProtoMessage

func (*DeviceImageResponse) ProtoMessage()

func (*DeviceImageResponse) ProtoReflect added in v5.7.1

func (x *DeviceImageResponse) ProtoReflect() protoreflect.Message

func (*DeviceImageResponse) Reset

func (x *DeviceImageResponse) Reset()

func (*DeviceImageResponse) String

func (x *DeviceImageResponse) String() string

type DeviceImageState

type DeviceImageState struct {
	DeviceId   string      `protobuf:"bytes,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	ImageState *ImageState `protobuf:"bytes,2,opt,name=imageState,proto3" json:"imageState,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceImageState) Descriptor deprecated

func (*DeviceImageState) Descriptor() ([]byte, []int)

Deprecated: Use DeviceImageState.ProtoReflect.Descriptor instead.

func (*DeviceImageState) GetDeviceId

func (x *DeviceImageState) GetDeviceId() string

func (*DeviceImageState) GetImageState

func (x *DeviceImageState) GetImageState() *ImageState

func (*DeviceImageState) ProtoMessage

func (*DeviceImageState) ProtoMessage()

func (*DeviceImageState) ProtoReflect added in v5.7.1

func (x *DeviceImageState) ProtoReflect() protoreflect.Message

func (*DeviceImageState) Reset

func (x *DeviceImageState) Reset()

func (*DeviceImageState) String

func (x *DeviceImageState) String() string

type DeviceType

type DeviceType struct {

	// Unique name for the device type
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Unique vendor id for the device type applicable to ONU
	// 4 bytes of vendor id from ONU serial number
	VendorId  string   `protobuf:"bytes,5,opt,name=vendor_id,json=vendorId,proto3" json:"vendor_id,omitempty"`
	VendorIds []string `protobuf:"bytes,6,rep,name=vendor_ids,json=vendorIds,proto3" json:"vendor_ids,omitempty"`
	// Name of the adapter that handles device type
	// Deprecated and replaced by adapterType
	Adapter string `protobuf:"bytes,2,opt,name=adapter,proto3" json:"adapter,omitempty"`
	// Capabilities
	AcceptsBulkFlowUpdate           bool `` /* 129-byte string literal not displayed */
	AcceptsAddRemoveFlowUpdates     bool `` /* 149-byte string literal not displayed */
	AcceptsDirectLogicalFlowsUpdate bool `` /* 161-byte string literal not displayed */
	// Type of adapter that can handle this device type
	AdapterType string `protobuf:"bytes,8,opt,name=adapter_type,json=adapterType,proto3" json:"adapter_type,omitempty"`
	// contains filtered or unexported fields
}

A Device Type

func (*DeviceType) Descriptor deprecated

func (*DeviceType) Descriptor() ([]byte, []int)

Deprecated: Use DeviceType.ProtoReflect.Descriptor instead.

func (*DeviceType) GetAcceptsAddRemoveFlowUpdates

func (x *DeviceType) GetAcceptsAddRemoveFlowUpdates() bool

func (*DeviceType) GetAcceptsBulkFlowUpdate

func (x *DeviceType) GetAcceptsBulkFlowUpdate() bool

func (*DeviceType) GetAcceptsDirectLogicalFlowsUpdate

func (x *DeviceType) GetAcceptsDirectLogicalFlowsUpdate() bool

func (*DeviceType) GetAdapter

func (x *DeviceType) GetAdapter() string

func (*DeviceType) GetAdapterType

func (x *DeviceType) GetAdapterType() string

func (*DeviceType) GetId

func (x *DeviceType) GetId() string

func (*DeviceType) GetVendorId

func (x *DeviceType) GetVendorId() string

func (*DeviceType) GetVendorIds

func (x *DeviceType) GetVendorIds() []string

func (*DeviceType) ProtoMessage

func (*DeviceType) ProtoMessage()

func (*DeviceType) ProtoReflect added in v5.7.1

func (x *DeviceType) ProtoReflect() protoreflect.Message

func (*DeviceType) Reset

func (x *DeviceType) Reset()

func (*DeviceType) String

func (x *DeviceType) String() string

type DeviceTypes

type DeviceTypes struct {
	Items []*DeviceType `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

A plurality of device types

func (*DeviceTypes) Descriptor deprecated

func (*DeviceTypes) Descriptor() ([]byte, []int)

Deprecated: Use DeviceTypes.ProtoReflect.Descriptor instead.

func (*DeviceTypes) GetItems

func (x *DeviceTypes) GetItems() []*DeviceType

func (*DeviceTypes) ProtoMessage

func (*DeviceTypes) ProtoMessage()

func (*DeviceTypes) ProtoReflect added in v5.7.1

func (x *DeviceTypes) ProtoReflect() protoreflect.Message

func (*DeviceTypes) Reset

func (x *DeviceTypes) Reset()

func (*DeviceTypes) String

func (x *DeviceTypes) String() string

type Device_HostAndPort

type Device_HostAndPort struct {
	HostAndPort string `protobuf:"bytes,21,opt,name=host_and_port,json=hostAndPort,proto3,oneof"`
}

type Device_Ipv4Address

type Device_Ipv4Address struct {
	// Device contact IPv4 address (format: "a.b.c.d" or can use hostname too)
	Ipv4Address string `protobuf:"bytes,14,opt,name=ipv4_address,json=ipv4Address,proto3,oneof"`
}

type Device_Ipv6Address

type Device_Ipv6Address struct {
	// Device contact IPv6 address using the canonical string form
	// ("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
	Ipv6Address string `protobuf:"bytes,15,opt,name=ipv6_address,json=ipv6Address,proto3,oneof"`
}

type Device_ProxyAddress

type Device_ProxyAddress struct {
	DeviceId           string `protobuf:"bytes,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`                               // Which device to use as proxy to this device
	DeviceType         string `protobuf:"bytes,2,opt,name=device_type,json=deviceType,proto3" json:"device_type,omitempty"`                         // The device type of the proxy device to use as the adapter name
	ChannelId          uint32 `protobuf:"varint,3,opt,name=channel_id,json=channelId,proto3" json:"channel_id,omitempty"`                           // Sub-address within proxy
	ChannelGroupId     uint32 `protobuf:"varint,4,opt,name=channel_group_id,json=channelGroupId,proto3" json:"channel_group_id,omitempty"`          // Channel Group index
	ChannelTermination string `protobuf:"bytes,5,opt,name=channel_termination,json=channelTermination,proto3" json:"channel_termination,omitempty"` // Channel Termination name
	OnuId              uint32 `protobuf:"varint,6,opt,name=onu_id,json=onuId,proto3" json:"onu_id,omitempty"`                                       // onu identifier; optional
	OnuSessionId       uint32 `protobuf:"varint,7,opt,name=onu_session_id,json=onuSessionId,proto3" json:"onu_session_id,omitempty"`                // session identifier for the ONU; optional
	AdapterEndpoint    string `protobuf:"bytes,8,opt,name=adapter_endpoint,json=adapterEndpoint,proto3" json:"adapter_endpoint,omitempty"`          // endpoint of the adapter that handles the proxy device
	// contains filtered or unexported fields
}

func (*Device_ProxyAddress) Descriptor deprecated

func (*Device_ProxyAddress) Descriptor() ([]byte, []int)

Deprecated: Use Device_ProxyAddress.ProtoReflect.Descriptor instead.

func (*Device_ProxyAddress) GetAdapterEndpoint

func (x *Device_ProxyAddress) GetAdapterEndpoint() string

func (*Device_ProxyAddress) GetChannelGroupId

func (x *Device_ProxyAddress) GetChannelGroupId() uint32

func (*Device_ProxyAddress) GetChannelId

func (x *Device_ProxyAddress) GetChannelId() uint32

func (*Device_ProxyAddress) GetChannelTermination

func (x *Device_ProxyAddress) GetChannelTermination() string

func (*Device_ProxyAddress) GetDeviceId

func (x *Device_ProxyAddress) GetDeviceId() string

func (*Device_ProxyAddress) GetDeviceType

func (x *Device_ProxyAddress) GetDeviceType() string

func (*Device_ProxyAddress) GetOnuId

func (x *Device_ProxyAddress) GetOnuId() uint32

func (*Device_ProxyAddress) GetOnuSessionId

func (x *Device_ProxyAddress) GetOnuSessionId() uint32

func (*Device_ProxyAddress) ProtoMessage

func (*Device_ProxyAddress) ProtoMessage()

func (*Device_ProxyAddress) ProtoReflect added in v5.7.1

func (x *Device_ProxyAddress) ProtoReflect() protoreflect.Message

func (*Device_ProxyAddress) Reset

func (x *Device_ProxyAddress) Reset()

func (*Device_ProxyAddress) String

func (x *Device_ProxyAddress) String() string

type Devices

type Devices struct {
	Items []*Device `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*Devices) Descriptor deprecated

func (*Devices) Descriptor() ([]byte, []int)

Deprecated: Use Devices.ProtoReflect.Descriptor instead.

func (*Devices) GetItems

func (x *Devices) GetItems() []*Device

func (*Devices) ProtoMessage

func (*Devices) ProtoMessage()

func (*Devices) ProtoReflect added in v5.7.1

func (x *Devices) ProtoReflect() protoreflect.Message

func (*Devices) Reset

func (x *Devices) Reset()

func (*Devices) String

func (x *Devices) String() string

type Event

type Event struct {

	// event header
	Header *EventHeader `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// oneof event types referred by EventType.
	//
	// Types that are valid to be assigned to EventType:
	//
	//	*Event_ConfigEvent
	//	*Event_KpiEvent
	//	*Event_KpiEvent2
	//	*Event_DeviceEvent
	//	*Event_RpcEvent
	//	*Event_KpiEvent3
	EventType isEvent_EventType `protobuf_oneof:"event_type"`
	// contains filtered or unexported fields
}

Event Structure

func (*Event) Descriptor deprecated

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetConfigEvent

func (x *Event) GetConfigEvent() *ConfigEvent

func (*Event) GetDeviceEvent

func (x *Event) GetDeviceEvent() *DeviceEvent

func (*Event) GetEventType

func (x *Event) GetEventType() isEvent_EventType

func (*Event) GetHeader

func (x *Event) GetHeader() *EventHeader

func (*Event) GetKpiEvent

func (x *Event) GetKpiEvent() *KpiEvent

func (*Event) GetKpiEvent2

func (x *Event) GetKpiEvent2() *KpiEvent2

func (*Event) GetKpiEvent3 added in v5.6.8

func (x *Event) GetKpiEvent3() *KpiEvent3

func (*Event) GetRpcEvent

func (x *Event) GetRpcEvent() *RPCEvent

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect added in v5.7.1

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type EventCategory

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

Identify the area of the system impacted by the event.

func (*EventCategory) Descriptor deprecated

func (*EventCategory) Descriptor() ([]byte, []int)

Deprecated: Use EventCategory.ProtoReflect.Descriptor instead.

func (*EventCategory) ProtoMessage

func (*EventCategory) ProtoMessage()

func (*EventCategory) ProtoReflect added in v5.7.1

func (x *EventCategory) ProtoReflect() protoreflect.Message

func (*EventCategory) Reset

func (x *EventCategory) Reset()

func (*EventCategory) String

func (x *EventCategory) String() string

type EventCategory_Types

type EventCategory_Types int32
const (
	EventCategory_COMMUNICATION EventCategory_Types = 0
	EventCategory_ENVIRONMENT   EventCategory_Types = 1
	EventCategory_EQUIPMENT     EventCategory_Types = 2
	EventCategory_SERVICE       EventCategory_Types = 3
	EventCategory_PROCESSING    EventCategory_Types = 4
	EventCategory_SECURITY      EventCategory_Types = 5 // Add new event areas here
)

func (EventCategory_Types) Descriptor added in v5.7.1

func (EventCategory_Types) Enum added in v5.7.1

func (EventCategory_Types) EnumDescriptor deprecated

func (EventCategory_Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventCategory_Types.Descriptor instead.

func (EventCategory_Types) Number added in v5.7.1

func (EventCategory_Types) String

func (x EventCategory_Types) String() string

func (EventCategory_Types) Type added in v5.7.1

type EventFilter

type EventFilter struct {
	Id        string             `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Enable    bool               `protobuf:"varint,2,opt,name=enable,proto3" json:"enable,omitempty"`
	DeviceId  string             `protobuf:"bytes,3,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	EventType string             `protobuf:"bytes,4,opt,name=event_type,json=eventType,proto3" json:"event_type,omitempty"`
	Rules     []*EventFilterRule `protobuf:"bytes,5,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

func (*EventFilter) Descriptor deprecated

func (*EventFilter) Descriptor() ([]byte, []int)

Deprecated: Use EventFilter.ProtoReflect.Descriptor instead.

func (*EventFilter) GetDeviceId

func (x *EventFilter) GetDeviceId() string

func (*EventFilter) GetEnable

func (x *EventFilter) GetEnable() bool

func (*EventFilter) GetEventType

func (x *EventFilter) GetEventType() string

func (*EventFilter) GetId

func (x *EventFilter) GetId() string

func (*EventFilter) GetRules

func (x *EventFilter) GetRules() []*EventFilterRule

func (*EventFilter) ProtoMessage

func (*EventFilter) ProtoMessage()

func (*EventFilter) ProtoReflect added in v5.7.1

func (x *EventFilter) ProtoReflect() protoreflect.Message

func (*EventFilter) Reset

func (x *EventFilter) Reset()

func (*EventFilter) String

func (x *EventFilter) String() string

type EventFilterRule

type EventFilterRule struct {
	Key   EventFilterRuleKey_EventFilterRuleType `protobuf:"varint,1,opt,name=key,proto3,enum=event.EventFilterRuleKey_EventFilterRuleType" json:"key,omitempty"`
	Value string                                 `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*EventFilterRule) Descriptor deprecated

func (*EventFilterRule) Descriptor() ([]byte, []int)

Deprecated: Use EventFilterRule.ProtoReflect.Descriptor instead.

func (*EventFilterRule) GetKey

func (*EventFilterRule) GetValue

func (x *EventFilterRule) GetValue() string

func (*EventFilterRule) ProtoMessage

func (*EventFilterRule) ProtoMessage()

func (*EventFilterRule) ProtoReflect added in v5.7.1

func (x *EventFilterRule) ProtoReflect() protoreflect.Message

func (*EventFilterRule) Reset

func (x *EventFilterRule) Reset()

func (*EventFilterRule) String

func (x *EventFilterRule) String() string

type EventFilterRuleKey

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

func (*EventFilterRuleKey) Descriptor deprecated

func (*EventFilterRuleKey) Descriptor() ([]byte, []int)

Deprecated: Use EventFilterRuleKey.ProtoReflect.Descriptor instead.

func (*EventFilterRuleKey) ProtoMessage

func (*EventFilterRuleKey) ProtoMessage()

func (*EventFilterRuleKey) ProtoReflect added in v5.7.1

func (x *EventFilterRuleKey) ProtoReflect() protoreflect.Message

func (*EventFilterRuleKey) Reset

func (x *EventFilterRuleKey) Reset()

func (*EventFilterRuleKey) String

func (x *EventFilterRuleKey) String() string

type EventFilterRuleKey_EventFilterRuleType

type EventFilterRuleKey_EventFilterRuleType int32
const (
	EventFilterRuleKey_filter_all        EventFilterRuleKey_EventFilterRuleType = 0
	EventFilterRuleKey_category          EventFilterRuleKey_EventFilterRuleType = 1
	EventFilterRuleKey_sub_category      EventFilterRuleKey_EventFilterRuleType = 2
	EventFilterRuleKey_kpi_event_type    EventFilterRuleKey_EventFilterRuleType = 3
	EventFilterRuleKey_config_event_type EventFilterRuleKey_EventFilterRuleType = 4
	EventFilterRuleKey_device_event_type EventFilterRuleKey_EventFilterRuleType = 5
)

func (EventFilterRuleKey_EventFilterRuleType) Descriptor added in v5.7.1

func (EventFilterRuleKey_EventFilterRuleType) Enum added in v5.7.1

func (EventFilterRuleKey_EventFilterRuleType) EnumDescriptor deprecated

func (EventFilterRuleKey_EventFilterRuleType) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventFilterRuleKey_EventFilterRuleType.Descriptor instead.

func (EventFilterRuleKey_EventFilterRuleType) Number added in v5.7.1

func (EventFilterRuleKey_EventFilterRuleType) String

func (EventFilterRuleKey_EventFilterRuleType) Type added in v5.7.1

type EventFilters

type EventFilters struct {
	Filters []*EventFilter `protobuf:"bytes,1,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

func (*EventFilters) Descriptor deprecated

func (*EventFilters) Descriptor() ([]byte, []int)

Deprecated: Use EventFilters.ProtoReflect.Descriptor instead.

func (*EventFilters) GetFilters

func (x *EventFilters) GetFilters() []*EventFilter

func (*EventFilters) ProtoMessage

func (*EventFilters) ProtoMessage()

func (*EventFilters) ProtoReflect added in v5.7.1

func (x *EventFilters) ProtoReflect() protoreflect.Message

func (*EventFilters) Reset

func (x *EventFilters) Reset()

func (*EventFilters) String

func (x *EventFilters) String() string

type EventHeader

type EventHeader struct {

	// Unique ID for this event.  e.g. voltha.some_olt.1234
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Refers to the functional area affect by the event
	Category EventCategory_Types `protobuf:"varint,2,opt,name=category,proto3,enum=event.EventCategory_Types" json:"category,omitempty"`
	// Refers to functional category of the event
	SubCategory EventSubCategory_Types `` /* 129-byte string literal not displayed */
	// Refers to the type of the event
	Type EventType_Types `protobuf:"varint,4,opt,name=type,proto3,enum=event.EventType_Types" json:"type,omitempty"`
	// The version identifier for this event type, thus allowing each
	// event type to evolve independently. The version should be in the
	// format “MAJOR.MINOR” format and minor changes must only be additive
	// and non-breaking.
	TypeVersion string `protobuf:"bytes,5,opt,name=type_version,json=typeVersion,proto3" json:"type_version,omitempty"`
	// Timestamp at which the event was first raised.
	// This represents the UTC time stamp since epoch (in seconds) when the
	// the event was first raised from the source entity.
	// If the source entity doesn't send the raised_ts, this shall be set
	// to timestamp when the event was received.
	RaisedTs *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=raised_ts,json=raisedTs,proto3" json:"raised_ts,omitempty"`
	// Timestamp at which the event was reported.
	// This represents the UTC time stamp since epoch (in seconds) when the
	// the event was reported (this time stamp is >= raised_ts).
	// If the source entity that reported this event doesn't send the
	// reported_ts, this shall be set to the same value as raised_ts.
	ReportedTs *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=reported_ts,json=reportedTs,proto3" json:"reported_ts,omitempty"`
	// contains filtered or unexported fields
}

Identify the functional category originating the event

func (*EventHeader) Descriptor deprecated

func (*EventHeader) Descriptor() ([]byte, []int)

Deprecated: Use EventHeader.ProtoReflect.Descriptor instead.

func (*EventHeader) GetCategory

func (x *EventHeader) GetCategory() EventCategory_Types

func (*EventHeader) GetId

func (x *EventHeader) GetId() string

func (*EventHeader) GetRaisedTs

func (x *EventHeader) GetRaisedTs() *timestamppb.Timestamp

func (*EventHeader) GetReportedTs

func (x *EventHeader) GetReportedTs() *timestamppb.Timestamp

func (*EventHeader) GetSubCategory

func (x *EventHeader) GetSubCategory() EventSubCategory_Types

func (*EventHeader) GetType

func (x *EventHeader) GetType() EventType_Types

func (*EventHeader) GetTypeVersion

func (x *EventHeader) GetTypeVersion() string

func (*EventHeader) ProtoMessage

func (*EventHeader) ProtoMessage()

func (*EventHeader) ProtoReflect added in v5.7.1

func (x *EventHeader) ProtoReflect() protoreflect.Message

func (*EventHeader) Reset

func (x *EventHeader) Reset()

func (*EventHeader) String

func (x *EventHeader) String() string

type EventSubCategory

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

Identify the functional category originating the event

func (*EventSubCategory) Descriptor deprecated

func (*EventSubCategory) Descriptor() ([]byte, []int)

Deprecated: Use EventSubCategory.ProtoReflect.Descriptor instead.

func (*EventSubCategory) ProtoMessage

func (*EventSubCategory) ProtoMessage()

func (*EventSubCategory) ProtoReflect added in v5.7.1

func (x *EventSubCategory) ProtoReflect() protoreflect.Message

func (*EventSubCategory) Reset

func (x *EventSubCategory) Reset()

func (*EventSubCategory) String

func (x *EventSubCategory) String() string

type EventSubCategory_Types

type EventSubCategory_Types int32
const (
	EventSubCategory_PON  EventSubCategory_Types = 0
	EventSubCategory_OLT  EventSubCategory_Types = 1
	EventSubCategory_ONT  EventSubCategory_Types = 2
	EventSubCategory_ONU  EventSubCategory_Types = 3
	EventSubCategory_NNI  EventSubCategory_Types = 4
	EventSubCategory_NONE EventSubCategory_Types = 5 //Adding None for RPC Events
)

func (EventSubCategory_Types) Descriptor added in v5.7.1

func (EventSubCategory_Types) Enum added in v5.7.1

func (EventSubCategory_Types) EnumDescriptor deprecated

func (EventSubCategory_Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventSubCategory_Types.Descriptor instead.

func (EventSubCategory_Types) Number added in v5.7.1

func (EventSubCategory_Types) String

func (x EventSubCategory_Types) String() string

func (EventSubCategory_Types) Type added in v5.7.1

type EventType

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

Identify the type of event

func (*EventType) Descriptor deprecated

func (*EventType) Descriptor() ([]byte, []int)

Deprecated: Use EventType.ProtoReflect.Descriptor instead.

func (*EventType) ProtoMessage

func (*EventType) ProtoMessage()

func (*EventType) ProtoReflect added in v5.7.1

func (x *EventType) ProtoReflect() protoreflect.Message

func (*EventType) Reset

func (x *EventType) Reset()

func (*EventType) String

func (x *EventType) String() string

type EventType_Types

type EventType_Types int32
const (
	EventType_CONFIG_EVENT EventType_Types = 0
	EventType_KPI_EVENT    EventType_Types = 1
	EventType_KPI_EVENT2   EventType_Types = 2
	EventType_DEVICE_EVENT EventType_Types = 3
	EventType_RPC_EVENT    EventType_Types = 4
	EventType_KPI_EVENT3   EventType_Types = 5
)

func (EventType_Types) Descriptor added in v5.7.1

func (EventType_Types) Enum added in v5.7.1

func (x EventType_Types) Enum() *EventType_Types

func (EventType_Types) EnumDescriptor deprecated

func (EventType_Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventType_Types.Descriptor instead.

func (EventType_Types) Number added in v5.7.1

func (EventType_Types) String

func (x EventType_Types) String() string

func (EventType_Types) Type added in v5.7.1

type Event_ConfigEvent

type Event_ConfigEvent struct {
	// Refers to ConfigEvent
	ConfigEvent *ConfigEvent `protobuf:"bytes,2,opt,name=config_event,json=configEvent,proto3,oneof"`
}

type Event_DeviceEvent

type Event_DeviceEvent struct {
	// Refers to DeviceEvent
	DeviceEvent *DeviceEvent `protobuf:"bytes,5,opt,name=device_event,json=deviceEvent,proto3,oneof"`
}

type Event_KpiEvent

type Event_KpiEvent struct {
	// Refers to KpiEvent
	KpiEvent *KpiEvent `protobuf:"bytes,3,opt,name=kpi_event,json=kpiEvent,proto3,oneof"`
}

type Event_KpiEvent2

type Event_KpiEvent2 struct {
	// Refers to KpiEvent2
	KpiEvent2 *KpiEvent2 `protobuf:"bytes,4,opt,name=kpi_event2,json=kpiEvent2,proto3,oneof"`
}

type Event_KpiEvent3 added in v5.6.8

type Event_KpiEvent3 struct {
	// Refers to KpiEvent3 (64-bit counter support)
	KpiEvent3 *KpiEvent3 `protobuf:"bytes,7,opt,name=kpi_event3,json=kpiEvent3,proto3,oneof"`
}

type Event_RpcEvent

type Event_RpcEvent struct {
	// Refers to an RPC Event
	RpcEvent *RPCEvent `protobuf:"bytes,6,opt,name=rpc_event,json=rpcEvent,proto3,oneof"`
}

type ID

type ID = common.ID

type IDs

type IDs = common.IDs

type Image

type Image struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // software patch name
	// Version, this is the sole identifier of the image. it's the vendor specified OMCI version
	// must be known at the time of initiating a download, activate, commit image on an onu.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// hash of the image to be verified against
	// Deprecated in voltha 2.8, will be removed
	Hash uint32 `protobuf:"varint,3,opt,name=hash,proto3" json:"hash,omitempty"`
	// Deprecated in voltha 2.8, will be removed
	InstallDatetime string `protobuf:"bytes,4,opt,name=install_datetime,json=installDatetime,proto3" json:"install_datetime,omitempty"` // combined date and time expressed in UTC.
	// The active software image is one that is currently loaded and executing
	// in the ONU or circuit pack. Under normal operation, one software image
	// is always active while the other is inactive. Under no circumstances are
	// both software images allowed to be active at the same time
	// Deprecated in voltha 2.8, will be removed
	IsActive bool `protobuf:"varint,5,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"` // True if the image is active
	// The committed software image is loaded and executed upon reboot of the
	// ONU and/or circuit pack. During normal operation, one software image is
	// always committed, while the other is uncommitted.
	// Deprecated in voltha 2.8, will be removed
	IsCommitted bool `protobuf:"varint,6,opt,name=is_committed,json=isCommitted,proto3" json:"is_committed,omitempty"` // True if the image is committed
	// A software image is valid if it has been verified to be an executable
	// code image. The verification mechanism is not subject to standardization;
	// however, it should include at least a data integrity (e.g., CRC) check of
	// the entire code image.
	// Deprecated in voltha 2.8, will be removed
	IsValid bool `protobuf:"varint,7,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"` // True if the image is valid
	// URL where the image is available
	// URL MUST be fully qualified,
	// including filename, username and password
	Url string `protobuf:"bytes,8,opt,name=url,proto3" json:"url,omitempty"`
	// Represents the vendor/device mfr
	// Needs to match the vendor of the device the image will be installed on
	// optional, if not matched no check will be performed
	Vendor string `protobuf:"bytes,9,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// Represents the ONU Image CRC value.
	// Default to value 0 if not specified.
	// If different then 0 it's used to verify the image retrieved from outside before sending it to the ONU.
	// Calculation of this needs to be done according to ITU-T I.363.5 as per OMCI spec (section A.2.27)
	Crc32 uint32 `protobuf:"varint,10,opt,name=crc32,proto3" json:"crc32,omitempty"`
	// contains filtered or unexported fields
}

Object representing an image

func (*Image) Descriptor deprecated

func (*Image) Descriptor() ([]byte, []int)

Deprecated: Use Image.ProtoReflect.Descriptor instead.

func (*Image) GetCrc32

func (x *Image) GetCrc32() uint32

func (*Image) GetHash

func (x *Image) GetHash() uint32

func (*Image) GetInstallDatetime

func (x *Image) GetInstallDatetime() string

func (*Image) GetIsActive

func (x *Image) GetIsActive() bool

func (*Image) GetIsCommitted

func (x *Image) GetIsCommitted() bool

func (*Image) GetIsValid

func (x *Image) GetIsValid() bool

func (*Image) GetName

func (x *Image) GetName() string

func (*Image) GetUrl

func (x *Image) GetUrl() string

func (*Image) GetVendor

func (x *Image) GetVendor() string

func (*Image) GetVersion

func (x *Image) GetVersion() string

func (*Image) ProtoMessage

func (*Image) ProtoMessage()

func (*Image) ProtoReflect added in v5.7.1

func (x *Image) ProtoReflect() protoreflect.Message

func (*Image) Reset

func (x *Image) Reset()

func (*Image) String

func (x *Image) String() string

type ImageDownload deprecated

type ImageDownload struct {

	// Device Identifier
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Image unique identifier
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// URL where the image is available
	// should include username password
	Url string `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	// CRC of the image to be verified aginst
	Crc uint32 `protobuf:"varint,4,opt,name=crc,proto3" json:"crc,omitempty"`
	// Download state
	DownloadState ImageDownload_ImageDownloadState `` /* 146-byte string literal not displayed */
	// Downloaded version
	ImageVersion string `protobuf:"bytes,6,opt,name=image_version,json=imageVersion,proto3" json:"image_version,omitempty"`
	// Bytes downloaded
	DownloadedBytes uint32 `protobuf:"varint,7,opt,name=downloaded_bytes,json=downloadedBytes,proto3" json:"downloaded_bytes,omitempty"`
	// Download failure reason
	Reason ImageDownload_ImageDownloadFailureReason `protobuf:"varint,8,opt,name=reason,proto3,enum=device.ImageDownload_ImageDownloadFailureReason" json:"reason,omitempty"`
	// Additional info
	AdditionalInfo string `protobuf:"bytes,9,opt,name=additional_info,json=additionalInfo,proto3" json:"additional_info,omitempty"`
	// Save current configuration
	SaveConfig bool `protobuf:"varint,10,opt,name=save_config,json=saveConfig,proto3" json:"save_config,omitempty"`
	// Image local location
	LocalDir string `protobuf:"bytes,11,opt,name=local_dir,json=localDir,proto3" json:"local_dir,omitempty"`
	// Image activation state
	ImageState ImageDownload_ImageActivateState `` /* 138-byte string literal not displayed */
	// Image file size
	FileSize uint32 `protobuf:"varint,13,opt,name=file_size,json=fileSize,proto3" json:"file_size,omitempty"`
	// contains filtered or unexported fields
}

Older version of the API please see DeviceImageDownloadRequest Deprecated in voltha 2.8, will be removed

Deprecated: Marked as deprecated in voltha_protos/device.proto.

func (*ImageDownload) Descriptor deprecated

func (*ImageDownload) Descriptor() ([]byte, []int)

Deprecated: Use ImageDownload.ProtoReflect.Descriptor instead.

func (*ImageDownload) GetAdditionalInfo

func (x *ImageDownload) GetAdditionalInfo() string

func (*ImageDownload) GetCrc

func (x *ImageDownload) GetCrc() uint32

func (*ImageDownload) GetDownloadState

func (x *ImageDownload) GetDownloadState() ImageDownload_ImageDownloadState

func (*ImageDownload) GetDownloadedBytes

func (x *ImageDownload) GetDownloadedBytes() uint32

func (*ImageDownload) GetFileSize

func (x *ImageDownload) GetFileSize() uint32

func (*ImageDownload) GetId

func (x *ImageDownload) GetId() string

func (*ImageDownload) GetImageState

func (*ImageDownload) GetImageVersion

func (x *ImageDownload) GetImageVersion() string

func (*ImageDownload) GetLocalDir

func (x *ImageDownload) GetLocalDir() string

func (*ImageDownload) GetName

func (x *ImageDownload) GetName() string

func (*ImageDownload) GetReason

func (*ImageDownload) GetSaveConfig

func (x *ImageDownload) GetSaveConfig() bool

func (*ImageDownload) GetUrl

func (x *ImageDownload) GetUrl() string

func (*ImageDownload) ProtoMessage

func (*ImageDownload) ProtoMessage()

func (*ImageDownload) ProtoReflect added in v5.7.1

func (x *ImageDownload) ProtoReflect() protoreflect.Message

func (*ImageDownload) Reset

func (x *ImageDownload) Reset()

func (*ImageDownload) String

func (x *ImageDownload) String() string

type ImageDownload_ImageActivateState

type ImageDownload_ImageActivateState int32
const (
	ImageDownload_IMAGE_UNKNOWN    ImageDownload_ImageActivateState = 0
	ImageDownload_IMAGE_INACTIVE   ImageDownload_ImageActivateState = 1
	ImageDownload_IMAGE_ACTIVATING ImageDownload_ImageActivateState = 2
	ImageDownload_IMAGE_ACTIVE     ImageDownload_ImageActivateState = 3
	ImageDownload_IMAGE_REVERTING  ImageDownload_ImageActivateState = 4
	ImageDownload_IMAGE_REVERTED   ImageDownload_ImageActivateState = 5
)

func (ImageDownload_ImageActivateState) Descriptor added in v5.7.1

func (ImageDownload_ImageActivateState) Enum added in v5.7.1

func (ImageDownload_ImageActivateState) EnumDescriptor deprecated

func (ImageDownload_ImageActivateState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageDownload_ImageActivateState.Descriptor instead.

func (ImageDownload_ImageActivateState) Number added in v5.7.1

func (ImageDownload_ImageActivateState) String

func (ImageDownload_ImageActivateState) Type added in v5.7.1

type ImageDownload_ImageDownloadFailureReason

type ImageDownload_ImageDownloadFailureReason int32
const (
	ImageDownload_NO_ERROR           ImageDownload_ImageDownloadFailureReason = 0
	ImageDownload_INVALID_URL        ImageDownload_ImageDownloadFailureReason = 1
	ImageDownload_DEVICE_BUSY        ImageDownload_ImageDownloadFailureReason = 2
	ImageDownload_INSUFFICIENT_SPACE ImageDownload_ImageDownloadFailureReason = 3
	ImageDownload_UNKNOWN_ERROR      ImageDownload_ImageDownloadFailureReason = 4
	ImageDownload_CANCELLED          ImageDownload_ImageDownloadFailureReason = 5
)

func (ImageDownload_ImageDownloadFailureReason) Descriptor added in v5.7.1

func (ImageDownload_ImageDownloadFailureReason) Enum added in v5.7.1

func (ImageDownload_ImageDownloadFailureReason) EnumDescriptor deprecated

func (ImageDownload_ImageDownloadFailureReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageDownload_ImageDownloadFailureReason.Descriptor instead.

func (ImageDownload_ImageDownloadFailureReason) Number added in v5.7.1

func (ImageDownload_ImageDownloadFailureReason) String

func (ImageDownload_ImageDownloadFailureReason) Type added in v5.7.1

type ImageDownload_ImageDownloadState

type ImageDownload_ImageDownloadState int32
const (
	ImageDownload_DOWNLOAD_UNKNOWN     ImageDownload_ImageDownloadState = 0
	ImageDownload_DOWNLOAD_SUCCEEDED   ImageDownload_ImageDownloadState = 1
	ImageDownload_DOWNLOAD_REQUESTED   ImageDownload_ImageDownloadState = 2
	ImageDownload_DOWNLOAD_STARTED     ImageDownload_ImageDownloadState = 3
	ImageDownload_DOWNLOAD_FAILED      ImageDownload_ImageDownloadState = 4
	ImageDownload_DOWNLOAD_UNSUPPORTED ImageDownload_ImageDownloadState = 5
	ImageDownload_DOWNLOAD_CANCELLED   ImageDownload_ImageDownloadState = 6
)

func (ImageDownload_ImageDownloadState) Descriptor added in v5.7.1

func (ImageDownload_ImageDownloadState) Enum added in v5.7.1

func (ImageDownload_ImageDownloadState) EnumDescriptor deprecated

func (ImageDownload_ImageDownloadState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageDownload_ImageDownloadState.Descriptor instead.

func (ImageDownload_ImageDownloadState) Number added in v5.7.1

func (ImageDownload_ImageDownloadState) String

func (ImageDownload_ImageDownloadState) Type added in v5.7.1

type ImageDownloads deprecated

type ImageDownloads struct {
	Items []*ImageDownload `protobuf:"bytes,2,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

Deprecated in voltha 2.8, will be removed

Deprecated: Marked as deprecated in voltha_protos/device.proto.

func (*ImageDownloads) Descriptor deprecated

func (*ImageDownloads) Descriptor() ([]byte, []int)

Deprecated: Use ImageDownloads.ProtoReflect.Descriptor instead.

func (*ImageDownloads) GetItems

func (x *ImageDownloads) GetItems() []*ImageDownload

func (*ImageDownloads) ProtoMessage

func (*ImageDownloads) ProtoMessage()

func (*ImageDownloads) ProtoReflect added in v5.7.1

func (x *ImageDownloads) ProtoReflect() protoreflect.Message

func (*ImageDownloads) Reset

func (x *ImageDownloads) Reset()

func (*ImageDownloads) String

func (x *ImageDownloads) String() string

type ImageState

type ImageState struct {

	// image version
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Download state
	DownloadState ImageState_ImageDownloadState `` /* 143-byte string literal not displayed */
	// Image Operation Failure reason (use for both Download and Activate)
	Reason ImageState_ImageFailureReason `protobuf:"varint,3,opt,name=reason,proto3,enum=device.ImageState_ImageFailureReason" json:"reason,omitempty"`
	// Image activation state
	ImageState ImageState_ImageActivationState `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ImageState) Descriptor deprecated

func (*ImageState) Descriptor() ([]byte, []int)

Deprecated: Use ImageState.ProtoReflect.Descriptor instead.

func (*ImageState) GetDownloadState

func (x *ImageState) GetDownloadState() ImageState_ImageDownloadState

func (*ImageState) GetImageState

func (x *ImageState) GetImageState() ImageState_ImageActivationState

func (*ImageState) GetReason

func (*ImageState) GetVersion

func (x *ImageState) GetVersion() string

func (*ImageState) ProtoMessage

func (*ImageState) ProtoMessage()

func (*ImageState) ProtoReflect added in v5.7.1

func (x *ImageState) ProtoReflect() protoreflect.Message

func (*ImageState) Reset

func (x *ImageState) Reset()

func (*ImageState) String

func (x *ImageState) String() string

type ImageState_ImageActivationState

type ImageState_ImageActivationState int32
const (
	ImageState_IMAGE_UNKNOWN             ImageState_ImageActivationState = 0
	ImageState_IMAGE_INACTIVE            ImageState_ImageActivationState = 1
	ImageState_IMAGE_ACTIVATING          ImageState_ImageActivationState = 2 // Happens during Reboot of the ONU after activate call.
	ImageState_IMAGE_ACTIVE              ImageState_ImageActivationState = 3
	ImageState_IMAGE_COMMITTING          ImageState_ImageActivationState = 4
	ImageState_IMAGE_COMMITTED           ImageState_ImageActivationState = 5
	ImageState_IMAGE_ACTIVATION_ABORTING ImageState_ImageActivationState = 6
	ImageState_IMAGE_ACTIVATION_ABORTED  ImageState_ImageActivationState = 7
	ImageState_IMAGE_COMMIT_ABORTING     ImageState_ImageActivationState = 8
	ImageState_IMAGE_COMMIT_ABORTED      ImageState_ImageActivationState = 9
	ImageState_IMAGE_DOWNLOADING         ImageState_ImageActivationState = 10
	ImageState_IMAGE_DOWNLOADING_ABORTED ImageState_ImageActivationState = 11
)

func (ImageState_ImageActivationState) Descriptor added in v5.7.1

func (ImageState_ImageActivationState) Enum added in v5.7.1

func (ImageState_ImageActivationState) EnumDescriptor deprecated

func (ImageState_ImageActivationState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageState_ImageActivationState.Descriptor instead.

func (ImageState_ImageActivationState) Number added in v5.7.1

func (ImageState_ImageActivationState) String

func (ImageState_ImageActivationState) Type added in v5.7.1

type ImageState_ImageDownloadState

type ImageState_ImageDownloadState int32
const (
	ImageState_DOWNLOAD_UNKNOWN     ImageState_ImageDownloadState = 0
	ImageState_DOWNLOAD_SUCCEEDED   ImageState_ImageDownloadState = 1
	ImageState_DOWNLOAD_REQUESTED   ImageState_ImageDownloadState = 2
	ImageState_DOWNLOAD_STARTED     ImageState_ImageDownloadState = 3
	ImageState_DOWNLOAD_FAILED      ImageState_ImageDownloadState = 4
	ImageState_DOWNLOAD_UNSUPPORTED ImageState_ImageDownloadState = 5
	ImageState_DOWNLOAD_CANCELLING  ImageState_ImageDownloadState = 6
	ImageState_DOWNLOAD_CANCELLED   ImageState_ImageDownloadState = 7
)

func (ImageState_ImageDownloadState) Descriptor added in v5.7.1

func (ImageState_ImageDownloadState) Enum added in v5.7.1

func (ImageState_ImageDownloadState) EnumDescriptor deprecated

func (ImageState_ImageDownloadState) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageState_ImageDownloadState.Descriptor instead.

func (ImageState_ImageDownloadState) Number added in v5.7.1

func (ImageState_ImageDownloadState) String

func (ImageState_ImageDownloadState) Type added in v5.7.1

type ImageState_ImageFailureReason

type ImageState_ImageFailureReason int32
const (
	ImageState_NO_ERROR               ImageState_ImageFailureReason = 0
	ImageState_INVALID_URL            ImageState_ImageFailureReason = 1
	ImageState_DEVICE_BUSY            ImageState_ImageFailureReason = 2
	ImageState_INSUFFICIENT_SPACE     ImageState_ImageFailureReason = 3 // VOLTHA ONU ADAPTER has no more space to store images
	ImageState_UNKNOWN_ERROR          ImageState_ImageFailureReason = 4 // Used also for Checksum failure on ONU
	ImageState_CANCELLED_ON_REQUEST   ImageState_ImageFailureReason = 5
	ImageState_CANCELLED_ON_ONU_STATE ImageState_ImageFailureReason = 6
	ImageState_VENDOR_DEVICE_MISMATCH ImageState_ImageFailureReason = 7
	ImageState_OMCI_TRANSFER_ERROR    ImageState_ImageFailureReason = 8
	ImageState_IMAGE_REFUSED_BY_ONU   ImageState_ImageFailureReason = 9
)

func (ImageState_ImageFailureReason) Descriptor added in v5.7.1

func (ImageState_ImageFailureReason) Enum added in v5.7.1

func (ImageState_ImageFailureReason) EnumDescriptor deprecated

func (ImageState_ImageFailureReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use ImageState_ImageFailureReason.Descriptor instead.

func (ImageState_ImageFailureReason) Number added in v5.7.1

func (ImageState_ImageFailureReason) String

func (ImageState_ImageFailureReason) Type added in v5.7.1

type Images

type Images struct {
	Image []*Image `protobuf:"bytes,1,rep,name=image,proto3" json:"image,omitempty"`
	// contains filtered or unexported fields
}

func (*Images) Descriptor deprecated

func (*Images) Descriptor() ([]byte, []int)

Deprecated: Use Images.ProtoReflect.Descriptor instead.

func (*Images) GetImage

func (x *Images) GetImage() []*Image

func (*Images) ProtoMessage

func (*Images) ProtoMessage()

func (*Images) ProtoReflect added in v5.7.1

func (x *Images) ProtoReflect() protoreflect.Message

func (*Images) Reset

func (x *Images) Reset()

func (*Images) String

func (x *Images) String() string

type Key

type Key = common.Key

type KpiEvent

type KpiEvent struct {
	Type     KpiEventType_Types           `protobuf:"varint,1,opt,name=type,proto3,enum=event.KpiEventType_Types" json:"type,omitempty"`
	Ts       float32                      `protobuf:"fixed32,2,opt,name=ts,proto3" json:"ts,omitempty"` // UTC time-stamp of data in slice mode (seconds since epoc)
	Prefixes map[string]*MetricValuePairs ``                                                            /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Legacy KPI Event structured. In mid-August, the KPI event format was updated

to a more easily parsable format. See VOL-1140
for more information.

func (*KpiEvent) Descriptor deprecated

func (*KpiEvent) Descriptor() ([]byte, []int)

Deprecated: Use KpiEvent.ProtoReflect.Descriptor instead.

func (*KpiEvent) GetPrefixes

func (x *KpiEvent) GetPrefixes() map[string]*MetricValuePairs

func (*KpiEvent) GetTs

func (x *KpiEvent) GetTs() float32

func (*KpiEvent) GetType

func (x *KpiEvent) GetType() KpiEventType_Types

func (*KpiEvent) ProtoMessage

func (*KpiEvent) ProtoMessage()

func (*KpiEvent) ProtoReflect added in v5.7.1

func (x *KpiEvent) ProtoReflect() protoreflect.Message

func (*KpiEvent) Reset

func (x *KpiEvent) Reset()

func (*KpiEvent) String

func (x *KpiEvent) String() string

type KpiEvent2

type KpiEvent2 struct {

	// Type of KPI Event
	Type KpiEventType_Types `protobuf:"varint,1,opt,name=type,proto3,enum=event.KpiEventType_Types" json:"type,omitempty"`
	// Fields used when for slice:
	Ts        float64              `protobuf:"fixed64,2,opt,name=ts,proto3" json:"ts,omitempty"` // UTC time-stamp of data in slice mode (seconds since epoch)
	SliceData []*MetricInformation `protobuf:"bytes,3,rep,name=slice_data,json=sliceData,proto3" json:"slice_data,omitempty"`
	// contains filtered or unexported fields
}

func (*KpiEvent2) Descriptor deprecated

func (*KpiEvent2) Descriptor() ([]byte, []int)

Deprecated: Use KpiEvent2.ProtoReflect.Descriptor instead.

func (*KpiEvent2) GetSliceData

func (x *KpiEvent2) GetSliceData() []*MetricInformation

func (*KpiEvent2) GetTs

func (x *KpiEvent2) GetTs() float64

func (*KpiEvent2) GetType

func (x *KpiEvent2) GetType() KpiEventType_Types

func (*KpiEvent2) ProtoMessage

func (*KpiEvent2) ProtoMessage()

func (*KpiEvent2) ProtoReflect added in v5.7.1

func (x *KpiEvent2) ProtoReflect() protoreflect.Message

func (*KpiEvent2) Reset

func (x *KpiEvent2) Reset()

func (*KpiEvent2) String

func (x *KpiEvent2) String() string

type KpiEvent3 added in v5.6.8

type KpiEvent3 struct {

	// Type of KPI Event
	Type KpiEventType_Types `protobuf:"varint,1,opt,name=type,proto3,enum=event.KpiEventType_Types" json:"type,omitempty"`
	// Fields used when for slice:
	Ts        float64                `protobuf:"fixed64,2,opt,name=ts,proto3" json:"ts,omitempty"` // UTC time-stamp of data in slice mode (seconds since epoch)
	SliceData []*MetricInformation64 `protobuf:"bytes,3,rep,name=slice_data,json=sliceData,proto3" json:"slice_data,omitempty"`
	// contains filtered or unexported fields
}

KpiEvent3 with support for 64-bit unsigned integer counters. Use this for metrics that require full 64-bit precision (e.g., FEC counters, GEM counters).

func (*KpiEvent3) Descriptor deprecated added in v5.6.8

func (*KpiEvent3) Descriptor() ([]byte, []int)

Deprecated: Use KpiEvent3.ProtoReflect.Descriptor instead.

func (*KpiEvent3) GetSliceData added in v5.6.8

func (x *KpiEvent3) GetSliceData() []*MetricInformation64

func (*KpiEvent3) GetTs added in v5.6.8

func (x *KpiEvent3) GetTs() float64

func (*KpiEvent3) GetType added in v5.6.8

func (x *KpiEvent3) GetType() KpiEventType_Types

func (*KpiEvent3) ProtoMessage added in v5.6.8

func (*KpiEvent3) ProtoMessage()

func (*KpiEvent3) ProtoReflect added in v5.7.1

func (x *KpiEvent3) ProtoReflect() protoreflect.Message

func (*KpiEvent3) Reset added in v5.6.8

func (x *KpiEvent3) Reset()

func (*KpiEvent3) String added in v5.6.8

func (x *KpiEvent3) String() string

type KpiEventType

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

func (*KpiEventType) Descriptor deprecated

func (*KpiEventType) Descriptor() ([]byte, []int)

Deprecated: Use KpiEventType.ProtoReflect.Descriptor instead.

func (*KpiEventType) ProtoMessage

func (*KpiEventType) ProtoMessage()

func (*KpiEventType) ProtoReflect added in v5.7.1

func (x *KpiEventType) ProtoReflect() protoreflect.Message

func (*KpiEventType) Reset

func (x *KpiEventType) Reset()

func (*KpiEventType) String

func (x *KpiEventType) String() string

type KpiEventType_Types

type KpiEventType_Types int32
const (
	KpiEventType_slice KpiEventType_Types = 0 // slice: a set of path/metric data for same time-stamp
	KpiEventType_ts    KpiEventType_Types = 1 // time-series: array of data for same metric
)

func (KpiEventType_Types) Descriptor added in v5.7.1

func (KpiEventType_Types) Enum added in v5.7.1

func (KpiEventType_Types) EnumDescriptor deprecated

func (KpiEventType_Types) EnumDescriptor() ([]byte, []int)

Deprecated: Use KpiEventType_Types.Descriptor instead.

func (KpiEventType_Types) Number added in v5.7.1

func (KpiEventType_Types) String

func (x KpiEventType_Types) String() string

func (KpiEventType_Types) Type added in v5.7.1

type LogicalDevice

type LogicalDevice struct {

	// unique id of logical device
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// unique datapath id for the logical device (used by the SDN controller)
	DatapathId uint64 `protobuf:"varint,2,opt,name=datapath_id,json=datapathId,proto3" json:"datapath_id,omitempty"`
	// device description
	Desc *openflow_13.OfpDesc `protobuf:"bytes,3,opt,name=desc,proto3" json:"desc,omitempty"`
	// device features
	SwitchFeatures *openflow_13.OfpSwitchFeatures `protobuf:"bytes,4,opt,name=switch_features,json=switchFeatures,proto3" json:"switch_features,omitempty"`
	// name of the root device anchoring logical device
	RootDeviceId string `protobuf:"bytes,5,opt,name=root_device_id,json=rootDeviceId,proto3" json:"root_device_id,omitempty"`
	// contains filtered or unexported fields
}

func (*LogicalDevice) Descriptor deprecated

func (*LogicalDevice) Descriptor() ([]byte, []int)

Deprecated: Use LogicalDevice.ProtoReflect.Descriptor instead.

func (*LogicalDevice) GetDatapathId

func (x *LogicalDevice) GetDatapathId() uint64

func (*LogicalDevice) GetDesc

func (x *LogicalDevice) GetDesc() *openflow_13.OfpDesc

func (*LogicalDevice) GetId

func (x *LogicalDevice) GetId() string

func (*LogicalDevice) GetRootDeviceId

func (x *LogicalDevice) GetRootDeviceId() string

func (*LogicalDevice) GetSwitchFeatures

func (x *LogicalDevice) GetSwitchFeatures() *openflow_13.OfpSwitchFeatures

func (*LogicalDevice) ProtoMessage

func (*LogicalDevice) ProtoMessage()

func (*LogicalDevice) ProtoReflect added in v5.7.1

func (x *LogicalDevice) ProtoReflect() protoreflect.Message

func (*LogicalDevice) Reset

func (x *LogicalDevice) Reset()

func (*LogicalDevice) String

func (x *LogicalDevice) String() string

type LogicalDevices

type LogicalDevices struct {
	Items []*LogicalDevice `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*LogicalDevices) Descriptor deprecated

func (*LogicalDevices) Descriptor() ([]byte, []int)

Deprecated: Use LogicalDevices.ProtoReflect.Descriptor instead.

func (*LogicalDevices) GetItems

func (x *LogicalDevices) GetItems() []*LogicalDevice

func (*LogicalDevices) ProtoMessage

func (*LogicalDevices) ProtoMessage()

func (*LogicalDevices) ProtoReflect added in v5.7.1

func (x *LogicalDevices) ProtoReflect() protoreflect.Message

func (*LogicalDevices) Reset

func (x *LogicalDevices) Reset()

func (*LogicalDevices) String

func (x *LogicalDevices) String() string

type LogicalPort

type LogicalPort struct {
	Id           string                    `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	OfpPort      *openflow_13.OfpPort      `protobuf:"bytes,2,opt,name=ofp_port,json=ofpPort,proto3" json:"ofp_port,omitempty"`
	DeviceId     string                    `protobuf:"bytes,3,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	DevicePortNo uint32                    `protobuf:"varint,4,opt,name=device_port_no,json=devicePortNo,proto3" json:"device_port_no,omitempty"`
	RootPort     bool                      `protobuf:"varint,5,opt,name=root_port,json=rootPort,proto3" json:"root_port,omitempty"`
	OfpPortStats *openflow_13.OfpPortStats `protobuf:"bytes,6,opt,name=ofp_port_stats,json=ofpPortStats,proto3" json:"ofp_port_stats,omitempty"`
	// contains filtered or unexported fields
}

func (*LogicalPort) Descriptor deprecated

func (*LogicalPort) Descriptor() ([]byte, []int)

Deprecated: Use LogicalPort.ProtoReflect.Descriptor instead.

func (*LogicalPort) GetDeviceId

func (x *LogicalPort) GetDeviceId() string

func (*LogicalPort) GetDevicePortNo

func (x *LogicalPort) GetDevicePortNo() uint32

func (*LogicalPort) GetId

func (x *LogicalPort) GetId() string

func (*LogicalPort) GetOfpPort

func (x *LogicalPort) GetOfpPort() *openflow_13.OfpPort

func (*LogicalPort) GetOfpPortStats

func (x *LogicalPort) GetOfpPortStats() *openflow_13.OfpPortStats

func (*LogicalPort) GetRootPort

func (x *LogicalPort) GetRootPort() bool

func (*LogicalPort) ProtoMessage

func (*LogicalPort) ProtoMessage()

func (*LogicalPort) ProtoReflect added in v5.7.1

func (x *LogicalPort) ProtoReflect() protoreflect.Message

func (*LogicalPort) Reset

func (x *LogicalPort) Reset()

func (*LogicalPort) String

func (x *LogicalPort) String() string

type LogicalPortId

type LogicalPortId struct {

	// unique id of logical device
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// id of the port on the logical device
	PortId string `protobuf:"bytes,2,opt,name=port_id,json=portId,proto3" json:"port_id,omitempty"`
	// contains filtered or unexported fields
}

func (*LogicalPortId) Descriptor deprecated

func (*LogicalPortId) Descriptor() ([]byte, []int)

Deprecated: Use LogicalPortId.ProtoReflect.Descriptor instead.

func (*LogicalPortId) GetId

func (x *LogicalPortId) GetId() string

func (*LogicalPortId) GetPortId

func (x *LogicalPortId) GetPortId() string

func (*LogicalPortId) ProtoMessage

func (*LogicalPortId) ProtoMessage()

func (*LogicalPortId) ProtoReflect added in v5.7.1

func (x *LogicalPortId) ProtoReflect() protoreflect.Message

func (*LogicalPortId) Reset

func (x *LogicalPortId) Reset()

func (*LogicalPortId) String

func (x *LogicalPortId) String() string

type LogicalPorts

type LogicalPorts struct {
	Items []*LogicalPort `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*LogicalPorts) Descriptor deprecated

func (*LogicalPorts) Descriptor() ([]byte, []int)

Deprecated: Use LogicalPorts.ProtoReflect.Descriptor instead.

func (*LogicalPorts) GetItems

func (x *LogicalPorts) GetItems() []*LogicalPort

func (*LogicalPorts) ProtoMessage

func (*LogicalPorts) ProtoMessage()

func (*LogicalPorts) ProtoReflect added in v5.7.1

func (x *LogicalPorts) ProtoReflect() protoreflect.Message

func (*LogicalPorts) Reset

func (x *LogicalPorts) Reset()

func (*LogicalPorts) String

func (x *LogicalPorts) String() string

type MetricInformation

type MetricInformation struct {
	Metadata *MetricMetaData    `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	Metrics  map[string]float32 `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Struct to group metadata for a metric (or group of metrics) with the key-value pairs of collected metrics

func (*MetricInformation) Descriptor deprecated

func (*MetricInformation) Descriptor() ([]byte, []int)

Deprecated: Use MetricInformation.ProtoReflect.Descriptor instead.

func (*MetricInformation) GetMetadata

func (x *MetricInformation) GetMetadata() *MetricMetaData

func (*MetricInformation) GetMetrics

func (x *MetricInformation) GetMetrics() map[string]float32

func (*MetricInformation) ProtoMessage

func (*MetricInformation) ProtoMessage()

func (*MetricInformation) ProtoReflect added in v5.7.1

func (x *MetricInformation) ProtoReflect() protoreflect.Message

func (*MetricInformation) Reset

func (x *MetricInformation) Reset()

func (*MetricInformation) String

func (x *MetricInformation) String() string

type MetricInformation64 added in v5.6.8

type MetricInformation64 struct {
	Metadata *MetricMetaData    `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	Metrics  map[string]float64 `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Struct to group metadata for a metric (or group of metrics) with the key-value pairs of collected metrics using 64-bit double precision floating point. This supports both floating-point metrics and large integer counters up to 2^53 (e.g., FEC counters, GEM counters, optical power levels).

func (*MetricInformation64) Descriptor deprecated added in v5.6.8

func (*MetricInformation64) Descriptor() ([]byte, []int)

Deprecated: Use MetricInformation64.ProtoReflect.Descriptor instead.

func (*MetricInformation64) GetMetadata added in v5.6.8

func (x *MetricInformation64) GetMetadata() *MetricMetaData

func (*MetricInformation64) GetMetrics added in v5.6.8

func (x *MetricInformation64) GetMetrics() map[string]float64

func (*MetricInformation64) ProtoMessage added in v5.6.8

func (*MetricInformation64) ProtoMessage()

func (*MetricInformation64) ProtoReflect added in v5.7.1

func (x *MetricInformation64) ProtoReflect() protoreflect.Message

func (*MetricInformation64) Reset added in v5.6.8

func (x *MetricInformation64) Reset()

func (*MetricInformation64) String added in v5.6.8

func (x *MetricInformation64) String() string

type MetricMetaData

type MetricMetaData struct {
	Title           string  `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"`                                              // Metric group or individual metric name
	Ts              float64 `protobuf:"fixed64,2,opt,name=ts,proto3" json:"ts,omitempty"`                                                  // UTC time-stamp of data (seconds since epoch) of
	LogicalDeviceId string  `protobuf:"bytes,3,opt,name=logical_device_id,json=logicalDeviceId,proto3" json:"logical_device_id,omitempty"` // The logical device ID of the VOLTHA
	// (equivalent to the DPID that ONOS has
	// for the VOLTHA device without the
	//
	//	'of:' prefix
	SerialNo string            `protobuf:"bytes,4,opt,name=serial_no,json=serialNo,proto3" json:"serial_no,omitempty"` // The OLT, ONU, ... device serial number
	DeviceId string            `protobuf:"bytes,5,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"` // The OLT, ONU, ... physical device ID
	Context  map[string]string ``                                                                                      // Name value pairs that provide additional
	/* 141-byte string literal not displayed */
	Uuid string `protobuf:"bytes,7,opt,name=uuid,proto3" json:"uuid,omitempty"` // Transaction identifier used to match On
	// contains filtered or unexported fields
}

Struct to convey a dictionary of metric metadata.

func (*MetricMetaData) Descriptor deprecated

func (*MetricMetaData) Descriptor() ([]byte, []int)

Deprecated: Use MetricMetaData.ProtoReflect.Descriptor instead.

func (*MetricMetaData) GetContext

func (x *MetricMetaData) GetContext() map[string]string

func (*MetricMetaData) GetDeviceId

func (x *MetricMetaData) GetDeviceId() string

func (*MetricMetaData) GetLogicalDeviceId

func (x *MetricMetaData) GetLogicalDeviceId() string

func (*MetricMetaData) GetSerialNo

func (x *MetricMetaData) GetSerialNo() string

func (*MetricMetaData) GetTitle

func (x *MetricMetaData) GetTitle() string

func (*MetricMetaData) GetTs

func (x *MetricMetaData) GetTs() float64

func (*MetricMetaData) GetUuid

func (x *MetricMetaData) GetUuid() string

func (*MetricMetaData) ProtoMessage

func (*MetricMetaData) ProtoMessage()

func (*MetricMetaData) ProtoReflect added in v5.7.1

func (x *MetricMetaData) ProtoReflect() protoreflect.Message

func (*MetricMetaData) Reset

func (x *MetricMetaData) Reset()

func (*MetricMetaData) String

func (x *MetricMetaData) String() string

type MetricValuePairs

type MetricValuePairs struct {

	// Metric / value pairs.
	Metrics map[string]float32 `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

Struct to convey a dictionary of metric->value pairs. Typically used in pure shared-timestamp or shared-timestamp + shared object prefix situations.

func (*MetricValuePairs) Descriptor deprecated

func (*MetricValuePairs) Descriptor() ([]byte, []int)

Deprecated: Use MetricValuePairs.ProtoReflect.Descriptor instead.

func (*MetricValuePairs) GetMetrics

func (x *MetricValuePairs) GetMetrics() map[string]float32

func (*MetricValuePairs) ProtoMessage

func (*MetricValuePairs) ProtoMessage()

func (*MetricValuePairs) ProtoReflect added in v5.7.1

func (x *MetricValuePairs) ProtoReflect() protoreflect.Message

func (*MetricValuePairs) Reset

func (x *MetricValuePairs) Reset()

func (*MetricValuePairs) String

func (x *MetricValuePairs) String() string

type OnuImage

type OnuImage struct {

	// image version
	Version     string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	IsCommited  bool   `protobuf:"varint,2,opt,name=isCommited,proto3" json:"isCommited,omitempty"`
	IsActive    bool   `protobuf:"varint,3,opt,name=isActive,proto3" json:"isActive,omitempty"`
	IsValid     bool   `protobuf:"varint,4,opt,name=isValid,proto3" json:"isValid,omitempty"`
	ProductCode string `protobuf:"bytes,5,opt,name=productCode,proto3" json:"productCode,omitempty"`
	// Hash is computed by the ONU and is optional as per OMCI spec (paragraph 9.1.4)
	// No assumption should be made on the existence of this attribute at any time.
	Hash string `protobuf:"bytes,6,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

OnuImage represents the OMCI information as per OMCI spec the information will be populates exactly as extracted from the device.

func (*OnuImage) Descriptor deprecated

func (*OnuImage) Descriptor() ([]byte, []int)

Deprecated: Use OnuImage.ProtoReflect.Descriptor instead.

func (*OnuImage) GetHash

func (x *OnuImage) GetHash() string

func (*OnuImage) GetIsActive

func (x *OnuImage) GetIsActive() bool

func (*OnuImage) GetIsCommited

func (x *OnuImage) GetIsCommited() bool

func (*OnuImage) GetIsValid

func (x *OnuImage) GetIsValid() bool

func (*OnuImage) GetProductCode

func (x *OnuImage) GetProductCode() string

func (*OnuImage) GetVersion

func (x *OnuImage) GetVersion() string

func (*OnuImage) ProtoMessage

func (*OnuImage) ProtoMessage()

func (*OnuImage) ProtoReflect added in v5.7.1

func (x *OnuImage) ProtoReflect() protoreflect.Message

func (*OnuImage) Reset

func (x *OnuImage) Reset()

func (*OnuImage) String

func (x *OnuImage) String() string

type OnuImages

type OnuImages struct {
	Items []*OnuImage `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*OnuImages) Descriptor deprecated

func (*OnuImages) Descriptor() ([]byte, []int)

Deprecated: Use OnuImages.ProtoReflect.Descriptor instead.

func (*OnuImages) GetItems

func (x *OnuImages) GetItems() []*OnuImage

func (*OnuImages) ProtoMessage

func (*OnuImages) ProtoMessage()

func (*OnuImages) ProtoReflect added in v5.7.1

func (x *OnuImages) ProtoReflect() protoreflect.Message

func (*OnuImages) Reset

func (x *OnuImages) Reset()

func (*OnuImages) String

func (x *OnuImages) String() string

type OnuSerialNumberOnOLTPon added in v5.6.6

type OnuSerialNumberOnOLTPon struct {
	OltDeviceId  *common.ID `protobuf:"bytes,1,opt,name=olt_device_id,json=oltDeviceId,proto3" json:"olt_device_id,omitempty"`
	Port         *Port      `protobuf:"bytes,2,opt,name=port,proto3" json:"port,omitempty"`
	SerialNumber string     `protobuf:"bytes,3,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
	// contains filtered or unexported fields
}

Represents a serialNumber of a child device on a olt pon port

func (*OnuSerialNumberOnOLTPon) Descriptor deprecated added in v5.6.6

func (*OnuSerialNumberOnOLTPon) Descriptor() ([]byte, []int)

Deprecated: Use OnuSerialNumberOnOLTPon.ProtoReflect.Descriptor instead.

func (*OnuSerialNumberOnOLTPon) GetOltDeviceId added in v5.6.6

func (x *OnuSerialNumberOnOLTPon) GetOltDeviceId() *common.ID

func (*OnuSerialNumberOnOLTPon) GetPort added in v5.6.6

func (x *OnuSerialNumberOnOLTPon) GetPort() *Port

func (*OnuSerialNumberOnOLTPon) GetSerialNumber added in v5.6.6

func (x *OnuSerialNumberOnOLTPon) GetSerialNumber() string

func (*OnuSerialNumberOnOLTPon) ProtoMessage added in v5.6.6

func (*OnuSerialNumberOnOLTPon) ProtoMessage()

func (*OnuSerialNumberOnOLTPon) ProtoReflect added in v5.7.1

func (x *OnuSerialNumberOnOLTPon) ProtoReflect() protoreflect.Message

func (*OnuSerialNumberOnOLTPon) Reset added in v5.6.6

func (x *OnuSerialNumberOnOLTPon) Reset()

func (*OnuSerialNumberOnOLTPon) String added in v5.6.6

func (x *OnuSerialNumberOnOLTPon) String() string

type OperStatus

type OperStatus = common.OperStatus

type OperStatus_Types

type OperStatus_Types = common.OperStatus_Types

type OperationResp

type OperationResp = common.OperationResp

type OperationResp_OperationReturnCode

type OperationResp_OperationReturnCode = common.OperationResp_OperationReturnCode

type PmConfig

type PmConfig struct {
	Name       string          `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type       PmConfig_PmType `protobuf:"varint,2,opt,name=type,proto3,enum=device.PmConfig_PmType" json:"type,omitempty"`
	Enabled    bool            `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`                         // Whether or not this metric makes it to Kafka
	SampleFreq uint32          `protobuf:"varint,4,opt,name=sample_freq,json=sampleFreq,proto3" json:"sample_freq,omitempty"` // Sample rate in 10ths of a second
	// contains filtered or unexported fields
}

func (*PmConfig) Descriptor deprecated

func (*PmConfig) Descriptor() ([]byte, []int)

Deprecated: Use PmConfig.ProtoReflect.Descriptor instead.

func (*PmConfig) GetEnabled

func (x *PmConfig) GetEnabled() bool

func (*PmConfig) GetName

func (x *PmConfig) GetName() string

func (*PmConfig) GetSampleFreq

func (x *PmConfig) GetSampleFreq() uint32

func (*PmConfig) GetType

func (x *PmConfig) GetType() PmConfig_PmType

func (*PmConfig) ProtoMessage

func (*PmConfig) ProtoMessage()

func (*PmConfig) ProtoReflect added in v5.7.1

func (x *PmConfig) ProtoReflect() protoreflect.Message

func (*PmConfig) Reset

func (x *PmConfig) Reset()

func (*PmConfig) String

func (x *PmConfig) String() string

type PmConfig_PmType

type PmConfig_PmType int32
const (
	PmConfig_COUNTER PmConfig_PmType = 0
	PmConfig_GAUGE   PmConfig_PmType = 1
	PmConfig_STATE   PmConfig_PmType = 2
	PmConfig_CONTEXT PmConfig_PmType = 3
)

func (PmConfig_PmType) Descriptor added in v5.7.1

func (PmConfig_PmType) Enum added in v5.7.1

func (x PmConfig_PmType) Enum() *PmConfig_PmType

func (PmConfig_PmType) EnumDescriptor deprecated

func (PmConfig_PmType) EnumDescriptor() ([]byte, []int)

Deprecated: Use PmConfig_PmType.Descriptor instead.

func (PmConfig_PmType) Number added in v5.7.1

func (PmConfig_PmType) String

func (x PmConfig_PmType) String() string

func (PmConfig_PmType) Type added in v5.7.1

type PmConfigs

type PmConfigs struct {
	Id          string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                       // To work around a chameleon POST bug
	DefaultFreq uint32 `protobuf:"varint,2,opt,name=default_freq,json=defaultFreq,proto3" json:"default_freq,omitempty"` // Default sample rate
	// Forces group names and group semantics
	Grouped bool `protobuf:"varint,3,opt,name=grouped,proto3" json:"grouped,omitempty"`
	// Allows Pm to set an individual sample frequency
	FreqOverride bool             `protobuf:"varint,4,opt,name=freq_override,json=freqOverride,proto3" json:"freq_override,omitempty"`
	Groups       []*PmGroupConfig `protobuf:"bytes,5,rep,name=groups,proto3" json:"groups,omitempty"`                   // The groups if grouped is true
	Metrics      []*PmConfig      `protobuf:"bytes,6,rep,name=metrics,proto3" json:"metrics,omitempty"`                 // The metrics themselves if grouped is false.
	MaxSkew      uint32           `protobuf:"varint,7,opt,name=max_skew,json=maxSkew,proto3" json:"max_skew,omitempty"` //Default value is set to 5 seconds
	// contains filtered or unexported fields
}

func (*PmConfigs) Descriptor deprecated

func (*PmConfigs) Descriptor() ([]byte, []int)

Deprecated: Use PmConfigs.ProtoReflect.Descriptor instead.

func (*PmConfigs) GetDefaultFreq

func (x *PmConfigs) GetDefaultFreq() uint32

func (*PmConfigs) GetFreqOverride

func (x *PmConfigs) GetFreqOverride() bool

func (*PmConfigs) GetGrouped

func (x *PmConfigs) GetGrouped() bool

func (*PmConfigs) GetGroups

func (x *PmConfigs) GetGroups() []*PmGroupConfig

func (*PmConfigs) GetId

func (x *PmConfigs) GetId() string

func (*PmConfigs) GetMaxSkew

func (x *PmConfigs) GetMaxSkew() uint32

func (*PmConfigs) GetMetrics

func (x *PmConfigs) GetMetrics() []*PmConfig

func (*PmConfigs) ProtoMessage

func (*PmConfigs) ProtoMessage()

func (*PmConfigs) ProtoReflect added in v5.7.1

func (x *PmConfigs) ProtoReflect() protoreflect.Message

func (*PmConfigs) Reset

func (x *PmConfigs) Reset()

func (*PmConfigs) String

func (x *PmConfigs) String() string

type PmGroupConfig

type PmGroupConfig struct {
	GroupName string      `protobuf:"bytes,1,opt,name=group_name,json=groupName,proto3" json:"group_name,omitempty"`
	GroupFreq uint32      `protobuf:"varint,2,opt,name=group_freq,json=groupFreq,proto3" json:"group_freq,omitempty"` // Frequency applicable to the grop
	Enabled   bool        `protobuf:"varint,3,opt,name=enabled,proto3" json:"enabled,omitempty"`                      // Enable/disable group level only
	Metrics   []*PmConfig `protobuf:"bytes,4,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*PmGroupConfig) Descriptor deprecated

func (*PmGroupConfig) Descriptor() ([]byte, []int)

Deprecated: Use PmGroupConfig.ProtoReflect.Descriptor instead.

func (*PmGroupConfig) GetEnabled

func (x *PmGroupConfig) GetEnabled() bool

func (*PmGroupConfig) GetGroupFreq

func (x *PmGroupConfig) GetGroupFreq() uint32

func (*PmGroupConfig) GetGroupName

func (x *PmGroupConfig) GetGroupName() string

func (*PmGroupConfig) GetMetrics

func (x *PmGroupConfig) GetMetrics() []*PmConfig

func (*PmGroupConfig) ProtoMessage

func (*PmGroupConfig) ProtoMessage()

func (*PmGroupConfig) ProtoReflect added in v5.7.1

func (x *PmGroupConfig) ProtoReflect() protoreflect.Message

func (*PmGroupConfig) Reset

func (x *PmGroupConfig) Reset()

func (*PmGroupConfig) String

func (x *PmGroupConfig) String() string

type Port

type Port struct {
	PortNo     uint32                  `protobuf:"varint,1,opt,name=port_no,json=portNo,proto3" json:"port_no,omitempty"`         // Device-unique port number
	Label      string                  `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`                          // Arbitrary port label
	Type       Port_PortType           `protobuf:"varint,3,opt,name=type,proto3,enum=device.Port_PortType" json:"type,omitempty"` //  Type of port
	AdminState common.AdminState_Types `protobuf:"varint,5,opt,name=admin_state,json=adminState,proto3,enum=common.AdminState_Types" json:"admin_state,omitempty"`
	OperStatus common.OperStatus_Types `protobuf:"varint,6,opt,name=oper_status,json=operStatus,proto3,enum=common.OperStatus_Types" json:"oper_status,omitempty"`
	DeviceId   string                  `protobuf:"bytes,7,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"` // Unique .id of device that owns this port
	Peers      []*Port_PeerPort        `protobuf:"bytes,8,rep,name=peers,proto3" json:"peers,omitempty"`
	RxPackets  uint64                  `protobuf:"fixed64,9,opt,name=rx_packets,json=rxPackets,proto3" json:"rx_packets,omitempty"`
	RxBytes    uint64                  `protobuf:"fixed64,10,opt,name=rx_bytes,json=rxBytes,proto3" json:"rx_bytes,omitempty"`
	RxErrors   uint64                  `protobuf:"fixed64,11,opt,name=rx_errors,json=rxErrors,proto3" json:"rx_errors,omitempty"`
	TxPackets  uint64                  `protobuf:"fixed64,12,opt,name=tx_packets,json=txPackets,proto3" json:"tx_packets,omitempty"`
	TxBytes    uint64                  `protobuf:"fixed64,13,opt,name=tx_bytes,json=txBytes,proto3" json:"tx_bytes,omitempty"`
	TxErrors   uint64                  `protobuf:"fixed64,14,opt,name=tx_errors,json=txErrors,proto3" json:"tx_errors,omitempty"`
	// ofp_port represents the characteristics of a port, e.g. hardware
	// address and supported features.  This field is relevant only for
	// UNI and NNI ports.   For PON ports, it can be left empty.
	OfpPort *openflow_13.OfpPort `protobuf:"bytes,15,opt,name=ofp_port,json=ofpPort,proto3" json:"ofp_port,omitempty"`
	// contains filtered or unexported fields
}

func (*Port) Descriptor deprecated

func (*Port) Descriptor() ([]byte, []int)

Deprecated: Use Port.ProtoReflect.Descriptor instead.

func (*Port) GetAdminState

func (x *Port) GetAdminState() common.AdminState_Types

func (*Port) GetDeviceId

func (x *Port) GetDeviceId() string

func (*Port) GetLabel

func (x *Port) GetLabel() string

func (*Port) GetOfpPort

func (x *Port) GetOfpPort() *openflow_13.OfpPort

func (*Port) GetOperStatus

func (x *Port) GetOperStatus() common.OperStatus_Types

func (*Port) GetPeers

func (x *Port) GetPeers() []*Port_PeerPort

func (*Port) GetPortNo

func (x *Port) GetPortNo() uint32

func (*Port) GetRxBytes

func (x *Port) GetRxBytes() uint64

func (*Port) GetRxErrors

func (x *Port) GetRxErrors() uint64

func (*Port) GetRxPackets

func (x *Port) GetRxPackets() uint64

func (*Port) GetTxBytes

func (x *Port) GetTxBytes() uint64

func (*Port) GetTxErrors

func (x *Port) GetTxErrors() uint64

func (*Port) GetTxPackets

func (x *Port) GetTxPackets() uint64

func (*Port) GetType

func (x *Port) GetType() Port_PortType

func (*Port) ProtoMessage

func (*Port) ProtoMessage()

func (*Port) ProtoReflect added in v5.7.1

func (x *Port) ProtoReflect() protoreflect.Message

func (*Port) Reset

func (x *Port) Reset()

func (*Port) String

func (x *Port) String() string

type PortStatistics added in v5.6.5

type PortStatistics = common.PortStatistics

type Port_PeerPort

type Port_PeerPort struct {
	DeviceId string `protobuf:"bytes,1,opt,name=device_id,json=deviceId,proto3" json:"device_id,omitempty"`
	PortNo   uint32 `protobuf:"varint,2,opt,name=port_no,json=portNo,proto3" json:"port_no,omitempty"`
	// contains filtered or unexported fields
}

func (*Port_PeerPort) Descriptor deprecated

func (*Port_PeerPort) Descriptor() ([]byte, []int)

Deprecated: Use Port_PeerPort.ProtoReflect.Descriptor instead.

func (*Port_PeerPort) GetDeviceId

func (x *Port_PeerPort) GetDeviceId() string

func (*Port_PeerPort) GetPortNo

func (x *Port_PeerPort) GetPortNo() uint32

func (*Port_PeerPort) ProtoMessage

func (*Port_PeerPort) ProtoMessage()

func (*Port_PeerPort) ProtoReflect added in v5.7.1

func (x *Port_PeerPort) ProtoReflect() protoreflect.Message

func (*Port_PeerPort) Reset

func (x *Port_PeerPort) Reset()

func (*Port_PeerPort) String

func (x *Port_PeerPort) String() string

type Port_PortType

type Port_PortType int32
const (
	Port_UNKNOWN      Port_PortType = 0
	Port_ETHERNET_NNI Port_PortType = 1
	Port_ETHERNET_UNI Port_PortType = 2
	Port_PON_OLT      Port_PortType = 3
	Port_PON_ONU      Port_PortType = 4
	Port_VENET_OLT    Port_PortType = 5
	Port_VENET_ONU    Port_PortType = 6
)

func (Port_PortType) Descriptor added in v5.7.1

func (Port_PortType) Enum added in v5.7.1

func (x Port_PortType) Enum() *Port_PortType

func (Port_PortType) EnumDescriptor deprecated

func (Port_PortType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Port_PortType.Descriptor instead.

func (Port_PortType) Number added in v5.7.1

func (Port_PortType) String

func (x Port_PortType) String() string

func (Port_PortType) Type added in v5.7.1

type Ports

type Ports struct {
	Items []*Port `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*Ports) Descriptor deprecated

func (*Ports) Descriptor() ([]byte, []int)

Deprecated: Use Ports.ProtoReflect.Descriptor instead.

func (*Ports) GetItems

func (x *Ports) GetItems() []*Port

func (*Ports) ProtoMessage

func (*Ports) ProtoMessage()

func (*Ports) ProtoReflect added in v5.7.1

func (x *Ports) ProtoReflect() protoreflect.Message

func (*Ports) Reset

func (x *Ports) Reset()

func (*Ports) String

func (x *Ports) String() string

type RPCEvent

type RPCEvent struct {

	// RPC name
	Rpc string `protobuf:"bytes,1,opt,name=rpc,proto3" json:"rpc,omitempty"`
	// The operation id of that request.  Can be a log correlation ID
	OperationId string `protobuf:"bytes,2,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
	// Identifies the service name originating the event
	Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
	// Identifies the stack originating the event
	StackId string `protobuf:"bytes,4,opt,name=stack_id,json=stackId,proto3" json:"stack_id,omitempty"`
	// Identifies the resource upon which the action is taken, e.g. device_id
	ResourceId string `protobuf:"bytes,5,opt,name=resource_id,json=resourceId,proto3" json:"resource_id,omitempty"`
	// Textual explanation of the event
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// Key/Value storage for extra information that may give context to the event
	Context map[string]string `` /* 141-byte string literal not displayed */
	// Status of the RPC Event
	Status *common.OperationResp `protobuf:"bytes,8,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Describes the events specific to an RPC request

func (*RPCEvent) Descriptor deprecated

func (*RPCEvent) Descriptor() ([]byte, []int)

Deprecated: Use RPCEvent.ProtoReflect.Descriptor instead.

func (*RPCEvent) GetContext

func (x *RPCEvent) GetContext() map[string]string

func (*RPCEvent) GetDescription

func (x *RPCEvent) GetDescription() string

func (*RPCEvent) GetOperationId

func (x *RPCEvent) GetOperationId() string

func (*RPCEvent) GetResourceId

func (x *RPCEvent) GetResourceId() string

func (*RPCEvent) GetRpc

func (x *RPCEvent) GetRpc() string

func (*RPCEvent) GetService

func (x *RPCEvent) GetService() string

func (*RPCEvent) GetStackId

func (x *RPCEvent) GetStackId() string

func (*RPCEvent) GetStatus

func (x *RPCEvent) GetStatus() *common.OperationResp

func (*RPCEvent) ProtoMessage

func (*RPCEvent) ProtoMessage()

func (*RPCEvent) ProtoReflect added in v5.7.1

func (x *RPCEvent) ProtoReflect() protoreflect.Message

func (*RPCEvent) Reset

func (x *RPCEvent) Reset()

func (*RPCEvent) String

func (x *RPCEvent) String() string

type SelfTestResponse

type SelfTestResponse struct {
	Result SelfTestResponse_SelfTestResult `protobuf:"varint,1,opt,name=result,proto3,enum=device.SelfTestResponse_SelfTestResult" json:"result,omitempty"`
	// contains filtered or unexported fields
}

Device Self Test Response

func (*SelfTestResponse) Descriptor deprecated

func (*SelfTestResponse) Descriptor() ([]byte, []int)

Deprecated: Use SelfTestResponse.ProtoReflect.Descriptor instead.

func (*SelfTestResponse) GetResult

func (*SelfTestResponse) ProtoMessage

func (*SelfTestResponse) ProtoMessage()

func (*SelfTestResponse) ProtoReflect added in v5.7.1

func (x *SelfTestResponse) ProtoReflect() protoreflect.Message

func (*SelfTestResponse) Reset

func (x *SelfTestResponse) Reset()

func (*SelfTestResponse) String

func (x *SelfTestResponse) String() string

type SelfTestResponse_SelfTestResult

type SelfTestResponse_SelfTestResult int32
const (
	SelfTestResponse_SUCCESS       SelfTestResponse_SelfTestResult = 0
	SelfTestResponse_FAILURE       SelfTestResponse_SelfTestResult = 1
	SelfTestResponse_NOT_SUPPORTED SelfTestResponse_SelfTestResult = 2
	SelfTestResponse_UNKNOWN_ERROR SelfTestResponse_SelfTestResult = 3
)

func (SelfTestResponse_SelfTestResult) Descriptor added in v5.7.1

func (SelfTestResponse_SelfTestResult) Enum added in v5.7.1

func (SelfTestResponse_SelfTestResult) EnumDescriptor deprecated

func (SelfTestResponse_SelfTestResult) EnumDescriptor() ([]byte, []int)

Deprecated: Use SelfTestResponse_SelfTestResult.Descriptor instead.

func (SelfTestResponse_SelfTestResult) Number added in v5.7.1

func (SelfTestResponse_SelfTestResult) String

func (SelfTestResponse_SelfTestResult) Type added in v5.7.1

type SimulateAlarmRequest

type SimulateAlarmRequest struct {

	// Device Identifier
	Id                  string                             `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Indicator           string                             `protobuf:"bytes,2,opt,name=indicator,proto3" json:"indicator,omitempty"`
	IntfId              string                             `protobuf:"bytes,3,opt,name=intf_id,json=intfId,proto3" json:"intf_id,omitempty"`
	PortTypeName        string                             `protobuf:"bytes,4,opt,name=port_type_name,json=portTypeName,proto3" json:"port_type_name,omitempty"`
	OnuDeviceId         string                             `protobuf:"bytes,5,opt,name=onu_device_id,json=onuDeviceId,proto3" json:"onu_device_id,omitempty"`
	InverseBitErrorRate int32                              `protobuf:"varint,6,opt,name=inverse_bit_error_rate,json=inverseBitErrorRate,proto3" json:"inverse_bit_error_rate,omitempty"`
	Drift               int32                              `protobuf:"varint,7,opt,name=drift,proto3" json:"drift,omitempty"`
	NewEqd              int32                              `protobuf:"varint,8,opt,name=new_eqd,json=newEqd,proto3" json:"new_eqd,omitempty"`
	OnuSerialNumber     string                             `protobuf:"bytes,9,opt,name=onu_serial_number,json=onuSerialNumber,proto3" json:"onu_serial_number,omitempty"`
	Operation           SimulateAlarmRequest_OperationType `protobuf:"varint,10,opt,name=operation,proto3,enum=device.SimulateAlarmRequest_OperationType" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

func (*SimulateAlarmRequest) Descriptor deprecated

func (*SimulateAlarmRequest) Descriptor() ([]byte, []int)

Deprecated: Use SimulateAlarmRequest.ProtoReflect.Descriptor instead.

func (*SimulateAlarmRequest) GetDrift

func (x *SimulateAlarmRequest) GetDrift() int32

func (*SimulateAlarmRequest) GetId

func (x *SimulateAlarmRequest) GetId() string

func (*SimulateAlarmRequest) GetIndicator

func (x *SimulateAlarmRequest) GetIndicator() string

func (*SimulateAlarmRequest) GetIntfId

func (x *SimulateAlarmRequest) GetIntfId() string

func (*SimulateAlarmRequest) GetInverseBitErrorRate

func (x *SimulateAlarmRequest) GetInverseBitErrorRate() int32

func (*SimulateAlarmRequest) GetNewEqd

func (x *SimulateAlarmRequest) GetNewEqd() int32

func (*SimulateAlarmRequest) GetOnuDeviceId

func (x *SimulateAlarmRequest) GetOnuDeviceId() string

func (*SimulateAlarmRequest) GetOnuSerialNumber

func (x *SimulateAlarmRequest) GetOnuSerialNumber() string

func (*SimulateAlarmRequest) GetOperation

func (*SimulateAlarmRequest) GetPortTypeName

func (x *SimulateAlarmRequest) GetPortTypeName() string

func (*SimulateAlarmRequest) ProtoMessage

func (*SimulateAlarmRequest) ProtoMessage()

func (*SimulateAlarmRequest) ProtoReflect added in v5.7.1

func (x *SimulateAlarmRequest) ProtoReflect() protoreflect.Message

func (*SimulateAlarmRequest) Reset

func (x *SimulateAlarmRequest) Reset()

func (*SimulateAlarmRequest) String

func (x *SimulateAlarmRequest) String() string

type SimulateAlarmRequest_OperationType

type SimulateAlarmRequest_OperationType int32
const (
	SimulateAlarmRequest_RAISE SimulateAlarmRequest_OperationType = 0
	SimulateAlarmRequest_CLEAR SimulateAlarmRequest_OperationType = 1
)

func (SimulateAlarmRequest_OperationType) Descriptor added in v5.7.1

func (SimulateAlarmRequest_OperationType) Enum added in v5.7.1

func (SimulateAlarmRequest_OperationType) EnumDescriptor deprecated

func (SimulateAlarmRequest_OperationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use SimulateAlarmRequest_OperationType.Descriptor instead.

func (SimulateAlarmRequest_OperationType) Number added in v5.7.1

func (SimulateAlarmRequest_OperationType) String

func (SimulateAlarmRequest_OperationType) Type added in v5.7.1

type TestModeKeys

type TestModeKeys = common.TestModeKeys

type UnimplementedVolthaServiceServer

type UnimplementedVolthaServiceServer struct{}

UnimplementedVolthaServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedVolthaServiceServer) AbortImageUpgradeToDevice

func (UnimplementedVolthaServiceServer) ActivateImage

func (UnimplementedVolthaServiceServer) ActivateImageUpdate

func (UnimplementedVolthaServiceServer) CancelImageDownload

func (UnimplementedVolthaServiceServer) CommitImage

func (UnimplementedVolthaServiceServer) CreateDevice

func (UnimplementedVolthaServiceServer) CreateEventFilter

func (UnimplementedVolthaServiceServer) DeleteDevice

func (UnimplementedVolthaServiceServer) DeleteEventFilter

func (UnimplementedVolthaServiceServer) DeleteVoipSystemProfile

func (UnimplementedVolthaServiceServer) DeleteVoipUserProfile

func (UnimplementedVolthaServiceServer) DisableDevice

func (UnimplementedVolthaServiceServer) DisableLogicalDevicePort

func (UnimplementedVolthaServiceServer) DisableOnuDevice added in v5.6.6

func (UnimplementedVolthaServiceServer) DisableOnuSerialNumber added in v5.6.6

func (UnimplementedVolthaServiceServer) DisablePort

func (UnimplementedVolthaServiceServer) DownloadImage

func (UnimplementedVolthaServiceServer) DownloadImageToDevice

func (UnimplementedVolthaServiceServer) EnableDevice

func (UnimplementedVolthaServiceServer) EnableLogicalDevicePort

func (UnimplementedVolthaServiceServer) EnableOnuDevice added in v5.6.6

func (UnimplementedVolthaServiceServer) EnableOnuSerialNumber added in v5.6.6

func (UnimplementedVolthaServiceServer) EnablePort

func (UnimplementedVolthaServiceServer) ForceDeleteDevice

func (UnimplementedVolthaServiceServer) GetAlarmDeviceData

func (UnimplementedVolthaServiceServer) GetCoreInstance

func (UnimplementedVolthaServiceServer) GetDevice

func (UnimplementedVolthaServiceServer) GetDeviceType

func (UnimplementedVolthaServiceServer) GetEventFilter

func (UnimplementedVolthaServiceServer) GetExtValue

func (UnimplementedVolthaServiceServer) GetImageDownload

func (UnimplementedVolthaServiceServer) GetImageDownloadStatus

func (UnimplementedVolthaServiceServer) GetImageStatus

func (UnimplementedVolthaServiceServer) GetImages

func (UnimplementedVolthaServiceServer) GetLogicalDevice

func (UnimplementedVolthaServiceServer) GetLogicalDevicePort

func (UnimplementedVolthaServiceServer) GetMibDeviceData

func (UnimplementedVolthaServiceServer) GetOnuImages

func (UnimplementedVolthaServiceServer) GetVoltha

func (UnimplementedVolthaServiceServer) ListAdapters

func (UnimplementedVolthaServiceServer) ListCoreInstances

func (UnimplementedVolthaServiceServer) ListDeviceFlowGroups

func (UnimplementedVolthaServiceServer) ListDeviceFlows

func (UnimplementedVolthaServiceServer) ListDeviceIds

func (UnimplementedVolthaServiceServer) ListDevicePmConfigs

func (UnimplementedVolthaServiceServer) ListDevicePorts

func (UnimplementedVolthaServiceServer) ListDeviceTypes

func (UnimplementedVolthaServiceServer) ListDevices

func (UnimplementedVolthaServiceServer) ListEventFilters

func (UnimplementedVolthaServiceServer) ListImageDownloads

func (UnimplementedVolthaServiceServer) ListLogicalDeviceFlowGroups

func (UnimplementedVolthaServiceServer) ListLogicalDeviceFlows

func (UnimplementedVolthaServiceServer) ListLogicalDeviceMeters

func (UnimplementedVolthaServiceServer) ListLogicalDevicePorts

func (UnimplementedVolthaServiceServer) ListLogicalDevices

func (UnimplementedVolthaServiceServer) PutVoipSystemProfile

func (UnimplementedVolthaServiceServer) PutVoipUserProfile

func (UnimplementedVolthaServiceServer) RebootDevice

func (UnimplementedVolthaServiceServer) ReceiveChangeEvents

func (UnimplementedVolthaServiceServer) ReceivePacketsIn

func (UnimplementedVolthaServiceServer) ReconcileDevices

func (UnimplementedVolthaServiceServer) RevertImageUpdate

func (UnimplementedVolthaServiceServer) SelfTest

func (UnimplementedVolthaServiceServer) SetExtValue

func (UnimplementedVolthaServiceServer) SimulateAlarm

func (UnimplementedVolthaServiceServer) StartOmciTestAction

func (UnimplementedVolthaServiceServer) StreamPacketsOut

func (UnimplementedVolthaServiceServer) UpdateDevice added in v5.6.7

func (UnimplementedVolthaServiceServer) UpdateDevicePmConfigs

func (UnimplementedVolthaServiceServer) UpdateEventFilter

func (UnimplementedVolthaServiceServer) UpdateLogicalDeviceFlowGroupTable

func (UnimplementedVolthaServiceServer) UpdateLogicalDeviceFlowTable

func (UnimplementedVolthaServiceServer) UpdateLogicalDeviceMeterTable

type UnsafeVolthaServiceServer added in v5.7.1

type UnsafeVolthaServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeVolthaServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VolthaServiceServer will result in compilation errors.

type UpdateDevice added in v5.6.7

type UpdateDevice struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` //Device id of the device, for now only updating the OLT device is supported, and only ip address of the OLT
	// Types that are valid to be assigned to Address:
	//
	//	*UpdateDevice_Ipv4Address
	//	*UpdateDevice_Ipv6Address
	//	*UpdateDevice_HostAndPort
	Address isUpdateDevice_Address `protobuf_oneof:"address"`
	// contains filtered or unexported fields
}

func (*UpdateDevice) Descriptor deprecated added in v5.6.7

func (*UpdateDevice) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDevice.ProtoReflect.Descriptor instead.

func (*UpdateDevice) GetAddress added in v5.6.7

func (x *UpdateDevice) GetAddress() isUpdateDevice_Address

func (*UpdateDevice) GetHostAndPort added in v5.6.7

func (x *UpdateDevice) GetHostAndPort() string

func (*UpdateDevice) GetId added in v5.6.7

func (x *UpdateDevice) GetId() string

func (*UpdateDevice) GetIpv4Address added in v5.6.7

func (x *UpdateDevice) GetIpv4Address() string

func (*UpdateDevice) GetIpv6Address added in v5.6.7

func (x *UpdateDevice) GetIpv6Address() string

func (*UpdateDevice) ProtoMessage added in v5.6.7

func (*UpdateDevice) ProtoMessage()

func (*UpdateDevice) ProtoReflect added in v5.7.1

func (x *UpdateDevice) ProtoReflect() protoreflect.Message

func (*UpdateDevice) Reset added in v5.6.7

func (x *UpdateDevice) Reset()

func (*UpdateDevice) String added in v5.6.7

func (x *UpdateDevice) String() string

type UpdateDevice_HostAndPort added in v5.6.7

type UpdateDevice_HostAndPort struct {
	HostAndPort string `protobuf:"bytes,4,opt,name=host_and_port,json=hostAndPort,proto3,oneof"`
}

type UpdateDevice_Ipv4Address added in v5.6.7

type UpdateDevice_Ipv4Address struct {
	// Device contact IPv4 address (format: "a.b.c.d" or can use hostname too)
	Ipv4Address string `protobuf:"bytes,2,opt,name=ipv4_address,json=ipv4Address,proto3,oneof"`
}

type UpdateDevice_Ipv6Address added in v5.6.7

type UpdateDevice_Ipv6Address struct {
	// Device contact IPv6 address using the canonical string form
	// ("xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx")
	Ipv6Address string `protobuf:"bytes,3,opt,name=ipv6_address,json=ipv6Address,proto3,oneof"`
}

type Voltha

type Voltha struct {
	Version           string                  `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	Adapters          []*Adapter              `protobuf:"bytes,2,rep,name=adapters,proto3" json:"adapters,omitempty"`
	LogicalDevices    []*LogicalDevice        `protobuf:"bytes,3,rep,name=logical_devices,json=logicalDevices,proto3" json:"logical_devices,omitempty"`
	Devices           []*Device               `protobuf:"bytes,4,rep,name=devices,proto3" json:"devices,omitempty"`
	DeviceTypes       []*DeviceType           `protobuf:"bytes,5,rep,name=device_types,json=deviceTypes,proto3" json:"device_types,omitempty"`
	EventFilters      []*EventFilter          `protobuf:"bytes,7,rep,name=event_filters,json=eventFilters,proto3" json:"event_filters,omitempty"`
	OmciMibDatabase   []*omci.MibDeviceData   `protobuf:"bytes,28,rep,name=omci_mib_database,json=omciMibDatabase,proto3" json:"omci_mib_database,omitempty"`
	OmciAlarmDatabase []*omci.AlarmDeviceData `protobuf:"bytes,29,rep,name=omci_alarm_database,json=omciAlarmDatabase,proto3" json:"omci_alarm_database,omitempty"`
	// contains filtered or unexported fields
}

Voltha represents the Voltha cluster data. Each Core instance will hold a subset of the entire cluster. However, some items (e.g. adapters) will be held by all cores for better performance

func (*Voltha) Descriptor deprecated

func (*Voltha) Descriptor() ([]byte, []int)

Deprecated: Use Voltha.ProtoReflect.Descriptor instead.

func (*Voltha) GetAdapters

func (x *Voltha) GetAdapters() []*Adapter

func (*Voltha) GetDeviceTypes

func (x *Voltha) GetDeviceTypes() []*DeviceType

func (*Voltha) GetDevices

func (x *Voltha) GetDevices() []*Device

func (*Voltha) GetEventFilters

func (x *Voltha) GetEventFilters() []*EventFilter

func (*Voltha) GetLogicalDevices

func (x *Voltha) GetLogicalDevices() []*LogicalDevice

func (*Voltha) GetOmciAlarmDatabase

func (x *Voltha) GetOmciAlarmDatabase() []*omci.AlarmDeviceData

func (*Voltha) GetOmciMibDatabase

func (x *Voltha) GetOmciMibDatabase() []*omci.MibDeviceData

func (*Voltha) GetVersion

func (x *Voltha) GetVersion() string

func (*Voltha) ProtoMessage

func (*Voltha) ProtoMessage()

func (*Voltha) ProtoReflect added in v5.7.1

func (x *Voltha) ProtoReflect() protoreflect.Message

func (*Voltha) Reset

func (x *Voltha) Reset()

func (*Voltha) String

func (x *Voltha) String() string

type VolthaServiceClient

type VolthaServiceClient interface {
	// Get high level information on the Voltha cluster
	GetVoltha(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*Voltha, error)
	// List all Voltha cluster core instances
	ListCoreInstances(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*CoreInstances, error)
	// Get details on a Voltha cluster instance
	GetCoreInstance(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*CoreInstance, error)
	// List all active adapters (plugins) in the Voltha cluster
	ListAdapters(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*Adapters, error)
	// List all logical devices managed by the Voltha cluster
	ListLogicalDevices(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*LogicalDevices, error)
	// Get additional information on a given logical device
	GetLogicalDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*LogicalDevice, error)
	// List ports of a logical device
	ListLogicalDevicePorts(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*LogicalPorts, error)
	// Gets a logical device port
	GetLogicalDevicePort(ctx context.Context, in *LogicalPortId, opts ...grpc.CallOption) (*LogicalPort, error)
	// Enables a logical device port
	EnableLogicalDevicePort(ctx context.Context, in *LogicalPortId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Disables a logical device port
	DisableLogicalDevicePort(ctx context.Context, in *LogicalPortId, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List all flows of a logical device
	ListLogicalDeviceFlows(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*openflow_13.Flows, error)
	// Update flow table for logical device
	UpdateLogicalDeviceFlowTable(ctx context.Context, in *openflow_13.FlowTableUpdate, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Update meter table for logical device
	UpdateLogicalDeviceMeterTable(ctx context.Context, in *openflow_13.MeterModUpdate, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List all meters of a logical device
	ListLogicalDeviceMeters(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*openflow_13.Meters, error)
	// List all flow groups of a logical device
	ListLogicalDeviceFlowGroups(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*openflow_13.FlowGroups, error)
	// Update group table for device
	UpdateLogicalDeviceFlowGroupTable(ctx context.Context, in *openflow_13.FlowGroupTableUpdate, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List all physical devices controlled by the Voltha cluster
	ListDevices(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*Devices, error)
	// List all physical devices IDs controlled by the Voltha cluster
	ListDeviceIds(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*common.IDs, error)
	// Request to a voltha Core to reconcile a set of devices based on their IDs
	ReconcileDevices(ctx context.Context, in *common.IDs, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get more information on a given physical device
	GetDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*Device, error)
	// Pre-provision a new physical device
	CreateDevice(ctx context.Context, in *Device, opts ...grpc.CallOption) (*Device, error)
	// Enable a device.  If the device was in pre-provisioned state then it
	// will transition to ENABLED state.  If it was is DISABLED state then it
	// will transition to ENABLED state as well.
	EnableDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Disable a device
	DisableDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Reboot a device
	RebootDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Delete a device
	DeleteDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Forcefully delete a device
	ForceDeleteDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deprecated: Do not use.
	// Request an image download to the standby partition
	// of a device.
	// Note that the call is expected to be non-blocking.
	DownloadImage(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Get image download status on a device
	// The request retrieves progress on device and updates db record
	// Deprecated in voltha 2.8, will be removed
	GetImageDownloadStatus(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*ImageDownload, error)
	// Deprecated: Do not use.
	// Get image download db record
	// Deprecated in voltha 2.8, will be removed
	GetImageDownload(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*ImageDownload, error)
	// Deprecated: Do not use.
	// List image download db records for a given device
	// Deprecated in voltha 2.8, will be removed
	ListImageDownloads(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*ImageDownloads, error)
	// Deprecated: Do not use.
	// Cancel an existing image download process on a device
	// Deprecated in voltha 2.8, will be removed
	CancelImageDownload(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Activate the specified image at a standby partition
	// to active partition.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device
	// Note that the call is expected to be non-blocking.
	// Deprecated in voltha 2.8, will be removed
	ActivateImageUpdate(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Revert the specified image at standby partition
	// to active partition, and revert to previous image
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// previous image running on device
	// Note that the call is expected to be non-blocking.
	// Deprecated in voltha 2.8, will be removed
	RevertImageUpdate(ctx context.Context, in *ImageDownload, opts ...grpc.CallOption) (*common.OperationResp, error)
	// Downloads a certain image to the standby partition of the devices
	// Note that the call is expected to be non-blocking.
	DownloadImageToDevice(ctx context.Context, in *DeviceImageDownloadRequest, opts ...grpc.CallOption) (*DeviceImageResponse, error)
	// Get image status on a number of devices devices
	// Polled from northbound systems to get state of download/activate/commit
	GetImageStatus(ctx context.Context, in *DeviceImageRequest, opts ...grpc.CallOption) (*DeviceImageResponse, error)
	// Aborts the upgrade of an image on a device
	// To be used carefully, stops any further operations for the Image on the given devices
	// Might also stop if possible existing work, but no guarantees are given,
	// depends on implementation and procedure status.
	AbortImageUpgradeToDevice(ctx context.Context, in *DeviceImageRequest, opts ...grpc.CallOption) (*DeviceImageResponse, error)
	// Get Both Active and Standby image for a given device
	GetOnuImages(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*OnuImages, error)
	// Activate the specified image from a standby partition
	// to active partition.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device
	// Note that the call is expected to be non-blocking.
	ActivateImage(ctx context.Context, in *DeviceImageRequest, opts ...grpc.CallOption) (*DeviceImageResponse, error)
	// Commit the specified image to be default.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device upon next reboot
	// Note that the call is expected to be non-blocking.
	CommitImage(ctx context.Context, in *DeviceImageRequest, opts ...grpc.CallOption) (*DeviceImageResponse, error)
	// List ports of a device
	ListDevicePorts(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*Ports, error)
	// List pm config of a device
	ListDevicePmConfigs(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*PmConfigs, error)
	// Update the pm config of a device
	UpdateDevicePmConfigs(ctx context.Context, in *PmConfigs, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// List all flows of a device
	ListDeviceFlows(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*openflow_13.Flows, error)
	// List all flow groups of a device
	ListDeviceFlowGroups(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*openflow_13.FlowGroups, error)
	// List device types known to Voltha
	ListDeviceTypes(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*DeviceTypes, error)
	// Get additional information on a device type
	GetDeviceType(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*DeviceType, error)
	// Stream control packets to the dataplane
	StreamPacketsOut(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[openflow_13.PacketOut, emptypb.Empty], error)
	// Receive control packet stream
	ReceivePacketsIn(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (grpc.ServerStreamingClient[openflow_13.PacketIn], error)
	ReceiveChangeEvents(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (grpc.ServerStreamingClient[openflow_13.ChangeEvent], error)
	CreateEventFilter(ctx context.Context, in *EventFilter, opts ...grpc.CallOption) (*EventFilter, error)
	// Get all filters present for a device
	GetEventFilter(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*EventFilters, error)
	UpdateEventFilter(ctx context.Context, in *EventFilter, opts ...grpc.CallOption) (*EventFilter, error)
	DeleteEventFilter(ctx context.Context, in *EventFilter, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Get all the filters present
	ListEventFilters(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*EventFilters, error)
	GetImages(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*Images, error)
	SelfTest(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*SelfTestResponse, error)
	// OpenOMCI MIB information
	GetMibDeviceData(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*omci.MibDeviceData, error)
	// OpenOMCI ALARM information
	GetAlarmDeviceData(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*omci.AlarmDeviceData, error)
	// Simulate an Alarm
	SimulateAlarm(ctx context.Context, in *SimulateAlarmRequest, opts ...grpc.CallOption) (*common.OperationResp, error)
	EnablePort(ctx context.Context, in *Port, opts ...grpc.CallOption) (*emptypb.Empty, error)
	DisablePort(ctx context.Context, in *Port, opts ...grpc.CallOption) (*emptypb.Empty, error)
	GetExtValue(ctx context.Context, in *extension.ValueSpecifier, opts ...grpc.CallOption) (*extension.ReturnValues, error)
	SetExtValue(ctx context.Context, in *extension.ValueSet, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// omci start and stop cli implementation
	StartOmciTestAction(ctx context.Context, in *omci.OmciTestRequest, opts ...grpc.CallOption) (*omci.TestResponse, error)
	// Saves or updates system wide configuration into voltha KV
	PutVoipSystemProfile(ctx context.Context, in *voip_system_profile.VoipSystemProfileRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deletes the given profile from voltha KV
	DeleteVoipSystemProfile(ctx context.Context, in *common.Key, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Saves or updates a profile (VOIP) into voltha KV
	PutVoipUserProfile(ctx context.Context, in *voip_user_profile.VoipUserProfileRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Deletes the given profile from voltha KV
	DeleteVoipUserProfile(ctx context.Context, in *common.Key, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Disables the ONU, stops it from participating in the ranging process. different from DisableDevice
	DisableOnuDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Enables the ONU at the PLOAM , enables the ONU to participate in the ranging process. different from EnableDevice
	EnableOnuDevice(ctx context.Context, in *common.ID, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Disables the ONU at the PLOAM , different from DisableDevice. This would be used if the Device is not present in the VOLTHA
	DisableOnuSerialNumber(ctx context.Context, in *OnuSerialNumberOnOLTPon, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Disables the ONU at the PLOAM , different from EnableDevice. This would be used if the Device is not present in the VOLTHA
	EnableOnuSerialNumber(ctx context.Context, in *OnuSerialNumberOnOLTPon, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Update the Device configuration, for now only ip address updation is supported
	UpdateDevice(ctx context.Context, in *UpdateDevice, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

VolthaServiceClient is the client API for VolthaService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Voltha APIs

type VolthaServiceServer

type VolthaServiceServer interface {
	// Get high level information on the Voltha cluster
	GetVoltha(context.Context, *emptypb.Empty) (*Voltha, error)
	// List all Voltha cluster core instances
	ListCoreInstances(context.Context, *emptypb.Empty) (*CoreInstances, error)
	// Get details on a Voltha cluster instance
	GetCoreInstance(context.Context, *common.ID) (*CoreInstance, error)
	// List all active adapters (plugins) in the Voltha cluster
	ListAdapters(context.Context, *emptypb.Empty) (*Adapters, error)
	// List all logical devices managed by the Voltha cluster
	ListLogicalDevices(context.Context, *emptypb.Empty) (*LogicalDevices, error)
	// Get additional information on a given logical device
	GetLogicalDevice(context.Context, *common.ID) (*LogicalDevice, error)
	// List ports of a logical device
	ListLogicalDevicePorts(context.Context, *common.ID) (*LogicalPorts, error)
	// Gets a logical device port
	GetLogicalDevicePort(context.Context, *LogicalPortId) (*LogicalPort, error)
	// Enables a logical device port
	EnableLogicalDevicePort(context.Context, *LogicalPortId) (*emptypb.Empty, error)
	// Disables a logical device port
	DisableLogicalDevicePort(context.Context, *LogicalPortId) (*emptypb.Empty, error)
	// List all flows of a logical device
	ListLogicalDeviceFlows(context.Context, *common.ID) (*openflow_13.Flows, error)
	// Update flow table for logical device
	UpdateLogicalDeviceFlowTable(context.Context, *openflow_13.FlowTableUpdate) (*emptypb.Empty, error)
	// Update meter table for logical device
	UpdateLogicalDeviceMeterTable(context.Context, *openflow_13.MeterModUpdate) (*emptypb.Empty, error)
	// List all meters of a logical device
	ListLogicalDeviceMeters(context.Context, *common.ID) (*openflow_13.Meters, error)
	// List all flow groups of a logical device
	ListLogicalDeviceFlowGroups(context.Context, *common.ID) (*openflow_13.FlowGroups, error)
	// Update group table for device
	UpdateLogicalDeviceFlowGroupTable(context.Context, *openflow_13.FlowGroupTableUpdate) (*emptypb.Empty, error)
	// List all physical devices controlled by the Voltha cluster
	ListDevices(context.Context, *emptypb.Empty) (*Devices, error)
	// List all physical devices IDs controlled by the Voltha cluster
	ListDeviceIds(context.Context, *emptypb.Empty) (*common.IDs, error)
	// Request to a voltha Core to reconcile a set of devices based on their IDs
	ReconcileDevices(context.Context, *common.IDs) (*emptypb.Empty, error)
	// Get more information on a given physical device
	GetDevice(context.Context, *common.ID) (*Device, error)
	// Pre-provision a new physical device
	CreateDevice(context.Context, *Device) (*Device, error)
	// Enable a device.  If the device was in pre-provisioned state then it
	// will transition to ENABLED state.  If it was is DISABLED state then it
	// will transition to ENABLED state as well.
	EnableDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Disable a device
	DisableDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Reboot a device
	RebootDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Delete a device
	DeleteDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Forcefully delete a device
	ForceDeleteDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Deprecated: Do not use.
	// Request an image download to the standby partition
	// of a device.
	// Note that the call is expected to be non-blocking.
	DownloadImage(context.Context, *ImageDownload) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Get image download status on a device
	// The request retrieves progress on device and updates db record
	// Deprecated in voltha 2.8, will be removed
	GetImageDownloadStatus(context.Context, *ImageDownload) (*ImageDownload, error)
	// Deprecated: Do not use.
	// Get image download db record
	// Deprecated in voltha 2.8, will be removed
	GetImageDownload(context.Context, *ImageDownload) (*ImageDownload, error)
	// Deprecated: Do not use.
	// List image download db records for a given device
	// Deprecated in voltha 2.8, will be removed
	ListImageDownloads(context.Context, *common.ID) (*ImageDownloads, error)
	// Deprecated: Do not use.
	// Cancel an existing image download process on a device
	// Deprecated in voltha 2.8, will be removed
	CancelImageDownload(context.Context, *ImageDownload) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Activate the specified image at a standby partition
	// to active partition.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device
	// Note that the call is expected to be non-blocking.
	// Deprecated in voltha 2.8, will be removed
	ActivateImageUpdate(context.Context, *ImageDownload) (*common.OperationResp, error)
	// Deprecated: Do not use.
	// Revert the specified image at standby partition
	// to active partition, and revert to previous image
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// previous image running on device
	// Note that the call is expected to be non-blocking.
	// Deprecated in voltha 2.8, will be removed
	RevertImageUpdate(context.Context, *ImageDownload) (*common.OperationResp, error)
	// Downloads a certain image to the standby partition of the devices
	// Note that the call is expected to be non-blocking.
	DownloadImageToDevice(context.Context, *DeviceImageDownloadRequest) (*DeviceImageResponse, error)
	// Get image status on a number of devices devices
	// Polled from northbound systems to get state of download/activate/commit
	GetImageStatus(context.Context, *DeviceImageRequest) (*DeviceImageResponse, error)
	// Aborts the upgrade of an image on a device
	// To be used carefully, stops any further operations for the Image on the given devices
	// Might also stop if possible existing work, but no guarantees are given,
	// depends on implementation and procedure status.
	AbortImageUpgradeToDevice(context.Context, *DeviceImageRequest) (*DeviceImageResponse, error)
	// Get Both Active and Standby image for a given device
	GetOnuImages(context.Context, *common.ID) (*OnuImages, error)
	// Activate the specified image from a standby partition
	// to active partition.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device
	// Note that the call is expected to be non-blocking.
	ActivateImage(context.Context, *DeviceImageRequest) (*DeviceImageResponse, error)
	// Commit the specified image to be default.
	// Depending on the device implementation, this call
	// may or may not cause device reboot.
	// If no reboot, then a reboot is required to make the
	// activated image running on device upon next reboot
	// Note that the call is expected to be non-blocking.
	CommitImage(context.Context, *DeviceImageRequest) (*DeviceImageResponse, error)
	// List ports of a device
	ListDevicePorts(context.Context, *common.ID) (*Ports, error)
	// List pm config of a device
	ListDevicePmConfigs(context.Context, *common.ID) (*PmConfigs, error)
	// Update the pm config of a device
	UpdateDevicePmConfigs(context.Context, *PmConfigs) (*emptypb.Empty, error)
	// List all flows of a device
	ListDeviceFlows(context.Context, *common.ID) (*openflow_13.Flows, error)
	// List all flow groups of a device
	ListDeviceFlowGroups(context.Context, *common.ID) (*openflow_13.FlowGroups, error)
	// List device types known to Voltha
	ListDeviceTypes(context.Context, *emptypb.Empty) (*DeviceTypes, error)
	// Get additional information on a device type
	GetDeviceType(context.Context, *common.ID) (*DeviceType, error)
	// Stream control packets to the dataplane
	StreamPacketsOut(grpc.ClientStreamingServer[openflow_13.PacketOut, emptypb.Empty]) error
	// Receive control packet stream
	ReceivePacketsIn(*emptypb.Empty, grpc.ServerStreamingServer[openflow_13.PacketIn]) error
	ReceiveChangeEvents(*emptypb.Empty, grpc.ServerStreamingServer[openflow_13.ChangeEvent]) error
	CreateEventFilter(context.Context, *EventFilter) (*EventFilter, error)
	// Get all filters present for a device
	GetEventFilter(context.Context, *common.ID) (*EventFilters, error)
	UpdateEventFilter(context.Context, *EventFilter) (*EventFilter, error)
	DeleteEventFilter(context.Context, *EventFilter) (*emptypb.Empty, error)
	// Get all the filters present
	ListEventFilters(context.Context, *emptypb.Empty) (*EventFilters, error)
	GetImages(context.Context, *common.ID) (*Images, error)
	SelfTest(context.Context, *common.ID) (*SelfTestResponse, error)
	// OpenOMCI MIB information
	GetMibDeviceData(context.Context, *common.ID) (*omci.MibDeviceData, error)
	// OpenOMCI ALARM information
	GetAlarmDeviceData(context.Context, *common.ID) (*omci.AlarmDeviceData, error)
	// Simulate an Alarm
	SimulateAlarm(context.Context, *SimulateAlarmRequest) (*common.OperationResp, error)
	EnablePort(context.Context, *Port) (*emptypb.Empty, error)
	DisablePort(context.Context, *Port) (*emptypb.Empty, error)
	GetExtValue(context.Context, *extension.ValueSpecifier) (*extension.ReturnValues, error)
	SetExtValue(context.Context, *extension.ValueSet) (*emptypb.Empty, error)
	// omci start and stop cli implementation
	StartOmciTestAction(context.Context, *omci.OmciTestRequest) (*omci.TestResponse, error)
	// Saves or updates system wide configuration into voltha KV
	PutVoipSystemProfile(context.Context, *voip_system_profile.VoipSystemProfileRequest) (*emptypb.Empty, error)
	// Deletes the given profile from voltha KV
	DeleteVoipSystemProfile(context.Context, *common.Key) (*emptypb.Empty, error)
	// Saves or updates a profile (VOIP) into voltha KV
	PutVoipUserProfile(context.Context, *voip_user_profile.VoipUserProfileRequest) (*emptypb.Empty, error)
	// Deletes the given profile from voltha KV
	DeleteVoipUserProfile(context.Context, *common.Key) (*emptypb.Empty, error)
	// Disables the ONU, stops it from participating in the ranging process. different from DisableDevice
	DisableOnuDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Enables the ONU at the PLOAM , enables the ONU to participate in the ranging process. different from EnableDevice
	EnableOnuDevice(context.Context, *common.ID) (*emptypb.Empty, error)
	// Disables the ONU at the PLOAM , different from DisableDevice. This would be used if the Device is not present in the VOLTHA
	DisableOnuSerialNumber(context.Context, *OnuSerialNumberOnOLTPon) (*emptypb.Empty, error)
	// Disables the ONU at the PLOAM , different from EnableDevice. This would be used if the Device is not present in the VOLTHA
	EnableOnuSerialNumber(context.Context, *OnuSerialNumberOnOLTPon) (*emptypb.Empty, error)
	// Update the Device configuration, for now only ip address updation is supported
	UpdateDevice(context.Context, *UpdateDevice) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

VolthaServiceServer is the server API for VolthaService service. All implementations must embed UnimplementedVolthaServiceServer for forward compatibility.

Voltha APIs

type VolthaService_ReceiveChangeEventsClient

type VolthaService_ReceiveChangeEventsClient = grpc.ServerStreamingClient[openflow_13.ChangeEvent]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VolthaService_ReceiveChangeEventsServer

type VolthaService_ReceiveChangeEventsServer = grpc.ServerStreamingServer[openflow_13.ChangeEvent]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VolthaService_ReceivePacketsInClient

type VolthaService_ReceivePacketsInClient = grpc.ServerStreamingClient[openflow_13.PacketIn]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VolthaService_ReceivePacketsInServer

type VolthaService_ReceivePacketsInServer = grpc.ServerStreamingServer[openflow_13.PacketIn]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VolthaService_StreamPacketsOutClient

type VolthaService_StreamPacketsOutClient = grpc.ClientStreamingClient[openflow_13.PacketOut, emptypb.Empty]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VolthaService_StreamPacketsOutServer

type VolthaService_StreamPacketsOutServer = grpc.ClientStreamingServer[openflow_13.PacketOut, emptypb.Empty]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

Jump to

Keyboard shortcuts

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