Skip to content

Protocol Documentation

Table of Contents

Top

api/diags/diags.proto

ListDeviceChangeRequest

ListDeviceChangeRequest requests a stream of changes and updates to them By default, the request requests a stream of all changes that are present in the topology when the request is received by the service. However, if subscribe is true, the stream will remain open after all changes have been sent and events that occur following the last changes will be streamed to the client until the stream is closed. If "withoutReplay" is true then only changes that happen after the call will be returned

Field Type Label Description
subscribe bool subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur after all devices have been streamed to the client
device_id string option to specify a specific device change - if blank or '*' then select all Can support * (match many chars) or '?' (match one char) as wildcard
device_version string device_version is an optional device version
withoutReplay bool option to request only changes that happen after the call

ListDeviceChangeResponse

ListDeviceChangeResponse carries a single network change event

Field Type Label Description
change onos.config.change.device.DeviceChange change is the device change on which the event occurred
type Type type is a qualification of the type of change being made

ListNetworkChangeRequest

ListNetworkChangeRequest requests a stream of changes and updates to them By default, the request requests a stream of all changes that are present in the topology when the request is received by the service. However, if subscribe is true, the stream will remain open after all changes have been sent and events that occur following the last changes will be streamed to the client until the stream is closed. If "withoutReplay" is true then only changes that happen after the call will be returned

Field Type Label Description
subscribe bool subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur after all devices have been streamed to the client
changeid string option to specify a specific network change - if blank or '*' then select all Can support * (match many chars) or '?' (match one char) as wildcard
withoutReplay bool option to request only changes that happen after the call

ListNetworkChangeResponse

ListNetworkChangeResponse carries a single network change event

Field Type Label Description
change onos.config.change.network.NetworkChange change is the network change on which the event occurred
type Type type is a qualification of the type of change being made

OpStateRequest

OpStateRequest is a message for specifying GetOpState query parameters.

Field Type Label Description
deviceId string The request is always in the context of a Device ID. If the device does not exist or is disconnected an error will be returned.
subscribe bool subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur after all paths for the device have been streamed to the client

OpStateResponse

Field Type Label Description
type onos.config.admin.Type type is the type of the event
pathvalue onos.config.change.device.PathValue device is the device on which the event occurred

Type

Change (Network or Device) event type

Name Number Description
NONE 0 NONE indicates this response does not represent a modification of the Change
ADDED 1 ADDED is an event which occurs when a Change is added to the topology
UPDATED 2 UPDATED is an event which occurs when a Change is updated
REMOVED 3 REMOVED is an event which occurs when a Change is removed from the configuration

ChangeService

Method Name Request Type Response Type Description
ListNetworkChanges ListNetworkChangeRequest ListNetworkChangeResponse stream List gets a stream of network change add/update/remove events for network changes matching changeid
ListDeviceChanges ListDeviceChangeRequest ListDeviceChangeResponse stream List gets a stream of device change add/update/remove events for device changes matching changeid

OpStateDiags

OpStateDiags provides means for obtaining diagnostic information about internal system state.

Method Name Request Type Response Type Description
GetOpState OpStateRequest OpStateResponse stream GetOpState returns a stream of submitted OperationalStateCache aimed at individual devices. If subscribe is true keep on streaming after the initial set are finished

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type
double double double float
float float float float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long
uint32 Uses variable-length encoding. uint32 int int/long
uint64 Uses variable-length encoding. uint64 long int/long
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long
sfixed32 Always four bytes. int32 int int
sfixed64 Always eight bytes. int64 long int/long
bool bool boolean boolean
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode
bytes May contain any arbitrary sequence of bytes. string ByteString str